Download Order Payload
curl --request GET \
--url https://api.kyckr.com/v2/orders/{orderId}/download \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.kyckr.com/v2/orders/{orderId}/download"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.kyckr.com/v2/orders/{orderId}/download', 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/orders/{orderId}/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.kyckr.com/v2/orders/{orderId}/download"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kyckr.com/v2/orders/{orderId}/download")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kyckr.com/v2/orders/{orderId}/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"_payloadType": "BOProfile_v2",
"schemaVersion": "1.0.0",
"subject": {
"subjectType": "Entity",
"name": "Example Holdings SAS",
"registrationNumber": "123456789",
"jurisdiction": "FR",
"status": {
"original": null,
"normalized": "Active"
},
"legalForm": {
"original": "5710 (SAS, société par actions simplifiée)",
"normalized": "Private Limited Company"
},
"addresses": [
{
"type": "Registered Address",
"fullAddress": "1 Rue de l'Exemple, 75001 Paris, France",
"streetNumber": "1",
"streetName": "Rue de l'Exemple",
"city": "Paris",
"postcode": "75001",
"country": "France",
"isoCode": "FR"
}
],
"incorporationDate": {
"original": "2015-03-12",
"normalized": "2015-03-12"
}
},
"registryInfo": {
"registryName": "Registre National des Bénéficiaires Effectifs (RBE)",
"dataAsOfDate": "2025-06-03T00:00:00Z",
"extractedAt": "2025-06-04T09:15:00Z"
},
"interestedParties": [
{
"partyId": "FR:a1b2c3d4e5f6a7b8",
"partyIdBasis": "DerivedDigest",
"partyType": "Individual",
"name": "Jane Example",
"disclosure": {
"status": "Partial"
},
"birthDate": {
"original": "1980-05",
"normalized": null
},
"birthYear": 1980,
"nationalities": [
"FR"
],
"countryOfResidence": "FR",
"interests": [
{
"type": {
"original": null,
"normalized": "Shareholding"
},
"share": {
"exact": 60,
"original": "60.0%"
},
"directOrIndirect": {
"original": null,
"normalized": "Direct"
},
"heldAs": "Self",
"hasSignificantControl": true,
"startDate": "2025-06-03T00:00:00Z"
},
{
"type": {
"original": null,
"normalized": "VotingRights"
},
"share": {
"exact": 60,
"original": "60.0%"
},
"directOrIndirect": {
"original": null,
"normalized": "Direct"
},
"heldAs": "Self",
"hasSignificantControl": true,
"startDate": "2025-06-03T00:00:00Z"
}
],
"totalOwnership": {
"exact": 60,
"original": "60.0%"
},
"totalVotingRights": {
"exact": 60,
"original": "60.0%"
}
}
],
"registerStatements": []
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/400",
"title": "Missing Parameter",
"detail": "The `isoCode` parameter is required",
"errors": []
}
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/401",
"title": "Unauthorized",
"detail": "Please authorize before making requests",
"errors": []
}
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/403",
"title": "Forbidden",
"detail": "This feature is not available on this account",
"errors": []
}
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/404",
"title": "Not Found",
"detail": "This resource could not be found",
"errors": []
}
}Orders
Download Order Payload
Retrieve the order result as either a structured JSON payload or a PDF document. The JSON body follows the product that was ordered (the order’s productDetails.productName). For an Enhanced Profile order it is the Enhanced Profile shown below. For a beneficial ownership order (UBO_Register_Profile) it is the beneficial ownership profile, returned as the whole response body and carrying _payloadType: BOProfile_v2; see the UBO Register API reference for its schema. The order’s links.data points to the JSON and links.document to the PDF.
GET
/
orders
/
{orderId}
/
download
Download Order Payload
curl --request GET \
--url https://api.kyckr.com/v2/orders/{orderId}/download \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.kyckr.com/v2/orders/{orderId}/download"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.kyckr.com/v2/orders/{orderId}/download', 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/orders/{orderId}/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.kyckr.com/v2/orders/{orderId}/download"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kyckr.com/v2/orders/{orderId}/download")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kyckr.com/v2/orders/{orderId}/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"_payloadType": "BOProfile_v2",
"schemaVersion": "1.0.0",
"subject": {
"subjectType": "Entity",
"name": "Example Holdings SAS",
"registrationNumber": "123456789",
"jurisdiction": "FR",
"status": {
"original": null,
"normalized": "Active"
},
"legalForm": {
"original": "5710 (SAS, société par actions simplifiée)",
"normalized": "Private Limited Company"
},
"addresses": [
{
"type": "Registered Address",
"fullAddress": "1 Rue de l'Exemple, 75001 Paris, France",
"streetNumber": "1",
"streetName": "Rue de l'Exemple",
"city": "Paris",
"postcode": "75001",
"country": "France",
"isoCode": "FR"
}
],
"incorporationDate": {
"original": "2015-03-12",
"normalized": "2015-03-12"
}
},
"registryInfo": {
"registryName": "Registre National des Bénéficiaires Effectifs (RBE)",
"dataAsOfDate": "2025-06-03T00:00:00Z",
"extractedAt": "2025-06-04T09:15:00Z"
},
"interestedParties": [
{
"partyId": "FR:a1b2c3d4e5f6a7b8",
"partyIdBasis": "DerivedDigest",
"partyType": "Individual",
"name": "Jane Example",
"disclosure": {
"status": "Partial"
},
"birthDate": {
"original": "1980-05",
"normalized": null
},
"birthYear": 1980,
"nationalities": [
"FR"
],
"countryOfResidence": "FR",
"interests": [
{
"type": {
"original": null,
"normalized": "Shareholding"
},
"share": {
"exact": 60,
"original": "60.0%"
},
"directOrIndirect": {
"original": null,
"normalized": "Direct"
},
"heldAs": "Self",
"hasSignificantControl": true,
"startDate": "2025-06-03T00:00:00Z"
},
{
"type": {
"original": null,
"normalized": "VotingRights"
},
"share": {
"exact": 60,
"original": "60.0%"
},
"directOrIndirect": {
"original": null,
"normalized": "Direct"
},
"heldAs": "Self",
"hasSignificantControl": true,
"startDate": "2025-06-03T00:00:00Z"
}
],
"totalOwnership": {
"exact": 60,
"original": "60.0%"
},
"totalVotingRights": {
"exact": 60,
"original": "60.0%"
}
}
],
"registerStatements": []
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/400",
"title": "Missing Parameter",
"detail": "The `isoCode` parameter is required",
"errors": []
}
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/401",
"title": "Unauthorized",
"detail": "Please authorize before making requests",
"errors": []
}
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/403",
"title": "Forbidden",
"detail": "This feature is not available on this account",
"errors": []
}
}{
"orderId": 12345,
"correlationId": "string",
"customerReference": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"details": "string",
"cost": {
"type": "credit",
"value": 0
},
"links": {
"self": "../dictionary"
},
"data": {
"type": "https://httpstatuses.com/404",
"title": "Not Found",
"detail": "This resource could not be found",
"errors": []
}
}Authorizations
Query Parameters
Response
OK
The structured payload for the ordered product: the EnhancedProfile schema for an Enhanced Profile order (see GET Enhanced Profile), or the beneficial ownership profile for a UBO_Register_Profile order.