Create and update a loan
POST /Loan and PUT /Loan/{Id}
Use these calls to create and update a loan request in Arix.
Request URL https:// ... Post/Loan
Request URL https:// ... Put/Loan/{Id}
When you update a loan with PUT/Loan, use a LoanUpdate object. The attributes for a LoanUpdateobject are the same as those used in the Loan object, when you call POST/Loan
The API block below is the reference information for the API attributes you can use when you create a loan. They are the same attributes shown when you receive a response.
The same attributes are used for the update a loan request: PUT /Loan/{Id}
POST /Loan
Use this call to create a loan request in Arix.
Endpoint: /Loan
Allows you to create a new loan by making an HTTP POST request to the specified URL. The request should include various details such as loan number, borrower information, loan amount, net funding, interest rate, and other relevant loan parameters. Additionally, the request can include information about different payment fields for rails.
POST
https://arixapisandbox.crbnj.net/Loan
{
"Loan": {
"LoanNumber": {{loanNumber}},
"IssuingBankId": "CRB",
"Platform": "string",
"LoanType": 1,
"NoteDate": "2019-12-31",
"BorrowerLastName": Waters,
"BorrowerFirstName": Therese,
"BorrowerDOB": "1986-12-31",
"BorrowerSSN": {{borrowerSSN}},
"BorrowerAddress": {{borrowerAddress}},
"BorrowerCity": Davisshire,
"BorrowerState": {{borrowerState}},
"BorrowerZip": {{borrowerZip}},
"LoanAmount": 1500,
"NetFunding": 1300,
"Rate": 0.2,
"APR": "10",
"BatchId": "string",
"BorrowerPhone": 959-390-4893,
"BorrowerEmail": [email protected],
"Amortization": 0,
"Term": 36,
"RateType": 0,
"PriorLoanFlag": "string",
"FICO": 10,
"FICODate": "2017-12-31",
"CreditGrade": "string",
"AssetClass": 0,
"LoanPurpose": "string",
"Investor": "string",
"Servicer": "string",
"ApplicationDate": {{ApplicationDate}},
"RegBDecisionDate": {{RegBDecisionDate}},
"PurchaseDate": {{PurchaseDate}},
"PaymentDueDate": {{PaymentDueDate}},
"ApprovedLoanAmount": 0,
"PeriodicPayment": 0,
"OriginationFee": 100,
"HomeownerFlag": "string",
"OpenCreditLines": 0,
"AnnualIncome": 0,
"CreditInquiries12months": 0,
"DQPast24months": 0,
"PublicRecordsOnFile": 0,
"EmploymentLength": 0,
"DebtUtilization": 0,
"TotalRevolvingDebt": 0,
"AccountsOpenedPast24months": 0,
"CollectionsExcludingMedical": 0,
"MonthsSinceLastRecord": 0,
"Employer": "string",
"DTI": 0,
"MLAFLAG": "string",
"MAPR": "string",
"ReceiverName": "string",
"SameDayFlag": 0,
"AddendaRecord": "string",
"CoBorrowerFirstName": "string",
"CoBorrowerLastName": "string",
"CoBorrowerDOB": "1986-12-31",
"CoBorrowerSSN": "string",
"CoBorrowerAddress": "string",
"CoBorrowerCity": "string",
"CoBorrowerState": "string",
"CoBorrowerZip": "string",
"CoBorrowerPhone": "string",
"CoBorrowerEmail": "string",
"CoBorrowerFICO": 0,
"MerchantName": "string",
"MerchantFee": 0,
"RefundAmount": 0,
"AdjustedLoanAmount": 0,
"AdjustedNetFunding": 0,
"AdjustedOriginationFee": 0,
"AdjustedCurrentMonthlyPayment": 0,
"RefundDate": "2017-12-31",
"AdjustedMerchantFee": 0,
"FinalPaymentDate": {{FinalPaymentDate}},
"FinalPayment": 0,
"FinanceCharge": 0,
"TotalPayments": 0,
"PPY": 0,
"PaymentFrequency": 0,
"StandardEntryTypeCode": "string",
"InterestAccrualMethodDays": 0,
"SubpoolId": "Moe83",
"Program": "DTM",
"Field1": "string",
"Field2": "string",
"Field3": "string",
"Field4": "string",
"Field5": "string",
"Field6": "string",
"Field7": "string",
"Field8": "string",
"Field9": "string",
"Field10": "string",
"Field11": "string",
"Field12": "string",
"Field13": "string",
"Field14": "string",
"Field15": "string",
"Field16": "string",
"Field17": "string",
"Field18": "string",
"Field19": "string",
"Field20": "string",
"Rails": [
{
"ACHFields": {
"StandardEntryClassCode": "PPD",
"TransactionType": "push",
"ToRoutingNumber": "021214891",
"ToAccountType": "Checking",
"ToAccountName": "Anita Loan",
"ToAccountNumber": "9999999999",
"Description": "LoanFunds"
},
"RailType": "COSACH",
"Priority": 1,
"Amount": 100
}
]
}
}Field 3 CIP
"{
"CIP Decision": "NonDocumentary, Documentary,Other",
"CIP Vendors used": {
"CIP KYC vendor": "Socure",
"CIP bank account vendor": "Plaid"
},
"CIP Documents used": {
"CIP Document": "Driving license",
"CIP Seconday Document": "Utility Bill"
},
"CIP Verification used": {
"OCR": "Mitek",
"Fraud": "Experian Fraud",
"Phone number": "White pages"
}
},
"CIPCollectionMethod": {
"Name": "FromCustomerviaApplication|FromCustomerviaLeadGenerator|FromExternalSource",
"Address": "FromCustomerviaApplication|FromCustomerviaLeadGenerator|FromExternalSource",
"DOB": "FromCustomerviaApplication|FromCustomerviaLeadGenerator|FromExternalSource",
"SSN": "FromCustomerviaApplication|FromCustomerviaLeadGenerator|FromExternalSource",
"CIPCollectionMethodExternalSource": "CreditReport - this field is required if the method of collection is from an external source; CreditReport is an example"
}, "TaxNumber":"SSN|ITIN"
}" Field 5 Credit Decisioning
{
"ApplicationId":"Unique applicationId, generated by the partner",
"RevolvingLineFirstAppearance":"yes/no",
"RevolvingLineGUID":"ID From Origination/First Appearance",
"RevolvingLineBalanceAsOfWhenCallingCRB":"",
"FloridaStampTaxCollectedFromCustomer":"Y/N",
"FloridaStampTaxAmount":"0.00",
"FloridaStampTaxRateUsed":"0.0035",
"DMVFeeAmount":"0.00",
"DiscountedLoan":"Y|N",
"Purchase discount":"N%",
"PurchaseDiscountAmount":"0.00",
"PremiumFee":"0.00",
"CreditBureau":"TU|Experian|Equifax|Innovis|Other",
"CreditPolicyVersion":"v1.0",
"CreditModelVersion":"v1.0",
"CreditModelVersion_2ndmodel":"v1.0",
"CreditModelVersion_3rdmodel":"v1.0",
"CreditUnderwritingRulesVersion":"v1.0",
"CreditModelVersion_Score":"100",
"CreditModelVersion_2ndmodel_Score":"100",
"CreditModelVersion_3rdmodel_Score":"100",
"PricingPolicyVersion":"v1.0",
"BypassRuleChecking":"True|False",
"CRBIssuingBranch":"NJ|DE"
}Field 6 Standard Format (Business)
{
"name": "business name",
"tin": "EIN/SSN",
"incDate": "2008-01-01",
"stateIncorp": "AZ",
"countryDomicile": "US",
"phone": "4805477526",
"email": "business email",
"address": "business address",
"city": "business city",
"state": "business state",
"zipCode": "business zip",
"physicalAddress": "the complete physical address of the business if different to the business address. Cannot be PO Box or TBD",
"payroll": "Average monthly payroll",
"businessType": "Business Entity Type - Sole proprietor,Partnership, C-Corp, S-Corp, LLC, Independent contractor, Eligible self-employed individual,501(c)(3) nonprofit, 501(c)(19) veterans organization, Tribal business (sec. 31(b)(2)(C) of Small Business Act), Other",
"businessPurpose": "Business purpose / description",
"industry": "xxx",
"naicsCode": "xxx",
"franchise": "Yes/No",
"RegisteredTradingNames": "",
"ProductServicesOffered": "",
"InsuranceType": "",
"AuthorisedSignatory": "",
"AuthorisedSignatoryVerificationMethod": "",
"BusinessLicenseInformation": "",
"BusinessWebSiteVerification": "Yes|No",
"BusinessAnnualTurnOver": "Gross Annual Revenue, cannot be null",
"BusinessPricingDetails": {
"pricingTier2": "",
"pricingTier3": ""
},
"BusinessCreditLimit": {
"ConsumerCreditLimit": "",
"DailyCreditLimit": "",
"BusinessApprovalException": "Y|N"
}
}Field 7 Standard Format (Business Owners/Principals)
[
{
"name": "owner Name",
"ownershipPer": 24,
"tin": "SSN|EIN|TIN",
"address": "owner address",
"city": "owner city",
"state": "ownerstate",
"zipCode": "owner zip",
"dob": "YYYY-MM-dd",
"phone": "owner phone",
"OwnerFico": 700,
"CIP Decision": "NonDocumentary, Documentary,Other",
"CIP Vendors used": {
"CIP KYC vendor": "eg Socure",
"CIP bank account vendor": "eg Plaid"
},
"CIP Documents used": {
"CIP Document": "eg for a person a Driving license",
"CIP Secondary Document": "eg for a person Utility Bill"
},
"OFAC decision":"True|False",
"OFAC decision source":"",
"CIP Verification used": {
"OCR": "eg Mitek",
"Fraud": "eg Experian Fraud",
"Phone number": "eg White pages",
"type": "Owner | Control person",
"citizenship": "US",
"residencyType": "Permanent Resident Alien | Non-Immigrant Alien | Illegal Alien"
}
},
{}
]Any vendors noted above are provided for illustration only.
IMPORTANT When you add a date field in a request, the format must be: yyyy-mm-dd. These fields include BorrowerDOB and FICODate and must be in this format: 1970-12-05