Submit KYB data
curl --request POST \
--url https://api.privy.io/v1/organizations/{organization_id}/kyb/submit \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'privy-app-id: <privy-app-id>' \
--data '
{
"provider": "bridge",
"data": {
"business_legal_name": "<string>",
"business_trade_name": "<string>",
"transliterated_business_legal_name": "<string>",
"transliterated_business_trade_name": "<string>",
"business_description": "<string>",
"business_type": "llc",
"business_industry": [
"<string>"
],
"email": "[email protected]",
"phone": "<string>",
"incorporation_date": "<string>",
"is_dao": true,
"primary_website": "<string>",
"other_websites": [
"<string>"
],
"ownership_threshold": 15,
"has_material_intermediary_ownership": true,
"publicly_traded_listings": [
{
"market_identifier_code": "<string>",
"stock_number": "<string>",
"ticker": "<string>"
}
],
"associated_persons": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"date_of_birth": "<string>",
"residential_address": {
"street_line_1": "<string>",
"city": "<string>",
"country": "<string>",
"street_line_2": "<string>",
"subdivision": "<string>",
"postal_code": "<string>"
},
"identifying_information": [
{
"type": "<string>",
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"has_ownership": true,
"has_control": true,
"is_signer": true,
"middle_name": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"phone": "<string>",
"is_director": true,
"title": "<string>",
"ownership_percentage": 50,
"nationalities": [
"<string>"
],
"relationship_established_at": "<string>",
"documents": [
{
"purposes": [
"proof_of_address"
],
"file": "<string>",
"description": "<string>"
}
]
}
],
"estimated_annual_revenue_usd": "1000000_9999999",
"expected_monthly_payments_usd": 1,
"source_of_funds": "sales_of_goods_and_services",
"source_of_funds_description": "<string>",
"account_purpose": "treasury_management",
"account_purpose_other": "<string>",
"acting_as_intermediary": true,
"operates_in_prohibited_countries": true,
"high_risk_activities": [
"none_of_the_above"
],
"high_risk_activities_explanation": "<string>",
"conducts_money_services": true,
"conducts_money_services_using_bridge": true,
"conducts_money_services_description": "<string>",
"compliance_screening_explanation": "<string>",
"has_foreign_tax_registration": true,
"identifying_information": [
{
"type": "<string>",
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"documents": [
{
"purposes": [
"business_formation"
],
"file": "<string>",
"description": "<string>"
}
]
},
"endorsements": [
"sepa"
],
"client_agreement_id": "<string>"
}
'HttpResponse<String> response = Unirest.post("https://api.privy.io/v1/organizations/{organization_id}/kyb/submit")
.header("privy-app-id", "<privy-app-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"bridge\",\n \"data\": {\n \"business_legal_name\": \"<string>\",\n \"business_trade_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\",\n \"transliterated_business_trade_name\": \"<string>\",\n \"business_description\": \"<string>\",\n \"business_type\": \"llc\",\n \"business_industry\": [\n \"<string>\"\n ],\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"incorporation_date\": \"<string>\",\n \"is_dao\": true,\n \"primary_website\": \"<string>\",\n \"other_websites\": [\n \"<string>\"\n ],\n \"ownership_threshold\": 15,\n \"has_material_intermediary_ownership\": true,\n \"publicly_traded_listings\": [\n {\n \"market_identifier_code\": \"<string>\",\n \"stock_number\": \"<string>\",\n \"ticker\": \"<string>\"\n }\n ],\n \"associated_persons\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"date_of_birth\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street_line_2\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"has_ownership\": true,\n \"has_control\": true,\n \"is_signer\": true,\n \"middle_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"is_director\": true,\n \"title\": \"<string>\",\n \"ownership_percentage\": 50,\n \"nationalities\": [\n \"<string>\"\n ],\n \"relationship_established_at\": \"<string>\",\n \"documents\": [\n {\n \"purposes\": [\n \"proof_of_address\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"estimated_annual_revenue_usd\": \"1000000_9999999\",\n \"expected_monthly_payments_usd\": 1,\n \"source_of_funds\": \"sales_of_goods_and_services\",\n \"source_of_funds_description\": \"<string>\",\n \"account_purpose\": \"treasury_management\",\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"operates_in_prohibited_countries\": true,\n \"high_risk_activities\": [\n \"none_of_the_above\"\n ],\n \"high_risk_activities_explanation\": \"<string>\",\n \"conducts_money_services\": true,\n \"conducts_money_services_using_bridge\": true,\n \"conducts_money_services_description\": \"<string>\",\n \"compliance_screening_explanation\": \"<string>\",\n \"has_foreign_tax_registration\": true,\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [\n \"business_formation\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"endorsements\": [\n \"sepa\"\n ],\n \"client_agreement_id\": \"<string>\"\n}")
.asString();const options = {
method: 'POST',
headers: {
'privy-app-id': '<privy-app-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
provider: 'bridge',
data: {
business_legal_name: '<string>',
business_trade_name: '<string>',
transliterated_business_legal_name: '<string>',
transliterated_business_trade_name: '<string>',
business_description: '<string>',
business_type: 'llc',
business_industry: ['<string>'],
email: '[email protected]',
phone: '<string>',
incorporation_date: '<string>',
is_dao: true,
primary_website: '<string>',
other_websites: ['<string>'],
ownership_threshold: 15,
has_material_intermediary_ownership: true,
publicly_traded_listings: [
{
market_identifier_code: '<string>',
stock_number: '<string>',
ticker: '<string>'
}
],
associated_persons: [
{
first_name: '<string>',
last_name: '<string>',
email: '[email protected]',
date_of_birth: '<string>',
residential_address: {
street_line_1: '<string>',
city: '<string>',
country: '<string>',
street_line_2: '<string>',
subdivision: '<string>',
postal_code: '<string>'
},
identifying_information: [
{
type: '<string>',
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
has_ownership: true,
has_control: true,
is_signer: true,
middle_name: '<string>',
transliterated_first_name: '<string>',
transliterated_middle_name: '<string>',
transliterated_last_name: '<string>',
phone: '<string>',
is_director: true,
title: '<string>',
ownership_percentage: 50,
nationalities: ['<string>'],
relationship_established_at: '<string>',
documents: [{purposes: ['proof_of_address'], file: '<string>', description: '<string>'}]
}
],
estimated_annual_revenue_usd: '1000000_9999999',
expected_monthly_payments_usd: 1,
source_of_funds: 'sales_of_goods_and_services',
source_of_funds_description: '<string>',
account_purpose: 'treasury_management',
account_purpose_other: '<string>',
acting_as_intermediary: true,
operates_in_prohibited_countries: true,
high_risk_activities: ['none_of_the_above'],
high_risk_activities_explanation: '<string>',
conducts_money_services: true,
conducts_money_services_using_bridge: true,
conducts_money_services_description: '<string>',
compliance_screening_explanation: '<string>',
has_foreign_tax_registration: true,
identifying_information: [
{
type: '<string>',
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
documents: [{purposes: ['business_formation'], file: '<string>', description: '<string>'}]
},
endorsements: ['sepa'],
client_agreement_id: '<string>'
})
};
fetch('https://api.privy.io/v1/organizations/{organization_id}/kyb/submit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.privy.io/v1/organizations/{organization_id}/kyb/submit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => 'bridge',
'data' => [
'business_legal_name' => '<string>',
'business_trade_name' => '<string>',
'transliterated_business_legal_name' => '<string>',
'transliterated_business_trade_name' => '<string>',
'business_description' => '<string>',
'business_type' => 'llc',
'business_industry' => [
'<string>'
],
'email' => '[email protected]',
'phone' => '<string>',
'incorporation_date' => '<string>',
'is_dao' => true,
'primary_website' => '<string>',
'other_websites' => [
'<string>'
],
'ownership_threshold' => 15,
'has_material_intermediary_ownership' => true,
'publicly_traded_listings' => [
[
'market_identifier_code' => '<string>',
'stock_number' => '<string>',
'ticker' => '<string>'
]
],
'associated_persons' => [
[
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '[email protected]',
'date_of_birth' => '<string>',
'residential_address' => [
'street_line_1' => '<string>',
'city' => '<string>',
'country' => '<string>',
'street_line_2' => '<string>',
'subdivision' => '<string>',
'postal_code' => '<string>'
],
'identifying_information' => [
[
'type' => '<string>',
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'has_ownership' => true,
'has_control' => true,
'is_signer' => true,
'middle_name' => '<string>',
'transliterated_first_name' => '<string>',
'transliterated_middle_name' => '<string>',
'transliterated_last_name' => '<string>',
'phone' => '<string>',
'is_director' => true,
'title' => '<string>',
'ownership_percentage' => 50,
'nationalities' => [
'<string>'
],
'relationship_established_at' => '<string>',
'documents' => [
[
'purposes' => [
'proof_of_address'
],
'file' => '<string>',
'description' => '<string>'
]
]
]
],
'estimated_annual_revenue_usd' => '1000000_9999999',
'expected_monthly_payments_usd' => 1,
'source_of_funds' => 'sales_of_goods_and_services',
'source_of_funds_description' => '<string>',
'account_purpose' => 'treasury_management',
'account_purpose_other' => '<string>',
'acting_as_intermediary' => true,
'operates_in_prohibited_countries' => true,
'high_risk_activities' => [
'none_of_the_above'
],
'high_risk_activities_explanation' => '<string>',
'conducts_money_services' => true,
'conducts_money_services_using_bridge' => true,
'conducts_money_services_description' => '<string>',
'compliance_screening_explanation' => '<string>',
'has_foreign_tax_registration' => true,
'identifying_information' => [
[
'type' => '<string>',
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'documents' => [
[
'purposes' => [
'business_formation'
],
'file' => '<string>',
'description' => '<string>'
]
]
],
'endorsements' => [
'sepa'
],
'client_agreement_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"privy-app-id: <privy-app-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.privy.io/v1/organizations/{organization_id}/kyb/submit"
payload := strings.NewReader("{\n \"provider\": \"bridge\",\n \"data\": {\n \"business_legal_name\": \"<string>\",\n \"business_trade_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\",\n \"transliterated_business_trade_name\": \"<string>\",\n \"business_description\": \"<string>\",\n \"business_type\": \"llc\",\n \"business_industry\": [\n \"<string>\"\n ],\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"incorporation_date\": \"<string>\",\n \"is_dao\": true,\n \"primary_website\": \"<string>\",\n \"other_websites\": [\n \"<string>\"\n ],\n \"ownership_threshold\": 15,\n \"has_material_intermediary_ownership\": true,\n \"publicly_traded_listings\": [\n {\n \"market_identifier_code\": \"<string>\",\n \"stock_number\": \"<string>\",\n \"ticker\": \"<string>\"\n }\n ],\n \"associated_persons\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"date_of_birth\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street_line_2\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"has_ownership\": true,\n \"has_control\": true,\n \"is_signer\": true,\n \"middle_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"is_director\": true,\n \"title\": \"<string>\",\n \"ownership_percentage\": 50,\n \"nationalities\": [\n \"<string>\"\n ],\n \"relationship_established_at\": \"<string>\",\n \"documents\": [\n {\n \"purposes\": [\n \"proof_of_address\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"estimated_annual_revenue_usd\": \"1000000_9999999\",\n \"expected_monthly_payments_usd\": 1,\n \"source_of_funds\": \"sales_of_goods_and_services\",\n \"source_of_funds_description\": \"<string>\",\n \"account_purpose\": \"treasury_management\",\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"operates_in_prohibited_countries\": true,\n \"high_risk_activities\": [\n \"none_of_the_above\"\n ],\n \"high_risk_activities_explanation\": \"<string>\",\n \"conducts_money_services\": true,\n \"conducts_money_services_using_bridge\": true,\n \"conducts_money_services_description\": \"<string>\",\n \"compliance_screening_explanation\": \"<string>\",\n \"has_foreign_tax_registration\": true,\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [\n \"business_formation\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"endorsements\": [\n \"sepa\"\n ],\n \"client_agreement_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("privy-app-id", "<privy-app-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"provider": "bridge",
"environment": "production",
"status": "approved",
"tos": {
"status": "approved",
"link": "<string>"
},
"endorsements": [
{
"name": "sepa",
"status": "approved",
"missing": [
"<string>"
]
}
],
"capabilities": {
"payin_crypto": "active",
"payout_crypto": "active",
"payin_fiat": "active",
"payout_fiat": "active"
},
"requirements_due": [
"<string>"
],
"future_requirements_due": [
"<string>"
],
"kyb": {
"status": "approved",
"link": "<string>",
"rejection_reasons": [
"<string>"
]
}
}KYB
Submit KYB data
Submits KYB verification data for the organization. Safe to call more than once: the first call creates the provider customer and later calls update it, so a partial submission can be completed incrementally.
POST
/
v1
/
organizations
/
{organization_id}
/
kyb
/
submit
Submit KYB data
curl --request POST \
--url https://api.privy.io/v1/organizations/{organization_id}/kyb/submit \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'privy-app-id: <privy-app-id>' \
--data '
{
"provider": "bridge",
"data": {
"business_legal_name": "<string>",
"business_trade_name": "<string>",
"transliterated_business_legal_name": "<string>",
"transliterated_business_trade_name": "<string>",
"business_description": "<string>",
"business_type": "llc",
"business_industry": [
"<string>"
],
"email": "[email protected]",
"phone": "<string>",
"incorporation_date": "<string>",
"is_dao": true,
"primary_website": "<string>",
"other_websites": [
"<string>"
],
"ownership_threshold": 15,
"has_material_intermediary_ownership": true,
"publicly_traded_listings": [
{
"market_identifier_code": "<string>",
"stock_number": "<string>",
"ticker": "<string>"
}
],
"associated_persons": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"date_of_birth": "<string>",
"residential_address": {
"street_line_1": "<string>",
"city": "<string>",
"country": "<string>",
"street_line_2": "<string>",
"subdivision": "<string>",
"postal_code": "<string>"
},
"identifying_information": [
{
"type": "<string>",
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"has_ownership": true,
"has_control": true,
"is_signer": true,
"middle_name": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"phone": "<string>",
"is_director": true,
"title": "<string>",
"ownership_percentage": 50,
"nationalities": [
"<string>"
],
"relationship_established_at": "<string>",
"documents": [
{
"purposes": [
"proof_of_address"
],
"file": "<string>",
"description": "<string>"
}
]
}
],
"estimated_annual_revenue_usd": "1000000_9999999",
"expected_monthly_payments_usd": 1,
"source_of_funds": "sales_of_goods_and_services",
"source_of_funds_description": "<string>",
"account_purpose": "treasury_management",
"account_purpose_other": "<string>",
"acting_as_intermediary": true,
"operates_in_prohibited_countries": true,
"high_risk_activities": [
"none_of_the_above"
],
"high_risk_activities_explanation": "<string>",
"conducts_money_services": true,
"conducts_money_services_using_bridge": true,
"conducts_money_services_description": "<string>",
"compliance_screening_explanation": "<string>",
"has_foreign_tax_registration": true,
"identifying_information": [
{
"type": "<string>",
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"documents": [
{
"purposes": [
"business_formation"
],
"file": "<string>",
"description": "<string>"
}
]
},
"endorsements": [
"sepa"
],
"client_agreement_id": "<string>"
}
'HttpResponse<String> response = Unirest.post("https://api.privy.io/v1/organizations/{organization_id}/kyb/submit")
.header("privy-app-id", "<privy-app-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"bridge\",\n \"data\": {\n \"business_legal_name\": \"<string>\",\n \"business_trade_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\",\n \"transliterated_business_trade_name\": \"<string>\",\n \"business_description\": \"<string>\",\n \"business_type\": \"llc\",\n \"business_industry\": [\n \"<string>\"\n ],\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"incorporation_date\": \"<string>\",\n \"is_dao\": true,\n \"primary_website\": \"<string>\",\n \"other_websites\": [\n \"<string>\"\n ],\n \"ownership_threshold\": 15,\n \"has_material_intermediary_ownership\": true,\n \"publicly_traded_listings\": [\n {\n \"market_identifier_code\": \"<string>\",\n \"stock_number\": \"<string>\",\n \"ticker\": \"<string>\"\n }\n ],\n \"associated_persons\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"date_of_birth\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street_line_2\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"has_ownership\": true,\n \"has_control\": true,\n \"is_signer\": true,\n \"middle_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"is_director\": true,\n \"title\": \"<string>\",\n \"ownership_percentage\": 50,\n \"nationalities\": [\n \"<string>\"\n ],\n \"relationship_established_at\": \"<string>\",\n \"documents\": [\n {\n \"purposes\": [\n \"proof_of_address\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"estimated_annual_revenue_usd\": \"1000000_9999999\",\n \"expected_monthly_payments_usd\": 1,\n \"source_of_funds\": \"sales_of_goods_and_services\",\n \"source_of_funds_description\": \"<string>\",\n \"account_purpose\": \"treasury_management\",\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"operates_in_prohibited_countries\": true,\n \"high_risk_activities\": [\n \"none_of_the_above\"\n ],\n \"high_risk_activities_explanation\": \"<string>\",\n \"conducts_money_services\": true,\n \"conducts_money_services_using_bridge\": true,\n \"conducts_money_services_description\": \"<string>\",\n \"compliance_screening_explanation\": \"<string>\",\n \"has_foreign_tax_registration\": true,\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [\n \"business_formation\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"endorsements\": [\n \"sepa\"\n ],\n \"client_agreement_id\": \"<string>\"\n}")
.asString();const options = {
method: 'POST',
headers: {
'privy-app-id': '<privy-app-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
provider: 'bridge',
data: {
business_legal_name: '<string>',
business_trade_name: '<string>',
transliterated_business_legal_name: '<string>',
transliterated_business_trade_name: '<string>',
business_description: '<string>',
business_type: 'llc',
business_industry: ['<string>'],
email: '[email protected]',
phone: '<string>',
incorporation_date: '<string>',
is_dao: true,
primary_website: '<string>',
other_websites: ['<string>'],
ownership_threshold: 15,
has_material_intermediary_ownership: true,
publicly_traded_listings: [
{
market_identifier_code: '<string>',
stock_number: '<string>',
ticker: '<string>'
}
],
associated_persons: [
{
first_name: '<string>',
last_name: '<string>',
email: '[email protected]',
date_of_birth: '<string>',
residential_address: {
street_line_1: '<string>',
city: '<string>',
country: '<string>',
street_line_2: '<string>',
subdivision: '<string>',
postal_code: '<string>'
},
identifying_information: [
{
type: '<string>',
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
has_ownership: true,
has_control: true,
is_signer: true,
middle_name: '<string>',
transliterated_first_name: '<string>',
transliterated_middle_name: '<string>',
transliterated_last_name: '<string>',
phone: '<string>',
is_director: true,
title: '<string>',
ownership_percentage: 50,
nationalities: ['<string>'],
relationship_established_at: '<string>',
documents: [{purposes: ['proof_of_address'], file: '<string>', description: '<string>'}]
}
],
estimated_annual_revenue_usd: '1000000_9999999',
expected_monthly_payments_usd: 1,
source_of_funds: 'sales_of_goods_and_services',
source_of_funds_description: '<string>',
account_purpose: 'treasury_management',
account_purpose_other: '<string>',
acting_as_intermediary: true,
operates_in_prohibited_countries: true,
high_risk_activities: ['none_of_the_above'],
high_risk_activities_explanation: '<string>',
conducts_money_services: true,
conducts_money_services_using_bridge: true,
conducts_money_services_description: '<string>',
compliance_screening_explanation: '<string>',
has_foreign_tax_registration: true,
identifying_information: [
{
type: '<string>',
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
documents: [{purposes: ['business_formation'], file: '<string>', description: '<string>'}]
},
endorsements: ['sepa'],
client_agreement_id: '<string>'
})
};
fetch('https://api.privy.io/v1/organizations/{organization_id}/kyb/submit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.privy.io/v1/organizations/{organization_id}/kyb/submit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => 'bridge',
'data' => [
'business_legal_name' => '<string>',
'business_trade_name' => '<string>',
'transliterated_business_legal_name' => '<string>',
'transliterated_business_trade_name' => '<string>',
'business_description' => '<string>',
'business_type' => 'llc',
'business_industry' => [
'<string>'
],
'email' => '[email protected]',
'phone' => '<string>',
'incorporation_date' => '<string>',
'is_dao' => true,
'primary_website' => '<string>',
'other_websites' => [
'<string>'
],
'ownership_threshold' => 15,
'has_material_intermediary_ownership' => true,
'publicly_traded_listings' => [
[
'market_identifier_code' => '<string>',
'stock_number' => '<string>',
'ticker' => '<string>'
]
],
'associated_persons' => [
[
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '[email protected]',
'date_of_birth' => '<string>',
'residential_address' => [
'street_line_1' => '<string>',
'city' => '<string>',
'country' => '<string>',
'street_line_2' => '<string>',
'subdivision' => '<string>',
'postal_code' => '<string>'
],
'identifying_information' => [
[
'type' => '<string>',
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'has_ownership' => true,
'has_control' => true,
'is_signer' => true,
'middle_name' => '<string>',
'transliterated_first_name' => '<string>',
'transliterated_middle_name' => '<string>',
'transliterated_last_name' => '<string>',
'phone' => '<string>',
'is_director' => true,
'title' => '<string>',
'ownership_percentage' => 50,
'nationalities' => [
'<string>'
],
'relationship_established_at' => '<string>',
'documents' => [
[
'purposes' => [
'proof_of_address'
],
'file' => '<string>',
'description' => '<string>'
]
]
]
],
'estimated_annual_revenue_usd' => '1000000_9999999',
'expected_monthly_payments_usd' => 1,
'source_of_funds' => 'sales_of_goods_and_services',
'source_of_funds_description' => '<string>',
'account_purpose' => 'treasury_management',
'account_purpose_other' => '<string>',
'acting_as_intermediary' => true,
'operates_in_prohibited_countries' => true,
'high_risk_activities' => [
'none_of_the_above'
],
'high_risk_activities_explanation' => '<string>',
'conducts_money_services' => true,
'conducts_money_services_using_bridge' => true,
'conducts_money_services_description' => '<string>',
'compliance_screening_explanation' => '<string>',
'has_foreign_tax_registration' => true,
'identifying_information' => [
[
'type' => '<string>',
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'documents' => [
[
'purposes' => [
'business_formation'
],
'file' => '<string>',
'description' => '<string>'
]
]
],
'endorsements' => [
'sepa'
],
'client_agreement_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"privy-app-id: <privy-app-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.privy.io/v1/organizations/{organization_id}/kyb/submit"
payload := strings.NewReader("{\n \"provider\": \"bridge\",\n \"data\": {\n \"business_legal_name\": \"<string>\",\n \"business_trade_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\",\n \"transliterated_business_trade_name\": \"<string>\",\n \"business_description\": \"<string>\",\n \"business_type\": \"llc\",\n \"business_industry\": [\n \"<string>\"\n ],\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"incorporation_date\": \"<string>\",\n \"is_dao\": true,\n \"primary_website\": \"<string>\",\n \"other_websites\": [\n \"<string>\"\n ],\n \"ownership_threshold\": 15,\n \"has_material_intermediary_ownership\": true,\n \"publicly_traded_listings\": [\n {\n \"market_identifier_code\": \"<string>\",\n \"stock_number\": \"<string>\",\n \"ticker\": \"<string>\"\n }\n ],\n \"associated_persons\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"date_of_birth\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street_line_2\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"has_ownership\": true,\n \"has_control\": true,\n \"is_signer\": true,\n \"middle_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"is_director\": true,\n \"title\": \"<string>\",\n \"ownership_percentage\": 50,\n \"nationalities\": [\n \"<string>\"\n ],\n \"relationship_established_at\": \"<string>\",\n \"documents\": [\n {\n \"purposes\": [\n \"proof_of_address\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n }\n ],\n \"estimated_annual_revenue_usd\": \"1000000_9999999\",\n \"expected_monthly_payments_usd\": 1,\n \"source_of_funds\": \"sales_of_goods_and_services\",\n \"source_of_funds_description\": \"<string>\",\n \"account_purpose\": \"treasury_management\",\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"operates_in_prohibited_countries\": true,\n \"high_risk_activities\": [\n \"none_of_the_above\"\n ],\n \"high_risk_activities_explanation\": \"<string>\",\n \"conducts_money_services\": true,\n \"conducts_money_services_using_bridge\": true,\n \"conducts_money_services_description\": \"<string>\",\n \"compliance_screening_explanation\": \"<string>\",\n \"has_foreign_tax_registration\": true,\n \"identifying_information\": [\n {\n \"type\": \"<string>\",\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [\n \"business_formation\"\n ],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"endorsements\": [\n \"sepa\"\n ],\n \"client_agreement_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("privy-app-id", "<privy-app-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"provider": "bridge",
"environment": "production",
"status": "approved",
"tos": {
"status": "approved",
"link": "<string>"
},
"endorsements": [
{
"name": "sepa",
"status": "approved",
"missing": [
"<string>"
]
}
],
"capabilities": {
"payin_crypto": "active",
"payout_crypto": "active",
"payin_fiat": "active",
"payout_fiat": "active"
},
"requirements_due": [
"<string>"
],
"future_requirements_due": [
"<string>"
],
"kyb": {
"status": "approved",
"link": "<string>",
"rejection_reasons": [
"<string>"
]
}
}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
application/json
Request body for headless KYB data submission.
KYC/KYB provider identifier.
Available options:
bridge KYB verification data for headless submission. Fields are individually optional because the provider accepts partial submissions and grants endorsements once enough data has arrived; a partial submission can be completed by calling the endpoint again.
Show child attributes
Show child attributes
Provider environment (production or sandbox).
Available options:
production, sandbox Endorsements to request during KYB.
Maximum array length:
1000Endorsement identifier.
Maximum string length:
256Client-side agreement ID for ToS acceptance.
Required string length:
1 - 1024Response
200 - application/json
KYB status snapshot reflecting the submitted data.
Full KYB status for an organization with a given provider.
KYC/KYB provider identifier.
Available options:
bridge Provider environment (production or sandbox).
Available options:
production, sandbox KYC/KYB status for the user.
Example:
"approved"
Terms of Service acceptance status for a KYC or KYB flow.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Capability statuses for the customer.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Was this page helpful?