Generated and Uploaded Documents
Returns an array of available documents. Documents can be downloaded by sending an authorized GET request to the url provided.
The urls for individual documents are subject to change if an applicant replaces a document.
These are the available types of documents:
- packet - All documents in one downloadable PDF
- summary - A document generated by Approve Owl
- statement - An Approved Owl generated bank statement
- upload - A document uploaded by the applicant
Request
Requires Authorization
GET: https://sandbox.approveowl.com/api/v1/applicants/:applicant_id/documents
| Parameter | Type | Description |
|---|---|---|
| :applicant_id | string | The applicant ID |
Example Response
[
{
"name": "Report Card",
"type": "summary",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/report_card.pdf",
"created_at": "2023-08-14T12:50:40.480-05:00"
},
{
"name": "Identity Summary",
"type": "summary",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/identity_summary.pdf",
"created_at": "2023-08-14T12:50:40.480-05:00"
},
{
"name": "Identification Card",
"type": "identification",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/identification_card.pdf",
"created_at": "2023-08-14T12:50:40.480-05:00"
},
{
"name": "Financial Summary",
"type": "summary",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/financial_summary.pdf",
"created_at": "2023-08-14T12:50:40.480-05:00"
},
{
"name": "Regions Bank Checking 1428",
"type": "bank_statement",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/bank_statement_fb6f87a5-8c63-4b2c-975f-ff12177abe46.pdf",
"created_at": "2020-06-12T13:50:42.555-05:00"
},
{
"name": "Insurance Card",
"type": "uploaded_document",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/uploaded_document_a25a71dc-8e54-43d0-93e9-040c92812b2b.pdf",
"created_at": "2022-01-10T09:33:24.749-06:00"
},
{
"name": "Electric Bill",
"type": "uploaded_document",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/uploaded_document_bf5a8dfd-5b5e-46f2-8b64-050ecf4217ae.pdf",
"created_at": "2022-01-10T09:32:15.506-06:00"
},
{
"name": "Water Bill",
"type": "uploaded_document",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/uploaded_document_6ddc20b1-1678-4fb5-a892-369865c6e9d5.pdf",
"created_at": "2022-01-10T09:25:31.588-06:00"
},
{
"name": "All Documents",
"type": "packet",
"url": "https://sandbox.approveowl.com/api/v1/applicants/e13a342e-01ee-46ec-828d-e6dbc10896d0/documents/packet.pdf",
"created_at": "2023-08-14T12:50:40.480-05:00"
}
]