Cancel and fence an unposted closing

POST/loans/{id}/closings/{case}/cancellation

Path parameters

idstringRequired

casestringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

evidence_sha256stringRequired

reasonstringRequired

Returns

200 OK

caseobjectRequired

15 child attributes

created_atstring · date-timeRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

day_countstringOptional

escrow_monthly_amountintegerRequired

idstringRequired

makerstringRequired

planobjectRequired

15 child attributes

consummation_datestring · dateRequired

A business date, YYYY-MM-DD

escrow_analysis_idstringOptional

escrow_waiver_sha256stringOptional

first_payment_datestring · dateRequired

A business date, YYYY-MM-DD

flood_insurance_requiredbooleanRequired

funding_datestring · dateRequired

A business date, YYYY-MM-DD

operating_calendarobjectRequired

2 child attributes

closedarray of string · dateRequired

weekdaysarray of integersRequired

partiesarray of stringsRequired

Borrower/signers

policy_sha256stringRequired

principal_dwellingbooleanRequired

purposestringRequired

real_estatebooleanRequired

requirementsarray of objectsRequired

2 child attributes

codestringRequired

stagestringRequired

Consummation or funding

rescission_ownersarray of stringsRequired

statestringRequired

principal_amountintegerRequired

product_codestringRequired

product_versionintegerRequired

rate_bpsintegerRequired

rescission_requiredbooleanRequired

target_idstringRequired

target_kindstringRequired

term_monthsintegerRequired

decisionobject or nullOptional

4 child attributes

actorstringRequired

approvebooleanRequired

atstring · date-timeRequired

reasonstringRequired

documentsarray of objectsRequired

11 child attributes

case_idstringRequired

Example case_2tVh8nqLxq4GbDe0K1F6S9zRcWm

codestringRequired

created_atstring · date-timeRequired

decisionobject or nullOptional

4 child attributes

actorstringRequired

approvebooleanRequired

atstring · date-timeRequired

reasonstringRequired

idstringRequired

Example achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm

makerstringRequired

receiptsarray of objectsRequired

5 child attributes

atstring · date-timeRequired

consent_sha256stringOptional

copiesintegerRequired

methodstringRequired

Paper or electronic

partystringRequired

referencestringRequired

sha256stringRequired

signaturesarray of objectsRequired

3 child attributes

atstring · date-timeRequired

evidence_sha256stringRequired

partystringRequired

valid_throughstring · dateOptional

A business date, YYYY-MM-DD

eventsarray of objectsRequired

6 child attributes

actionobject or nullOptional

2 child attributes

evidence_sha256stringRequired

reasonstringRequired

actorstringRequired

atstring · date-timeRequired

consummationobject or nullOptional

2 child attributes

atstring · date-timeRequired

initial_rate_notice_idstringOptional

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

rescission_deadlinestring · date or nullOptional

A business date, YYYY-MM-DD

statusstringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503