Skip to main content
POST
Run a KYC identity check

Authorizations

Authorization
string
header
required

Your API key: gt_live_… or gt_test_…

Body

application/json
documentFrontBase64
string
required

Base64 JPEG or PNG of the ID front.

livenessFramesBase64
string
required

Base64 liveness capture.

livenessMediaType
enum<string>
required
Available options:
jpeg_frames,
mp4,
webm
idNumber
string
required
Maximum string length: 200
firstName
string
required
Maximum string length: 200
lastName
string
required
Maximum string length: 200
dateOfBirth
string
required

YYYY-MM-DD.

Maximum string length: 200
gender
string
required
Maximum string length: 200
documentBackBase64
string

Base64 of the back (ID cards and licences).

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).