Skip to main content
GET
/
exchange
/
api
/
info
Get CEX Profile
curl --request GET \
  --url https://external.dev.onboardpay.co/exchange/api/info \
  --header 'x-auth-token: <api-key>'
import requests

url = "https://external.dev.onboardpay.co/exchange/api/info"

headers = {"x-auth-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://external.dev.onboardpay.co/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://external.dev.onboardpay.co/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-auth-token: <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://external.dev.onboardpay.co/exchange/api/info"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-auth-token", "<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://external.dev.onboardpay.co/exchange/api/info")
.header("x-auth-token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://external.dev.onboardpay.co/exchange/api/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "businessId": "3a5aaea8-504a-4404-ad3d-b82574fba5e5",
  "businessName": "Onabord exchange",
  "businessLocation": "<string>",
  "businessWebsiteUrl": "<string>",
  "businessPhoneNumber": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "businessEmail": "[email protected]",
  "businessRegNo": "<string>",
  "businessRegCountry": "<string>",
  "businessLogoUrl": "<string>",
  "businessFormationDate": "2023-12-25",
  "businessType": "<string>",
  "businessIndustry": "<string>",
  "enabledProducts": [
    "<string>"
  ]
}
{
"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

x-auth-token
string
header
required

Response

Success

CEX user profile object

businessId
string<uuid>
required

General format for UUID

Example:

"3a5aaea8-504a-4404-ad3d-b82574fba5e5"

businessName
string
required

Registered name of business entity

Example:

"Onabord exchange"

businessLocation
string
required

business full location address

businessWebsiteUrl
string<url>
required

HTTP link to business website

businessPhoneNumber
string
required

Phone number field.

Pattern: \+[1-9][0-9]{0,3}[0-9]{7,14}
createdAt
string<date-time>
required

Timestamp field.

updatedAt
string<date-time>
required

Timestamp field.

businessEmail
string<email>

Business profile email address

businessRegNo
string

Business registration number (if any)

businessRegCountry
string

Business country of registration (if any)

businessLogoUrl
string<url>

HTTP link to business image logo

businessFormationDate
string<date>

Date the business entity was formed

businessType
string
businessIndustry
string
enabledProducts
string[]