Skip to main content
POST
Register a KYB document

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

customer
string<uuid>
required

Body

application/json
type
enum<string>
required

Document type. Determines whether the document satisfies the formation-document requirement at submit time.

Available options:
CERTIFICATE_OF_INCORPORATION,
ARTICLES_OF_INCORPORATION,
BENEFICIAL_OWNERSHIP_CERTIFICATE,
INCORPORATION_DOCUMENTS,
CAC_STATUS_REPORT,
ACCOUNT_AGREEMENT,
PROOF_OF_ADDRESS,
BANK_STATEMENT,
LICENSE,
SHARE_REGISTRATION,
COMPANY_OWNERSHIP_STRUCTURE,
DIRECTORS_REGISTER,
OTHER
Example:

"CERTIFICATE_OF_INCORPORATION"

name
string
required
Maximum string length: 255
Example:

"Acme Inc — Certificate of Incorporation.pdf"

file_id
string<uuid>
required

The file_id returned by POST /api/external/customer/{customer}/document/presigned-url.

description
string | null
Maximum string length: 2000
Example:

"Filed 2019-03-12, Companies House"

Response

Document registered.