NEnestechops
exchange-external-api

Get CEX Profile

Changed on
get/exchange/api/info

Request

Response

Success

businessNamestring required

Registered name of business entity

businessPhoneNumberstring

Phone number field.

businessFormationDatestring date required

Date the business entity was formed

businessLogoUrlstring url

HTTP link to business image logo

businessRegCountrystring required

Business country of registration (if any), Valid alpha2 country code

businessLocationstring required

business full location address

productNamestring

product name

productWebsiteUrlstring url

HTTP link to product website

productDescriptionstring

Description of product

operatingAddressstring

Operating address, when different from the registered address

taxCountrystring required

Tax residency country, Valid alpha2 country code

taxIdentificationNumberstring required

Business tax identification number (TIN)

legalEntityType'LIMITED_LIABILITY_COMPANY' | 'PUBLIC_COMPANY' | 'SOLE_PROPRIETORSHIP' | 'PARTNERSHIP' | 'CORPORATION' | 'TRUST' | 'PRIVATE_FOUNDATION' | 'CHARITY' | 'NON_PROFIT_ORGANIZATION' | 'PUBLIC_AGENCY' required

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

businessIndustry'TECHNOLOGY_SOFTWARE' | 'FINANCIAL_SERVICES' | 'ECOMMERCE' | 'MARKETING_ADVERTISING' | 'CONSULTING_PROFESSIONAL_SERVICES' | 'EDUCATION' | 'HEALTHCARE' | 'MANUFACTURING' | 'LOGISTICS_SUPPLY_CHAIN' | 'REAL_ESTATE' | 'CRYPTO_WEB3' | 'GAMING' | 'MEDIA_ENTERTAINMENT' | 'OTHER' required

Sector the business primarily operates in

businessCategory'GENERAL_BUSINESS' | 'OTC_FX_LIQUIDITY_PROVIDER' | 'LICENSED_FINANCIAL_SERVICES' required

KYB onboarding tier that determines the required document set

monthlyTransactionVolumestring required

Monthly transaction volume bucket in USD (current for Tally applications, expected for Vetting Office contract v2)

transactsOnBehalfOfThirdPartiesboolean required

Whether the business transacts on behalf of other parties

operatesInRestrictedRegionsboolean required

Whether the business operates in or serves customers from restricted regions

restrictedRegionsstring

Free-text list of restricted regions, when applicable

tradingNamestring

Optional "doing business as" name

onboardUseCasesstring[]

What the business will use Onboard for

holdsLicenceboolean

Whether the business holds a licence or regulatory registration

flowOfFundsExplanationstring

Written flow of funds, accepted instead of a diagram

authorisedSignatoriesstring[]

BVNs of authorised signatories (Nigerian-registered entities)

businessIdstring uuid required

General format for UUID

businessEmailstring email required

Business profile email address

businessRegNostring required

Business registration number (if any)

businessTypestring
enabledProductsstring[]
declarationAcceptedAtstring date-time

Timestamp field.

isDisabledboolean

Whether the business is disabled (blacklisted). A disabled business's users, API keys and partner tokens are refused.

disabledAtstring date-time

Timestamp field.

disabledBystring

userId of the admin who last disabled the business

disabledReasonstring

Admin-supplied reason for the last disable

reenabledAtstring date-time

Timestamp field.

reenabledBystring

userId of the admin who last re-enabled the business

createdAtstring date-time required

Timestamp field.

updatedAtstring date-time required

Timestamp field.

Example response

{
  "businessName": "Onboard exchange",
  "productDescription": "Fun Media",
  "businessId": "3a5aaea8-504a-4404-ad3d-b82574fba5e5"
}

Changes

  • 541ad1a5adf2Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 17a757ababf9Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status