Loan attributes and parameters
The table below is the reference information for the API attributes you can use when you create a loan or update a loan. They are the same attributes that show when you receive a response. Required response attributes show in the second table at the bottom.
Request Object: Loan (for POST loan)
Request Object: LoanUpdate (for PUT request)
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
For fields that are of type Number (decimal), Arix stores 6 decimal points. For fields that are of type Integer, you shouldn't send a decimal.
Attribute | Description |
|---|---|
LoanNumber string | A customer generated loan number. Up to 100 characters. Required |
IssuingBankId string | The ID of the issuing bank. CRB, NHB or BRB. Required |
Platform string (100 characters) | The entity that is the intermediary between the customer and CR Required |
LoanType string | Select from: 1 - HFS (Hold For Sale) 2 - LTHFS (Long Term Hold For Sale) 4 - CRBRetained (Retained) Required |
NoteDate string | Date the borrower becomes obligated to pay the loan. Date can be the signing date or the funding date (dependent on the loan documents). The format must be: yyyy-mm-dd. Required |
BorrowerLastName string (80 characters) | Borrower's last name Required |
BorrowerFirstName string (80 characters) | Borrower's first name Required |
BorrowerDOB string | Borrower's date of birth The format must be: yyyy-mm-dd. Required |
BorrowerSSN string | Borrower's Social Security Number Required |
BorrowerAddress string (160 characters) | Borrower's address Required |
BorrowerCity string (80 characters) | Borrower's city of residence Required |
BorrowerState string (40 characters) letter code) | Borrower's State of residence Required |
BorrowerZip
string (20 digits) | Borrower's zip code Required |
LoanAmount number | Gross dollar amount requested. This amount represents the sum of the origination fee plus (+) net funding amount. Required |
NetFunding number | Net dollar amount to be funded Required |
Rate number | Interest rate, as a percent Required |
APR number | Annual percentage interest rate, as a percent Required |
ServicingBankId string | ID of the servicing bank Optional |
BorrowerPhone string (30 digits) | Borrower's phone number Optional |
BorrowerEmail string (100 characters) | Borrower's email address Optional |
Amortization integer or null | Number of payments at loan origination to pay off the loan Optional |
Term integer or null | Number of months from loan origination to pay off the loan. Optional |
RateType integer or null | 1 - fixed 2- floating Optional |
PriorLoanFlag string (20 characters) | Whether the borrower took a loan with the platform in the past. Y - yes N - no Optional |
FICO integer or null | Borrower's 3-digit FICO score used for risk assessment Optional |
FICODate string | Date FICO score was obtained The format must be: yyyy-mm-dd. Optional |
CreditGrade string (20 characters) | Internal grade for loan or from credit policy Optional |
AssetClass integer or null | Reason for loan: 1 - student 2 - solar 3 - debt consolidation 4 - home improvement 5 - POS (point of service) 6 - medical 7 - auto 99 - other Optional |
LoanPurpose string (500 characters) | Borrower's stated purpose for the loan Optional |
Investor string (300 characters) | Name of investor who will be purchasing the loan Leave blank for loans retained by CR. Optional |
Servicer string (100 characters) | The entity that handles the servicing of your account, such as billing statements, notices Optional |
ApplicationDate string | Date the borrower applied for the loan. The format must be: yyyy-mm-dd. Optional |
RegBDecisionDate string | Date the loan was approved The format must be: yyyy-mm-dd. Optional |
PurchaseDate string | Date the lender or investor will purchase the loan from CR The format must be: yyyy-mm-dd. Optional |
PaymentDueDate string | Date the first payment is due The format must be: yyyy-mm-dd. Optional |
ApprovedLoanAmount number | Dollar amount the borrower was approved to borrow at the time of application. The amount can change before the final loan amount for reasons related to the borrower or lender. Optional |
PeriodicPayment number | Dollar amount of monthly payments Optional |
OriginationFee number | Charge to the borrower for the loan Optional |
HomeownerFlag string (20 characters) | Confirm if the borrower is a homeowner Yes or No. Optional |
OpenCreditLines integer or null | Number of open credit lines Optional |
AnnualIncome integer or null | Borrower's annual income Optional |
CreditInquiries12months integer or null | Number of credit inquiries made on the borrower in the last 12 months Optional |
DQPast24months integer or null | Number of times the borrower has paid their loan late in the last 24 months on all accounts Optional |
PublicRecordsOnFile integer or null | Number of open public records, such as bankruptcy, tax liens or judgments Optional |
EmploymentLength integer or null | Number of years the borrower has been employed at their current job Optional |
DebtUtilization number | Percent of available credit used by borrower Optional |
TotalRevolvingDebt number | Dollar amount of all revolving debt on the credit report Optional |
AccountsOpenedPast24months integer or null | Number of accounts the borrower opened in the last 24 months Optional |
CollectionsExcludingMedical integer or null | Number of open collection accounts, not including collections for medical procedures. Optional |
MonthsSinceLastRecord integer or null | This field indicates the number of months since the last active public record was on their credit report. A public record may indicate that a borrower stopped paying bills. Optional |
Employer string (500 characters) | Name of employer. Optional |
DTI decimal | Debt to Income Ratio Ratio of total monthly payment obligations divided by the monthly income as a decimal, not as a percent. It is calculated differently for each credit policy. It must be submitted as a decimal. The decimal value should be between 0-300. Optional |
MLAFLAG string (20 characters) | If the loan is being made to a covered borrower. Yes or No. Optional |
MAPR string (20 characters) | Military APR A standard calculation used by lenders for loans covered by the Department of Defense's Military Lending Act & Regulation Z. MAPR is required if MLAFLAG = Yes For more information, see: https://www.fdic.gov/regulations/compliance/manual/5/V-13.1.pdf Optional |
ReceiverName string (200 characters) | Name of party receiving funds via ACH Optional |
SameDayFlag integer or null | If the loan being funded via ACH or same-day ACH. (Same-day ACH requires set up by CR). Optional |
AddendaRecord string (80 characters) | Additional record used for information purposes Optional |
CoBorrowerFirstName string (80 characters) | Coborrower's first name Optional |
CoBorrowerLastName string (80 characters) | Coborrower's last name Optional |
CoBorrowerDOB string | Coborrower's date of birth. The format must be: yyyy-mm-dd Optional |
CoBorrowerSSN string | Coborrower's Social Security Number Optional |
CoBorrowerAddress string (160 characters) | Coborrower's address Optional |
CoBorrowerCity string (80 characters) | Coborrower's city of residence Optional |
CoBorrowerState string (40 characters) code) | Coborrower's State of residence Optional |
CoBorrowerZip string (20 digits) | Coborrower's zip code Optional |
CoBorrowerPhone string (30 digits) | Coborrower's phone number Optional |
CoBorrowerEmail string (100 characters) | Coborrower's email address Optional |
CoBorrowerFICO integer or null | Coborrower's FICO score Optional |
MerchantName string (200 characters) | Merchant's name Optional |
MerchantFee number | Dollar amount paid to merchant Optional |
RefundAmount number | Refund amount Optional |
RefundDate string | Refund date The format must be: yyyy-mm-dd Optional |
FinalPaymentDate string | Date due for final loan payment The format must be: yyyy-mm-dd. Optional |
FinalPayment number | Dollar amount of final payment Optional |
FinanceCharge number | Finance charge paid by the borrower Optional |
TotalPayments number | Total paid by the borrower after all the payments were made Optional |
PPY number | Number of payments per year Optional |
PaymentFrequency integer or null | Frequency of payments: 1 - weekly 2 - semi-monthly 3 - monthly 4 - bi-monthly 5 - other 6 - bi-weekly Optional |
StandardEntryTypeCode string (20 characters) | PPD - consumer accounts CCD - corporate accounts Optional |
InterestAccrualMethodDays integer or null | 365 (days) Optional |
SubpoolId string (20 characters) | ID of the subpool that the loan belongs to Optional |
Program string (100 characters) | MPL defined program that the loan belongs to Optional |
Field1 string | Reserved for submitter's IP address Up to 5,000 characters. Required |
Field2 string | Reserved for JSON "{
""OFAC decision"":""True|False"",
""OFAC decision source"":""""
}" Up to 5,000 characters. Required |
Field3 string | Reserved for JSON "{
{
"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"
}"
Up to 5,000 characters. Required |
Field4 string | Reserved for loan agreement version Up to 5,000 characters. Required |
Field5 string | Reserved for credit decisioning parameters JSON {
"RevolvingLineFirstAppearance":"yes/no",
"RevolvingLineGUID":"ID From Origination/First Appearance",
"RevolvingLineBalanceAsOfWhenCallingCRB":"",
"FloridaStampTaxCollectedFromCustomer":"Y/N",
"FloridaStampTaxAmount":"0.00",
"DMVFeeAmount":"0.00",
"FloridaStampTaxRateUsed":"0.0035",
"DiscountedLoan":"Y|N",
"Purchase discount":"N%",
"CreditPolicyVersion":"v1.0",
"CreditModelVersion":"v1.0",
"PremiumFee":"0.00"
} Up to 5,000 characters. Required for any credit information requested by CR |
Field6 string | Required for business information Up to 5,000 characters. See standard JSON format below |
Field7 string | Reserved for business owner Information Collect information on controlling person and business owners who own 25% or more. For SBA loans the threshold is 20%. Up to 5,000 characters. See standard JSON format below |
Field6 string | Required for business information Up to 5,000 characters. See standard JSON format below |
Field7 string | Reserved for business owner Information Collect information on controlling person and business owners who own 25% or more. For SBA loans the threshold is 20%. Up to 5,000 characters. See standard JSON format below |
Field8 string | Open field for text. Up to 5,000 characters. Optional |
Field9 string | Reserved for fraud vendor raw response Up to 5,000 characters. Optional |
Field10 string | Open field for text. Up to 5,000 characters. Optional |
Field11 string | Open field for text. Up to 5,000 characters. Optional |
Field12 string | Open field for text. Up to 5,000 characters. Optional |
Field13 string | Open field for text. Up to 5,000 characters. Optional |
Field14 string | Open field for text. Up to 5,000 characters. Optional |
Field15 string | Open field for text. Up to 5,000 characters. Optional |
Field16 string | Reserved for second look investors raw response Up to 5,000 characters. Optional |
Field17 string | Open field for text. Up to 5,000 characters. Optional |
Field18 string | Open field for text. Up to 5,000 characters. Optional |
Field19 string | Open field for text. Up to 5,000 characters. Optional |
Field20 string | Open field for text. Up to 5,000 characters. Optional |
Field21 byte [ ] | Optional addition of loan information. Byte array in Base 64. Up to 8,000 characters. Optional |
Rails List {RailTransaction} | Click rail transactions for information on rails Required |
Any vendors noted above are provided for illustration only.
Attribute | Description |
|---|---|
Status string | The status of a loan See Enums for response statuses. |
TimeStamp string | Timestamp of the update |
Id GUID | Unique identifier for the loan |
MPLId string | ID of the MPL |
Date string | Date of the transaction |
