Create document template

curl --request POST \
  --url https://api.beltic.com/v1/document-templates \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --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,
        "requires_digital_signature": 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,
        "requires_digital_signature": true
      },
      "description": "<string>",
      "status": "published",
      "is_active": true,
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "relationships": {}
  }
}

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. Set requires_digital_signature: true when documents processed with this template must contain a signature; if no signature is detected, the fraud result includes a missing-signature RISK indicator.
Validation Fields: Date checks should be represented as boolean fields with beltic:validation

Validation Field Pattern:

Keep the source date field as type: ["string", "null"] with "custom:type": "date"
Add a sibling boolean field with "beltic:validation"
Use field_ref to reference the source date field in the same object scope
Works in top-level objects, nested objects, and array item objects

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' \
  --header 'X-Api-Key: <api-key>' \
  --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,
        "requires_digital_signature": 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,
        "requires_digital_signature": true
      },
      "description": "<string>",
      "status": "published",
      "is_active": true,
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "relationships": {}
  }
}

Authorizations

X-Api-Key

string

header

required

API key for authentication. Access https://console.beltic.com/ to obtain your API key.

Body

application/json

data

object

required

Show child attributes

Response

Template created successfully

data

object

required

Show child attributes

Get Document

List Document Templates

⌘I