List documents | Verifa

import requests
url = "https://devapi.withverifa.com/api/v1/documents"
headers = {"X-API-Key": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "string",
      "document_type": "id_front",
      "status": "pending",
      "created_at": "2024-01-15T09:30:00Z",
      "org_id": "string",
      "session_id": "string",
      "identity_id": "string",
      "classification": "string",
      "mime_type": "string",
      "file_size_bytes": 1,
      "original_filename": "string",
      "page_count": 1,
      "metadata": {},
      "upload_source": "string",
      "download_url": "string",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Returns a paginated list of standalone documents for your organization.

Required scope: documents:read

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Query parameters

statusenumOptional

Filter by document status.

Allowed values:

classificationstringOptional

Filter by document classification.

session_idstringOptional

Filter by associated session ID.

identity_idstringOptional

Filter by associated identity ID.

document_typeenumOptional

Filter by document type.

Allowed values:

limitintegerOptional1-100Defaults to 50

Maximum number of documents to return.

offsetintegerOptional>=0Defaults to 0

Number of documents to skip.

Response

A list of documents.

datalist of objects

paginationobject

Errors

401

Unauthorized Error

Authentication

Headers

Query parameters

Response

Errors