List documents for an application
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “ Query Parameters ”Example
ZGVzY3x1cGRhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMQOpaque cursor from a previous response’s nextCursor. Omit on the first page. Cursors are tied to a sort direction: changing order mid-pagination is rejected.
Items per page (1-100). Default 50.
Sort direction (with id as tiebreaker). Default desc (newest first). The column being sorted is endpoint-specific. See the individual endpoint docs.
Example
507f1f77bcf86cd799439011ID of the application whose documents you want to list
Include documents that a replacement superseded. They stay hidden: true on the wire and are returned so a reviewer can see a document’s earlier versions. Off by default, which is the unchanged contract.
Include hidden documents the caller may unhide. For a platform user or an API key that is the documents hidden from the platform or through the API; documents hidden by Steward are never returned. Hidden rows stay hidden: true on the wire, with hiddenSource set. Off by default, which is the unchanged contract.
Responses
Section titled “ Responses ”Documents retrieved successfully
object
object
Human-readable label for the document type
Freshly signed S3 URL (re-signed on every read, ~7-day TTL). Null when the document has no underlying S3 object.
Who hid the document: CLIENT when it was hidden from the platform or through the API, STEWARD when Steward hid it. Null while the document is visible. A hidden document with no recorded source reports STEWARD.
True when a newer version of this document (a later-expiring ID card, a later proof of address, a later-signed tax form or FATCA/CRS declaration about the same subject) has passed all its checks and replaces it. A replaced document raises no review; its check results are unchanged.
object
The type of document validation
Array of validation results for this validation type
object
The key of the validation check
Boolean indicating if the validation check passed
Human-readable description of the validation check
Optional explanation providing context for the validation result (e.g., why it passed despite minor differences)
Number of validation attempts for this document type (starts at 1, increments on each upload)
Steward check keys superseded by an IDV vendor verdict on the same concern. Derived on read from the validations array, never persisted. The vendor is authoritative where the two overlap. Consumers must exclude these keys from pass/fail counts and hide them from display, while passing the underlying results back unchanged on write. The keys are a display and gating projection, never an instruction to delete stored data.
JSON metadata associated with the document
object
The chain entity this document is about, when it is not the applicant. Stamped at submission from the same resolution the onboarding profile drawer files chain documents by; null for the applicant’s own documents and for any document uploaded outside a dynamic onboarding.
object
Stable ownership key for the entity: entityType|lowercased name.
The entity name as the source document stated it.
Notes attached to the document
object
Note ID
Type of parent entity this note belongs to
ID of the parent entity
Content of the note
File attachments
object
S3 key of the attachment
Original file name
MIME type of the file
URL to access the file
ID of the user who created the note
ID of the user who last updated the note
User who created the note
object
First name of the user
Last name of the user
Email address of the user
User who last updated the note
object
First name of the user
Last name of the user
Email address of the user
Date the note was created
Date the note was last updated
True when the note was written as Steward-only and stays off the client feed. Customer writes cannot set it.
Label for the parent entity, for cross-entity listings that render notes from several sources in one feed. The document file name for DOCUMENT notes, “Screening” for SCREENING_HIT notes, the annotated event headline for AUDIT_LOG notes, null for APPLICATION notes. Only populated by the by-application listing.
ID the client needs to navigate back to the note’s source. The document ID for DOCUMENT notes; for SCREENING_HIT notes the screened entity (individual or business) ID, which is what the Screening tab keys its deep link on, not the hit ID; for AUDIT_LOG notes the audit entry ID, which the Audit Log tab opens off ?auditLogId=. Null for APPLICATION notes. Only populated by the by-application listing.
When in the relationship this document arrived. Derived on read from the request or review it is stamped with, or the review cycle its upload fell inside; never stored, so every document ever uploaded carries one.
The earlier, byte-identical copy this document duplicates. Null when it is the first of its bytes on the application.
object
The document that replaced this one. Only ever present on a row returned by includeSuperseded.
object
The additional-information request this document answers, when it answers one.
object
Why the reviewer asked, as recorded on the request.
Who the ask was about, when it named someone other than the applicant.
The platform user who uploaded this document. Null for anything an applicant supplied.
object
Position of this document’s type in the order the application’s workflow asks for its documents. Null when the workflow names no order or does not name this type. The client sorts those last.
Examples
{ "items": [ { "id": "507f1f77bcf86cd799439011", "type": "PROOF_OF_ADDRESS", "originSystem": null, "subType": null, "title": "Proof of Address", "fileName": "utility_bill.pdf", "key": "documents/utility_bill.pdf", "contentType": "application/pdf", "url": "https://storage.example.com/documents/utility_bill.pdf", "hidden": false, "hiddenSource": null, "replaced": false, "applicationId": "507f1f77bcf86cd799439012", "validations": [ { "type": "VALID_PROOF_OF_ADDRESS", "results": [ { "key": "validAddress", "isValid": true, "label": "Valid Address", "value": "John Smith, 123 Main Street, London EC1A 1BB", "explanation": "Individual addressee at a residential address, not a PO box or business address." } ], "validationAttempts": 2, "jobId": "3f6c2a9e-8b1d-4c7a-9e2f-5d4b1a6c8e03" } ], "supersededCheckKeys": [], "metadata": {}, "subject": null, "createdAt": "2026-03-30T12:00:00.000Z", "updatedAt": "2026-03-30T12:00:00.000Z", "notes": [ { "id": "507f1f77bcf86cd799439011", "entityType": "DOCUMENT", "entityId": "507f1f77bcf86cd799439011", "content": "Applicant confirmed ownership structure during call", "attachments": [ { "key": "uploads/uuid_document.pdf", "fileName": "document.pdf", "contentType": "application/pdf", "fileUrl": "https://bucket.s3.amazonaws.com/uploads/uuid_document.pdf" } ], "createdBy": "60d5ecb54b24003a7c8e92b2", "updatedBy": "60d5ecb54b24003a7c8e92b2", "createdByUser": { "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com" }, "updatedByUser": { "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com" }, "createdAt": "2026-03-30T12:00:00.000Z", "updatedAt": "2026-03-30T12:00:00.000Z", "stewardOnly": false, "sourceLabel": null, "sourceLinkId": null } ], "arrival": "initial_onboarding", "duplicateOf": null, "supersededBy": null, "additionalInfoRequest": null, "addedBy": null, "workflowOrder": 0 } ], "nextCursor": "ZGVzY3xjcmVhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMQ"}{ "items": [ { "id": "507f1f77bcf86cd799439011", "type": "PROOF_OF_ADDRESS", "originSystem": null, "subType": null, "title": "Proof of Address", "fileName": "utility_bill.pdf", "key": "documents/utility_bill.pdf", "contentType": "application/pdf", "url": "https://storage.example.com/documents/utility_bill.pdf", "hidden": false, "hiddenSource": null, "replaced": false, "applicationId": "507f1f77bcf86cd799439012", "validations": [ { "type": "VALID_PROOF_OF_ADDRESS", "results": [ { "key": "validAddress", "isValid": true, "label": "Valid Address", "value": "John Smith, 123 Main Street, London EC1A 1BB", "explanation": "Individual addressee at a residential address, not a PO box or business address." } ], "validationAttempts": 2, "jobId": "3f6c2a9e-8b1d-4c7a-9e2f-5d4b1a6c8e03" } ], "supersededCheckKeys": [], "metadata": {}, "subject": { "entityKey": "business|northreach holdings ag", "name": "Northreach Holdings AG", "entityType": "business" }, "createdAt": "2026-03-30T12:00:00.000Z", "updatedAt": "2026-03-30T12:00:00.000Z", "notes": [ { "id": "507f1f77bcf86cd799439011", "entityType": "APPLICATION", "entityId": "507f1f77bcf86cd799439011", "content": "Applicant confirmed ownership structure during call", "attachments": [ { "key": "uploads/uuid_document.pdf", "fileName": "document.pdf", "contentType": "application/pdf", "fileUrl": "https://bucket.s3.amazonaws.com/uploads/uuid_document.pdf" } ], "createdBy": "60d5ecb54b24003a7c8e92b2", "updatedBy": "60d5ecb54b24003a7c8e92b2", "createdByUser": { "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com" }, "updatedByUser": { "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com" }, "createdAt": "2026-03-30T12:00:00.000Z", "updatedAt": "2026-03-30T12:00:00.000Z", "stewardOnly": false, "sourceLabel": null, "sourceLinkId": null } ], "arrival": "initial_onboarding", "duplicateOf": { "documentId": "507f1f77bcf86cd799439014", "fileName": "utility_bill.pdf", "createdAt": "2026-01-01T00:00:00.000Z" }, "supersededBy": { "documentId": "507f1f77bcf86cd799439015" }, "additionalInfoRequest": { "requestId": "507f1f77bcf86cd799439016", "itemId": "9d7e3b21-6c4a-4f0e-8b52-1a9c7e4d2f60", "reason": "VALIDATION_FAILED", "requestedByName": "Jane Smith", "ownerLabel": "John Smith" }, "addedBy": { "userId": "60d5ecb54b24003a7c8e92b2", "name": "John Smith" }, "workflowOrder": 0 } ], "nextCursor": "ZGVzY3xjcmVhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMQ"}Application not found