Create a loan

POST /Loan

Use this call to create a loan request in Arix.

Request URL

https:// ... /Loan

For detailed reference information on the loan attributes, see Loan attributes and parameters.

📘

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

Sample request in JSON - POST /Loan

{
  "Loan": {
    "LoanNumber": {{loanNumber}},
    "IssuingBankId": "CRB",
    "Platform": "string",
    "LoanType": 1,
    "NoteDate": "2019-12-31",
    "BorrowerLastName": {{$randomLastName}},
    "BorrowerFirstName": {{$randomFirstName}},
    "BorrowerDOB": "1986-12-31",
    "BorrowerSSN": {{borrowerSSN}},
    "BorrowerAddress": {{borrowerAddress}},
    "BorrowerCity": {{$randomCity}},
    "BorrowerState": {{borrowerState}},
    "BorrowerZip": {{borrowerZip}},
    "LoanAmount": 1500,
    "NetFunding": 1300,
    "Rate": 0.2,
    "APR": "10",
    "BatchId": "string",
    "BorrowerPhone": {{$randomPhoneNumber}},
    "BorrowerEmail": {{$randomEmail}},
    "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": "GL",
          "ToAccountName": "Test",
          "ToAccountNumber": "9999999999",
          "Description": "Test"
        },
        "RailType": "COSACH",
        "Priority": 1,
        "Amount": 300
        }
    ]
  }
}

Sample response in JSON - POST /Loan

{
    "Id": "bd054ec9-8598-497e-ac2d-ac5400bbbf3e",
    "MPLId": "TST",
    "Date": "/Date(1602674613963-0400)/",
    "LoanNumber": "MZ-1afc220c66ed4ad",
    "IssuingBankId": "CRB",
    "Platform": "string",
    "LoanType": "HFS",
    "NoteDate": "/Date(1577768400000-0500)/",
    "BorrowerLastName": "Emard",
    "BorrowerFirstName": "Darrion",
    "BorrowerDOB": "/Date(536389200000-0500)/",
    "BorrowerSSN": "640517072",
    "BorrowerAddress": "8652_VonRueden_Walks",
    "BorrowerCity": "East",
    "BorrowerState": "LV",
    "BorrowerZip": "30878",
    "LoanAmount": 500,
    "NetFunding": 1300,
    "Rate": 0.05,
    "APR": 10,
    "BatchId": "string",
    "BorrowerPhone": "323-514-0396",
    "BorrowerEmail": "[email protected]",
    "Amortization": 0,
    "Term": 36,
    "RateType": 0,
    "PriorLoanFlag": "string",
    "FICO": 10,
    "FICODate": "/Date(1514696400000-0500)/",
    "CreditGrade": "string",
    "AssetClass": 0,
    "LoanPurpose": "string",
    "Investor": "string",
    "Servicer": "string",
    "ApplicationDate": "/Date(1602674613934-0400)/",
    "RegBDecisionDate": "/Date(1602674613934-0400)/",
    "PurchaseDate": "/Date(1602907200000-0400)/",
    "PaymentDueDate": "/Date(1607922000000-0500)/",
    "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": "/Date(536389200000-0500)/",
    "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": "/Date(1514696400000-0500)/",
    "AdjustedMerchantFee": 0,
    "FinalPaymentDate": "/Date(1618372800000-0400)/",
    "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": "GL",
                "ToAccountName": "Test",
                "ToAccountNumber": "9999999999",
                "Description": "Test"
            },
            "Id": "c208ac03-803a-4b94-96c2-ac5400bbbf3e",
            "RailType": "COSACH",
            "Priority": 1,
            "Amount": 300,
            "LoanId": "bd054ec9-8598-497e-ac2d-ac5400bbbf3e",
            "MPLId": "TST",
            "IssuingBankId": "CRB",
            "IsFailed": false,
            "LoanType": "Undefined"
        }
    ]
}

Did this page help you?