addresses array has 1 object element:
- This element contains Encompass loan's property address data.
- You need to give unique string id inside
@id field, property_address value inside @type field.
- You need to give the address text 1 of an Encompass loan property inside
has_address_line_1_text/has_value, the address text 2 of an Encompass loan property inside has_address_line_2_text/has_value,
the city of an Encompass loan property inside has_city_name/has_value, the state of an Encompass loan property inside has_state_code/has_value,
the postal code of an Encompass loan property inside has_postal_code/has_value.
contact_information array has 13 object elements:
- First object of
contact_information:
- You need to give unique string id(
contact_at element's value of people borrower object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan borrower inside
has_email_address/has_value field, the phone number of Encompass loan borrower inside has_phone_number/has_value field.
- Second object of
contact_information:
- You need to give unique string id(
contact_at element's value of people co_borrower object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan coborrower inside
has_email_address/has_value field, the phone number of Encompass loan coborrower inside has_phone_number/has_value field.
- Third object of
contact_information:
- You need to give unique string id(
contact_at element's value of people broker object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's broker inside
has_email_address/has_value field, the phone number of Encompass loan's broker inside has_phone_number/has_value field.
- Fourth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people builder object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's builder inside
has_email_address/has_value field, the phone number of Encompass loan's builder inside has_phone_number/has_value field.
- Fifth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people buyer_agent object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's buying agent inside
has_email_address/has_value field, the phone number of Encompass loan's buying agent inside has_phone_number/has_value field.
- Sixth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people certified_public_accountant object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's certified public accountant inside
has_email_address/has_value field, the phone number of Encompass loan's certified public accountant inside has_phone_number/has_value field.
- Seventh object of
contact_information:
- You need to give unique string id(
contact_at element's value of people financial_advisor object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's financial advisor inside
has_email_address/has_value field, the phone number of Encompass loan's financial advisor inside has_phone_number/has_value field.
- Eighth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people insurance_agent object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's insurance agent inside
has_email_address/has_value field, the phone number of Encompass loan's insurance agent inside has_phone_number/has_value field.
- Ninth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people seller_coordinator object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's seller coordinator inside
has_email_address/has_value field, the phone number of Encompass loan's seller coordinator inside has_phone_number/has_value field.
- Tenth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people loan_coordinator object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's buyer coordinator inside
has_email_address/has_value field, the phone number of Encompass loan's buyer coordinator inside has_phone_number/has_value field.
- Eleventh object of
contact_information:
- You need to give unique string id(
contact_at element's value of people title_holder object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's title
has_email_address/has_value field, the phone number of Encompass loan's title inside has_phone_number/has_value field.
- Twelfth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people ("@type"=attorney and "has_represented_party_type.has_value"="borrower") object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's buyer attorney
has_email_address/has_value field, the phone number of Encompass loan's buyer attorney inside has_phone_number/has_value field.
- Thirteenth object of
contact_information:
- You need to give unique string id(
contact_at element's value of people ("@type"=attorney and "has_represented_party_type.has_value"="other") object) inside @id field, contact_information value inside @type field.
- You need to give the email address of Encompass loan's seller attorney
has_email_address/has_value field, the phone number of Encompass loan's seller attorney inside has_phone_number/has_value field.
documents array has 1 object elements. It is related with the loan application:
- You need to give unique string id inside
@id field, loan_application value inside @type field.
- You need to give
@id field's values of borrower and co_borrower inside with_borrower array.
loan_statuses array has 1 object elements:
- You need to give unique string id inside
@id field, loan_status value inside @type field.
- You need to give Encompass loan status value inside
has_loan_status_identifier/has_value field.
loans array has 1 object elements:
- You need to give Encompass loan id inside
@id field, loan value inside @type field, Encompass loan's estimated closing date inside has_source_identifier/has_value,
and Encompass loan's funding date inside has_loan_funding_date/has_value
- You need to give
@id field's values of loan_application(document) inside with_loan_application array.
- You need to give
@id field's values of loan_status inside with_loan_status array.
- You need to give
@id field's value of subject_property inside secured_by_property array.
- You need to give
@id field's value of down_payment inside with_down_payment array.
- You need to give
@id field's value of loan_terms inside with_loan_terms array.
- You need to give
@id field's value of loan_program inside with_loan_program array.
- You need to give
@id field's value of ltv inside with_ltv array.
- You need to give
@id field's value of closing_information inside with_closing_information array.
- You need to give
@id field's value of loan_product inside with_loan_product array.
people array has 14 object elements:
- First object of
people:
- You need to give Encompass loan officer id inside
@id field, loan_officer value inside @type field and Encompass instance id inside has_source_identifier/has_value.
- Second object of
people:
- You need to give unique string id inside
@id field, borrower value inside @type field.
- You need to give the firstname of an Encompass loan borrower inside
has_first_name/has_value, the lastname of an Encompass loan borrower inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Third object of
people:
- You need to give unique string id inside
@id field, co_borrower value inside @type field.
- You need to give the firstname of an Encompass loan coborrower inside
has_first_name/has_value, the lastname of an Encompass loan coborrower inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Fourth object of
people:
- You need to give unique string id inside
@id field, broker value inside @type field.
- You need to give the firstname of an Encompass loan broker inside
has_first_name/has_value, the lastname of an Encompass loan broker inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Fifth object of
people:
- You need to give unique string id inside
@id field, builder value inside @type field.
- You need to give the firstname of an Encompass loan builder inside
has_first_name/has_value, the lastname of an Encompass loan builder inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Sixth object of
people:
- You need to give unique string id inside
@id field, buyer_agent value inside @type field.
- You need to give the firstname of an Encompass loan buyer agent inside
has_first_name/has_value, the lastname of an Encompass loan buyer agent inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Seventh object of
people:
- You need to give unique string id inside
@id field, certified_public_accountant value inside @type field.
- You need to give the firstname of an Encompass loan certified public accountant inside
has_first_name/has_value, the lastname of an Encompass loan certified public accountant inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Eighth object of
people:
- You need to give unique string id inside
@id field, financial_advisor value inside @type field.
- You need to give the firstname of an Encompass loan financial advisor inside
has_first_name/has_value, the lastname of an Encompass loan financial advisor inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Ninth object of
people:
- You need to give unique string id inside
@id field, insurance_agent value inside @type field.
- You need to give the firstname of an Encompass loan insurance agent inside
has_first_name/has_value, the lastname of an Encompass loan insurance agent inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Tenth object of
people:
- You need to give unique string id inside
@id field, seller_coordinator value inside @type field.
- You need to give the firstname of an Encompass loan seller coordinator inside
has_first_name/has_value, the lastname of an Encompass loan seller coordinator inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Eleventh object of
people:
- You need to give unique string id inside
@id field, loan_coordinator value inside @type field.
- You need to give the firstname of an Encompass loan buyer coordinator inside
has_first_name/has_value, the lastname of an Encompass loan buyer coordinator inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Twelfth object of
people:
- You need to give unique string id inside
@id field, title_holder value inside @type field.
- You need to give the firstname of an Encompass loan title inside
has_first_name/has_value, the lastname of an Encompass loan title inside has_last_name/has_value
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Thirteenth object of
people:
- You need to give unique string id inside
@id field, attorney value inside @type field.
- You need to give the firstname of an Encompass loan buyer attorney inside
has_first_name/has_value, the lastname of an Encompass loan buyer attorney inside has_last_name/has_value
- You need to give
borrower inside has_represented_party_type/has_value.
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
- Fourteenth object of
people:
- You need to give unique string id inside
@id field, attorney value inside @type field.
- You need to give the firstname of an Encompass loan seller attorney inside
has_first_name/has_value, the lastname of an Encompass loan buyer attorney inside has_last_name/has_value
- You need to give
other inside has_represented_party_type/has_value.
- You need to give unique string value inside
contact_at array's element. This value should match one object's '@id' of contact_information array
properties array has 1 object elements:
- You need to give unique string id inside
@id field, subject_property value inside @type field.
- You need to give
@id field's value of property_address inside with_address array.
- You need to give
@id field's value of sales_contract inside with_sales_contract array.
- You need to give
@id field's value of subject_property_valuation inside with_value array.
- You need to give the 'occupancy type' of an Encompass loan inside
has_property_current_usage_type/has_value
property_valuations array has 1 object elements:
- You need to give unique string id inside
@id field, subject_property_valuation value inside @type field.
- You need to give Encompass loan's appraised value inside
has_property_valuation_amount/has_value field.
down_payments array has 1 object elements:
- You need to give unique string id inside
@id field, down_payment value inside @type field.
- You need to give Encompass loan's down payment inside
has_down_payment_amount/has_value field.
loan_terms array has 1 object elements:
- You need to give unique string id inside
@id field, loan_terms value inside @type field.
- You need to give Encompass loan amortization term inside
has_amortization_term_months_count/has_value
- You need to give Encompass loan amount inside
has_note_amount/has_value field.
- You need to give Encompass loan rate payment inside
has_note_rate_percent/has_value field.
- You need to give Encompass loan purpose payment inside
has_loan_purpose_type/has_value field.
- You need to give Encompass loan type payment inside
has_mortgage_type/has_value field.
loan_programs array has 1 object elements:
- You need to give unique string id inside
@id field, loan_program value inside @type field.
- You need to give Encompass loan program inside
has_loan_program_identifier/has_value field.
ltvs array has 1 object elements:
- You need to give unique string id inside
@id field, ltv value inside @type field.
- You need to give Encompass loan value inside
has_ltv_ratio_percent/has_value field.
sales_contracts array has 1 object elements:
- You need to give unique string id inside
@id field, property_sales_contract value inside @type field.
- You need to give Encompass loan sales price inside
has_sales_contract_amount/has_value field.
closing_information array has 1 object elements:
- You need to give unique string id inside
@id field, closing_information value inside @type field.
- You need to give Encompass loan actual closing date inside
has_closing_date/has_value field.
loan_products array has 1 object elements:
- You need to give unique string id inside
@id field, loan_product value inside @type field.
- You need to give
@id field's value of lock inside with_lock array.
locks array has 1 object elements:
- You need to give unique string id inside
@id field, lock value inside @type field.
- You need to give Encompass loan lock date inside
has_lock_datetime/has_value field.
- You need to give Encompass loan lock expiration date inside
has_lock_expiration_datetime/has_value field.
Unmapped missing fields from Staircase Graph to DailyAI:
homeWarrantyContact objectincomne fieldfundedDate fieldposId field
When these unmapped missing fields are mapped, the documentation will be updated.
Example request payload:
{
"addresses": [
{
"@id": "01GMDENWW0DN844A89DVD2BMSF",
"@type": "property_address",
"has_address_line_1_text": {
"has_value": "4321 CulDeSac Street"
},
"has_city_name": {
"has_value": "Someplace"
},
"has_postal_code": {
"has_value": "02723"
},
"has_state_code": {
"has_value": "MA"
}
}
],
"contact_information": [
{
"@id": "01GMDENWW094ER2ECJXJZXVAM2",
"@type": "contact_information",
"has_email_address": {
"has_value": "supriya.gopal@elliemae.com"
},
"has_phone_number": {
"has_value": "123-456-7891"
}
},
{
"@id": "01GMDENWW02BG8YE3GAVXV6K28",
"@type": "contact_information",
"has_email_address": {
"has_value": "test@test.com"
},
"has_phone_number": {
"has_value": "123-456-7891"
}
},
{
"@id": "brokerContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "broker@broker.com"
},
"has_phone_number": {
"has_value": "111-111-1111"
}
},
{
"@id": "builderContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "builder@builder.com"
},
"has_phone_number": {
"has_value": "111-111-1112"
}
},
{
"@id": "buyingAgentContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "buyingagent@buyingagent.com"
},
"has_phone_number": {
"has_value": "111-111-1113"
}
},
{
"@id": "cpaContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "cpa@cpa.com"
},
"has_phone_number": {
"has_value": "111-111-1114"
}
},
{
"@id": "financialAdvisorContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "financialadvisor@financialadvisor.com"
},
"has_phone_number": {
"has_value": "111-111-1115"
}
},
{
"@id": "insuranceAgentContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "insuranceagent@insuranceagent.com"
},
"has_phone_number": {
"has_value": "111-111-1116"
}
},
{
"@id": "sellerCoordinatorContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "sellercoordinator@sellercoordinator.com"
},
"has_phone_number": {
"has_value": "111-111-1117"
}
},
{
"@id": "buyerCoordinatorContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "buyercoordinator@buyercoordinator.com"
},
"has_phone_number": {
"has_value": "111-111-1118"
}
},
{
"@id": "titleContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "title@title.com"
},
"has_phone_number": {
"has_value": "111-111-1119"
}
},
{
"@id": "buyerAttorneyContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "buyerattorney@buyerattorney.com"
},
"has_phone_number": {
"has_value": "111-111-1120"
}
},
{
"@id": "sellerAttorneyContact1",
"@type": "contact_information",
"has_email_address": {
"has_value": "sellerattorney@sellerattorney.com"
},
"has_phone_number": {
"has_value": "111-111-1121"
}
}
],
"documents": [
{
"@id": "01GMDENWW0P6MY2EKFZFA94A6B",
"@type": "loan_application",
"with_borrower": [
"01GMDENWW00NFVWWBJM3K645BD",
"01GMDENWW01SSXFGNWDQBRFWSN"
]
}
],
"loan_statuses": [
{
"@id": "01GMDENWW0KHBK735TA3V2RAXE",
"@type": "loan_status",
"has_loan_status_identifier": {
"has_value": "Started"
}
}
],
"loans": [
{
"@id": "5c835f3f-14ca-49f5-9e38-99195d56a131",
"@type": "loan",
"has_loan_estimated_closing_date": {
"has_value": "2012-04-23T18:25:43.511Z"
},
"has_loan_funding_date": {
"has_value": "2012-04-23T18:25:43.511Z"
},
"with_loan_application": [
"01GMDENWW0P6MY2EKFZFA94A6B"
],
"with_loan_status": [
"01GMDENWW0KHBK735TA3V2RAXE"
],
"secured_by_property": [
"sbp1"
],
"with_down_payment": [
"ldp1"
],
"with_loan_terms": [
"llt1"
],
"with_loan_program": [
"llp1"
],
"with_ltv": [
"lltv1"
],
"with_closing_information": [
"lci1"
],
"with_loan_product": [
"lp1"
]
}
],
"people": [
{
"@id": "admin",
"@type": "loan_officer",
"has_source_identifier": {
"has_value": "TEBE11229152"
}
},
{
"@id": "01GMDENWW00NFVWWBJM3K645BD",
"@type": "co_borrower",
"contact_at": [
"01GMDENWW094ER2ECJXJZXVAM2"
],
"has_first_name": {
"has_value": "amy"
},
"has_last_name": {
"has_value": "america"
}
},
{
"@id": "01GMDENWW01SSXFGNWDQBRFWSN",
"@type": "borrower",
"contact_at": [
"01GMDENWW02BG8YE3GAVXV6K28"
],
"has_first_name": {
"has_value": "andy"
},
"has_last_name": {
"has_value": "america"
}
},
{
"@id": "broker1",
"@type": "broker",
"contact_at": [
"brokerContact1"
],
"has_first_name": {
"has_value": "BrokerFirstName"
},
"has_last_name": {
"has_value": "BrokerLastName"
}
},
{
"@id": "builder1",
"@type": "builder",
"contact_at": [
"builderContact1"
],
"has_first_name": {
"has_value": "BuilderFirstName"
},
"has_last_name": {
"has_value": "BuilderLastName"
}
},
{
"@id": "buyingAgent1",
"@type": "buyer_agent",
"contact_at": [
"buyingAgentContact1"
],
"has_first_name": {
"has_value": "BuyingAgentFirstName"
},
"has_last_name": {
"has_value": "BuyingAgentLastName"
}
},
{
"@id": "cpa1",
"@type": "certified_public_accountant",
"contact_at": [
"cpaContact1"
],
"has_first_name": {
"has_value": "CpaFirstName"
},
"has_last_name": {
"has_value": "CpaLastName"
}
},
{
"@id": "financialAdvisor1",
"@type": "financial_advisor",
"contact_at": [
"financialAdvisorContact1"
],
"has_first_name": {
"has_value": "FinancialAdvisorFirstName"
},
"has_last_name": {
"has_value": "FinancialAdvisorLastName"
}
},
{
"@id": "insuranceAgent1",
"@type": "insurance_agent",
"contact_at": [
"insuranceAgentContact1"
],
"has_first_name": {
"has_value": "InsuranceAgentFirstName"
},
"has_last_name": {
"has_value": "InsuranceAgentLastName"
}
},
{
"@id": "sellerCoordinator1",
"@type": "seller_coordinator",
"contact_at": [
"sellerCoordinatorContact1"
],
"has_first_name": {
"has_value": "SellerCoordinatorFirstName"
},
"has_last_name": {
"has_value": "SellerCoordinatorLastName"
}
},
{
"@id": "buyerCoordinator1",
"@type": "loan_coordinator",
"contact_at": [
"buyerCoordinatorContact1"
],
"has_first_name": {
"has_value": "BuyerCoordinatorFirstName"
},
"has_last_name": {
"has_value": "BuyerCoordinatorLastName"
}
},
{
"@id": "title1",
"@type": "title_holder",
"contact_at": [
"titleContact1"
],
"has_first_name": {
"has_value": "TitleFirstName"
},
"has_last_name": {
"has_value": "TitleLastName"
}
},
{
"@id": "buyerAttorney1",
"@type": "attorney",
"contact_at": [
"buyerAttorneyContact1"
],
"has_first_name": {
"has_value": "BuyerAttorneyirstName"
},
"has_last_name": {
"has_value": "BuyerAttorneyLastName"
},
"has_represented_party_type": {
"has_value": "borrower"
}
},
{
"@id": "sellerAttorney1",
"@type": "attorney",
"contact_at": [
"sellerAttorneyContact1"
],
"has_first_name": {
"has_value": "SellerAttorneyirstName"
},
"has_last_name": {
"has_value": "SellerAttorneyLastName"
},
"has_represented_party_type": {
"has_value": "other"
}
}
],
"properties": [
{
"@id": "sbp1",
"@type": "subject_property",
"has_property_current_usage_type": {
"has_value": "primary_residence"
},
"has_amortization_term_months_count": {
"has_value": 360
},
"with_address": [
"01GMDENWW0DN844A89DVD2BMSF"
],
"with_sales_contract": [
"psc1"
],
"with_value": [
"appraisedValue1"
]
}
],
"property_valuations": [
{
"@id": "appraisedValue1",
"@type": "subject_property_valuation",
"has_property_valuation_amount": {
"has_value": 1000
}
}
],
"down_payments": [
{
"@id": "ldp1",
"@type": "down_payment",
"has_down_payment_amount": {
"has_value": 1000
}
}
],
"loan_terms": [
{
"@id": "llt1",
"@type": "loan_terms",
"has_note_amount": {
"has_value": 1234
},
"has_note_rate_percent": {
"has_value": 7.5
},
"has_loan_purpose_type": {
"has_value": "purchase"
},
"has_mortgage_type": {
"has_value": "fha"
}
}
],
"loan_programs": [
{
"@id": "llp1",
"@type": "loan_program",
"has_loan_program_identifier": {
"has_value": "Indentured Servitude"
}
}
],
"ltvs": [
{
"@id": "lltv1",
"@type": "ltv",
"has_ltv_ratio_percent": {
"has_value": 1000.1
}
}
],
"sales_contracts": [
{
"@id": "psc1",
"@type": "property_sales_contract",
"has_sales_contract_amount": {
"has_value": 1000
}
}
],
"closing_information": [
{
"@id": "lci1",
"@type": "closing_information",
"has_closing_date": {
"has_value": "2012-04-23T18:25:43.511Z"
}
}
],
"loan_products": [
{
"@id": "lp1",
"@type": "loan_product",
"with_lock": [
"lpl1"
]
}
],
"locks": [
{
"@id": "lpl1",
"@type": "lock",
"has_lock_datetime": {
"has_value": "2012-04-23T18:25:43.511Z"
},
"has_lock_expiration_datetime": {
"has_value": "2012-04-23T18:25:43.511Z"
}
}
]
}
After calling single-loan-transaction product flow invocation, you can retrieve this invocation status using this API.
Parameter product_name should be dailyai and invocation_id parameter should be the invocation_id value in the product flow invocation response body.
Historical Loan Transaction
In order to send loan historical loan update, the same input as for single-loan-transaction should be created.
This time putting historical-loan-transaction in product_flow_name field.
product_flow_name = "historical-loan-transaction"
Create Transaction
You can create a transaction and use transaction_id in your request body of product API calls. Please check this API.
Retrieve Transaction Collections
You can use this API to retrieve collections used in same transaction.
Retrieve a Transaction's Collection
You can use this API to retrieve a transaction's collection.
