Skip to main content
GET
Get CEX Profile
Returns general information about the API, including current status and version.

Authorizations

x-api-key
string
header
required

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 seconds
  • x-signature: SHA256 HMAC HEX signature calculated over t={x-timestamp}&{requestBody} using your API Secret.

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"

businessEmail
string<email>
required

Business profile email address

businessLocation
string
required

business full location address

businessRegNo
string
required

Business registration number (if any)

businessRegCountry
string
required

Business country of registration (if any)

businessFormationDate
string<date>
required

Date the business entity was formed

businessIndustry
enum<string>
required

Sector the business primarily operates in

Available options:
TECHNOLOGY_SOFTWARE,
FINANCIAL_SERVICES,
ECOMMERCE,
MARKETING_ADVERTISING,
CONSULTING_PROFESSIONAL_SERVICES,
EDUCATION,
HEALTHCARE,
MANUFACTURING,
LOGISTICS_SUPPLY_CHAIN,
REAL_ESTATE,
CRYPTO_WEB3,
GAMING,
MEDIA_ENTERTAINMENT,
OTHER
taxCountry
string
required

Tax residency country, Valid alpha2 country code

Required string length: 2
taxIdentificationNumber
string
required

Business tax identification number (TIN)

Legal structure of the business entity (KYB "Business type (Entity)")

Available options:
LIMITED_LIABILITY_COMPANY,
PUBLIC_COMPANY,
SOLE_PROPRIETORSHIP,
PARTNERSHIP,
CORPORATION,
TRUST,
PRIVATE_FOUNDATION,
CHARITY,
NON_PROFIT_ORGANIZATION,
PUBLIC_AGENCY
businessCategory
enum<string>
required

KYB onboarding tier that determines the required document set

Available options:
GENERAL_BUSINESS,
OTC_FX_LIQUIDITY_PROVIDER,
LICENSED_FINANCIAL_SERVICES
monthlyTransactionVolume
string
required

Current monthly transaction volume bucket in USD

transactsOnBehalfOfThirdParties
boolean
required

Whether the business transacts on behalf of other parties

operatesInRestrictedRegions
boolean
required

Whether the business operates in or serves customers from restricted regions

createdAt
string<date-time>
required

Timestamp field.

updatedAt
string<date-time>
required

Timestamp field.

productName
string

Product name

productWebsiteUrl
string<url>

HTTP link to the product / business website

productDescription
string

Description of product

businessPhoneNumber
string

Phone number field.

Pattern: \+[1-9][0-9]{0,3}[0-9]{7,14}
businessLogoUrl
string<url>

HTTP link to business image logo

businessType
string
enabledProducts
string[]
operatingAddress
string

Operating address, when different from the registered address

restrictedRegions
string

Free-text list of restricted regions, when applicable

ultimateBeneficialOwners
object[]
directors
object[]
authorisedSignatories
string[]

BVNs of authorised signatories (Nigerian-registered entities)

documents
object[]
declarationAcceptedAt
string<date-time>

Timestamp field.