Skip to main content
POST
Error

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

Response

The created 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: clear 0-39, pending 40-59, suspicious 60-79, fraudulent 80-100.

Required range: 0 <= x <= 100
action
required

Workflow routing from workspace thresholds. Not a verdict.

  • approve - approve
  • review - review
  • reject - reject
Available options:
approve,
review,
reject
thresholds
object
required

The cut lines 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