Skip to main content
POST
Initiate KYC verification for a user

Authorizations

Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id
string
required

ID of your Privy app.

Path Parameters

user_id
string
required

The ID of the user to initiate KYC for

Body

application/json
provider
enum<string>
required
Available options:
bridge
data
object
required

Response

200 - application/json

KYC verification status

Response for an onramp KYC verification.

user_id
string
required
status
enum<string>
required

Status of the KYC verification process.

Available options:
not_found,
active,
awaiting_questionnaire,
awaiting_ubo,
incomplete,
not_started,
offboarded,
paused,
rejected,
under_review
provider_user_id
string