List documents

Returns a paginated list of compliance documents scoped to the authenticated tenant.

Supports Flop pagination and filtering:

page - Page number (1-indexed, default: 1)
page_size - Items per page (default: 20, max: 100)
order_by - Field to sort by
order_directions - Sort direction (asc or desc)
filters - Flop filters (account_holder_id, document_type, status, primary, name)

get/api/documents

Request

Base URL: http://localhost:4100
URL: http://localhost:4100/api/documents
Auth: none required

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page (max: 100)

order_bystring

Field to sort by

order_directionsstring

Sort direction (asc or desc)

Response

Document list

Example response

{
  "data": [
    {
      "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "content_type": "",
      "description": "",
      "document_number": "",
      "document_type": "identity_document",
      "file_key": "",
      "file_name": "",
      "file_size": 0,
      "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "inserted_at": "2020-04-20T16:20:00Z",
      "metadata": {},
      "name": "",
      "primary": false,
      "status": "draft",
      "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "updated_at": "2020-04-20T16:20:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.