Documents and statements
Requesting a typed document, what comes back, and how bank statements differ.
Documents on a deal come from two places: bank statements the applicant supplied when they applied, and typed requests you raise yourself.
- 1
Ask for a specific item by type, such as filed accounts or management accounts.
Hands you a request id, and the same checklist row the client sees
- 2
Track what you have asked for through requested, uploaded and forwarded.
- 3
Read what came back. This is the one place signed links live.
Hands you short-lived download URLs
- 4
Fetch one file at the point of use. Never store the URL.
Typed requests
Raise a request with POST /deals/{ref}/requests for a specific item, such as filed accounts or management accounts, and track it through requested, uploaded and forwarded. The client sees the same checklist in their account.
Documents are collected once per client. If another request on the panel already supplied the same document type, your request is fulfilled from the archive immediately and you receive request.fulfilled without the client being asked again.
Statements
The statements object on a deal reports what is on file: whether statements exist, when they were uploaded, the provider and whether that provider is a bank or a fintech, how many months are covered, and the parsed average monthly inflow and outflow. The three parsed figures appear only where a statement parse recorded them. Where a parse recorded nothing, the field is null. An unreadable source is never reported as an empty result.
Downloading
Files are fetched through signed links with GET /deals/{ref}/documents/{id}. Links are short-lived by design, so fetch at the point of use rather than storing the URL.