Loan Agreements

Get a loan agreement by id

GET
Retrieve a loan agreement by its id

Path parameters

loan_agreement_idstringRequired

Response

This endpoint returns an object
id
string
application_id
string

The application_id of the corresponding loan application the agreement is for

created_on
datetime
Timestamp the loan agreement object is created on
document_url
string
Url where the loan agreement document is hosted
status
enum
The status of the document
Allowed values: pending_signaturesignedexpired
type
enum
The type of document
Allowed values: credit_agreementach_authorizationautopay_ach_authorizationcredit_disclosure
signature_timestamp
datetimeOptional
Timestamp of when e-signature is completed

Errors

GET
1curl https://production.pier-finance.com/api/loan_agreements/doc_43da3b3f95c745e1985a71e9a00d6c27 \
2 -H "Authorization: Bearer <token>"
1{
2 "id": "doc_43da3b3f95c745e1985a71e9a00d6c27",
3 "application_id": "app_a9d2f388030d4f4296f80fc327e08d0d",
4 "created_on": "2022-12-31T20:47:38.152Z",
5 "document_url": "https://example.com/document-endpoint-unique-hash",
6 "status": "pending_signature",
7 "type": "credit_agreement",
8 "signature_timestamp": null
9}