curl --request GET \
--url https://business-api.onboard.xyz/exchange/api/info \
--header 'x-api-key: <api-key>'import requests
url = "https://business-api.onboard.xyz/exchange/api/info"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://business-api.onboard.xyz/exchange/api/info', 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://business-api.onboard.xyz/exchange/api/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://business-api.onboard.xyz/exchange/api/info"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://business-api.onboard.xyz/exchange/api/info")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://business-api.onboard.xyz/exchange/api/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"businessId": "3a5aaea8-504a-4404-ad3d-b82574fba5e5",
"businessName": "Onabord exchange",
"businessEmail": "jsmith@example.com",
"businessLocation": "<string>",
"businessRegNo": "<string>",
"businessRegCountry": "<string>",
"businessFormationDate": "2023-12-25",
"businessIndustry": "TECHNOLOGY_SOFTWARE",
"taxCountry": "<string>",
"taxIdentificationNumber": "<string>",
"legalEntityType": "LIMITED_LIABILITY_COMPANY",
"businessCategory": "GENERAL_BUSINESS",
"monthlyTransactionVolume": "<string>",
"transactsOnBehalfOfThirdParties": true,
"operatesInRestrictedRegions": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productName": "<string>",
"productWebsiteUrl": "<string>",
"productDescription": "<string>",
"businessPhoneNumber": "<string>",
"businessLogoUrl": "<string>",
"businessType": "<string>",
"enabledProducts": [
"<string>"
],
"operatingAddress": "<string>",
"restrictedRegions": "<string>",
"ultimateBeneficialOwners": [
{
"fullName": "<string>",
"email": "jsmith@example.com",
"ownershipPercentage": 123
}
],
"directors": [
{
"fullName": "<string>",
"email": "jsmith@example.com"
}
],
"authorisedSignatories": [
"<string>"
],
"documents": [
{
"label": "<string>",
"uploadId": "<string>",
"url": "<string>"
}
],
"declarationAcceptedAt": "2023-11-07T05:31:56Z"
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}Get API Info
curl --request GET \
--url https://business-api.onboard.xyz/exchange/api/info \
--header 'x-api-key: <api-key>'import requests
url = "https://business-api.onboard.xyz/exchange/api/info"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://business-api.onboard.xyz/exchange/api/info', 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://business-api.onboard.xyz/exchange/api/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://business-api.onboard.xyz/exchange/api/info"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://business-api.onboard.xyz/exchange/api/info")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://business-api.onboard.xyz/exchange/api/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"businessId": "3a5aaea8-504a-4404-ad3d-b82574fba5e5",
"businessName": "Onabord exchange",
"businessEmail": "jsmith@example.com",
"businessLocation": "<string>",
"businessRegNo": "<string>",
"businessRegCountry": "<string>",
"businessFormationDate": "2023-12-25",
"businessIndustry": "TECHNOLOGY_SOFTWARE",
"taxCountry": "<string>",
"taxIdentificationNumber": "<string>",
"legalEntityType": "LIMITED_LIABILITY_COMPANY",
"businessCategory": "GENERAL_BUSINESS",
"monthlyTransactionVolume": "<string>",
"transactsOnBehalfOfThirdParties": true,
"operatesInRestrictedRegions": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"productName": "<string>",
"productWebsiteUrl": "<string>",
"productDescription": "<string>",
"businessPhoneNumber": "<string>",
"businessLogoUrl": "<string>",
"businessType": "<string>",
"enabledProducts": [
"<string>"
],
"operatingAddress": "<string>",
"restrictedRegions": "<string>",
"ultimateBeneficialOwners": [
{
"fullName": "<string>",
"email": "jsmith@example.com",
"ownershipPercentage": 123
}
],
"directors": [
{
"fullName": "<string>",
"email": "jsmith@example.com"
}
],
"authorisedSignatories": [
"<string>"
],
"documents": [
{
"label": "<string>",
"uploadId": "<string>",
"url": "<string>"
}
],
"declarationAcceptedAt": "2023-11-07T05:31:56Z"
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Response
Success
CEX user profile object
General format for UUID
"3a5aaea8-504a-4404-ad3d-b82574fba5e5"
Registered name of business entity
"Onabord exchange"
Business profile email address
business full location address
Business registration number (if any)
Business country of registration (if any)
Date the business entity was formed
Sector the business primarily operates in
TECHNOLOGY_SOFTWARE, FINANCIAL_SERVICES, ECOMMERCE, MARKETING_ADVERTISING, CONSULTING_PROFESSIONAL_SERVICES, EDUCATION, HEALTHCARE, MANUFACTURING, LOGISTICS_SUPPLY_CHAIN, REAL_ESTATE, CRYPTO_WEB3, GAMING, MEDIA_ENTERTAINMENT, OTHER Tax residency country, Valid alpha2 country code
2Business tax identification number (TIN)
Legal structure of the business entity (KYB "Business type (Entity)")
LIMITED_LIABILITY_COMPANY, PUBLIC_COMPANY, SOLE_PROPRIETORSHIP, PARTNERSHIP, CORPORATION, TRUST, PRIVATE_FOUNDATION, CHARITY, NON_PROFIT_ORGANIZATION, PUBLIC_AGENCY KYB onboarding tier that determines the required document set
GENERAL_BUSINESS, OTC_FX_LIQUIDITY_PROVIDER, LICENSED_FINANCIAL_SERVICES Current monthly transaction volume bucket in USD
Whether the business transacts on behalf of other parties
Whether the business operates in or serves customers from restricted regions
Timestamp field.
Timestamp field.
Product name
HTTP link to the product / business website
Description of product
Phone number field.
\+[1-9][0-9]{0,3}[0-9]{7,14}HTTP link to business image logo
Operating address, when different from the registered address
Free-text list of restricted regions, when applicable
Show child attributes
Show child attributes
Show child attributes
Show child attributes
BVNs of authorised signatories (Nigerian-registered entities)
Show child attributes
Show child attributes
Timestamp field.