Skip to main content
GET
List detections

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

submitted_by
string | null
batch_id
string | null
ungrouped
boolean
default:false
limit
integer
default:100
Required range: 1 <= x <= 2001
offset
integer
default:0
Required range: x >= 0

Response

One page of detections, newest first.

id
string
required
status
enum<string>
required

QUEUED, RUNNING, COMPLETED, or FAILED.

Available options:
QUEUED,
RUNNING,
COMPLETED,
FAILED
score
integer | null
required

The fraud score, normally 0 to 100. A higher score means a higher likelihood of fraud, but does not guarantee fraud. Humans should always review high-risk cases. Null while the detection runs, and null when one check determined the document verification result alone.

billable
boolean
required
created_at
string<date-time>
required
completed_at
string<date-time> | null
required
submitted_by
string | null
required
batch_id
string | null
required

The batch that holds this detection, if one exists.

filename
string | null
required
content_type
string | null
required
size_bytes
integer | null
required
s3_key
string | null
required

Where the API keeps the document.

failure_message
string | null
required

A sentence that explains failure_code.

failure_code
string | null

The reason for a FAILED status. Null in all other states.