Fiat

Initiate KYB terms of service

Changed on

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

post/v1/organizations/{organization_id}/kyb/tos

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/organizations/{organization_id}/kyb/tos
  • Auth
    HTTP basic

Path parameters

organization_idstring required

The ID of the organization.

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 required

Email address for the organization.

business_namestring

Legal name of the business.

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