Update KYC details

Update KYC status for a user

curl --request PATCH \
  --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"
}

PATCH

users

{user_id}

fiat

kyc

Update KYC status for a user

curl --request PATCH \
  --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 update KYC status for

Body

application/json

Option 1
Option 2

provider

enum<string>

required

Available options:

bridge

data

object

required

Show child attributes

data.type

enum<string>

required

Available options:

individual

data.first_name

string

required

Required string length: 1 - 1024

data.last_name

string

required

Required string length: 1 - 1024

data.email

string<email>

required

Required string length: 1 - 1024

data.residential_address

object

required

Show child attributes

data.residential_address.street_line_1

string

required

Minimum string length: 1

data.residential_address.city

string

required

Minimum string length: 1

data.residential_address.subdivision

string

required

Required string length: 1 - 3

data.residential_address.country

string

required

Required string length: 3

data.residential_address.street_line_2

string

Minimum string length: 1

data.residential_address.postal_code

string

Minimum string length: 1

data.birth_date

string

required

Required string length: 10

data.identifying_information

object[]

required

Minimum array length: 1

Show child attributes

data.identifying_information.type

string

required

data.identifying_information.issuing_country

string

required

Required string length: 3

data.identifying_information.number

string

data.identifying_information.description

string

data.identifying_information.expiration

string

data.identifying_information.image_front

string

data.identifying_information.image_back

string

data.ofac_screen

object

Show child attributes

data.ofac_screen.screened_at

string

required

data.ofac_screen.result

enum<string>

required

Available options:

passed

data.kyc_screen

object

Show child attributes

data.kyc_screen.screened_at

string

required

data.kyc_screen.result

enum<string>

required

Available options:

passed

data.signed_agreement_id

string

Required string length: 1 - 1024

data.middle_name

string

Required string length: 1 - 1024

data.transliterated_first_name

string

Required string length: 1 - 256

data.transliterated_middle_name

string

Required string length: 1 - 256

data.transliterated_last_name

string

Required string length: 1 - 256

data.phone

string

Required string length: 2 - 18

data.transliterated_residential_address

object

Show child attributes

data.transliterated_residential_address.street_line_1

string

required

Minimum string length: 1

data.transliterated_residential_address.city

string

required

Minimum string length: 1

data.transliterated_residential_address.subdivision

string

required

Required string length: 1 - 3

data.transliterated_residential_address.country

string

required

Required string length: 3

data.transliterated_residential_address.street_line_2

string

Minimum string length: 1

data.transliterated_residential_address.postal_code

string

Minimum string length: 1

data.endorsements

string[]

data.account_purpose

string

data.account_purpose_other

string

data.employment_status

string

data.expected_monthly_payments_usd

string

data.acting_as_intermediary

string

data.most_recent_occupation

string

data.source_of_funds

string

data.nationality

string

Required string length: 3

data.verified_selfie_at

string

data.completed_customer_safety_check_at

string

data.documents

object[]

Show child attributes

data.documents.purposes

string[]

required

Minimum array length: 1

Minimum string length: 1

data.documents.file

string

required

Minimum string length: 1

data.documents.description

string

Minimum string length: 1

data.has_signed_terms_of_service

boolean

Response

200 - application/json

Updated 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

Get KYC process status Get fiat accounts

⌘I

API reference

Wallets

Account funding

Policies

Condition sets

Transactions

Key quorums

Users

Authorizations

Headers

Path Parameters

Body

Response