Document API

Create Document Template

Create a new document template to standardize document processing workflows. Templates define reusable configurations including extraction schemas and fraud detection rules.

Template Components:

Schema: Defines the expected structure of extracted data
Fraud Config: Pipeline configuration for fraud detection

Best Practices:

Use descriptive names and detailed descriptions for team clarity
Test with sample documents before using in production
Keep templates focused on specific document types (e.g., “Passport”, “Driver License”)

POST

document-templates

Create document template

curl --request POST \
  --url https://api.beltic.com/v1/document-templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "document-template",
    "attributes": {
      "name": "Passport Document",
      "extraction_config": {
        "enabled": true,
        "schema": {
          "type": "object",
          "properties": {},
          "required": [
            "<string>"
          ],
          "additionalProperties": true
        },
        "extraction_rules": ""
      },
      "fraud_config": {
        "enabled": true
      },
      "description": "Template for processing passport documents"
    }
  }
}
'

{
  "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": {}
  }
}

Body

application/json

data

object

required

Show child attributes

Response

Template created successfully

data

object

required

Show child attributes

List Document TemplatesRetrieve 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)

⌘I

Create document template

curl --request POST \
  --url https://api.beltic.com/v1/document-templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "document-template",
    "attributes": {
      "name": "Passport Document",
      "extraction_config": {
        "enabled": true,
        "schema": {
          "type": "object",
          "properties": {},
          "required": [
            "<string>"
          ],
          "additionalProperties": true
        },
        "extraction_rules": ""
      },
      "fraud_config": {
        "enabled": true
      },
      "description": "Template for processing passport documents"
    }
  }
}
'

{
  "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": {}
  }
}