GET
/
loan_agreements
/
{loan_agreement_id}
curl --request GET \
  --url https://production.pier-finance.com/api/loan_agreements/{loan_agreement_id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "status": "pending_signature",
  "id": "doc_43da3b3f95c745e1985a71e9a00d6c27",
  "application_id": "app_a9d2f388030d4f4296f80fc327e08d0d",
  "document_url": "https://production-formapi-docs.s3.amazonaws.com/store/acc_QqdcDH47A63qKZbK3S/templates/tpl_4zqGxezHzrfqDaxGr2/submissions/sub_J9PbHbXYbL4jzRxc3R.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJESVN6QC4ACN3XSQ%2F20221231%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221231T204739Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=cf0c6429ef72ca06d861cb912f5d1cf376a5c26c7f904aaa9bf08f10103785bd",
  "created_on": "2022-12-31T20:47:38.152Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
loan_agreement_id
string
required

Response

200
application/json
​
id
string
required
​
application_id
string
required

The application_id of the corresponding loan application the agreement is for

Example:

"app_a9d2f388030d4f4296f80fc327e08d0d"

​
created_on
string
required

Timestamp the loan agreement object is created on

Example:

"2022-12-31T20:47:38.152Z"

​
document_url
string
required

Url where the loan agreement document is hosted

Example:

"https://production-formapi-docs.s3.amazonaws.com/store/acc_QqdcDH47A63qKZbK3S/templates/tpl_4zqGxezHzrfqDaxGr2/submissions/sub_J9PbHbXYbL4jzRxc3R.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJESVN6QC4ACN3XSQ%2F20221231%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221231T204739Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=cf0c6429ef72ca06d861cb912f5d1cf376a5c26c7f904aaa9bf08f10103785bd"

​
status
enum<string>
required

The status of the document

Available options:
pending_signature,
signed,
expired
​
signature_timestamp
string

Timestamp of when e-signature is completed