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>"
}
}Get a document check
Fetch a check by id. Poll this until status is completed or failed.
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>"
}
}Authorizations
Paste your workspace API key from Settings. Sent as Authorization: Bearer .
Path Parameters
The document check id, e.g. dc_9f2c4b1e8a7d4c3fb2e1d0a9c8b7a6f5.
Response
The check.
The document_check object returned by submit, retrieve, list, and webhooks.
Prefixed id, e.g. dc_9f2c….
processing- processingcompleted- completedfailed- failed
processing, completed, failed Null until the check completes. Reflects a dashboard override when one exists.
clear- clearpending- pendingsuspicious- suspiciousfraudulent- fraudulent
clear, pending, suspicious, fraudulent LOW- LOWMEDIUM- MEDIUMHIGH- HIGH
LOW, MEDIUM, HIGH 0-100, higher is riskier. Decision bands are set by workspace thresholds (defaults: clear <40, pending <60, suspicious <80, fraudulent ≥80).
0 <= x <= 100The outcome boundaries this check was scored against.
Show child attributes
Show child attributes
Why the document was cleared or flagged. Null while processing.
Show child attributes
Show child attributes
Workspace rules that fired on this document.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Content read off the document. Every field is best-effort and may be null.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Set only when status is failed.
Set when a webhook was configured but could not be delivered.