v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Document Collections

Get document collection details

The endpoint returns detailed information about a specific collection, including all uploaded files and recognized documents with their categorization results.

get/v1/documents/collections/{collection_id}/

Response

collection_idstring required

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "collection_id": "a1b2c3d4e5f6478899aabbccddeeff00",
  "uploaded_files": [
    {
      "file_id": "f1234567890abcdef1234567890abcde",
      "filename": "paystub.pdf",
      "mime_type": "application/pdf",
      "validations": {
        "is_viable_size": true,
        "is_supported_type": true,
        "is_accessible": true,
        "is_valid": true,
        "is_readable": true,
        "is_unique": true
      },
      "status": "validated",
      "user_id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789"
    }
  ],
  "documents": [
    {
      "document_id": "d0c1234567890abcdef1234567890abc",
      "file_id": "f1234567890abcdef1234567890abcde",
      "document_type": "PAYSTUB",
      "status": "successful",
      "first_name": "John",
      "last_name": "Doe",
      "user_id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789",
      "start_page": 1,
      "end_page": 2
    }
  ],
  "users": [
    {
      "id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789",
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "created_at": "2025-11-11T10:00:00Z",
  "updated_at": "2025-11-11T10:05:00Z"
}