Skip to main content
Start screening a customer

Authorizations

Authorization
string
header
required

Send the API key as a Bearer token.

Body

application/json
customer
Customer · object
required
policy
string
required

The screening policy agreed with you, such as basic-onboarding.

Required string length: 1 - 100
request_key
string
required

Your unique key for this request. Retrying with the same key and body returns the same screening.

Required string length: 1 - 200
reference
string | null

Your own record ID, returned unchanged.

Required string length: 1 - 500
test_scenario
enum<string> | null

Test keys only: return a fixed screening without running checks.

Available options:
approve,
review,
deny,
slow,
failed,
unknown_values

Response

The saved screening for a retry

categories
Category · object[]
required
completed_at
string<date-time> | null
required
created_at
string<date-time>
required
decision
RecordedDecision · object | null
required
id
string
required

Opaque identifier of up to 255 characters; do not parse it.

livemode
boolean
required
policy
string
required
recommendation
string | null
required

approve, review or deny once completed; treat unknown values as review.

reference
string | null
required
request_key
string
required
status
string
required

pending, completed or failed; tolerate new values.

summary
string | null
required

Plain text of at most 1,000 characters.

error
ErrorBody · object | null
object
string
default:screening
Allowed value: "screening"