Create a KYC link
curl --request POST \
--url https://api.sandbox.brickken.com/create-kyc-link \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "investor@example.com",
"needKyc": true
}
'import requests
url = "https://api.sandbox.brickken.com/create-kyc-link"
payload = {
"email": "investor@example.com",
"needKyc": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'investor@example.com', needKyc: true})
};
fetch('https://api.sandbox.brickken.com/create-kyc-link', 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.sandbox.brickken.com/create-kyc-link",
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' => 'investor@example.com',
'needKyc' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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.sandbox.brickken.com/create-kyc-link"
payload := strings.NewReader("{\n \"email\": \"investor@example.com\",\n \"needKyc\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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.sandbox.brickken.com/create-kyc-link")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"investor@example.com\",\n \"needKyc\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/create-kyc-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"investor@example.com\",\n \"needKyc\": true\n}"
response = http.request(request)
puts response.read_body{
"email": "jsmith@example.com",
"needKyc": true,
"userCreated": true,
"invitationSent": true,
"url": "<string>"
}KYC
Create KYC Link
Create or reuse an investor and return a Sumsub verification link.
POST
/
create-kyc-link
Create a KYC link
curl --request POST \
--url https://api.sandbox.brickken.com/create-kyc-link \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "investor@example.com",
"needKyc": true
}
'import requests
url = "https://api.sandbox.brickken.com/create-kyc-link"
payload = {
"email": "investor@example.com",
"needKyc": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'investor@example.com', needKyc: true})
};
fetch('https://api.sandbox.brickken.com/create-kyc-link', 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.sandbox.brickken.com/create-kyc-link",
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' => 'investor@example.com',
'needKyc' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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.sandbox.brickken.com/create-kyc-link"
payload := strings.NewReader("{\n \"email\": \"investor@example.com\",\n \"needKyc\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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.sandbox.brickken.com/create-kyc-link")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"investor@example.com\",\n \"needKyc\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/create-kyc-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"investor@example.com\",\n \"needKyc\": true\n}"
response = http.request(request)
puts response.read_body{
"email": "jsmith@example.com",
"needKyc": true,
"userCreated": true,
"invitationSent": true,
"url": "<string>"
}This endpoint always requires
When
x-api-key. The email is normalized before lookup, and needKyc defaults to true.
This operation can create an investor account and send an invitation email. The returned Sumsub URL grants access to a verification flow; do not log it, commit it, or expose it to another user.
needKyc is false, the investor is created without a KYC requirement and url is null.
Client examples
- CLI
- MCP
- SDK
brickken kyc create-link \
--email investor@example.com \
--need-kyc true \
--json
{
"name": "create_kyc_link",
"arguments": {
"email": "investor@example.com",
"needKyc": true
}
}
const result = await bkn.kyc.createLink({
email: 'investor@example.com',
needKyc: true,
})
Response
{
"email": "investor@example.com",
"needKyc": true,
"userCreated": true,
"invitationSent": true,
"url": "https://in.sumsub.com/..."
}
Authorizations
⌘I