Initiate KYB verification
Generates a hosted KYB link for the organization and returns the current KYB status snapshot.
Authorizations
Basic Auth header with your app ID as the username and your app secret as the password.
Headers
ID of your Privy app.
Path Parameters
The ID of the organization.
Body
Request body for initiating a hosted KYB flow for an organization.
KYC/KYB provider identifier.
bridge Email address for the organization.
Provider environment (production or sandbox).
production, sandbox Legal name of the business.
1 - 256Endorsements to request during KYB.
Endorsement identifier.
256URI to redirect after completing KYB.
Client-side agreement ID for ToS acceptance.
Response
KYB status snapshot including the hosted verification link.
Full KYB status for an organization with a given provider.
KYC/KYB provider identifier.
bridge Provider environment (production or sandbox).
production, sandbox KYC/KYB status for the user.
"approved"
Terms of Service acceptance status for a KYC or KYB flow.
Capability statuses for the customer.
Top-level items still needed (e.g. link a bank account).
Items that will be required in the future.
Verification status detail for a KYC or KYB check.

