Record consumer intent after Loan Estimate receipt
POST
/originations/{origin}/intentPath parameters
originstringRequiredHeaders
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-timeRequiredevidence_sha256stringRequiredpartystringRequiredReturns
200 OK
complete_atstring · date-time or nullOptionaldisclosuresarray of objectsRequired4 child attributes
decisionobject or nullOptional4 child attributes
actorstringRequiredapprovebooleanRequiredatstring · date-timeRequiredreasonstringRequireddeliveriesarray of objectsRequired7 child attributes
consent_sha256stringOptionalevidence_sha256stringRequiredmethodstringRequiredIn_person, mail, electronic
partystringRequiredprovider_listobject or nullOptional2 child attributes
revision_idstringRequiredsha256stringRequiredreceived_atstring · date-time or nullOptionalsent_atstring · date-timeRequiredissueobject or nullOptional7 child attributes
actorstringRequiredatstring · date-timeRequiredprovider_listobject or nullOptional3 child attributes
revision_idstringRequiredsha256stringRequiredtemplatestringRequiredretain_throughstring · dateRequiredA business date, YYYY-MM-DD
revision_idstringRequiredsha256stringRequiredtemplatestringRequiredrevisionobjectRequired13 child attributes
calculationobjectRequired14 child attributes
amount_financed_amountintegerRequiredaprstringRequiredapr_lowerstringRequiredapr_upperstringRequiredcash_to_close_amountintegerRequiredclosing_costs_amountintegerRequiredfinance_charge_amountintegerRequiredfive_year_principal_amountintegerRequiredfive_year_total_amountintegerRequiredorigination_amountintegerRequiredpaymentsarray of objectsRequiredtipstringRequiredtotal_interest_amountintegerRequiredtotal_payments_amountintegerRequiredchangeobject or nullOptional5 child attributes
affected_cost_idsarray of stringsRequiredevidence_sha256stringRequiredkindstringRequiredknown_atstring · date-timeRequiredreasonstringRequiredcostsarray of objectsRequired19 child attributes
affiliatebooleanRequiredamountintegerRequiredbona_fide_reasonablebooleanRequiredcan_shopbooleanRequiredcategorystringRequiredevidence_sha256stringRequiredidstringRequiredinsurer_choice_disclosedbooleanRequiredlabelstringRequiredon_provider_listbooleanRequiredpaid_before_amountintegerRequiredpaid_before_atstring · date-time or nullOptionalpaid_bystringRequiredBorrower, seller, other
payeestringRequiredprepaid_monthsintegerOptionalrecording_deed_amountintegerOptionalrecording_mortgage_amountintegerOptionalrequiredbooleanRequiredshoppedboolean or nullOptionalcreated_atstring · date-timeRequiredidstringRequiredkindstringRequiredmakerstringRequirednumberintegerRequiredorigination_idstringRequiredprevious_idstringOptionalprovider_listobject or nullOptional2 child attributes
reuseobject or nullOptionalservicesarray of objectsOptionalprovider_selectionsarray of objectsOptional6 child attributes
cost_idstringRequiredevidence_sha256stringRequiredlistobjectRequiredproviderobjectRequiredselected_atstring · date-timeRequiredselected_bystringRequiredtermsobjectRequired51 child attributes
annual_home_insurance_amountintegerRequiredannual_other_property_cost_amountintegerRequiredannual_property_tax_amountintegerRequiredassumableboolean or nullOptionalThese facts require independent confirmation against the note and applicable state law.
borrower_mailing_addressstringRequiredbuyer_brokerobject or nullOptionalconsummation_datestring · dateRequiredA business date, YYYY-MM-DD
contract_sha256stringRequireddeficiency_protectionboolean or nullOptionaldeposit_amountintegerRequireddeposit_holderstringRequiredescrow_adjustment_amountintegerRequiredescrow_declinedbooleanRequiredescrow_linesarray of objectsRequiredescrow_monthly_amountintegerRequiredescrow_waiver_fee_amountintegerRequiredestimate_expires_atstring · date-timeRequiredfeaturesarray of stringsRequiredfirst_payment_datestring · dateRequiredA business date, YYYY-MM-DD
funding_datestring · dateRequiredA business date, YYYY-MM-DD
grace_daysintegerRequiredinitial_escrow_amountintegerRequiredinsurance_escrowedbooleanRequiredlate_fee_amountintegerRequiredlender_contactobjectRequiredlender_credit_amountintegerRequiredmortgage_brokerobject or nullOptionalother_escrowedbooleanRequiredother_property_cost_labelstringRequiredpartial_paymentsstringRequiredpartiesarray of stringsRequiredprincipal_amountintegerRequiredprofilestringRequiredproperty_addressstringRequiredproperty_value_amountintegerRequiredproperty_value_basisstringRequiredpurposestringRequiredrate_bpsintegerRequiredrate_lock_expires_atstring · date-time or nullOptionalrate_lockedboolean or nullOptionalsale_price_amountintegerRequiredseller_addressstringRequiredseller_brokerobject or nullOptionalseller_credit_amountintegerRequiredseller_namestringRequiredservicingstringRequiredsettlement_agentobjectRequiredsettlement_file_numberstringRequiredstatestringRequiredtax_escrowedbooleanRequiredterm_monthsintegerRequiredestimate_duestring · date or nullOptionalA business date, YYYY-MM-DD
intentobject or nullOptional3 child attributes
atstring · date-timeRequiredevidence_sha256stringRequiredpartystringRequireditemsarray of objectsRequired5 child attributes
amountintegerOptionalevidence_sha256stringRequiredkindstringRequiredreceived_atstring · date-timeRequiredtextstringOptionalloan_idstringOptionalExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
originationobjectRequired8 child attributes
created_atstring · date-timeRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredmakerstringRequiredoperating_calendarobjectRequired2 child attributes
closedarray of string · dateRequiredweekdaysarray of integersRequiredpolicy_sha256stringRequiredproduct_codestringRequiredproduct_versionintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503