Skip to main content
GET
/
v1
/
documents
List documents
curl --request GET \
  --url https://api.beltic.com/v1/documents
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "document",
      "attributes": {
        "status": "pending",
        "file": {
          "id": "<string>",
          "filename": "<string>",
          "content_type": "image/jpeg",
          "byte_size": 3340938,
          "checksum": "cdff95d353d86a9fa1f06532a8ca212430d5b512efa669250c0777c9525d55fb",
          "status": "pending_upload",
          "url": "https://files.beltic.com/9941d601-0dd4-4a33-8043-4f158b480f0e/file?X-Amz-Signature=..."
        },
        "processing_errors": [
          {
            "status": "<string>",
            "code": "<string>",
            "title": "<string>",
            "detail": "<string>",
            "meta": {
              "occurred_at": "<string>"
            }
          }
        ],
        "created_at": "<string>",
        "submitted_at": "<string>",
        "processed_at": "<string>",
        "redacted_at": "<string>",
        "extracted_data": {},
        "fraud_result": {
          "score": "NORMAL",
          "file_metadata": {
            "producer": null,
            "creator": null,
            "creation_date": null,
            "mod_date": null,
            "author": null,
            "title": null,
            "keywords": null,
            "subject": null
          },
          "indicators": [
            {
              "id": "<string>",
              "type": "RISK",
              "category": "<string>",
              "title": "<string>",
              "description": "<string>",
              "origin": "FRAUD"
            }
          ],
          "document_classification": {
            "id": "<string>",
            "type": "<string>",
            "document_class_type": "<string>",
            "detailed_type": "<string>"
          }
        }
      },
      "relationships": {
        "document_template": {
          "data": {
            "type": "document-template",
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      },
      "meta": {
        "extraction_config": {
          "enabled": true,
          "schema": {
            "type": "object",
            "properties": {},
            "required": [
              "<string>"
            ],
            "additionalProperties": true
          },
          "extraction_rules": ""
        },
        "fraud_config": {
          "enabled": true
        },
        "file_url": "<string>"
      }
    }
  ],
  "meta": {
    "page": {
      "cursors": {
        "start": "<string>",
        "end": "<string>"
      },
      "hasNextPage": true,
      "hasPreviousPage": true,
      "total": 123
    }
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>"
  }
}

Query Parameters

​
page[size]
string

Number of items per page (default: 15)

Example:

"15"

​
page[after]
string

Cursor for fetching items after this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

​
page[before]
string

Cursor for fetching items before this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

​
page[total]
enum<string>

Include total count in response (may impact performance)

Available options:
true,
false
Example:

"true"

​
filter[status]
string

Filter documents by status. Supports single value or comma-separated values (e.g., "pending,submitted,processing,processed,failed,redacted")

Example:

"pending,submitted,processing,processed,failed,redacted"

​
filter[template_id]
string<uuid>

Filter documents by template ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Documents retrieved successfully

​
data
object[]
required
​
meta
object
required
​
links
object
required