Document reference

Document attributes

This section displays information on the documents that were received for the loan.

AttributeDescription
MPLId
string
ID of the MPL.
LoanId
GUID
Unique identifier of the loan.
FilePathPath for retrieving the document. Special permissions needed.
FileNameName of the file sent.
DateDate the file was received.
FileOverwrittenIf the original file was overwritten by another file, then the value will be 1.
IssuingBankId
string
ID of the issuing bank.

RequiredDocumentStatus parameters

This section displays the received status of required documents.

AttributeDescription
DocumentTypeOne of the documents required for loan processing.
ReceivedConfirms if a particular document was received.
ReceivedDateDate the document was received.

FAQs

Confirming the document status

To confirm the document status for a loan, call GET LoanDetail and use these collections:

  • RequiredDocs - to see which documents are required for a loan
  • Attachments - to see which documents were received by Arix

Loan in the status Received

A loan stays in Received for these reasons:

  • The naming format isn't correct based on a regex verification
  • Required documents weren't received
  • Required documents weren't named properly

❗️

Important

The status of the loan remains Received until all the required documents are received by Arix. No webhook is sent to notify that docs are incomplete.

Troubleshoot:

  1. Check if there is an error unzipping the files. If a file is corrupted, Arix won't be able to unzip it. Make sure to fix it and resend a POST with the attachments.
  2. Check the log files for errors.

Adding loan documents

You can add documents if the loan is in one of the statuses below.

StatusDescription
1Received
2DocsComplete
3PassedCompliance
4Approved
11AwaitingFunding
101ComplianceFailed

If a document is sent after the loan is funded, Arix will store it, but it will not parse it or run it through compliance.