curl --request POST \
--url https://api.clarian.finance/v1/{env}/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"kind": "person",
"display_name": "Customer",
"legal_name": "<string>",
"document_type": "<string>",
"document_number": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"external_id": "<string>",
"metadata": {},
"payout_mode": "<string>",
"payout_asset": "<string>",
"payout_wallet_address": "<string>",
"payout_wallet_network": "<string>"
}
'import requests
url = "https://api.clarian.finance/v1/{env}/customers"
payload = {
"kind": "person",
"display_name": "Customer",
"legal_name": "<string>",
"document_type": "<string>",
"document_number": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"external_id": "<string>",
"metadata": {},
"payout_mode": "<string>",
"payout_asset": "<string>",
"payout_wallet_address": "<string>",
"payout_wallet_network": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"X-Workspace-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Workspace-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
kind: 'person',
display_name: 'Customer',
legal_name: '<string>',
document_type: '<string>',
document_number: '<string>',
email: '<string>',
phone: '<string>',
country: '<string>',
external_id: '<string>',
metadata: {},
payout_mode: '<string>',
payout_asset: '<string>',
payout_wallet_address: '<string>',
payout_wallet_network: '<string>'
})
};
fetch('https://api.clarian.finance/v1/{env}/customers', 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.clarian.finance/v1/{env}/customers",
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([
'kind' => 'person',
'display_name' => 'Customer',
'legal_name' => '<string>',
'document_type' => '<string>',
'document_number' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'country' => '<string>',
'external_id' => '<string>',
'metadata' => [
],
'payout_mode' => '<string>',
'payout_asset' => '<string>',
'payout_wallet_address' => '<string>',
'payout_wallet_network' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Workspace-Id: <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.clarian.finance/v1/{env}/customers"
payload := strings.NewReader("{\n \"kind\": \"person\",\n \"display_name\": \"Customer\",\n \"legal_name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_number\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"metadata\": {},\n \"payout_mode\": \"<string>\",\n \"payout_asset\": \"<string>\",\n \"payout_wallet_address\": \"<string>\",\n \"payout_wallet_network\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Workspace-Id", "<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.clarian.finance/v1/{env}/customers")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"person\",\n \"display_name\": \"Customer\",\n \"legal_name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_number\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"metadata\": {},\n \"payout_mode\": \"<string>\",\n \"payout_asset\": \"<string>\",\n \"payout_wallet_address\": \"<string>\",\n \"payout_wallet_network\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Workspace-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"person\",\n \"display_name\": \"Customer\",\n \"legal_name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_number\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"metadata\": {},\n \"payout_mode\": \"<string>\",\n \"payout_asset\": \"<string>\",\n \"payout_wallet_address\": \"<string>\",\n \"payout_wallet_network\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "person",
"display_name": "<string>",
"legal_name": "<string>",
"document_type": "<string>",
"document_number": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"status": "<string>",
"kyc_status": "<string>",
"external_id": "<string>",
"payout_mode": "<string>",
"payout_asset": "<string>",
"payout_wallet_address": "<string>",
"payout_wallet_network": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Create customer
Workspace-level caller only; a customer-scoped key cannot create other parties.
curl --request POST \
--url https://api.clarian.finance/v1/{env}/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <api-key>' \
--data '
{
"kind": "person",
"display_name": "Customer",
"legal_name": "<string>",
"document_type": "<string>",
"document_number": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"external_id": "<string>",
"metadata": {},
"payout_mode": "<string>",
"payout_asset": "<string>",
"payout_wallet_address": "<string>",
"payout_wallet_network": "<string>"
}
'import requests
url = "https://api.clarian.finance/v1/{env}/customers"
payload = {
"kind": "person",
"display_name": "Customer",
"legal_name": "<string>",
"document_type": "<string>",
"document_number": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"external_id": "<string>",
"metadata": {},
"payout_mode": "<string>",
"payout_asset": "<string>",
"payout_wallet_address": "<string>",
"payout_wallet_network": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"X-Workspace-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Workspace-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
kind: 'person',
display_name: 'Customer',
legal_name: '<string>',
document_type: '<string>',
document_number: '<string>',
email: '<string>',
phone: '<string>',
country: '<string>',
external_id: '<string>',
metadata: {},
payout_mode: '<string>',
payout_asset: '<string>',
payout_wallet_address: '<string>',
payout_wallet_network: '<string>'
})
};
fetch('https://api.clarian.finance/v1/{env}/customers', 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.clarian.finance/v1/{env}/customers",
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([
'kind' => 'person',
'display_name' => 'Customer',
'legal_name' => '<string>',
'document_type' => '<string>',
'document_number' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'country' => '<string>',
'external_id' => '<string>',
'metadata' => [
],
'payout_mode' => '<string>',
'payout_asset' => '<string>',
'payout_wallet_address' => '<string>',
'payout_wallet_network' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Workspace-Id: <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.clarian.finance/v1/{env}/customers"
payload := strings.NewReader("{\n \"kind\": \"person\",\n \"display_name\": \"Customer\",\n \"legal_name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_number\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"metadata\": {},\n \"payout_mode\": \"<string>\",\n \"payout_asset\": \"<string>\",\n \"payout_wallet_address\": \"<string>\",\n \"payout_wallet_network\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Workspace-Id", "<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.clarian.finance/v1/{env}/customers")
.header("Authorization", "Bearer <token>")
.header("X-Workspace-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"person\",\n \"display_name\": \"Customer\",\n \"legal_name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_number\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"metadata\": {},\n \"payout_mode\": \"<string>\",\n \"payout_asset\": \"<string>\",\n \"payout_wallet_address\": \"<string>\",\n \"payout_wallet_network\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clarian.finance/v1/{env}/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Workspace-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"person\",\n \"display_name\": \"Customer\",\n \"legal_name\": \"<string>\",\n \"document_type\": \"<string>\",\n \"document_number\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"external_id\": \"<string>\",\n \"metadata\": {},\n \"payout_mode\": \"<string>\",\n \"payout_asset\": \"<string>\",\n \"payout_wallet_address\": \"<string>\",\n \"payout_wallet_network\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "person",
"display_name": "<string>",
"legal_name": "<string>",
"document_type": "<string>",
"document_number": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"status": "<string>",
"kyc_status": "<string>",
"external_id": "<string>",
"payout_mode": "<string>",
"payout_asset": "<string>",
"payout_wallet_address": "<string>",
"payout_wallet_network": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Authorization: Bearer cl_test_sk_... (sandbox) or Bearer cl_live_sk_... (live). A live key additionally needs production enabled by the workspace owner. Using a live key against the sandbox path revokes it on sight (leak signal); a sandbox key on live is refused and logged, but not revoked.
The workspace (tenant) UUID. Always required, including on session-authenticated dashboard calls.
Path Parameters
test is also accepted on the wire as an alias of sandbox; the key prefix must match (cl_test_sk_ for sandbox/test, cl_live_sk_ for live).
sandbox, live Body
person, business Only kept when it is one of the supported networks.
Response
OK
A party of kind customer. Fields mirror CreateCustomerRequest plus server-assigned ones.
Show child attributes
Show child attributes