Generate the Links needs to complete KYC for an individual or business
curl --request POST \
--url https://api.bridge.xyz/v0/kyc_links \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"email": "<string>",
"full_name": "<string>",
"endorsements": [],
"redirect_uri": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"transliterated_business_legal_name": "<string>"
}
'import requests
url = "https://api.bridge.xyz/v0/kyc_links"
payload = {
"email": "<string>",
"full_name": "<string>",
"endorsements": [],
"redirect_uri": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"transliterated_business_legal_name": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: '<string>',
full_name: '<string>',
endorsements: [],
redirect_uri: '<string>',
transliterated_first_name: '<string>',
transliterated_middle_name: '<string>',
transliterated_last_name: '<string>',
transliterated_business_legal_name: '<string>'
})
};
fetch('https://api.bridge.xyz/v0/kyc_links', 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.bridge.xyz/v0/kyc_links",
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([
'email' => '<string>',
'full_name' => '<string>',
'endorsements' => [
],
'redirect_uri' => '<string>',
'transliterated_first_name' => '<string>',
'transliterated_middle_name' => '<string>',
'transliterated_last_name' => '<string>',
'transliterated_business_legal_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.bridge.xyz/v0/kyc_links"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"endorsements\": [],\n \"redirect_uri\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Api-Key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/kyc_links")
.header("Idempotency-Key", "<idempotency-key>")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"endorsements\": [],\n \"redirect_uri\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bridge.xyz/v0/kyc_links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"endorsements\": [],\n \"redirect_uri\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "kyc_link_123",
"full_name": "John Doe",
"email": "johndoe@johndoe.com",
"type": "individual",
"kyc_link": "www.kyclink.com/blah",
"tos_link": "www.toslink.com/blah",
"kyc_status": "not_started",
"tos_status": "pending",
"customer_id": "cust_123"
}
KYC Links
Generate the Links needs to complete KYC for an individual or business
POST
/
kyc_links
Generate the Links needs to complete KYC for an individual or business
curl --request POST \
--url https://api.bridge.xyz/v0/kyc_links \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"email": "<string>",
"full_name": "<string>",
"endorsements": [],
"redirect_uri": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"transliterated_business_legal_name": "<string>"
}
'import requests
url = "https://api.bridge.xyz/v0/kyc_links"
payload = {
"email": "<string>",
"full_name": "<string>",
"endorsements": [],
"redirect_uri": "<string>",
"transliterated_first_name": "<string>",
"transliterated_middle_name": "<string>",
"transliterated_last_name": "<string>",
"transliterated_business_legal_name": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: '<string>',
full_name: '<string>',
endorsements: [],
redirect_uri: '<string>',
transliterated_first_name: '<string>',
transliterated_middle_name: '<string>',
transliterated_last_name: '<string>',
transliterated_business_legal_name: '<string>'
})
};
fetch('https://api.bridge.xyz/v0/kyc_links', 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.bridge.xyz/v0/kyc_links",
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([
'email' => '<string>',
'full_name' => '<string>',
'endorsements' => [
],
'redirect_uri' => '<string>',
'transliterated_first_name' => '<string>',
'transliterated_middle_name' => '<string>',
'transliterated_last_name' => '<string>',
'transliterated_business_legal_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.bridge.xyz/v0/kyc_links"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"endorsements\": [],\n \"redirect_uri\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Api-Key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/kyc_links")
.header("Idempotency-Key", "<idempotency-key>")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"endorsements\": [],\n \"redirect_uri\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bridge.xyz/v0/kyc_links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"endorsements\": [],\n \"redirect_uri\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"transliterated_business_legal_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "kyc_link_123",
"full_name": "John Doe",
"email": "johndoe@johndoe.com",
"type": "individual",
"kyc_link": "www.kyclink.com/blah",
"tos_link": "www.toslink.com/blah",
"kyc_status": "not_started",
"tos_status": "pending",
"customer_id": "cust_123"
}
Body
application/json
Information about the customer to create KYC Links for
List of endorsements to request for the generated KYC link.
For example, sepa endorsement could be requested to allow an individual customer to submit proof-of-address documents in the KYC flow.
The type of endorsement. Note: pix_onramp (BRL deposits via PIX) and pix_offramp (BRL withdrawals via PIX) can be requested individually for granular access. Requesting pix grants both directional endorsements. pix_onramp is not supported for non-BR individuals; if requested (or requested via pix) it will remain in an endorsement_not_available_in_customers_region state and no action is required.
Available options:
base, cards, cop, faster_payments, pix, pix_onramp, pix_offramp, sepa, spei Response
KYC Links generated
Was this page helpful?