Skip to main content
POST
Create KYC inquiry

Headers

api-key
string
required
Example:

"secret_live_xxx"

Body

application/json
subject_id
string
required

Your stable identifier for the subject being verified.

Example:

"user_123"

return_url
string<uri>
required

URL where the user is redirected after the hosted IDV flow completes.

level
enum<integer>

Preset: 1 = document + selfie, 2 = + address, 3 = + PEP/AML/adverse media. Mutually exclusive with features.

Available options:
1,
2,
3
features
object

Feature map (doc_scan, selfie_scan, etc.). Mutually exclusive with level.

metadata
object

Response

200 - application/json

Inquiry created.

id
string
Example:

"kyc_iq_xxx"

subject_id
string
features
object
return_url
string
metadata
object | null
expires_at
string<date-time>
level
enum<integer> | null
Available options:
1,
2,
3
created_by
string
created_at
string<date-time>
updated_at
string<date-time>
deleted_at
string<date-time> | null