Submit KYC data
curl --request POST \
--url https://api.privy.io/v1/users/{user_id}/kyc/submit \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'privy-app-id: <privy-app-id>' \
--data '
{
"provider": "bridge",
"data": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"date_of_birth": "<string>",
"nationalities": [
"<string>"
],
"identifying_information": [
{
"type": "<string>",
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"stripe_link_shared_data_id": "<string>",
"nonresident_alien_attestation": true,
"employment_status": "<string>",
"expected_monthly_payments_usd": "<string>",
"acting_as_intermediary": true,
"most_recent_occupation": "<string>",
"source_of_funds": "<string>",
"account_purpose": "<string>",
"account_purpose_other": "<string>",
"verified_database_at": "2023-11-07T05:31:56Z",
"verified_govid_at": "2023-11-07T05:31:56Z",
"verified_proof_of_address_at": "2023-11-07T05:31:56Z"
},
"endorsements": [
"sepa"
],
"client_agreement_id": "<string>"
}
'HttpResponse<String> response = Unirest.post("https://api.privy.io/v1/users/{user_id}/kyc/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 \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationalities\": [\n \"<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 \"stripe_link_shared_data_id\": \"<string>\",\n \"nonresident_alien_attestation\": true,\n \"employment_status\": \"<string>\",\n \"expected_monthly_payments_usd\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"source_of_funds\": \"<string>\",\n \"account_purpose\": \"<string>\",\n \"account_purpose_other\": \"<string>\",\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_proof_of_address_at\": \"2023-11-07T05:31:56Z\"\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: {
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
transliterated_first_name: '<string>',
transliterated_middle_name: '<string>',
transliterated_last_name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
date_of_birth: '<string>',
nationalities: ['<string>'],
identifying_information: [
{
type: '<string>',
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
stripe_link_shared_data_id: '<string>',
nonresident_alien_attestation: true,
employment_status: '<string>',
expected_monthly_payments_usd: '<string>',
acting_as_intermediary: true,
most_recent_occupation: '<string>',
source_of_funds: '<string>',
account_purpose: '<string>',
account_purpose_other: '<string>',
verified_database_at: '2023-11-07T05:31:56Z',
verified_govid_at: '2023-11-07T05:31:56Z',
verified_proof_of_address_at: '2023-11-07T05:31:56Z'
},
endorsements: ['sepa'],
client_agreement_id: '<string>'
})
};
fetch('https://api.privy.io/v1/users/{user_id}/kyc/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/users/{user_id}/kyc/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' => [
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'transliterated_first_name' => '<string>',
'transliterated_middle_name' => '<string>',
'transliterated_last_name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'date_of_birth' => '<string>',
'nationalities' => [
'<string>'
],
'identifying_information' => [
[
'type' => '<string>',
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'stripe_link_shared_data_id' => '<string>',
'nonresident_alien_attestation' => true,
'employment_status' => '<string>',
'expected_monthly_payments_usd' => '<string>',
'acting_as_intermediary' => true,
'most_recent_occupation' => '<string>',
'source_of_funds' => '<string>',
'account_purpose' => '<string>',
'account_purpose_other' => '<string>',
'verified_database_at' => '2023-11-07T05:31:56Z',
'verified_govid_at' => '2023-11-07T05:31:56Z',
'verified_proof_of_address_at' => '2023-11-07T05:31:56Z'
],
'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/users/{user_id}/kyc/submit"
payload := strings.NewReader("{\n \"provider\": \"bridge\",\n \"data\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationalities\": [\n \"<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 \"stripe_link_shared_data_id\": \"<string>\",\n \"nonresident_alien_attestation\": true,\n \"employment_status\": \"<string>\",\n \"expected_monthly_payments_usd\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"source_of_funds\": \"<string>\",\n \"account_purpose\": \"<string>\",\n \"account_purpose_other\": \"<string>\",\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_proof_of_address_at\": \"2023-11-07T05:31:56Z\"\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>"
],
"issues": [
"<string>"
]
}
],
"capabilities": {
"payin_crypto": "active",
"payout_crypto": "active",
"payin_fiat": "active",
"payout_fiat": "active"
},
"requirements_due": [
"<string>"
],
"future_requirements_due": [
"<string>"
],
"kyc": {
"status": "approved",
"link": "<string>",
"rejection_reasons": [
"<string>"
]
},
"stripe_cardholder_id": "<string>"
}KYC
Submit KYC data
Submits KYC data, creating a provider customer on the first call and updating it on later calls. Stripe Link can supply identity details, but an email is still required to create a customer.
POST
/
v1
/
users
/
{user_id}
/
kyc
/
submit
Submit KYC data
curl --request POST \
--url https://api.privy.io/v1/users/{user_id}/kyc/submit \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'privy-app-id: <privy-app-id>' \
--data '
{
"provider": "bridge",
"data": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"date_of_birth": "<string>",
"nationalities": [
"<string>"
],
"identifying_information": [
{
"type": "<string>",
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"stripe_link_shared_data_id": "<string>",
"nonresident_alien_attestation": true,
"employment_status": "<string>",
"expected_monthly_payments_usd": "<string>",
"acting_as_intermediary": true,
"most_recent_occupation": "<string>",
"source_of_funds": "<string>",
"account_purpose": "<string>",
"account_purpose_other": "<string>",
"verified_database_at": "2023-11-07T05:31:56Z",
"verified_govid_at": "2023-11-07T05:31:56Z",
"verified_proof_of_address_at": "2023-11-07T05:31:56Z"
},
"endorsements": [
"sepa"
],
"client_agreement_id": "<string>"
}
'HttpResponse<String> response = Unirest.post("https://api.privy.io/v1/users/{user_id}/kyc/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 \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationalities\": [\n \"<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 \"stripe_link_shared_data_id\": \"<string>\",\n \"nonresident_alien_attestation\": true,\n \"employment_status\": \"<string>\",\n \"expected_monthly_payments_usd\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"source_of_funds\": \"<string>\",\n \"account_purpose\": \"<string>\",\n \"account_purpose_other\": \"<string>\",\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_proof_of_address_at\": \"2023-11-07T05:31:56Z\"\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: {
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
transliterated_first_name: '<string>',
transliterated_middle_name: '<string>',
transliterated_last_name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
date_of_birth: '<string>',
nationalities: ['<string>'],
identifying_information: [
{
type: '<string>',
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
stripe_link_shared_data_id: '<string>',
nonresident_alien_attestation: true,
employment_status: '<string>',
expected_monthly_payments_usd: '<string>',
acting_as_intermediary: true,
most_recent_occupation: '<string>',
source_of_funds: '<string>',
account_purpose: '<string>',
account_purpose_other: '<string>',
verified_database_at: '2023-11-07T05:31:56Z',
verified_govid_at: '2023-11-07T05:31:56Z',
verified_proof_of_address_at: '2023-11-07T05:31:56Z'
},
endorsements: ['sepa'],
client_agreement_id: '<string>'
})
};
fetch('https://api.privy.io/v1/users/{user_id}/kyc/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/users/{user_id}/kyc/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' => [
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'transliterated_first_name' => '<string>',
'transliterated_middle_name' => '<string>',
'transliterated_last_name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'date_of_birth' => '<string>',
'nationalities' => [
'<string>'
],
'identifying_information' => [
[
'type' => '<string>',
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'stripe_link_shared_data_id' => '<string>',
'nonresident_alien_attestation' => true,
'employment_status' => '<string>',
'expected_monthly_payments_usd' => '<string>',
'acting_as_intermediary' => true,
'most_recent_occupation' => '<string>',
'source_of_funds' => '<string>',
'account_purpose' => '<string>',
'account_purpose_other' => '<string>',
'verified_database_at' => '2023-11-07T05:31:56Z',
'verified_govid_at' => '2023-11-07T05:31:56Z',
'verified_proof_of_address_at' => '2023-11-07T05:31:56Z'
],
'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/users/{user_id}/kyc/submit"
payload := strings.NewReader("{\n \"provider\": \"bridge\",\n \"data\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationalities\": [\n \"<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 \"stripe_link_shared_data_id\": \"<string>\",\n \"nonresident_alien_attestation\": true,\n \"employment_status\": \"<string>\",\n \"expected_monthly_payments_usd\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"source_of_funds\": \"<string>\",\n \"account_purpose\": \"<string>\",\n \"account_purpose_other\": \"<string>\",\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_proof_of_address_at\": \"2023-11-07T05:31:56Z\"\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>"
],
"issues": [
"<string>"
]
}
],
"capabilities": {
"payin_crypto": "active",
"payout_crypto": "active",
"payin_fiat": "active",
"payout_fiat": "active"
},
"requirements_due": [
"<string>"
],
"future_requirements_due": [
"<string>"
],
"kyc": {
"status": "approved",
"link": "<string>",
"rejection_reasons": [
"<string>"
]
},
"stripe_cardholder_id": "<string>"
}Authorizations
Body
application/json
Request body for headless KYC data submission.
Response
200 - application/json
KYC status snapshot reflecting the submitted data.
Full KYC status for a user with a given provider.
Was this page helpful?

