Submit a document

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "created_at": "<string>",
  "status": "processing",
  "decision": "clear",
  "risk_level": "LOW",
  "risk_score": 50,
  "thresholds": {
    "pending_below": 50,
    "suspicious_below": 50,
    "fraudulent_below": 50
  },
  "summary": "<string>",
  "flags": [
    {
      "code": "ai_generated_metadata",
      "category": "<string>",
      "severity": "low",
      "title": "<string>",
      "description": "<string>",
      "pages": [
        123
      ],
      "reasons": [
        {
          "code": "<string>",
          "summary": "<string>",
          "pages": [
            123
          ],
          "evidence": {}
        }
      ]
    }
  ],
  "rules": [
    {
      "id": "<string>",
      "title": "<string>",
      "outcome_guidance": "ACCEPTED",
      "score_delta": 123,
      "reasoning": "<string>"
    }
  ],
  "document": {
    "filename": "<string>",
    "mime_type": "<string>",
    "pages": 123,
    "size_bytes": 123,
    "sha256": "<string>",
    "format": "digital_pdf",
    "redacted": true
  },
  "extracted": {
    "doc_type": "<string>",
    "doc_subtype": "<string>",
    "issuer": "<string>",
    "name": "<string>",
    "address": "<string>",
    "document_date": "<string>",
    "account_number": "<string>",
    "currency": "<string>"
  },
  "engine": {
    "version": "<string>",
    "mode": "strict"
  },
  "error": "<string>",
  "webhook_error": "<string>",
  "object": "document_check"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

POST

api

document-checks

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "created_at": "<string>",
  "status": "processing",
  "decision": "clear",
  "risk_level": "LOW",
  "risk_score": 50,
  "thresholds": {
    "pending_below": 50,
    "suspicious_below": 50,
    "fraudulent_below": 50
  },
  "summary": "<string>",
  "flags": [
    {
      "code": "ai_generated_metadata",
      "category": "<string>",
      "severity": "low",
      "title": "<string>",
      "description": "<string>",
      "pages": [
        123
      ],
      "reasons": [
        {
          "code": "<string>",
          "summary": "<string>",
          "pages": [
            123
          ],
          "evidence": {}
        }
      ]
    }
  ],
  "rules": [
    {
      "id": "<string>",
      "title": "<string>",
      "outcome_guidance": "ACCEPTED",
      "score_delta": 123,
      "reasoning": "<string>"
    }
  ],
  "document": {
    "filename": "<string>",
    "mime_type": "<string>",
    "pages": 123,
    "size_bytes": 123,
    "sha256": "<string>",
    "format": "digital_pdf",
    "redacted": true
  },
  "extracted": {
    "doc_type": "<string>",
    "doc_subtype": "<string>",
    "issuer": "<string>",
    "name": "<string>",
    "address": "<string>",
    "document_date": "<string>",
    "account_number": "<string>",
    "currency": "<string>"
  },
  "engine": {
    "version": "<string>",
    "mode": "strict"
  },
  "error": "<string>",
  "webhook_error": "<string>",
  "object": "document_check"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Paste your workspace API key from Settings. Sent as Authorization: Bearer .

Query Parameters

wait

boolean

Block this request for up to 55s while analysis runs. Prefer polling; if analysis takes longer than the budget, the response is still the processing check.

Body

Input validation for POST /v1/document-checks.

Accepts either a multipart file or a JSON url; exactly one is required.

file

string<uri>

url

string<uri>

Maximum string length: 2048

mode

enum<string>

default:normal

strict - strict
normal - normal
lenient - lenient

Available options:

strict,

normal,

lenient

webhook_url

string<uri>

default:""

Maximum string length: 1024

redacted

boolean

default:false

redaction_sidecar

object

Response

The created check.

The document_check object returned by submit, retrieve, list, and webhooks.

string

required

Prefixed id, e.g. dc_9f2c….

created_at

string

required

status

enum<string>

required

processing - processing
completed - completed
failed - failed

Available options:

processing,

completed,

failed

decision

required

Null until the check completes. Reflects a dashboard override when one exists.

clear - clear
pending - pending
suspicious - suspicious
fraudulent - fraudulent

Available options:

clear,

pending,

suspicious,

fraudulent

risk_level

required

LOW - LOW
MEDIUM - MEDIUM
HIGH - HIGH

Available options:

LOW,

MEDIUM,

HIGH

risk_score

integer | null

required

0-100, higher is riskier. Decision bands are set by workspace thresholds (defaults: clear <40, pending <60, suspicious <80, fraudulent ≥80).

Required range: 0 <= x <= 100

thresholds

object

required

The outcome boundaries this check was scored against.

Show child attributes

summary

string | null

required

Why the document was cleared or flagged. Null while processing.

flags

object[]

required

Show child attributes

rules

object[]

required

Workspace rules that fired on this document.

Show child attributes

document

object

required

Show child attributes

extracted

object

required

Content read off the document. Every field is best-effort and may be null.

Show child attributes

engine

object

required

Show child attributes

error

string | null

required

Set only when status is failed.

webhook_error

string | null

required

Set when a webhook was configured but could not be delivered.

object

string

default:document_check

Document Checks

Rules

Authorizations

Query Parameters

Body

Response