List and search dossiers

Returns a paginated list of the organization's dossiers (KYC, KYB and doc),
most recent first, with optional search and filtering. Each row is a
lightweight summary — call GET /dossiers/:id for the full detail of a single
dossier (media, applicants, identity documents, liveness images).

Query parameters

  • search — optional, case-insensitive match on the dossier name, humanized
    token, or your customer reference (customer_identification).
  • status — optional business status filter (open, approved, rejected, …).
  • type — optional dossier type filter (kyc, kyb, doc).
  • date_from / date_to — optional ISO 8601 created-at range.
  • page — optional, 1-based page number (default 1, max 1000).
  • per_page — optional, items per page (default 50, max 100).

Response

{
  "dossiers": [
    {
      "id": "dossier_xxx",
      "token": "U45XZQE9N",
      "type": "kyc",
      "status": "approved",
      "name": "Jane Doe",
      "reference": "user-123",
      "risk_score": 4,
      "is_test": false,
      "download_status": "not_downloaded",
      "documents_count": 2,
      "created_at": "2025-01-20T10:30:00Z",
      "updated_at": "2025-01-20T10:35:00Z",
      "completed_at": "2025-01-20T10:34:00Z"
    }
  ],
  "page": 1, "per_page": 50, "total": 128, "total_pages": 3
}

Errors

  • 401 authentication_error — missing, malformed, or revoked private key.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Case-insensitive search over dossier name, humanized token and customer reference.

string
enum

Filter by business status.

string
enum

Filter by dossier type.

Allowed:
date-time

Only dossiers created on/after this ISO 8601 timestamp.

date-time

Only dossiers created on/before this ISO 8601 timestamp.

int32
1 to 1000
Defaults to 1

Offset pagination: 1-based page number (max 1000). Ignored when starting_after is given.

int32
1 to 100
Defaults to 50

Items per page (default 50, max 100).

string

Keyset pagination: a dossier id (dossier_xxx) from a previous page; returns the dossiers immediately after it. Cheaper than page for large result sets (no COUNT, no deep OFFSET). When given, page/total are not used — the response returns has_more + next_cursor instead.

Response
200

List and search dossiers

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!