Skip to main content
POST
Run a screening for a client

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Body

application/json

Run a screening for one client against the requested lists.

clientId
string<uuid>
required
lists
(string | object)[]
required
Minimum array length: 1
Minimum string length: 1

Response

200 - application/json

OK

id
string<uuid>
required
clientId
string<uuid>
required
checkedBy
string
required
Minimum string length: 1
results
object
required
createdAt
string<date-time>
required