Fiat

Initiate KYC verification

Changed on

Generates a hosted KYC link for the user and returns the current KYC status snapshot.

post/v1/users/{user_id}/kyc/links

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/users/{user_id}/kyc/links
  • Auth
    HTTP basic

Path parameters

user_idstring required

The ID of the user.

Headers

privy-app-idstring required

ID of your Privy app.

Request body

provider'bridge' required

KYC/KYB provider identifier.

environment'production' | 'sandbox'

Provider environment (production or sandbox).

emailstring email

Email address for the KYC session.

endorsementsKyxEndorsementName[]

Endorsements to request during KYC.

redirect_uristring uri

URI to redirect the user after completing KYC.

client_agreement_idstring

Client-side agreement ID for ToS acceptance.

Example request

{
  "endorsements": [
    "sepa"
  ]
}

Response

KYC status snapshot including the hosted verification link.

provider'bridge' required

KYC/KYB provider identifier.

environment'production' | 'sandbox' required

Provider environment (production or sandbox).

statusstring required

KYC/KYB status for the user.

requirements_duestring[] required

Top-level items still needed (e.g. link a bank account).

future_requirements_duestring[] required

Items that will be required in the future.

stripe_cardholder_idstring

Stripe Issuing cardholder ID assigned by Bridge for this user.

Example response

{
  "status": "approved",
  "tos": {
    "status": "approved"
  },
  "endorsements": [
    {
      "name": "sepa",
      "status": "approved"
    }
  ],
  "capabilities": {
    "payin_crypto": "active",
    "payout_crypto": "active",
    "payin_fiat": "active",
    "payout_fiat": "active"
  },
  "kyc": {
    "status": "approved"
  }
}

Changes