Skip to main content
POST
Screen a person or business

Authorizations

Authorization
string
header
required

Your API key: gt_live_… or gt_test_…

Body

application/json
subjectName
string
required
Maximum string length: 200
entityType
enum<string>
required
Available options:
individual,
entity
country
string

ISO code or name.

aliases
string[]

Other names.

dateOfBirth
string

Individuals only: YYYY, YYYY-MM or YYYY-MM-DD.

nationality
string

Individuals only.

idNumber
string

Individuals only: national ID or passport number.

registrationNumber
string

Entities only.

jurisdiction
string

Entities only: country of incorporation.

monitor
boolean

Re-screen this subject daily and alert on new hits (live keys).

externalRef
string

With monitor: your customer id.

Maximum string length: 100

Response

The check was accepted. Live keys start queued; test keys finish at once.

id
string
required
Example:

"ver_3f9a1c0b7d2e4a51c8e0f6a29b4d7c13"

type
enum<string>
required
Available options:
idp,
aml,
document,
kyb
status
enum<string>
required
Available options:
queued,
completed
verdict
string

Test keys only.

Allowed value: "pass"
sandbox
boolean

Test keys only.

monitoringId
string | null

AML only, when monitor: true was sent: the monitored subject's id (null with a test key).