Skip to main content
POST
Initiate KYC 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

user_id
string
required

The ID of the user.

Body

application/json

Request body for initiating Terms of Service acceptance.

provider
enum<string>
required

KYC/KYB provider identifier.

Available options:
bridge
environment
enum<string>

Provider environment (production or sandbox).

Available options:
production,
sandbox
email
string<email>

Email for the user. If not provided, falls back to the user's linked email.

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.