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>'
{
  "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>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.onboard.xyz/llms.txt

Use this file to discover all available pages before exploring further.

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[]