Order a UBO Register Profile
curl --request POST \
--url https://api.kyckr.com/v2/companies/{kyckrId}/uboregister \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerReference": "BO-2026-001"
}
'import requests
url = "https://api.kyckr.com/v2/companies/{kyckrId}/uboregister"
payload = { "customerReference": "BO-2026-001" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerReference: 'BO-2026-001'})
};
fetch('https://api.kyckr.com/v2/companies/{kyckrId}/uboregister', 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.kyckr.com/v2/companies/{kyckrId}/uboregister",
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([
'customerReference' => 'BO-2026-001'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.kyckr.com/v2/companies/{kyckrId}/uboregister"
payload := strings.NewReader("{\n \"customerReference\": \"BO-2026-001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.kyckr.com/v2/companies/{kyckrId}/uboregister")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerReference\": \"BO-2026-001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kyckr.com/v2/companies/{kyckrId}/uboregister")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerReference\": \"BO-2026-001\"\n}"
response = http.request(request)
puts response.read_body{
"correlationId": "90b271d92b084f0bad3730e828a63d39",
"timeStamp": "2026-03-09T10:20:00Z",
"data": {
"status": "Pending",
"orderId": 12345,
"cost": {
"type": "credit",
"value": 1
}
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}Operations
Order a UBO Register Profile
Places an order for a beneficial ownership profile and returns an orderId. Every order is asynchronous: the profile is never returned inline, and collection is the same in every jurisdiction.
Each successful call places a new, chargeable order. If a call times out or fails with a 5xx, check GET /v2/orders for an order carrying your customerReference before you call again.
Before you call
Search for the company with GET /v2/companies in the Company V2 API to obtain its kyckrId.
Collecting the profile
- Poll
GET /v2/orders/{orderId}untilstatusisSuccess. - Download the profile as JSON from
GET /v2/orders/{orderId}/download?format=json(links.dataon the order), or as a PDF withformat=pdf(links.document). - The JSON profile carries
_payloadType: BOProfile_v2, and the order’s product isUBO_Register_Profile.
POST
/
companies
/
{kyckrId}
/
uboregister
Order a UBO Register Profile
curl --request POST \
--url https://api.kyckr.com/v2/companies/{kyckrId}/uboregister \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerReference": "BO-2026-001"
}
'import requests
url = "https://api.kyckr.com/v2/companies/{kyckrId}/uboregister"
payload = { "customerReference": "BO-2026-001" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerReference: 'BO-2026-001'})
};
fetch('https://api.kyckr.com/v2/companies/{kyckrId}/uboregister', 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.kyckr.com/v2/companies/{kyckrId}/uboregister",
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([
'customerReference' => 'BO-2026-001'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.kyckr.com/v2/companies/{kyckrId}/uboregister"
payload := strings.NewReader("{\n \"customerReference\": \"BO-2026-001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.kyckr.com/v2/companies/{kyckrId}/uboregister")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerReference\": \"BO-2026-001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kyckr.com/v2/companies/{kyckrId}/uboregister")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerReference\": \"BO-2026-001\"\n}"
response = http.request(request)
puts response.read_body{
"correlationId": "90b271d92b084f0bad3730e828a63d39",
"timeStamp": "2026-03-09T10:20:00Z",
"data": {
"status": "Pending",
"orderId": 12345,
"cost": {
"type": "credit",
"value": 1
}
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}{
"orderId": "12345",
"correlationId": "<string>",
"customerReference": "<string>",
"timeStamp": "2023-11-07T05:31:56Z",
"details": "<string>",
"cost": {
"type": "credit",
"value": 123
},
"links": {},
"data": {
"type": "<string>",
"title": "<string>",
"detail": "<string>",
"errors": [
"<string>"
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Kyckr company reference, a shared format usable across Kyckr V2 APIs
Body
application/json
Optional reference for tracking
Example:
"BO-2026-001"
Response
Accepted: the order is created; collect the profile once the order completes
Order ID for billing/tracking
Example:
"12345"
Request correlation ID for tracing
Customer-provided reference
Response timestamp
Status message
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes