Skip to main content
GET
Get KYC status 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 get KYC status for

Query Parameters

provider
enum<string>
required

Valid set of onramp providers

Available options:
bridge,
bridge-sandbox
Example:

"bridge"

Response

200 - application/json

KYC verification status

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