Skip to main content
POST
Check a document

Authorizations

Authorization
string
header
required

Your API key: gt_live_… or gt_test_…

Body

application/json
documentKind
enum<string>
required
Available options:
identity,
proof_of_address,
kra_pin
documentFrontBase64
string
required

Base64 JPEG, PNG, WebP or PDF.

documentBackBase64
string

Identity documents only.

expectedName
string
expectedAddress
string

Proof of address only.

expectedDateOfBirth
string

Identity documents only: YYYY-MM-DD.

expectedKraPin
string

KRA PIN certificates only.

maxDocumentAgeDays
number

Proof of address: oldest acceptable issue date, in days (default 90).

externalRef
string

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