Skip to main content
POST
Initiate KYB terms of service

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

organization_id
string
required

The ID of the organization.

Body

application/json

Request body for initiating Terms of Service acceptance for an organization.

provider
enum<string>
required

KYC/KYB provider identifier.

Available options:
bridge
email
string<email>
required

Email address for the organization.

environment
enum<string>

Provider environment (production or sandbox).

Available options:
production,
sandbox
business_name
string

Legal name of the business.

Required string length: 1 - 256

Response

200 - application/json

Terms of service link and current acceptance status.

Response containing a Terms of Service link.

provider
enum<string>
required

KYC/KYB provider identifier.

Available options:
bridge
environment
enum<string>
required

Provider environment (production or sandbox).

Available options:
production,
sandbox
status
string
required

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

Example:

"approved"

URL for the Terms of Service acceptance page.