Document API

Get Document

Retrieve a document by its unique identifier. Returns the complete document record including processing status, extracted data, and fraud detection results.

Document Status Values:

pending: Document created but file not yet uploaded
submitted: File uploaded, queued for processing
processing: Currently being processed
processed: Processing completed successfully
failed: Processing failed (check error details)

Use Cases:

Check document processing status
Retrieve extracted data after processing completes
Access fraud detection analysis results

GET

documents

{id}

Get document

curl --request GET \
  --url https://api.beltic.com/v1/documents/{id}

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

Path Parameters

string<uuid>

required

Document ID

Response

Document found successfully

data

object

required

Show child attributes

Create Document TemplateCreate 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")

⌘I

Get document

curl --request GET \
  --url https://api.beltic.com/v1/documents/{id}

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