Retrieve every document on a loan: files uploaded against a document requirement (a document requirement can target the loan, a person, or a business) plus loan-level artifacts the platform generates, such as term sheets and adverse-action notices. Each entry carries the requirement it satisfies — including its review status and its id, which is what you pass as requirementID when uploading. requirement is null for generated artifacts. requirements lists every open requirement of the loan, including the ones with no file yet, so you can find the id for a first upload. Use the download endpoint to get a presigned URL for the file itself.
Security
ApiKeyAuth
- https://api.pioneerft.com/apihttps://api.pioneerft.com/api/public/v1/loans/{id}/documents
- https://api.staging.pioneerft.com/apihttps://api.staging.pioneerft.com/api/public/v1/loans/{id}/documents
curl -i -X GET \
'https://api.pioneerft.com/api/public/v1/loans/{id}/documents' \
-H 'Authorization: Bearer <YOUR_API Key_HERE>'Response
{ "data": [ { "id": "string", "name": "string", "type": "string", "size": 0, "category": "broker", "uploadedAt": "string", "requirement": { "id": "string", "name": "string", "status": "AWAITING_UPLOAD", "module": "string", "entityType": "loan", "entityID": "string", "period": "string" } } ], "requirements": [ { "id": "string", "name": "string", "type": "data", "status": "AWAITING_UPLOAD", "module": "string", "entityType": "loan", "entityID": "string", "periodRequired": true, "periods": [ { "period": "string", "status": "AWAITING_UPLOAD", "fileCount": -9007199254740991 } ], "fileCount": -9007199254740991 } ] }