GET /documents

List documents

Bearer API key or staff session operation listDocuments

Parameters

Name	In	Type	Required	Description
`customer_id`	query	string	No	—
`case_id`	query	string	No	—
`status`	query	string	No	one of `requested`, `uploaded`, `verified`, `rejected`, `expired`, `archived`
`q`	query	string	No	—
`limit`	query	integer	No	default `200` · max `500`

Request

This endpoint has no request body.

curl "$MONICHEK_API/documents?status=requested&limit=200" \
  -H "Authorization: Bearer $MONICHEK_API_KEY"

const res = await fetch(`${MONICHEK_API}/documents?status=requested&limit=200`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
  },
});

const data = await res.json();

import os
import requests

res = requests.get(
    f"{os.environ['MONICHEK_API']}/documents?status=requested&limit=200",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
)
print(res.json())

$ch = curl_init(getenv('MONICHEK_API') . '/documents?status=requested&limit=200');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

200 OK document page application/json

{
  "data": [],
  "next_cursor": ""
}

Error responses

Status	Meaning	Body
401	Unauthorized	RFC 9457 problem

Errors use the RFC 9457 problem format with a stable code.