Skip to main content
GET
Get a check and its result

Authorizations

Authorization
string
header
required

Your API key: gt_live_… or gt_test_…

Path Parameters

id
string
required

The check's id, for example ver_3f9a1c0b7d2e4a51….

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

The check.

id
string
required
type
enum<string>
required
Available options:
idp,
kyb,
aml,
liveness,
kyi,
document
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed
verdict
enum<string> | null
required

pass, review (a person needs to look) or reject; null until the check completes.

Available options:
pass,
review,
reject,
null
confidence
number | null
required

1 for pass, 0 for reject, null for review.

createdAt
number
required

Unix time in milliseconds.

completedAt
number | null
required
failureReason
string | null
required
sandbox
boolean
required
screening
object

Completed AML checks only.

document
object

Completed document checks only.

kyb
object

Completed KYB checks only.