Skip to content
Docs

Asset Onboarding/Onboarding

Retrieve an onboard request

GET/api/onboard/{id}
API key required
Request
curl -X GET \
  "https://api.test.figure.com/gateway-asset-onboarding/partner/api/onboard/{id}" \
  -H "apikey: $FIGURE_API_KEY"

Path parameters

  • idstringRequired

    Request name (String) or ID (UUID)

Responses

200OKobject

  • idstring<uuid>Required
  • namestringRequired
  • requestorIdstring<uuid>Required
  • statusenumRequired
    One ofCreatedSubmittedTransformedCompletedFailed
  • manifestobjectRequired
    ShowHide 6 attributes of manifest
    • loanTypeenumRequired
      One ofAUTO_LOANCONSUMER_UNSECUREDDSCRSMBRTL
    • loanTapeobjectRequired

      Origination data for the loans in this request. Required. Send it as a CSV file, an Excel file, or inline JSON. This is separate from the underwriting guideline and from per-loan closing documents.

      One of:

      LoanTapeCsvobject
      • sourceenumRequired
        One ofCSVPAYLOADEXCEL
      • filestringRequired

        CSV file with header row and loan data

      LoanTapeExcelobject
      • sourceenumRequired
        One ofCSVPAYLOADEXCEL
      • filestringRequired

        Excel file with header row and loan data

      LoanTapePayloadobject
      • sourceenumRequired
        One ofCSVPAYLOADEXCEL
      • dataarray of objectsRequired

        Map of key-values for loan tape

    • underwritingGuidelinesstringRequired

      File name of the underwriting guideline that applies to every loan in this request. Any file type is accepted, including PDF and JSON.

    • loansarray of objectsRequired
      ShowHide 3 attributes of loans
      • idstringRequired

        Third-party loan identifier

      • dataobjectRequired
        ShowHide 3 attributes of data
        • servicerIdstring<uuid>Required

          Figure UUID for servicer

        • originatorIdstring<uuid>

          Figure UUID for originator (defaults to the requestor when absent)

        • subservicerIdstring<uuid>

          Figure UUID for sub-servicer, if any

      • filesarray of objectsRequired

        List of loan-specific files. Each entry may be a file name or an object with fileName and documentType. File names must be unique within each loan

        ShowHide 2 attributes of files
        • fileNamestringRequired

          Relative file path

        • documentTypeenumRequired

          Document type

          One of
          948 valuesUSERPHOTOUSER_UPLOADED_DOCDRIVERSLICENSEFRONTDRIVERSLICENSEBACKDRIVERSLICENSE_PDF417PASSPORTFRONTPASSPORTBACKADVERSEACTIONC3ADVERSEACTIONC5DEEDRESERVED8IDCARDFRONTIDCARDBACKIDCARD_PDF417PERMANENTRESIDENTFRONTPERMANENTRESIDENTBACKPERMANENTRESIDENT_PDF417SSN_CARD_FRONTSSN_CARD_BACKBIRTH_CERTIFICATEMARRIAGE_CERTIFICATEHELOCAGREEMENTRESERVED12HOMEOWNERSINSURANCEPROPERTYTITLESERVICINGSTATEMENTSHIPPINGLABELCOUNSELINGAGENCIESAUTOPAYAGREEMENTCOMPLIANCEAGREEMENTFLOODDISCLOSUREINITIALTILAAPPRAISALCREDITDISCLOSURERIGHTTOCANCELCASTATEMENTOFLOANCADEEDOFTRUSTHELOCMORTGAGEAGREEMENTENOTARYVIDEOENOTARYAUDIOTRUSTAGREEMENTARTICLESCERTIFICATEFORMATIONOPERATINGPARNTNERSHIPAGREEMENTOPERATINGPARTNERSHIPAGREEMENTSTATEMENTOFLOANPROPERTYLEGALDESCRIPTIONPROVENANCEDILIGENCELICENSEEINFORMATIONHOMEAPPLICANTFAIRLENDINGPRIVACYGIACTEMAILADDRESSPHOTOGIACTVOIDEDCHECKIMAGEBORROWERINFORMATIONRECORDED_DEEDNACHAPREQUALAPPRAISALPROOFOFHAZARDINSURANCEPROOFOFFLOODINSURANCELENDERPLACEDHAZARDINSURANCELENDERPLACEDFLOODINSURANCENHPAYMENTSMSORIGINAGREEMENTFLANTICOERCIONINNOTICETOBORROWERFRAUDREVIEWSUPPORTPROHIBITEDACTSHOMEBUYERSPROTECTIONACTACKNOWLEDGEMENTOFRECEIPTRIGHTNOTTOCLOSEFILEPROCESSINGFREEDOMTOCHOOSEINSURANCEFIRSTLIENDISCLOSURESFIRSTPAYMENTNOTICELOANSALEDISCLOSUREATTORNEYDISCLOSURELICENSEDISCLOSUREHOMESTEADDISCLOSUREMAFLOODDISCLOSUREPLAID_ASSET_REPORTPROOF_OF_RECORDED_DEEDPAYSTUBTAXRETURNACKNOWLEDGEMENT_TILPROPERTY_TOTAL_VIEW_REPORTHM_OWNER_COUNSELING_NOTICERECORDED_ASSIGNMENTDELINQUENCY_SCRA_NOTICEHOMEOWNERPROTECTIONCENTERNOTIFSERVICINGDISCLOSUREPROPERTY_DESCRIPTION_SOURCETOTAL_VIEW_REPORTMETRO_CREDIT_REPORTEXPERIAN_METRO_CREDIT_REPORTTRANSUNION_METRO_CREDIT_REPORTEQUIFAX_METRO_CREDIT_REPORTCREDIT_REPORTING_DISPUTECREDIT_REPORTING_DISPUTE_RECEIPTINSURANCE_AUTHORIZATIONONSITE_APPRAISALONSITE_INVOICEUMB_ELB401_ACCOUNT_REQUESTUMB_ELB501_ACCOUNT_RESPONSEPAYOFF_REQUESTSIGNED_DEEDSIGNED_NOTEHOME_APPRAISALHOME_INSPECTIONTITLE_DOCUMENTLEASE_AGREEMENTPURCHASE_AGREEMENTCLOSING_DOCUMENTTRANSFER_OF_SERVICING_RIGHTSINITIAL_PURCHASE_AGREEMENTFINAL_PURCHASE_AGREEMENTHOMEOWONERS_INSURANCE_POLICYNAME_AFFIDAVITRAW_HOTDOGW2SS_INCOME_AWARD_LETTERDB_PENSION_ANNUITY_AWARD_LETTERCHILD_SUPPORT_COURT_ORDERALIMONY_COURT_ORDERUSER_UPLOADED_PAYSTUBUSER_UPLOADED_W2LARGE_DEPOSIT_SUPPORTING_INFORMATIONONSITE_FNMA_SUBMISSION_SUMMARYWIRECMEREPORTTITLE_COMMIT_BUNDLEBORROWER_AUTHPAYOFF_STATEMENTGLBA_NOTICERIGHT_TO_CANCEL_HEALTAXPAYER_CONSENTCFPB_HELOC_BOOKLETFBI_MORTGAGE_FRAUD_NOTICEHAZARD_DISCLOSUREADDITIONAL_MORTGAGE_DISCLOSURESANNUAL_STATEMENTSUBORDINATION_REVIEWSUBORDINATION_APPROVEDONSITE_FHLMC_SUBMISSION_SUMMARYCREDIT_SUPPLEMENTSIGNED_4506T_FORMPAYMENT_HISTORYCUSTOMER_DASHBOARD_DOCUMENTPCRADESKTOP_APPRAISALNONAGENCY_DISCLOSUREEQUAL_CREDIT_OPPORTUNITY_ACT_DISCLOSURELOAN_PROVISIONS_DISCLOSUREINTENT_TO_PROCEED_MORTGAGENOTICE_OF_INCOMPLETE_APPLICATION_MORTGAGECONDITIONAL_LOAN_APPROVAL_MORTGAGEHOMEOWNERS_COUNSELING_ACKNOWLEDGEMENT_MORTGAGEMA_REVIEW_BOARD_NOTICE_MORTGAGEUSER_UPLOADED_CONDITIONSPROPERTY_INSPECTION_WAIVER_MORTGAGECREDIT_UNION_AGREEMENT_MORTGAGEMA_RATE_LOCK_AGREEMENT_MORTGAGENJ_RATE_LOCK_AGREEMENT_MORTGAGENM_RATE_LOCK_AGREEMENT_MORTGAGEOR_RATE_LOCK_AGREEMENT_MORTGAGEWA_RATE_LOCK_AGREEMENT_MORTGAGELERETA_NEW_FILELERETA_NEW_LOAN_ECHO_BACKLERETA_TAX_AMOUNT_REPORTINGLERETA_TAX_AMOUNT_REPORTING_OKLERETA_INSURANCE_AMOUNT_REPORTINGLERETA_INSURANCE_AMOUNT_REPORTING_OKLERETA_PAY_OFF_SERVICE_TRANSFERLERETA_ESCROW_ANALYSIS_DEPOSIT_AND_PAYMENTLERETA_ESCROW_ANALYSIS_PAYMENT_UPDATECORE_LOGIC_ADDSCORE_LOGIC_RETURN_ADDSCORE_LOGIC_BNACORE_LOGIC_TARCORE_LOGIC_AUDITALLIED_SOLUTIONS_TRACKING_FILEALLIED_SOLUTIONS_BACKFEED_FILEFORBEARANCE_REQUESTEDUCATION_DEFERMENT_REQUESTBANKRUPTCYTPDDEATH_CERTIFICATEPOWER_OF_ATTORNEYTHIRD_PARTY_AUTHCREDIT_REPORTMILITARY_ORDERSPAYMENT_DISPUTEREFUND_CHECKNOTICE_TO_BORROWERFORECLOSURESUCCESSOR_IN_INTERESTBORROWER_CORRESPONDENCELOAN_ASSISTANCE_APPLICATIONLOAN_TRANSFER_ADDENDUMNOTICE_OF_ACCOMMODATIONFORBEARANCE_AGREEMENTFORBEARANCE_ACKNOWLEDGEMENTCANCELED_PAID_LOAN_AGREEMENTESCROW_ANALYSIS_STATEMENTLOAN_ASSISTANCE_AGREEMENTFORBEARANCE_EXIT_AGREEMENTFORM_1098_CIRS_FIRE_1098IRS_FIRE_1099_INTESCROW_ANALYSIS_ANNUAL_STATEMENTESCROW_SHORT_YEAR_STATEMENTMOHELA_GLBA_NOTICEMISSED_PAYMENT_NOTICEAUTO_PAY_DISABLED_NOTICEAUTO_PAY_CHANGED_NOTICEPAID_IN_FULL_NOTICEFORM_1099_C_COPY_BFORM_1099_C_COPY_CIRS_FIRE_1099_CEARLY_DELQ_NOTICESECONDARY_SERVICER_FUNDING_BOUNCE_REPORTDELQ_REPAYMENT_PLAN_AGREEMENTSKIP_A_PAY_AGREEMENTSCRA_CORRESPONDENCESERVICING_TRANSFER_FILESINBOUND_SERVICER_DATA_VALIDATION_REPORTOUTBOUND_SERVICER_DATA_VALIDATION_REPORTINSURANCE_VENDOR_DOCUMENTANTI_PREDATORY_LENDING_DATABASE_CERTEXECUTED_LOAN_MODIFICATION_RECORDEDEXECUTED_LOAN_MODIFICATION_NON_RECORDEDIL_ANTI_PREDATORY_LENDING_DISCLOSUREOUTBOUND_SERVICER_PENDING_TRANSFER_REPORTOUTBOUND_SERVICER_COMPLETED_TRANSFER_REPORTTHIRD_PARTY_SERVICING_TAPEEMINENT_DOMAINLIENLIS_PENDENSUNSAFE_PROPERTYPROBATEBUSINESS_RECORDSCH_7_BANKRUPTCYCH_11_BANKRUPTCYCH_13_BANKRUPTCYADVERSARY_BANKRUPTCYCLASS_ACTIONARBITRATIONCIVIL_SUITCRIMINALPLACEMENT_FILE_TO_FFAMTRANSACTION_FILE_TO_FFAMRECALL_FILE_TO_FFAMRECONCILIATION_FILE_TO_FFAMUPDATE_FILE_TO_FFAMPAYMENT_FILE_FROM_FFAMCLOSE_FILE_FROM_FFAMCOMMENT_FILE_FROM_FFAMUPDATE_FILE_FROM_FFAMH19_APPROVAL_DISCLOSUREH20_FINAL_DISCLOSURESLR_AGREEMENTSLR_DISCLOSUREEDUCATION_CERTDEFERMENT_END_NOTICEDIGITAL_SIGNATURE_PACKETLOAN_BROKERAGE_DISCLOSUREASSIGNMENT_OF_PROPERTYAPPLICATION_SUMMARYVERIFICATION_OF_EMPLOYMENTHOME_SECURED_LOAN_NOTICECREDIT_UNION_MEMBERSHIP_AGREEMENTFINANCE_CHARGE_DISCLOSUREPROPERTY_TAX_DOCSSLR_APPLICATION_DISCLOSUREHELOC_CREDIT_POLICYHELOC_UNDERWRITING_GUIDELINESINSURANCE_DISCLOSUREINT_REDUCT_FEE_DISCLOSUREHIGH_RATE_DISCLOSURECOMMITMENT_LETTER_DISCLOSUREFINAL_INT_REDUCT_FEE_DISCLOSURELOAN_APPLICATION_SUPPLEMENTEMPLOYED_BORROWER_ATTESTATIONCONDO_EARTHQUAKE_INSURANCE_NOTICEFLOOD_INSURANCE_NOTIFICATIONLENDER_PLACED_INSURANCE_NOTICEATTORNEY_REPRESENTATION_DISCLOSUREDISCLOSURE_OF_TERMS_OF_MORTGAGE_APPLICATIONCOMMUNICATION_CONSENTPL_AGREEMENTMULTI_STATE_DISCLOSUREEQUAL_CREDIT_DISCLOSUREITEMIZED_SCHEDULE_OF_CHARGESLOAN_AGREEMENTE_COMMS_POLICYE_SIGN_CONSENTDEPOSIT_ACCOUNT_AGREEMENTFIRST_LIEN_ATTESTATIONLIEN_ACCURACY_ATTESTATIONFORM_1098MERCHANT_AGREEMENTFEE_DISCLOSUREHELOC_AGREEMENT_VOIDSUBORDINATION_REQUEST_PACKAGESUBORDINATION_OTHERLOAN_SALE_DOCUMENTFINAL_FLOODDISCLOSUREFINAL_MAFLOODDISCLOSUREBROKER_AGREEMENTAPPLICATION_WORKSHEETPROOF_OF_CONSENTBROKER_AGREEMENT_PREVIEWCREDIT_ATTRIBUTES_REPORTLIENS_BREAKDOWNPLAID_IV_BREAKDOWNPLAID_BUSINESS_IV_BREAKDOWNINTERNAL_APPLICATION_SUMMARYPROPERTY_CONDITION_REPORTDC_FINANCING_AGREEMENTND_MONEY_BROKER_STATEMENTPUBLIC_INFORMATION_NOTICEATTORNEY_INSURANCE_PREFERENCE_ACKNOWLEDGMENTATTORNEY_INSURANCE_PREFERENCE_FORMREGULATORY_AGENCY_DISCLOSUREHELOC_AGREEMENT_ACKNOWLEDGEMENTINSTANT_TITLE_REPORTFULL_TITLE_REPORTALL_VENUES_REPORTHOA_INFO_REPORTEXTERNAL_PAYOFF_STATEMENTEXTERNAL_LIEN_RELEASEBROKER_PRICE_OPINIONHOME_EQUITY_CONSUMER_DISCLOSURESUMMARY_OF_POINTSMORTGAGE_BANKER_DISCLOSUREPROPERTY_FAIR_MARKET_VALUESUBSEQUENT_REFINANCE_LIMITATIONSAFFIDAVIT_AND_AGREEMENTRECEIPT_OF_COPIESEXTENSION_OF_CREDIT_AGREEMENTADVANCE_COPY_OF_FEES_AND_CHARGESAFFIDAVIT_OF_COMPLIANCEACKNOWLEDGMENT_OF_TEXAS_HELOC_DISCLOSURESFALSE_OR_MISLEADING_STATEMENTS_PENALTY_NOTICEDESIGNATION_OF_HOMESTEAD_AFFIDAVITACKNOWLEDGMENT_OF_NON_REPRESENTATIONTEXAS_HELOC_AGREEMENTTEXAS_OCCUPANCY_STATEMENTAPPLICATION_SUMMARY_CLOSINGEXTENSION_OF_CREDIT_AGREEMENT_RECEIPTAPPLICATION_SUMMARY_ATTORNEY_REVIEWTEXAS_SERVICING_DISCLOSURESTEXAS_SERVICING_COMPLAINTS_NOTICETEXAS_HELOC_DISCLOSURE_STATEMENTTEXAS_RECORDED_HELOC_AFFIDAVIT_AND_AGREEMENTTEXAS_RECORDED_AFFIDAVIT_OF_HOMESTEADTEXAS_VENDOR_LIEN_RELEASERELEASERESIDENTIAL_EVALUATIONBPO_EXTERIORFAIR_CREDIT_REPORTING_ACT_DISCLOSUREPRE_APPLICATION_DISCLOSUREINTEREST_RATE_DISCLOSURERIGHT_TO_SELECT_ATTORNEY_DISCLOSUREMORTGAGE_NEED_TO_KNOW_PAMPHLETSOFT_CREDIT_CONSENTARTIFICIAL_INTELLIGENCE_IMAGE_BUNDLETHIRD_PARTY_PAYOFF_AUTHORIZATIONDEBT_CONSOLIDATION_PAYMENTSDC_FP_7CLLC_OPERATION_AGREEMENTRESOLUTIONCERT_OF_GOOD_STANDINGPROPERTY_INSURANCEHOA_STATEMENTASSETSOWNER_TITLEUNDERWRITING_REVIEWFLOOD_INSURANCEMLS_REVIEWAPPRAISAL_SSR_FANNIEAPPRAISAL_SSR_FREDDIETRUV_VERIFICATION_OF_INCOME_AND_EMPLOYMENT_REPORTTRUV_VERIFICATION_OF_ASSETS_REPORTTRUV_INSURANCE_REPORTACKNOWLEDGED_RIGHT_TO_CANCELTANGIBLE_NET_BENEFIT_MULTI_STATEKYB_FINDINGSRENTAL_VALUATIONESCALATION_REVIEWAFFILIATED_BUSINESS_DISCLOSUREFORECLOSURE_FAIRNESS_ACT_DISCLOSURECONSTRUCTION_LIEN_DISCLOSURENONREFUNDABILITY_OF_LOAN_FEESLOWES_AUTHORIZED_USER_TERMS_AND_CONDITIONSTITLE_DISCREPANCY_REVIEWIRS_4506CFM_1084_CASH_FLOW_ANALYSISEXTEND_BUSINESS_VERIFICATION_CHECKLISTEXTEND_BUSINESS_VOEVALLEY_STRONG_MEMBERSHIP_AGREEMENTREVIEW_SIGNED_DOCSRECORDING_EXCEPTION_TASKHIGHNOTE_AUTHORIZED_USER_TERMS_AND_CONDITIONSDC_ESCROW_ACCOUNT_DISCLOSUREFIRST_LIEN_APPRAISAL_WAIVER_RECEIPT_FORMPATRIOT_ACT_DISCLOSUREPRIVACY_POLICY_NOTICETRIDANTI_COERCION_INSURANCE_DISCLOSUREACKNOWLEDGMENT_OF_RECEIPT_OF_LOAN_ESTIMATEADDENDUM_TO_LOAN_APPLICATIONADVANCED_FEE_APPLICATION_DISCLOSURECREDIT_SCORE_DISCLOSURE_A3H3FORM_4506_TITEMIZATION_OF_FEESECOA_NOTICELOAN_ESTIMATENOTICE_OF_INTENT_TO_PROCEED_WITH_LOAN_APPLICATIONNOTICE_OF_INTENT_TO_APPLY_FOR_JOINT_CREDITLIST_OF_HOMEOWNERSHIP_COUNSELING_ORGANIZATIONSCERTIFICATION_AND_AUTHORIZATIONFORM_1003_UNIFORM_RESIDENTIAL_LOAN_APPLICATIONFORM_1003_DEMOGRAPHIC_INFORMATION_ADDENDUMSOCIAL_SECURITY_NUMBER_VERIFICATIONANTI_STEERING_DISCLOSURE_OF_LOAN_OPTIONSBORROWER_TANGIBLE_BENEFIT_DISCLOSUREPROCESSING_FEE_PAYMENT_AUTHORIZATIONCREDIT_INQUIRY_LETTER_OF_EXPLANATIONUNSIGNED_DOCUMENT_BUNDLEPROPERTY_INSPECTION_WAIVERCERTIFICATE_OF_FOREIGN_STATUSIMPORTANT_PRIVACY_CHOICESINTENT_TO_PROCEEDWRITTEN_LIST_OF_PROVIDERSCA_FAIR_LENDING_NOTICECA_REQUEST_FOR_FAIR_LENDING_INFORMATIONCA_NOTICE_OF_RIGHT_TO_RECEIVE_COPY_OF_APPRAISAL_REPORTCA_REL_SUPPLEMENTAL_DISCLOSURECA_DISCLOSURE_RECEIPTCA_ADDENDUM_TO_UNIFORM_RESIDENTIAL_LOAN_APPLICATIONCA_ADVANCED_FEE_APPLICATION_DISCLOSURECA_CREDIT_SCORE_DISCLOSURECA_CREDIT_SCORE_NOTICECA_INSURANCE_DISCLOSURECA_AUTOMATED_VALUATION_MODEL_NOTICECA_TITLE_INSURANCE_DISCLOSURENV_REASONABLE_MEANS_DISCLOSURENV_ASSIGNMENT_FROM_MERSNV_EMPLOYEE_DISCLOSURENV_MORTGAGE_COMPANY_COMPENSATION_DISCLOSURENV_NOTICE_AND_WAIVERFL_INTEREST_RATE_LOCK_AGREEMENTFL_ANTI_COERCION_INSURANCE_NOTICEFL_ASSIGNMENT_FROM_MERSFL_MORTGAGEFL_NOTICE_TO_PURCHASERAK_ANTI_COERCION_INSURANCE_DISCLOSUREAK_DEED_OF_TRUSTAK_ASSIGNMENT_FROM_MERSTN_ASSIGNMENT_FROM_MERSTN_DEED_OF_TRUSTTN_LOCK_IN_AGREEMENTWI_ASSIGNMENT_FROM_MERSWI_MORTGAGEWI_PROPERTY_TAX_ESCROW_OPTIONME_ASSIGNMENT_FROM_MERSME_ASSIGNMENT_OF_MORTGAGEME_MORTGAGEME_RIGHT_TO_OWN_ATTORNEY_DISCLOSURENH_ASSIGNMENT_FROM_MERSNH_MORTGAGEND_ASSIGNMENT_FROM_MERSND_MORTGAGELA_ASSIGNMENT_FROM_MERSLA_MORTGAGELA_TITLE_INSURANCE_RIDERIA_ACKNOWLEDGMENT_OF_RECEIPT_OF_COPIESIA_ASSIGNMENT_FROM_MERSIA_MORTGAGEIA_ORAL_AGREEMENT_DISCLOSUREIA_PAYMENT_REDUCTION_FEE_DISCLOSUREIN_ASSIGNMENT_FROM_MERSIN_COMMITMENT_AGREEMENTIN_MORTGAGEIN_NOTICE_TO_BORROWERIN_PROPERTY_TAX_BENEFITSID_ASSIGNMENT_FROM_MERSID_DEED_OF_TRUSTID_ESCROW_ACCOUNT_DISCLOSUREID_MORTGAGE_BANKERDE_ASSIGNMENT_FROM_MERSDE_MORTGAGEAZ_APPRAISAL_DISCLOSUREAZ_ASSIGNMENT_FROM_MERSAZ_AUTHORIZATION_TO_COMPLETE_BLANK_SPACESAZ_DEED_OF_TRUSTMA_MORTGAGE_LOAN_RATE_LOCK_COMMITMENTMA_BORROWERS_INTEREST_WORKSHEETMA_ADDENDUM_TO_UNIFORM_RESIDENTIAL_LOAN_APPLICATIONMS_MORTGAGE_ORIGINATION_FEE_DISCLOSURE_AGREEMENTMS_DEED_OF_TRUSTMS_ASSIGNMENT_FROM_MERSNJ_ASSIGNMENT_FROM_MERSNJ_MORTGAGENJ_RIGHT_TO_CHOOSE_OWN_ATTORNEYNJ_CHOICE_OF_INSURER_NOTICENJ_RATE_LOCKINNJ_APPLICATION_DISCLOSUREOH_AFFILIATED_AGREEMENT_DISCLOSUREOH_HOMEBUYERS_PROTECTION_ACTOH_STATUTORY_AUTHORITY_DISCLOSUREOH_ACKNOWLEDGMENT_OF_RECEIPT_OF_HOME_MORTGAGE_LOAN_INFORMATIONAL_DOCUMENTOH_ADDENDUM_TO_LOAN_APPLICATIONRIGHT_TO_CHOOSE_ATTORNEYGA_ACKNOWLEDGEMENT_OF_RECEIPTGA_SECURITY_DEEDGA_ASSIGNMENT_FROM_MERSGA_WAIVER_OF_BORROWERS_RIGHTSGA_FORECLOSURE_DISCLOSUREGA_APPLICATION_FOR_HOMESTEAD_TAX_EXEMPTIONWA_DISCLOSURE_RECEIPTWA_INTEREST_RATE_LOCK_AGREEMENTNC_NOTICE_OF_INFORMATIONMO_LOAN_BROKERAGE_DISCLOSURE_STATEMENTMO_COLLATERAL_PROTECTION_INSURANCE_DISCLOSUREMD_SETTLEMENT_SERVICES_DISCLOSUREMD_WRITTEN_ACKNOWLEDGEMENT_NOTE_DELIVERYMD_LICENSEE_INFORMATION_OR_AFFIDAVITMD_TAX_PROPERTY_AFFIDAVITNM_RATE_LOCK_DISCLOSURENM_ATTORNEY_PREFERENCENM_FREEDOM_TO_CHOOSE_INSURANCE_COMPANYNM_FAVORABLE_TERMS_DISCLOSURENM_MORTGAGENM_ASSIGNMENT_FROM_MERSKY_FAIR_HOUSING_DISCLOSUREKY_HOMEOWNERSHIP_PROTECTION_CENTER_NOTIFICATIONKY_COMMITMENT_DISCLOSUREPA_APPLICATION_DISCLOSUREPA_MORTGAGEPA_ASSIGNMENT_FROM_MERSKS_BORROWER_ACKNOWLEDGEMENTSD_MORTGAGESD_ASSIGNMENT_FROM_MERSOR_FLOAT_OR_LOCK_AGREEMENTOR_ESCROW_ACCOUNT_STATEMENTOR_ESCROW_ACCOUNT_OPTION_NOTICEAR_ANTI_COERCION_INSURANCE_DISCLOSUREVT_DOCUMENT_PACKAGE_COVER_SHEETVT_ADDENDUM_TO_1003VT_APPLICATION_CAPACITY_NOTICEVT_MORTGAGE_LOAN_COMMITMENT_AGREEMENTCLOSING_WORKSHEETCLOSING_INSTRUCTIONSCLOSING_DISCLOSUREFORM_3200_NOTE_FIXEDFACT_ACT_NOTICEFORM_4506_COPY_OF_TAX_FORMRIGHT_TO_CANCEL_H8RIGHT_TO_CANCEL_H9ADDENDUM_TO_CLOSING_DISCLOSURENOTICE_OF_SERVICING_TRANSFERFIRST_PAYMENT_LETTER_ENHANCED_FEESSIGNATURE_NAME_AFFIDAVITOCCUPANCY_STATEMENTAMORTIZATION_SCHEDULENOTICE_OF_REQUIRED_FLOOD_INSURANCEW_9COMPLIANCE_AGREEMENTTAX_AND_INSURANCE_INFORMATION_SHEETDEED_OF_TRUSTASSIGNMENT_OF_DEED_OF_TRUSTADDENDUM_TO_NOTE_ACHESCROW_ACCOUNT_DISCLOSURE_ENHANCED_FEES_APPLICATIONNOTICE_OF_SPECIAL_FLOOD_HAZARDSMERS_RIDERTAX_PAYER_CONSENT_FORMFORM_1008_UNIFORM_UNDERWRITING_TRANSMITTAL_SUMMARYFLOOD_HAZARD_CERTIFICATIONPAYMENT_INCREASETANGIBLE_NET_BENEFIT_WORKSHEETFLOOD_DETERMINATIONCERTIFIED_FLOOD_DETERMINATIONTWN_CORELOGIC_VOE_PDF_REPORTVOE_AFFIDAVITFORM_3150_RIDER_PUDWV_DEED_OF_TRUSTWV_ASSIGNMENT_FROM_MERSWV_SUPPLEMENTAL_CLOSING_STATEMENTWV_COLLATERAL_PROTECTION_INSURANCE_DISCLOSUREKY_MORTGAGEKY_ASSIGNMENT_FROM_MERSWA_DEED_OF_TRUSTWA_ASSIGNMENT_FROM_MERSOH_DISCLOSURE_OF_RIGHT_NOT_TO_CLOSEOH_MORTGAGEOH_ASSIGNMENT_FROM_MERSCA_EXEMPTION_RECORDING_SHEETCA_PER_DIEM_INTEREST_DISCLOSURECA_FINANCING_LAW_STATEMENT_OF_LOAN_FINANCE_LENDERSCA_IMPOUND_ACCOUNT_STATEMENTCA_ASSIGNMENT_FROM_MERSNJ_INITIAL_TAX_AUTHORIZATIONMA_MORTGAGEMA_ASSIGNMENT_FROM_MERSAL_MORTGAGEAL_ASSIGNMENT_FROM_MERSNC_DEED_OF_TRUSTNC_ASSIGNMENT_FROM_MERSMO_DEED_OF_TRUSTMO_ASSIGNMENT_FROM_MERSMI_MORTGAGEMI_ASSIGNMENT_FROM_MERSMD_DEED_OF_TRUSTMD_ASSIGNMENT_FROM_MERSMT_ACKNOWLEDGEMENT_THAT_REAL_PROPERTY_IS_NOT_EXEMPTMT_ASSIGNMENT_FROM_MERSNOTICE_OF_CHANGE_IN_LOAN_TERMSFANNIE_MAE_3_2VERITAX_PDF_REPORTVERITAX_SSN_PDF_REPORTVERITAX_VOE_PDF_REPORTDOCUTECH_MISMO_2_6_XMLDU_UNDERWRTING_RESULTUCD_RESULTCONDITIONSFORM_1008ALLONGEFANNIE_MAE_SSRFREDDIE_MAC_SSRCHANGE_OF_CIRCUMSTANCEFRAUD_REPORTFLOOD_CERTIFICATELETTER_OF_INTENT_RERECORDSIGNED_CLOSING_PACKAGEFRAUD_SERVICE_LISTTRI_MERGE_CREDIT_REPORTTITLE_POLICYSETTLEMENT_STATEMENTMORTGAGE_STATEMENTBAILEE_LETTERTAX_CERTIFICATEMORTGAGE_PAYOFF_STATEMENTTWN_VOE_PDF_REPORTUCD_MISMO_XMLFORM_1099SCHEDULE_CAUTH_TO_CONTACT_EMPLOYERLOE_CREDIT_INQUIRY_OPEN_ACCOUNTLOE_CREDIT_INQUIRY_REFINANCING_PROPERTIESLOE_CREDIT_INQUIRY_ANOTHER_LOANLOE_CREDIT_INQUIRY_TIMESHARE_INTERESTTEMPORARY_LEAVEUCD_RESULT_FREDDIECLEAR_TO_CLOSE_CERTIFICATETITLE_COMMITMENT_LETTERFINAL_SETTLEMENT_STATEMENTFUNDING_RECONCILIATIONDU_UNDERWRITE_FINDINGSDU_CREDIT_REPORTAPPRAISAL_CARD_PAYMENT_RECEIPTEMPLOYMENT_GAPS_LOEPUBLIC_AGENCY_LETTERINTEREST_DIVIDEND_1099OTHER_INCOMETAX_RETURN_1099_401KTAX_RETURN_1099_IRATAX_RETURN_1099_KEOGHESTIMATED_CLOSING_DISCLOSURERESIDENCY_DOC_FRONTRESIDENCY_DOC_BACKCREDIT_REPORT_PDFULDD_MISMO_XMLULDD_FNMA_RESULTSL_BALANCE_EVIDENCETAX_RETURNSCOPY_OF_NOTEPROOF_OF_INCOME_RECEIPTFOSTER_CARE_AGENCYVA_REWARD_LETTERDISABILITY_LETTERPUBLIC_ASSISTANCE_LETTERTRUSTASSET_STATEMENTSIRS_WAGE_TRANSCRIPTIRS_1040_TRANSCRIPTPROOF_OF_RECEIPT_INCOMEBUSINESS_K1WRITTEN_VOE_PDF_REPORTVERBAL_VOE_PDF_REPORTEMPLOYER_LETTERVERIFICATION_OF_MORTGAGEVERIFICATION_OF_MORTGAGE_TRANSACTIONSREPLACEMENT_COST_ESTIMATORAPPRAISAL_RECEIPTCOLLATERAL_DESKTOP_ANALYSISAPPRAISAL_CHECKLISTGAP_CREDIT_REPORTUNDERWRITING_CHECKLISTADDITIONAL_REO_MORTGAGE_STATEMENTADDITIONAL_REO_HAZARD_INSURANCEADDITIONAL_REO_TAX_BILLCLOSING_PROTECTION_LETTERTITLE_ADDENDUMERNST_XML_DATAPERSONAL_TAX_RETURNBUSINESS_TAX_RETURNMISMO_2_6_GSE_XMLPROPERTY_CONDITION_INSPECTIONAPPRAISAL_UNDERWRITING_RISK_ANALYZER_REPORTH4S_AUTHORIZATIONCAP_TABLEMERCHANT_REVIEW_DOCUMENTMILESTONE_REVIEW_DOCUMENTFINANCIAL_STATEMENT_1_YEARATTESTATIONPARTNERSHIP_AGREEMENTARTICLES_OF_INCORPORATIONCERTIFICATE_OF_GOOD_STANDING_90_DAYCERTIFICATE_OF_TRUSTRESERVED2306EMPLOYMENT_IDENTIFICATION_NUMBERARTICLES_OF_ORGANIZATIONUNSPECIFIED_INVESTOR_PASSPORT_DOCUMENTEXTERNAL_VERIFICATION_LETTERIRS_TINSS_4EMPLOYER_IDENTIFICATION_NUMBERCOMPLIANCE_DOCEXTERNAL_VERIFICATION_DOCUMENTBANK_STATEMENTBROKERAGE_STATEMENTRETIREMENT_STATEMENTNON_US_PASSPORTINCOME_DOCUMENTALTERNATE_TAX_UPLOAD_LETTERACCREDITED_INVESTOR_ELIGIBILITYQUALIFIED_PURCHASER_ELIGIBILITYINCOME_AUDIT_INFORMATIONPPP_APPSIGNED_PPP_APPDU_MISMO_3_4_XMLEXECUTED_PURCHASE_AGREEMENTPURCHASE_PREAPPROVAL_LETTERNETCONNECT_TEST_RESPONSEINSURANCE_BINDERFINAL_AUSPB_CLOSING_INSTRUCTIONSVERIFICATION_OF_IDENTITYFIRST_LIEN_PACKAGEPB_CLOSING_PACKAGEPB_FUNDING_INSTRUCTIONSPB_SIGNED_FUNDING_INSTRUCTIONSPB_SIGNED_CLOSING_INSTRUCTIONSPB_SIGNED_CLOSING_PACKAGEPB_PRE_QUAL_DETAILSPB_WARRANTY_DEEDSALES_CONTRACTRATE_LOCKDISCLOSURE_TRACKERSLENDER_APPROVALUNDERWRITING_LOAN_TRANSMITTALALTAFINAL_FIRST_LIEN_CLOSING_DISCLOSUREFIRST_LIEN_CLOSING_DOCPIGGYBACK_CLOSING_DOCASSUMPTION_OF_MORTGAGE_BUNDLERATE_LOCK_FLOATRATE_LOCK_LOCKEDRATE_LOCK_EXTENSIONPIGGYBACK_INITIAL_DISCLOSURES_PACKAGEFURNISHING_NEGATIVE_INFORMATIONSECOND_HOME_RIDERPUD_RIDERCONDO_RIDERMULTI_FAMILY_RIDERRECORD_OF_RIGHTS_CERTESTIMATED_DISBURSEMENT_DETAILSLETTER_OF_EXPLANATIONCUSTOMER_COMPANY_INFORMATIONCUSTOMER_COMPANY_IDENTIFICATIONKYB_BUSINESS_REVIEW_PDFAPPRAISAL_ORDER_DISCLOSUREPROPERTY_VALUATION_INVOICEPOST_FUND_AVMLOAN_APPROVALUNDERWRITING_EXCEPTION_REVIEWMISMO_ENOTE_SMART_DOC_XMLENOTE_PDFRECORDED_ASSIGNMENT_OF_MORTGAGE_TO_DARTASSIGNMENT_OF_MORTGAGE_TO_DARTCRYPTO_PL_AGREEMENTCRYPTO_PL_AGREEMENT_CELSIUS_REFICRYPTO_PL_CELSIUS_REFI_IRREVOCABLE_DIRECTIONPROOF_OF_CRYPTO_ASSETSDIGITAL_COLLATERAL_DISCLOSURECLOC_AGREEMENTTITLE_INSURANCETANGIBLE_BENEFIT_DISCLOSURENOTICE_TO_PURCHASERREASONABLE_MEANS_DISCLOSUREFORECLOSURE_DISCLOSURESIGNED_FAIR_LENDING_NOTICEWAIVER_OF_BORROWERS_RIGHTSNOTARY_FORMREMOTE_NOTARY_FORMFUNDING_DOCSUCC_SEARCHUCC_FILINGSPOUSAL_COLLATERAL_AGREEMENTDFS_SUDRANIA_DATADFS_THIRD_PARTY_DOCLOAN_ORIGINATOR_BULK_CSVLOAN_ORIGINATOR_LICENSE_BULK_CSVBROKER_BULK_CSVBROKER_LICENSE_BULK_CSVMISMO_3_4_XMLMISC_USER_UPLOAD_DOCLEAD_PORTAL_USER_BULK_CSVLEAD_PORTAL_USER_LICENSE_BULK_CSVLEAD_PORTAL_USER_RELATIONSHIP_BULK_CSVRESPONSESUPPORTCANCELLATION_PROOFDOCUMUSLLC_TBDCOMPETING_OFFERNAME_CHANGE_DOCUMENTATIONBANK_VERIFICATIONVOIDED_CHECKBANK_LETTERNOTICE_OF_DEFAULTAPPRAISAL_OBJECTIVITY_NOTICEESCROW_WAIVER_CONSENTACKNOWLEDGMENT_OF_RECEIPT_OF_APPRAISALBORROWER_PROPERTY_CONDITION_CERTIFICATELOAN_APPLICANT_ATTESTATIONINVESTMENT_PURPOSE_AFFIDAVITBUSINESS_PURPOSE_AFFIDAVITFLOOD_DISASTER_PROTECTION_ACTASSIGNMENT_ASSIGNOR_TO_ASSIGNEEPREPAYMENT_ADDENDUMUNKNOWNINITIAL_DISCLOSURE_PACKAGE_COVER_LETTERACKNOWLEDGEMENT_OF_BORROWER_RIGHTSFORECLOSURE_DISCLOSURE_STATEMENTCOLLATERAL_PROTECTION_INSURANCE_NOTICENO_ORAL_AGREEMENTS_DISCLOSUREFRAUD_NOTICEMORTGAGE_COMPANY_DISCLOSUREJPG_CONVERTED_FROM_PDFBUSINESS_PURPOSE_STATEMENTCA_BORROWER_STATEMENT_BROKER_PARTICIPATIONCA_AVM_DISCLOSURENON_HOMESTEAD_STATEMENTGUARANTY_AGREEMENTNAME_STATEMENTPATRIOT_ACT_DISCLOSURE_INSTRUCTIONSINTERIM_INTEREST_DISCLOSURELENDER_HOLD_HARMLESSCLOSING_ATTORNEY_AFFIDAVITACCOMMODATION_RIDERDISCLOSURE_OF_GOVERNING_AUTHORITYMONEY_BROKER_CONTRACTNOTICE_OF_RIGHTSCHOICE_OF_AGENT_INSURER_NOTICEPAYMENT_OF_PROPERTY_TAX_NOTICEAPPRAISAL_DISCLOSURELEGAL_REP_INTERIM_FINANCING_DISCLOSUREFLOOD_INSURANCE_NOTICECHOICE_OF_INSURANCE_PROVIDERESCROW_AGREEMENTAPPLICATION_DISCLOSUREREFINANCE_LIEN_NOTICENONREFUNDABILITY_OF_ADVANCE_FEE_AGREEMENTPRIVATE_MORTGAGE_INSURANCE_DISCLOSURECOVERED_LOAN_NOTICERIGHT_TO_CHOOSE_INSURANCERIGHT_TO_CANCEL_APPLICATION_NOTICESECURITY_FREEZE_CREDIT_REPORTPAYMENT_REDUCTION_FEE_DISCLOSURESECOND_LIEN_DISCLOSURERESERVE_ACCOUNT_DISCLOSUREESCROW_ACCOUNT_DISCLOSURE_AGREEMENTAPPLICATION_FEE_DISCLOSUREVETERAN_NOTICEOVERNIGHT_DOCUMENT_DELIVERY_SERVICE_DISCLOSURECAP_AFFIDAVITPREPAYMENT_PENALTY_DISCLOSURERIGHT_TO_RECEIVE_NOTICEESCROW_DISCLOSURERECEIPT_OF_LOAN_CLOSINGLOAN_DOCUMENTS_DISCLOSUREINSURANCE_COVERAGE_DISCLOSURE_WARNINGCOLLATERAL_PROTECTION_ACT_DISCLOSURERESIDENTIAL_MORTGAGE_ORIGINATOR_CONTRACTVOLUNTARY_INFORMATION_GOVERNMENT_MONITORINGREVISED_TILABUSINESS_PURPOSE_LOEFINDERS_FEE_AGREEMENTBROKER_DISCLOSUREAUTHORIZATION_TO_COMPLETE_BLANK_SPACESADVANCE_FEE_AGREEMENTSCRIVENER_AFFIDAVITUNRESPONSIVE_BORROWER_LETTERPARTIAL_LIEN_RELEASE_REVIEWPARTIAL_LIEN_RELEASE_TEMPLATEPARTIAL_LIEN_RELEASE_SIGNEDCA_LOAN_BROKERAGE_AGREEMENTCA_DEPARTMENT_OF_REAL_ESTATE_DISCLOSURECA_FINANCING_LAW_STATEMENT_OF_LOAN_BROKERSIA_LOAN_BROKERAGE_AGREEMENTMT_MORTGAGE_LOAN_ORIGINATION_DISCLOSUREMORTGAGE_BROKER_LICENSE_NUMBER_DISCLOSUREGA_ATTORNEY_PREFERENCE_NOTICEGA_FORECLOSURE_DISCLOSURE_STATEMENTOH_ANTI_DISCRIMINATION_NOTICEBORROWER_IDTERM_SHEETAPPRAISAL_REVIEWBACKGROUND_REPORTOFAC_CHECKTITLE_COMMITMENTINVESTMENT_EXPERIENCEGOVERNING_DOCUMENTREHAB_BUDGETCLOSING_SETTLEMENT_STATEMENT_HUDINSURANCE_RCEINSURANCE_EOIINSURANCE_INVOICEINSURANCE_POLICYINSURANCE_MISC_REPORTSINSURANCE_EOI_FLOODINSURANCE_INVOICE_FLOODEXECUTED_PURCHASE_AGREEMENT_ADDENDUMENTITY_CORP_DOC_OTHERCONSTRUCTION_LOAN_AGREEMENTPROPERTY_CHAIN_OF_CUSTODYCONSENT_CREDIT_BACKGROUND_CHECKPROPERTY_MANAGEMENT_AGREEMENTIDENTITY_VERIFICATION_CERTLOAN_DOCS_ANXTRUEWORK_VERIFICATION_OF_INCOME_AND_EMPLOYMENT_REPORTBROKER_FEE_AGREEMENTCONDO_MASTER_POLICYMORTGAGE_INSURANCE_CERTIFICATERENT_LOSS_INSURANCEUNRECOGNIZED
    • externalIdKeystringRequired

      Name of field in loan tape for the third-party loan identifier (Default: 'LOAN_ID')

    • dataDictionaryobject

      One of:

      LoanDictionaryCsvobject
      • sourceenumRequired
        One ofCSVPAYLOADEXCEL
      • filestringRequired

        CSV file with first column of field names and second column of descriptions

      LoanDictionaryPayloadobject
      • sourceenumRequired
        One ofCSVPAYLOADEXCEL
      • dataarray of objectsRequired

        Map of field name-descriptions

  • loansarray of objectsRequired
    ShowHide 5 attributes of loans
    • idstringRequired

      Third-party loan identifier

    • figureIdstring<uuid>Required

      Figure internal loan identifier

    • errorsarray of strings

      Any loan specific errors. Example: Missing a file declared in manifest

    • transformedAtstring<date-time>
    • losStatusenum
      One ofREQUESTEDSUCCESSIN_RETRYFAILURE
  • createdAtstring<date-time>Required
  • updatedAtstring<date-time>Required
  • updateRequestIdstring<uuid>
  • sourceRequestIdstring<uuid>
400Bad Requestobject
  • messagestringRequired
403Forbiddenobject
  • messagestringRequired
404Not Foundobject
  • messagestringRequired
422Unprocessable Entityobject
  • messagestringRequired
500Internal Server Errorobject
  • messagestringRequired
Response
{
  "id": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
  "name": "string",
  "requestorId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
  "status": "Created",
  "manifest": {
    "loanType": "AUTO_LOAN",
    "loanTape": {
      "source": "CSV",
      "file": "loans.csv"
    },
    "underwritingGuidelines": "credit-policy.json",
    "dataDictionary": {
      "source": "CSV",
      "file": "data-dictionary.csv"
    },
    "loans": [
      {
        "id": "loan-1",
        "data": {
          "servicerId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
          "originatorId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
          "subservicerId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a"
        },
        "files": [
          "file-1.pdf",
          {
            "fileName": "file-2.png",
            "documentType": "USER_UPLOADED_DOC"
          }
        ]
      }
    ],
    "externalIdKey": "string"
  },
  "loans": [
    {
      "id": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "figureId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "errors": [
        "string"
      ],
      "transformedAt": "2026-01-15T14:30:00Z",
      "losStatus": "REQUESTED"
    }
  ],
  "createdAt": "2026-01-15T14:30:00Z",
  "updatedAt": "2026-01-15T14:30:00Z",
  "updateRequestId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
  "sourceRequestId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a"
}