GuidesChangelog

Update a loan by ID

Suggest Edits

Use the loan ID in this call to update loan details. When you update field values in the LoanUpdate object of the request body, the response body will show the updated values.

PUT /Loan/{Id}

Request URL
https:// ... /Loan/{Id}

Click here to access the call to update funding information.

To follow loan updates, query the loan with this call, GET LoanDetails.

📘

Information

You can update loan details with PUT /Loan when the loan is in one of these statuses:

  • Received (before loan passes compliance)
  • ComplianceFailed (before loan passes compliance)
  • AwaitingFunding (after the loan has passed compliance)

If you send PUT /Loan in any other status, Arix won't update the loan, even if a 200 is returned.

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

Example

Original Post /Loan API response

662

Updated API request using PUT /Loan/{Id}

The updated BorrowerLastName and BorrowerFirstName show below.

📘

Use LoanUpdate object

When you update a loan with PUT /Loan, use a LoanUpdate object.

The attributes for LoanUpdate object are the same as those used in the Loan object, when you call POST /Loan.

{
  "LoanUpdate": {
    "LoanNumber": "LR-96e3f915eab244f",
    "IssuingBankId": "CRB",
    "Platform": "string",
    "LoanType": "HFS",
    "NoteDate": "/Date(1611047069923-0000)/",
    "BorrowerLastName": "Andersen",
    "BorrowerFirstName": "Betty",
    "BorrowerDOB": "/Date(536389200000-0000)/",
    "BorrowerSSN": "666712488",
    "BorrowerAddress": "171_Jettie_Mountains",
    "BorrowerCity": "Gislasonchester",
    "BorrowerState": "TX",
    "BorrowerZip": "78948",
    "LoanAmount": 1400,
    "NetFunding": 800,
    "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": "2017-12-31T09:18:46.377Z",
    "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-31T09:18:46.377Z",
    "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
        }
    ]
  }
}

Updated over 1 year ago