Skip to main content
POST

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Body

application/json
idempotency_key
string
required

Required (the screening charges a fee). Also accepted as the Idempotency-Key header.

customer
object

Identity data. Provide person or company; when omitted it is filled from the account profile. Additional fields are accepted and forwarded to the screening engine.

monitor
boolean
default:false

Enable continuous monitoring from the start.

Response

Screening submitted and stored locally.

Local mirror of the screening plus billing fields. The full result is in result.

screening_id
string
kind
enum<string>
Available options:
screening
service
enum<string>
Available options:
compliance_person,
compliance_company
subject_type
enum<string>
Available options:
person,
company
subject_name
string
risk
string
monitor
boolean
screening_fee
string
fee_asset
string
idempotency_key
string
idempotency_hit
boolean
created_at
string<date-time>
result
object

Provider-neutral screening outcome from the compliance service.

Last modified on July 19, 2026