Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The document check id, e.g. dc_9f2c4b1e8a7d4c3fb2e1d0a9c8b7a6f5.

Response

The check.

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

id
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.

summary
string | null
required
flags
object[]
required
rules
object[]
required

Workspace rules that fired on this document.

document
object
required
extracted
object
required

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

engine
object
required
error
string | null
required

Set only when status is failed.

object
string
default:document_check