Merchants

List Merchant Documents

Returns document presence and validation lifecycle status for a specific sub-merchant.

This endpoint is metadata-only and does not return file bodies or signed retrieval URLs.

Supported query options:

  • Pagination: limit, page
  • Sorting: sort
  • Field filters: filter[field][eq]=value

Supported filter fields:

  • document_type
  • status

Supported sort fields:

  • created_at

Use - prefix for descending sort, for example sort=-created_at.

get/merchants/{merchant_id}/documents

Request

Path parameters

merchant_idstring required

ID of the sub-merchant under your partner account.

Query parameters

limitinteger

Maximum number of document records to return.

pageinteger

Page number for paginated document results.

sort'created_at' | '-created_at'

Sort field for merchant document results.

Prefix with - for descending order.

Filter merchant documents by type or validation status.

Filter semantics: filter[field][operator]=value.

Supported filters:

  • filter[document_type][eq]=bank_statements
  • filter[status][eq]=accepted

Response

Paginated list of merchant document metadata.

countinteger
pageinteger
limitinteger

Example response

{
  "count": 2,
  "page": 1,
  "limit": 25,
  "results": [
    {
      "id": "md_1234567890abcdef",
      "merchant_id": "mrc_1234567890abcdef",
      "document_type": "bank_statements",
      "status": "accepted",
      "validation_reasons": [],
      "uploaded_at": "2026-02-26T10:05:00.000Z",
      "validated_at": "2026-02-26T10:06:40.000Z",
      "object_key": "merchant/mrc_123/document/md_1234567890abcdef/bank_statement_2026_01.pdf",
      "created_at": "2026-02-26T10:00:00.000Z",
      "updated_at": "2026-02-26T10:06:40.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.