Submit a KYB profile

View as Markdown

Submits Know-Your-Business details for the acting company. The result is asynchronous — listen for the company.kyb_status_changed webhook.

Authentication

X-API-Keystring
Your partner API key.

Headers

X-Company-IdstringRequired

The company you are acting for (a company ULID).

Request

This endpoint expects an object.
companyNamestringRequired
industrystringRequired

A NAICS industry code (not free text).

registrationCountrystringRequired
registrationNumberstringRequired
uboFirstNamestringRequired
uboLastNamestringRequired
uboGenderenumRequired
uboCountryCodestringRequired=2 characters
uboIdTypeenumRequired
uboIdNumberstringRequired
uboDobdateRequired
websitestringOptionalformat: "uri"

Response

KYB profile submitted
statusstringOptional

Errors

422
Unprocessable Entity Error