PIpier-finance
LoanAgreements

Get a loan agreement by id

Retrieve a loan agreement by its id

get/loan_agreements/{loan_agreement_id}

Request

  • Base URL
    https://production.pier-finance.com/api
  • Auth
    HTTP bearer

Path parameters

loan_agreement_idstring required

Response

idstring required
application_idstring required

The application_id of the corresponding loan application the agreement is for

created_onstring date-time required

Timestamp the loan agreement object is created on

document_urlstring required

Url where the loan agreement document is hosted

signature_timestampstring date-time nullable

Timestamp of when e-signature is completed

status'pending_signature' | 'signed' | 'expired' required
type'credit_agreement' | 'ach_authorization' | 'autopay_ach_authorization' | 'credit_disclosure' required

Example response

{
  "application_id": "app_a9d2f388030d4f4296f80fc327e08d0d",
  "created_on": "2022-12-31T20:47:38.152Z",
  "document_url": "https://example.com/document-endpoint-unique-hash"
}

Changes

No recorded changes to this operation across all 1 revision of this API.