LoanDetail collections

Collections

A loan collection contains a specific set of results, in response to a query that you add to your call.

When you want to access information (any details) about a loan, use the GET /LoanDetail/{Id} API. You can add 1 or more of the loan collections available in Arix (which are shown in the table below), which customizes the API response.

The API response always returns the OriginalLoanInfo (original details that were entered when the loan was created), and can also return other information. Therefore, if you made changes to a loan, it's easy to view and compare any of the changes you made to the loan.

To check the collections you've called, look at the Fields in the path parameter that show after the equal (=) sign.

Example

In the response below, only results for FundingAttempts and ProcessedRails are returned, which in this case doesn't return any responses.
GET /LoanDetail/{Id}?Fields=FundingAttempts,ProcessedRails

❗️

Important

When you send a PUT call to these endpoints, only unprocessed rails are overwritten.

• PUT /Loan/{Id}
• PUT /Loan/{Id}/FundingInfo

Already processed rails and rails that are in the process of being funded aren't affected.

LoanInfoUpdate collection parameters

This collection returns information about any updates made to a loan.

FundingInfoUpdate collection parameters

This collection returns information about any funding updates made to a loan.

FundingAttempt collection parameters

This collection returns information about the attempts made to fund the loan, and the result.

FailedLoanInfoUpdate collection parameters

This collection returns information about a loan that failed.

FailedFundingInfoUpdate collection parameters

This collection returns information about loan funding that failed.

RequiredDocs collection parameters

This collection returns information about Required Documents and their received status for this loan.