Skip to content

Accessing Loan Documents

Loan documents can be accessed through the Exchange API using the Document Access Endpoint. This endpoint allows you to retrieve documents associated with loans in a secure manner.

Prerequisites

Section titled “Prerequisites”

Before you begin, ensure you have the following:

  • Your API key
  • Your Partner ID
  • A loan ID (the full loan id (e.g ‘a204bc33-35b5-4c70-81c4-091766ba806c|loan12345’))
  • A document ID to download

If you don’t have an API key or Partner ID, please refer to the Getting Started guide.

Download a document

Section titled “Download a document”

Documents are enumerated as part of the loan details, and in order to download a specific document, you will need both the loan ID and the document ID.

To download a document, make a GET request to the following endpoint:

GET https://qa.exchange.crfusa.com/api/loan/document
?partnerId={{partnerId}}
&loanId={{loanId}}
&documentId={{documentId}}
x-api-key: {{key}}

The response will be a raw binary stream of the document file. Make sure to look at the ‘Content-Disposition’ header to determine the original filename of the document and store it accordingly.