Skip to navigation
API ReferenceKYB Requests

Submit a KYB request

Creates a company KYB request on behalf of a user identified by their email.

  • If the user exists, the admin request is created and immediately unblocked (user_verified: true).
  • If the user does not exist, a draft account is created, a verification email is sent, and the admin request is blocked (user_verified: false).

Authentication

Authorizationstring

Pass your API key as Api-Key <your_api_key> in the Authorization header. API keys are issued per Project by the TREVEX team.

Request

This endpoint expects an object.
user_emailstringRequiredformat: "email"
Email of the person submitting the KYB request.
registered_company_namestringRequired
Legal registered name of the company.
country_codestringRequired=2 characters

ISO 3166-1 alpha-2 country code.

user_namestringOptional
Full name. Used only when creating a new account.
user_mobilestringOptional
Mobile number. Used only when creating a new account.
companyIDstringOptional

TREVEX company ID in the format TRXAE0000042. Omit or use "NEW_COMPANY" for a new unlisted company.

license_nostringOptional
registration_bodystringOptional

Issuing authority, e.g. DED, ADCCI.

trade_licensestringOptional

URL returned by upload_document, or any accessible document URL.

industry_sectorstringOptional
industry_industry_groupstringOptional
industry_industrystringOptional
industry_sub_industrystringOptional

Legacy single sub-industry. Prefer sub_industries.

sub_industrieslist of objects or stringsOptional

Preferred industry classification. Each item is {label, value}, or a plain string (in which case a slug ID is auto-generated from the label).

auth_sign_namestringOptional
auth_sign_designationstringOptional
auth_sign_work_emailstringOptionalformat: "email"
auth_sign_work_mobilestringOptional
auth_sign_nationalitystringOptional=2 characters

ISO 3166-1 alpha-2 nationality code. Must be exactly 2 characters.

auth_sign_authorized_signatorystringOptional
address_address_line_1stringOptional
address_address_line_2stringOptional
address_areastringOptional
address_citystringOptional
address_statestringOptional
address_countrystringOptional
address_postal_codestringOptional
address_telephonestringOptional
address_emailstringOptionalformat: "email"
address_working_hoursstringOptional

Response

KYB request submitted successfully.
statusCodeintegerOptional
request_idstringOptional
Unique KYB request reference. Store this for status polling and webhook matching.
messagestringOptional
user_verifiedbooleanOptional

false if a new account is being created. The KYB request is blocked until email verification.

Errors

400
Bad Request Error
409
Conflict Error