Skip to main content
GET
Get a KYC session
Reads a session back with its current status. A session you started and never finished disappears 10 minutes after its last code, and a finished one stays for 30 days. Another business’s session reads as 404.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Response

status
enum<string>
required
Available options:
OTP_SENT,
VERIFIED,
IN_REVIEW,
DECLINED
Example:

"OTP_SENT"

sessionId
string

Absent when this person was already verified for you, since no new session was needed.

Example:

"kys_9fa17c2e4b6d8a0c1e3f5a7b"

customerId
string

What to send on orders for this person. Present on VERIFIED and IN_REVIEW. Orders are refused until the status is VERIFIED.

Example:

"cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790"

externalUserId
string
Example:

"acme-user-123"

tier
number

The verification tier reached. Present on VERIFIED.

Example:

1

declineCode
enum<string>

Why, in general terms. Present on DECLINED.

Available options:
ID_NOT_VERIFIED,
ATTEMPTS_EXCEEDED,
ALREADY_LINKED
expiresAt
string<date-time>

When the code stops working. Present on OTP_SENT.