Document API

List Document Templates

Retrieve a paginated list of document templates with optional filtering. Useful for browsing available templates and selecting one for document processing.

Pagination:

Control page size with page[size] (default: 15, max: 100)
Navigate using cursor-based pagination with page[after] and page[before]
Include total count with page[total]=true (note: may impact performance)
Use response links for easy navigation between pages

Filtering:

Filter by status to show only ‘published’ templates
Filter by is_active to show only currently active templates

Common Queries:

Active templates: ?filter[is_active]=true
Recent templates: ?page[size]=10 (sorted by creation date)

GET

document-templates

List document templates

curl --request GET \
  --url https://api.beltic.com/v1/document-templates

{
  "data": [
    {
      "type": "document-template",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "attributes": {
        "name": "<string>",
        "extraction_config": {
          "enabled": true,
          "schema": "<unknown>",
          "extraction_rules": "<string>"
        },
        "fraud_config": {
          "enabled": true
        },
        "description": "<string>",
        "status": "published",
        "is_active": true,
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "relationships": {}
    }
  ],
  "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]

enum<string>

Filter templates by status

Available options:

published

Example:

"published"

filter[is_active]

enum<string>

Filter templates by active state (default: true)

Available options:

true,

false

Example:

"true"

Response

Templates retrieved successfully

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

links

object

required

Show child attributes

Get Document TemplateRetrieve a specific document template by its unique identifier. Returns the template configuration. **Response Includes:** - Template metadata (name, description, status) - Complete configuration (JSON schema, extraction config, fraud config) - Status flag (is_active) - Timestamps (created_at, updated_at)

⌘I

List document templates

curl --request GET \
  --url https://api.beltic.com/v1/document-templates

{
  "data": [
    {
      "type": "document-template",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "attributes": {
        "name": "<string>",
        "extraction_config": {
          "enabled": true,
          "schema": "<unknown>",
          "extraction_rules": "<string>"
        },
        "fraud_config": {
          "enabled": true
        },
        "description": "<string>",
        "status": "published",
        "is_active": true,
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "relationships": {}
    }
  ],
  "meta": {
    "page": {
      "cursors": {
        "start": "<string>",
        "end": "<string>"
      },
      "hasNextPage": true,
      "hasPreviousPage": true,
      "total": 123
    }
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>"
  }
}