Sign in
Documents

List documents

Get all documents for the organization, optionally filtered by customer or transfer.

get/v1/documents

Query parameters

limitnumber

Number of results to return (1-1000). Use with offset for traditional pagination.

offsetnumber

Number of results to skip. Use with limit for traditional pagination.

page_sizenumber

Number of results per page (1-1000). Use with starting_after for cursor-based pagination.

starting_afterstring

Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.

customerIdstring
Example:cus_abc123

Filter by customer ID

transferIdstring
Example:txn_xyz789

Filter by transfer ID

counterpartyIdstring
Example:cp_abc123

Filter by counterparty ID through linked transfers

includeInternalboolean

Include internal/system-generated documents

Headers

X-API-Keystring

API key

Response

Documents retrieved successfully

totalnumber
limitnumber
offsetnumber

Example response

{
  "data": [
    {
      "id": "doc_abc123",
      "organizationId": "org_xyz789",
      "customerId": "cus_abc123",
      "transferId": "txn_xyz789",
      "documentType": "INVOICE",
      "documentSubtype": "BANK_STATEMENT",
      "fileName": "invoice-2026-001.pdf",
      "contentType": "application/pdf",
      "sizeBytes": 1024000,
      "status": "UPLOADED"
    }
  ]
}

Changes

Changed in 1 of the 19 revisions of this API.1

  • 70223aefae8c1See the full diff
    • ●

      added the new LIVENESS_CHECK enum value to the // response property for the response status

      response-property-enum-value-added