API Fields to pull and send data through Zapier
In this article, you'll find a list of different API fields for seamless data integration via Zapier. These API fields will help you to move information between apps effortlessly. We've organized them based on different events, making it easy for you to find what you need.
| Get Loan Details API | |
| API Fields | LOS UI Field Names |
| APPLICATION_INTAKE | Loan Stage Name |
| QUALIFICATION | Loan Stage Name |
| PREAPPROVED | Loan Stage Name |
| LOAN_SETUP | Loan Stage Name |
| DISCLOSURE_SENT | Loan Stage Name |
| UNDERWRITING_SUBMITTED | Loan Stage Name |
| APPROVED_WITH_CONDITION | Loan Stage Name |
| RE_SUBMITTAL | Loan Stage Name |
| CLEAR_TO_CLOSE | Loan Stage Name |
| DOCS_OUT | Loan Stage Name |
| DOCS_SIGNED | Loan Stage Name |
| LOAN_FUNDED | Loan Stage Name |
| BROKER_CHECK_RECEIVED | Loan Stage Name |
| COMMISSION_PAID | Loan Stage Name |
| ADVERSE | Loan Stage Name |
| HOI_date | Loan Tracker Name |
| HOI_status | Loan Tracker Name |
| APPRAISAL_date | Loan Tracker Name |
| APPRAISAL_status | Loan Tracker Name |
| TITLE_date | Loan Tracker Name |
| TITLE_status | Loan Tracker Name |
| archiveIndicator | Loan Archive Indicator |
| ariveLoanId | ARIVE Display Loan Id |
| baseLoanAmount | Base Loan Amount |
| cashoutPurpose | Cashout Purpose |
| cltv | Combined LTV Ratio |
| createDateTime | Loan Created At |
| creditRepairIndicator | Credit Repair Indicator |
| crmReferenceId | CRM Reference Id |
| currentLoanStatus_adverseReason | Adverse Reason |
| currentLoanStatus_date | Status Date |
| currentLoanStatus_status | Status Name |
| deepLinkURL | Deep Link URL |
| financedFees | Financed Fees |
| hcltv | HCLTV Ratio |
| keyDates_appraisalContingency | Appraisal Contingency Date |
| keyDates_appraisalDeliveryDate | Appraisal Delivery Date |
| keyDates_appraisalOrderedDate | Appraisal Ordered Date |
| keyDates_closingContingency | Closing Contingency Date/Estimated Closing Date |
| keyDates_dateToAvoidEPO | Date to Avoid EPO |
| keyDates_estFirstPaymentDate | Estimated First Payment Date |
| keyDates_firstPaymentDate | First Payment Date |
| keyDates_hoiOrderedDate | HOI Ordered Date |
| keyDates_hoiReceivedDate | HOI Received Date |
| keyDates_initialCDSentDate | Initial CD Sent Date |
| keyDates_initialCDSignedDate | Initial CD Signed Date |
| keyDates_initialLESentDate | Initial LE Sent Date |
| keyDates_initialLESignedDate | Initial LE Signed Date |
| keyDates_intentToProceedDate | Intent To Proceed Date |
| keyDates_loanContingency | Loan Contingency Date |
| keyDates_mostRecentCDSentDate | Most Recent CD Sent Date |
| keyDates_mostRecentCDSignedDate | Most Recent CD Signed Date |
| keyDates_mostRecentLESentDate | Most Recent LE Sent Date |
| keyDates_mostRecentLESignedDate | Most Recent LE Signed Date |
| keyDates_preApprovalExpiryDate | Pre-Approval Expiry Date |
| keyDates_taxTranscriptOrderedDate | Tax Transcipt Ordered Date |
| keyDates_taxTranscriptReceivedDate | Tax Transcript Received Date |
| keyDates_titleOrderedDate | Title Ordered Date |
| keyDates_titleReceivedDate | Title Received Date |
| keyDates_tridDate | TRID Date |
| leadSource | Lead Source |
| lenderName | Lender Name |
| loanBorrowers_firstName | First Name |
| loanBorrowers_lastName | Last Name |
| loanBorrowers_emailAddressText | |
| loanBorrowers_mobilePhone10digit | Phone |
| loanBorrowers_workPhone | Work Phone |
| loanBorrowers_homePhone | Home Phone |
| loanBorrowers_applicantType | Applicant Type (Borrower/Co-Borrower) |
| loanBorrowers_borrowerPairLoanAppSequence | Borrower Pair Loan App Sequence Number |
| loanBorrowers_dayOfBirth | Borrower Day Of Birth |
| loanBorrowers_monthOfBirth | Borrower Month Of Birth |
| loanBorrowers_maritalStatusType | Borrower Marital Status |
| loanBorrowers_posAppSubmissionDate | POS Application Submission Date |
| loanBorrowers_address_addressLineText | Street Address |
| loanBorrowers_address_addressUnitIdentifier | Address Unit Id |
| loanBorrowers_address_addressCity | Address City |
| loanBorrowers_address_addressState | Address State |
| loanBorrowers_address_addressPostalCode | Address Postal Code |
| loanBorrowers_address_addressCountry | Address Country |
| loanBorrowers_address_durationTermMonths | Address Duration In Months |
| loanBorrowers_address_residencyBasisType | Address Residency Basis Type |
| loanCreatedFrom | Loan Origination Source |
| loanOriginatorEmail | Email of Primary Loan Officer |
| loanProcessorEmail | Loan Processor Email |
| loanPurpose | Loan Purpose |
| loanTeamUsers_emailAddressText | User Email |
| loanTeamUsers_firstName | User First Name |
| loanTeamUsers_lastName | User Last Name |
| loanTeamUsers_mobilePhone10digit | User Phone |
| loanTeamUsers_loanRole | User Role |
| loanTeamUsers_primary | Primary User |
| ltv | LTV Ratio |
| modifiedDateTime | Loan Updated At |
| mortgageType | Mortgage Type |
| noteRate | Note Rate |
| purchasePriceOrEstimatedValue | Property Value |
| refinanceType | Refinance Type |
| subjectProperty_addressLineText | Subject Property Street Address |
| subjectProperty_addressUnitIdentifier | Subject Property Unit |
| subjectProperty_city | Subject Property City |
| subjectProperty_county | Subject Property County |
| subjectProperty_postalCode | Subject Property Postal Code |
| subjectProperty_state | Subject Property State |
| subjectProperty_housingType | Property Type |
| subjectProperty_propertyUsageType | Occupancy |
| subjectProperty_salesContractAmt | Purchase Price |
| subjectTBDIndicator | Subject Property TBD Indicator |
| sysGUID | ARIVE System GUID |
| downPayment | Down Payment |
| totalMonthlyHousingExpenseAmt | Total PITI |
| amortizationTerm | Amortization Term |
| discountPoints | Discount Points |
| compensation | Compensation |
| earnestMoneyDeposit | Earnest Money Deposit |
| sellerCredit | Seller Credit |
| homeownersInsuranceMonthlyAmt | Housing Expense - Homeowners Insurance Monthly Amount |
| realEstateTaxMonthlyAmt | Housing Expense - Real Estate Tax Monthly Amount |
| mIPremiumMonthlyAmt | Housing Expense - MI Premium Monthly Amount |
| homeownersAssociationDuesAndCondominiumFeesMonthlyAmt | Housing Expense - HOA Dues And Condo Fees Monthly Amount |
| lockStatus | Rate Lock Status |
| lockDate | Rate Lock Date |
| lockExpirationDate | Lock Expiry Date |
| businessContacts_firstName | First Name |
| businessContacts_lastName | Last Name |
| businessContacts_emailAddressText | |
| businessContacts_mobilePhone10digit | Phone |
| businessContacts_role | Role |
| businessContacts_companyName | Company Name |
| Create New Loan API | |
| externalCreateDate | Application Creation Date |
| leadSource | Lead Source |
| homebuyingStage | Home Buying Stage |
| originatorEmail | Email of Primary Loan Officer |
| loanPurpose | Loan Purpose |
| refinanceType | Refinance Type |
| cashoutPurpose | Cashout Purpose |
| mortgageType | Mortgage Type |
| baseLoanAmount | Base Loan Amount |
| purchasePriceOrEstimatedValue | Property Value / Sales Price |
| estimatedHOIMonthly | Estimated Monthly HOI Amount |
| estimatedPropertyTaxesMonthly | Estimated Monthly Property Taxes |
| estimatedAssociationDuesMonthly | Estimated Monthly HOA Dues |
| estimatedFICO | Estimated Loan FICO |
| currentInterestRateRefi | Current Interest Rate Refinance |
| propertyType | Property Type |
| propertyUsageType | Property Usage (Primary, Second Home etc.) |
| subjectTBDIndicator | Is Subject Property TBD? |
| subjectProperty_addressLineText | Subject Property Street Address |
| subjectProperty_addressUnitIdentifier | Subject Property Unit |
| subjectProperty_city | Subject Property City |
| subjectProperty_county | Subject Property County |
| subjectProperty_postalCode | Subject Property Postal Code |
| subjectProperty_state | Subject Property State |
| loanBorrowers_applicantType | Applicant Type (Borrower | CoBorrower) |
| loanBorrowers_borrowerPairLoanAppSequence | 1003 Number, Single 1003 can only have 2 borrowers |
| loanBorrowers_firstName | Borrower First Name |
| loanBorrowers_middleName | Borrower Middle Name |
| loanBorrowers_lastName | Borrower Last Name |
| loanBorrowers_suffix | Borrower Name Suffix |
| loanBorrowers_nickName | Borrower Nick Name |
| loanBorrowers_birthDate | Borrower Birth Date |
| loanBorrowers_emailAddressText | Borrower Email |
| loanBorrowers_mobilePhone10digit | Borrower Cell Phone# |
| loanBorrowers_homePhone10digit | Borrower Home Phone# |
| loanBorrowers_currentEmployment | Employment type |
| loanBorrowers_totalMonthlyIncome | Borrower Total Monthly Income |
| loanBorrowers_militaryServiceType | Borrower Military Service Type |
| loanBorrowers_maritalStatusType | Borrower Marital Status Type |
| loanBorrowers_residencyType | Borrower Residency Type |
| loanBorrowers_currentResidence_addressLineText | Street Address |
| loanBorrowers_currentResidence_addressUnitIdentifier | Address Unit Id |
| loanBorrowers_currentResidence_addressCity | Address City |
| loanBorrowers_currentResidence_addressState | Address State |
| loanBorrowers_currentResidence_addressPostalCode | Address Postal Code |
| loanBorrowers_currentResidence_addressCountry | Address Country |
| loanBorrowers_currentResidence_durationTermMonths | Address Duration In Months |
| loanBorrowers_currentResidence_residencyBasisType | Address Residency Basis Type |
| loanBorrowers_mailingAddressSeparateFromResidence | Borrower Mailing Address Is Separate From Residence |
| loanBorrowers_mailingAddress_addressLineText | Street Address |
| loanBorrowers_mailingAddress_addressUnitIdentifier | Address Unit Id |
| loanBorrowers_mailingAddress_addressCity | Address City |
| loanBorrowers_mailingAddress_addressState | Address State |
| loanBorrowers_mailingAddress_addressPostalCode | Address Postal Code |
| loanBorrowers_mailingAddress_addressCounty | Address County |
| loanBorrowers_dependentCount | Number of Dependents |
| loanBorrowers_dependentsAgesDesc | Comma Separated ages of all dependents |
| loanBorrowers_firstTimeHomeBuyer | Is Borrower a First time Homebuyer |
| loanBorrowers_languagePreference | Borrower Language Preference |
| loanBorrowers_defaultPast7years | Any Default in last 7 Years |
| crmReferenceId | CRM Reference Id |
| Update Loan API | |
| ariveLoanId/sysGUID | ARIVE Display Loan Id/ARIVE System GUID |
| loanStages | Loan Stages |
| stageDate | Stage Date |
| current | Is Current Stage? |
| intentToProceedDate | Intent To Proceed Date |
| lenderLoanNumber | Lender Loan Number |
| lenderNMLS | Lender NMLS |
| CRM Reference Id | CRM Id |
| Adverse Loan API | |
| ariveLoanId/sysGUID | ARIVE Display Loan Id/ARIVE System GUID |
| adverseDate | Adverse Date |
| reason | Adverse Reason |
| denialReasons | Denial Reasons |
| withdrawnReason | Withdrawn Reason |
| decisionBasedOnCredit | Decision Based On Credit Report |
| decisionBasedOnOutsideSource | Decision Based On Outside Source |
| decisionBasedOnOtherDesc | Decision Based On Other Description |
| deliveryType | Delivery Type |
| deliveryDate | Delivery Date |
| Get Lead Details API | |
| ariveLeadId | ARIVE Display Lead Id |
| sysGUID | ARIVE System GUID |
| leadSource | Lead Source |
| otherSourceDesc | Other Lead Source Description |
| homebuyingStage | Buying Stage |
| assigneeEmail | Email of Primary Lead Owner |
| loanPurpose | Loan Purpose |
| refinanceType | Refinance Type |
| cashoutPurpose | Cashout Purpose |
| mortgageType | Mortgage Type |
| baseLoanAmount | Base Loan Amount |
| amortizationType | Amortization Type |
| noteRate | Note Rate |
| qualifyingRate | Qualifying Rate |
| term | Amortization Term In Months |
| interestOnly | Interest Only |
| InterestOnlyTerm | Interest Only Term In Months |
| InitialFixedPeriodEffectiveMonthsCount | Initial Adjustment Period |
| NormalRateAdjustmentPeriod | Subsequent Adjustment Period |
| lienPosition | Lien Position |
| impoundWaiver | Impound Waiver |
| desiredMonthlyPayment | Desired Monthly Payment in Months |
| purchasePriceOrEstimatedValue | Property Value / Sales Price |
| estimatedHOIMonthly | Estimated Monthly HOI Amount |
| estimatedPropertyTaxesMonthly | Estimated Monthly Property Taxes |
| estimatedAssociationDuesMonthly | Estimated Monthly HOA Dues |
| estimatedFICO | Estimated Loan FICO |
| currentInterestRateRefi | Current Interest Rate Refinance |
| propertyType | Property Type |
| propertyUsageType | Property Usage |
| leadStatus | Lead Status |
| subjectTBDIndicator | Subject Property TBD Indicator |
| noContactRequest | DNC Request |
| emailOptOut | Email Opt-out |
| smsOptOut | Sms Opt-out |
| deepLinkURL | Deep Link URL |
| subjectProperty_lineText | Subject Property Street Address |
| subjectProperty_unitId | Subject Property Unit |
| subjectProperty_city | Subject Property City |
| subjectProperty_county | Subject Property County |
| subjectProperty_postalCode | Subject Property Postal Code |
| subjectProperty_state | Subject Property State |
| borrower_firstName | Borrower First Name |
| borrower_lastName | Borrower Last Name |
| borrower_emailAddressText | Borrower Email Address |
| borrower_dayOfBirth | Borrower Day Of Birth |
| borrower_monthOfBirth | Borrower Month Of Birth |
| borrower_mobilePhone10digit | Borrower Cell Phone# |
| borrower_currentResidence_addressLineText | Borrower Current Street Address |
| borrower_currentResidence_addressUnitIdentifier | Borrower Address Unit Id |
| borrower_currentResidence_addressCity | Borrower Address City |
| borrower_currentResidence_addressPostalCode | Borrower Address Postal Code |
| borrower_currentResidence_addressState | Borrower Address State Code |
| borrower_currentResidence_addressCountry | Borrower Address Country |
| borrower_employmentType | Borrower Employment Type |
| borrower_hasCoBorrower | Borrower Has Co-Borrower |
| borrower_hasRealEstate | Borrower Has Real Estate |
| borrower_annualIncome | Borrower Annual Income |
| borrower_militaryServiceType | Borrower Military Service Type |
| borrower_firstTimeHomeBuyer | Is Borrower a First time Homebuyer |
| borrower_yearsSinceForeclosure | Years Since Foreclosure |
| borrower_yearsSinceBankruptcy | Years Since Bankruptcy |
| borrower_currentlyOwningAHome | Currently Owning A Home |
| borrower_planningToSellItBeforeBuying | Planning To Sell Currently Owned Home Before Buying |
| borrower_totalLiability | Borrower Total Monthly Liability |
| borrower_occupancy | Borrower Residency basis type |
| borrower_durationMonthsCount | Borrower Address Duration In Months |
| coBorrower_firstName | CoBorrower First Name |
| coBorrower_lastName | CoBorrower Last Name |
| coBorrower_emailAddressText | CoBorrower Email Address |
| coBorrower_dayOfBirth | CoBorrower Day Of Birth |
| coBorrower_monthOfBirth | CoBorrower Month Of Birth |
| coBorrower_birthDate | CoBorrower Date of Birth |
| coBorrower_cellPhone | CoBorrower Cell Phone# |
| coBorrower_militaryServiceType | CoBorrower Military Service Type |
| crmReferenceId | CRM Reference Id |