Skip to main content
POST
/
v1
/
users
/
{user_id}
/
fiat
/
kyc
Initiate KYC verification for a user
curl --request POST \
  --url https://api.privy.io/v1/users/{user_id}/fiat/kyc \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '{
  "provider": "bridge-sandbox",
  "data": {
    "type": "individual",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "+59898222122",
    "residential_address": {
      "street_line_1": "1234 Lombard Street",
      "street_line_2": "Apt 2F",
      "city": "San Francisco",
      "subdivision": "CA",
      "postal_code": "94109",
      "country": "USA"
    },
    "signed_agreement_id": "123",
    "birth_date": "1989-09-09",
    "identifying_information": [
      {
        "type": "ssn",
        "number": "111-11-1111",
        "issuing_country": "USA",
        "image_front": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
        "image_back": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
      }
    ]
  }
}'
{
  "user_id": "cmaftdj280001ww1ihwhy57s3",
  "provider_user_id": "303912cc-74fa-4f7a-9c51-2945b40ac09a",
  "status": "under_review"
}

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
  • Option 1
  • Option 2
​
provider
enum<string>
required
Available options:
bridge
​
data
object
required

Response

200 - application/json

KYC verification status

​
user_id
string
required
​
status
enum<string>
required
Available options:
not_found,
active,
awaiting_questionnaire,
awaiting_ubo,
incomplete,
not_started,
offboarded,
paused,
rejected,
under_review
​
provider_user_id
string
⌘I