Record the signed contractual obligation after disclosure checks
POST
/loans/{id}/closings/{case}/consummationPath parameters
idstringRequiredcasestringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
atstring · date-timeRequiredinitial_rate_notice_idstringOptionalReturns
200 OK
caseobjectRequired15 child attributes
created_atstring · date-timeRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
day_countstringOptionalescrow_monthly_amountintegerRequiredidstringRequiredmakerstringRequiredplanobjectRequired15 child attributes
consummation_datestring · dateRequiredA business date, YYYY-MM-DD
escrow_analysis_idstringOptionalescrow_waiver_sha256stringOptionalfirst_payment_datestring · dateRequiredA business date, YYYY-MM-DD
flood_insurance_requiredbooleanRequiredfunding_datestring · dateRequiredA business date, YYYY-MM-DD
operating_calendarobjectRequired2 child attributes
closedarray of string · dateRequiredweekdaysarray of integersRequiredpartiesarray of stringsRequiredBorrower/signers
policy_sha256stringRequiredprincipal_dwellingbooleanRequiredpurposestringRequiredreal_estatebooleanRequiredrequirementsarray of objectsRequired2 child attributes
codestringRequiredstagestringRequiredConsummation or funding
rescission_ownersarray of stringsRequiredstatestringRequiredprincipal_amountintegerRequiredproduct_codestringRequiredproduct_versionintegerRequiredrate_bpsintegerRequiredrescission_requiredbooleanRequiredtarget_idstringRequiredtarget_kindstringRequiredterm_monthsintegerRequireddecisionobject or nullOptional4 child attributes
actorstringRequiredapprovebooleanRequiredatstring · date-timeRequiredreasonstringRequireddocumentsarray of objectsRequired11 child attributes
case_idstringRequiredExample case_2tVh8nqLxq4GbDe0K1F6S9zRcWm
codestringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional4 child attributes
actorstringRequiredapprovebooleanRequiredatstring · date-timeRequiredreasonstringRequiredidstringRequiredExample achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm
makerstringRequiredreceiptsarray of objectsRequired5 child attributes
atstring · date-timeRequiredconsent_sha256stringOptionalcopiesintegerRequiredmethodstringRequiredPaper or electronic
partystringRequiredreferencestringRequiredsha256stringRequiredsignaturesarray of objectsRequired3 child attributes
atstring · date-timeRequiredevidence_sha256stringRequiredpartystringRequiredvalid_throughstring · dateOptionalA business date, YYYY-MM-DD
eventsarray of objectsRequired6 child attributes
actionobject or nullOptional2 child attributes
evidence_sha256stringRequiredreasonstringRequiredactorstringRequiredatstring · date-timeRequiredconsummationobject or nullOptional2 child attributes
atstring · date-timeRequiredinitial_rate_notice_idstringOptionaljournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredrescission_deadlinestring · date or nullOptionalA business date, YYYY-MM-DD
statusstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503