Fiat

Initiate KYC terms of service

Changed on

Generates a Bridge terms-of-service acceptance link for the user.

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

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/users/{user_id}/kyc/tos
  • 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 for the user. If not provided, falls back to the user's linked email.

Response

Terms of service link and current acceptance status.

provider'bridge' required

KYC/KYB provider identifier.

environment'production' | 'sandbox' required

Provider environment (production or sandbox).

statusstring required

Status of Terms of Service acceptance. Passthrough from the provider.

linkstring uri required

URL for the Terms of Service acceptance page.

Example response

{
  "status": "approved"
}

Changes