Skip to main content
GET
/
v1
/
documents
/
{id}
Get document
curl --request GET \
  --url https://api.beltic.com/v1/documents/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "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>"
        }
      },
      "extracted_data_coordinates": {
        "version": 1,
        "fields": {
          "partners[0]": [
            {
              "surface": {
                "type": "page",
                "number": 2
              },
              "coordinate_space": "normalized_page",
              "bbox": {
                "left": 0.177,
                "top": 0.783,
                "width": 0.672,
                "height": 0.016
              },
              "polygon": [
                {
                  "x": 0.177,
                  "y": 0.783
                },
                {
                  "x": 0.848,
                  "y": 0.783
                },
                {
                  "x": 0.848,
                  "y": 0.799
                },
                {
                  "x": 0.177,
                  "y": 0.799
                }
              ]
            }
          ]
        }
      },
      "fraud_result_coordinates": {
        "version": 1,
        "indicators": {
          "grp_overlaps": [
            {
              "surface": {
                "type": "page",
                "number": 1
              },
              "coordinate_space": "normalized_page",
              "bbox": {
                "left": 0.471,
                "top": 0.601,
                "width": 0.397,
                "height": 0.27
              },
              "polygon": null,
              "detail": {
                "original_text": "ParsedImage",
                "new_text": ""
              }
            }
          ]
        }
      }
    },
    "relationships": {
      "document_template": {
        "data": {
          "type": "document-template",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "session": {
        "data": {
          "type": "session",
          "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,
        "requires_digital_signature": true
      },
      "file_url": "<string>",
      "ocr_external_id": "<string>",
      "fraud_check_external_id": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.beltic.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Api-Key
string
header
required

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

Path Parameters

id
string<uuid>
required

Document ID

Response

Document found successfully

data
object
required