Skip to main content

Create Company

Requirements

KYB Schema​

Recommended KYB integration & use schema is provided below.

KYB Integration Schema

Check Flow​

To know what data should be provided for the form, flow information should be reviewed. This can be done by calling KYB Token Retrieve endpoint.

KYB Token Retrieve - retrieves flow information related to the specific KYB token, detailing the data required for form submission

Retrieve KYB session info

Various info for KYB session.

Authorizations:
KYB token auth

Responses

Response samples

Content type
application/json
{
  • "locale": "en",
  • "theme": {
    },
  • "flow": {
    }
}
note

This step could be skipped if the same flow is used, as similar data fields should be provided.

Form Creation​

Create KYB Form by sending request to the endpoint shared below.

Create KYB form - creates a new KYB form linked to the generated KYB token for capturing and submitting necessary compliance information

Create new KYB form

Authorizations:
KYB token auth
Request Body schema: application/json
required
required
object (CompanyInfoRequest)
Array of objects (KybFormDocumentCreateRequest)
Array of any (BeneficiaryRequest)
object (ClientSystemRequest)

Responses

Request samples

Content type
application/json
{
  • "company": {
    },
  • "documents": [
    ],
  • "beneficiaries": [
    ],
  • "clientSystem": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "company": {
    },
  • "documents": [
    ],
  • "beneficiaries": [
    ],
  • "clientSystem": {
    },
  • "meta": {
    }
}

After the form is created, it is possible to call:

Info Retrieve - retrieves detailed information about an active KYB session, including various aspects of the company's compliance and verification process

Retrieve KYB form info

Authorizations:
KYB token authAPI key pair
path Parameters
id
required
string

A unique value identifying this company.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "company": {
    },
  • "documents": [
    ],
  • "beneficiaries": [
    ],
  • "clientSystem": {
    },
  • "meta": {
    }
}
Form Update - updates information on an existing KYB form

Update KYB form info

Authorizations:
KYB token authAPI key pair
path Parameters
id
required
string

A unique value identifying this company.

Request Body schema: application/json
required
required
object (CompanyInfoRequest)
object (ClientSystemRequest)

Responses

Request samples

Content type
application/json
{
  • "company": {
    },
  • "clientSystem": {
    }
}

Response samples

Content type
application/json
{
  • "company": {
    },
  • "clientSystem": {
    }
}
Form Partial Update - partially updates specific sections of an existing KYB form

Partially update KYB form info

Authorizations:
KYB token authAPI key pair
path Parameters
id
required
string

A unique value identifying this company.

Request Body schema: application/json
object (CompanyInfoRequest)
object (ClientSystemRequest)

Responses

Request samples

Content type
application/json
{
  • "company": {
    },
  • "clientSystem": {
    }
}

Response samples

Content type
application/json
{
  • "company": {
    },
  • "clientSystem": {
    }
}

It is possible to receive a list with KYB forms associated with a particular KYB token. There can be one or zero items in the list, indicating that the KYB form was or was not created.

List KYB forms - lists all KYB forms associated with a particular KYB token, indicating whether a form has been created.

List KYB forms

List KYB forms associated with KYB token. There can be one or zero items in the list, indicating that the KYB form was or was not created.

Authorizations:
KYB token auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Documents​

It is possible to manage documents within the KYB form/company. Available endpoints are dedicated to:

List all available documents - lists all documents associated with the KYB form/company

List documents

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
query Parameters
type
Array of strings
Items Enum: "ANNUAL_REPORT" "BANK_STATEMENT" "COMPANY_ADVERSE_MEDIA" "DIRECTORS_REGISTRY" "DIRECTOR_CERT" "DIRECTOR_ONLINE_PRESENCE" "EMAIL_CHECK" "E_SIGNATURE_CERT" "GOOD_STANDING_CERT" "INCORPORATION_ARTICLES" "INCORPORATION_CERT" "INCUMBENCY_CERT" "INDIVIDUAL_ADVERSE_MEDIA" "INFORMATION_STATEMENT" "INVOICE" "NAME_CHANGE_PROOF" "ONLINE_PRESENCE" "ORG_CHART" "OTHER" "OWNERSHIP_STRUCTURE" "PROOF_OF_ADDRESS" "PROOF_OF_DOMAIN" "SHAREHOLDER_CERT" "SHAREHOLDER_ONLINE_PRESENCE" "SHAREHOLDER_REGISTRY" "SOURCE_OF_FUNDS" "SOURCE_OF_WEALTH" "STATE_REGISTRY" "TRADING_STATUS_PROOF" "TRUST_AGREEMENT" "UBO_CERT" "UBO_REGISTRY" "WEBSITE_OVERVIEW"

Multiple values may be separated by commas.

type_Exclude
Array of strings
Items Enum: "ANNUAL_REPORT" "BANK_STATEMENT" "COMPANY_ADVERSE_MEDIA" "DIRECTORS_REGISTRY" "DIRECTOR_CERT" "DIRECTOR_ONLINE_PRESENCE" "EMAIL_CHECK" "E_SIGNATURE_CERT" "GOOD_STANDING_CERT" "INCORPORATION_ARTICLES" "INCORPORATION_CERT" "INCUMBENCY_CERT" "INDIVIDUAL_ADVERSE_MEDIA" "INFORMATION_STATEMENT" "INVOICE" "NAME_CHANGE_PROOF" "ONLINE_PRESENCE" "ORG_CHART" "OTHER" "OWNERSHIP_STRUCTURE" "PROOF_OF_ADDRESS" "PROOF_OF_DOMAIN" "SHAREHOLDER_CERT" "SHAREHOLDER_ONLINE_PRESENCE" "SHAREHOLDER_REGISTRY" "SOURCE_OF_FUNDS" "SOURCE_OF_WEALTH" "STATE_REGISTRY" "TRADING_STATUS_PROOF" "TRUST_AGREEMENT" "UBO_CERT" "UBO_REGISTRY" "WEBSITE_OVERVIEW"

Multiple values may be separated by commas.

Responses

Response samples

Content type
application/json
[
  • {
    }
]
Add new document - uploads a new document to the KYB form/company

Add new document

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
Request Body schema: application/json
required
type
required
string (KybDocumentTypeEnum)
Enum: "INCORPORATION_CERT" "DIRECTOR_CERT" "SHAREHOLDER_CERT" "UBO_CERT" "INCORPORATION_ARTICLES" "SHAREHOLDER_REGISTRY" "DIRECTORS_REGISTRY" "STATE_REGISTRY" "UBO_REGISTRY" "OWNERSHIP_STRUCTURE" "INCUMBENCY_CERT" "TRUST_AGREEMENT" "INFORMATION_STATEMENT" "GOOD_STANDING_CERT" "PROOF_OF_DOMAIN" "PROOF_OF_ADDRESS" "SOURCE_OF_FUNDS" "BANK_STATEMENT" "INVOICE" "ONLINE_PRESENCE" "DIRECTOR_ONLINE_PRESENCE" "SHAREHOLDER_ONLINE_PRESENCE" "WEBSITE_OVERVIEW" "E_SIGNATURE_CERT" "ANNUAL_REPORT" "NAME_CHANGE_PROOF" "TRADING_STATUS_PROOF" "ORG_CHART" "COMPANY_ADVERSE_MEDIA" "INDIVIDUAL_ADVERSE_MEDIA" "EMAIL_CHECK" "SOURCE_OF_WEALTH" "OTHER"
filename
string or null <= 100 characters
file
required
string <byte>

Base64 encoded document file. Can be: jpeg, jpg, png, gif, webp, heic, heif, pdf files.

Responses

Request samples

Content type
application/json
{
  • "type": "INCORPORATION_CERT",
  • "filename": "string",
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "INCORPORATION_CERT",
  • "filename": "string",
  • "file": "http://example.com"
}
Retrieve particular document - retrieves a specific document linked to the KYB form/company

Retrieve document

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "INCORPORATION_CERT",
  • "filename": "string",
  • "file": "http://example.com"
}
Update document - updates an existing document within the KYB form/company

Update document

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Request Body schema: application/json
required
type
required
string (KybDocumentTypeEnum)
Enum: "INCORPORATION_CERT" "DIRECTOR_CERT" "SHAREHOLDER_CERT" "UBO_CERT" "INCORPORATION_ARTICLES" "SHAREHOLDER_REGISTRY" "DIRECTORS_REGISTRY" "STATE_REGISTRY" "UBO_REGISTRY" "OWNERSHIP_STRUCTURE" "INCUMBENCY_CERT" "TRUST_AGREEMENT" "INFORMATION_STATEMENT" "GOOD_STANDING_CERT" "PROOF_OF_DOMAIN" "PROOF_OF_ADDRESS" "SOURCE_OF_FUNDS" "BANK_STATEMENT" "INVOICE" "ONLINE_PRESENCE" "DIRECTOR_ONLINE_PRESENCE" "SHAREHOLDER_ONLINE_PRESENCE" "WEBSITE_OVERVIEW" "E_SIGNATURE_CERT" "ANNUAL_REPORT" "NAME_CHANGE_PROOF" "TRADING_STATUS_PROOF" "ORG_CHART" "COMPANY_ADVERSE_MEDIA" "INDIVIDUAL_ADVERSE_MEDIA" "EMAIL_CHECK" "SOURCE_OF_WEALTH" "OTHER"
filename
string or null <= 100 characters

Responses

Request samples

Content type
application/json
{
  • "type": "INCORPORATION_CERT",
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "INCORPORATION_CERT",
  • "filename": "string",
  • "file": "http://example.com"
}
Partially update document - partially updates a document in the KYB form/company

Partially update document

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Request Body schema: application/json
type
string (KybDocumentTypeEnum)
Enum: "INCORPORATION_CERT" "DIRECTOR_CERT" "SHAREHOLDER_CERT" "UBO_CERT" "INCORPORATION_ARTICLES" "SHAREHOLDER_REGISTRY" "DIRECTORS_REGISTRY" "STATE_REGISTRY" "UBO_REGISTRY" "OWNERSHIP_STRUCTURE" "INCUMBENCY_CERT" "TRUST_AGREEMENT" "INFORMATION_STATEMENT" "GOOD_STANDING_CERT" "PROOF_OF_DOMAIN" "PROOF_OF_ADDRESS" "SOURCE_OF_FUNDS" "BANK_STATEMENT" "INVOICE" "ONLINE_PRESENCE" "DIRECTOR_ONLINE_PRESENCE" "SHAREHOLDER_ONLINE_PRESENCE" "WEBSITE_OVERVIEW" "E_SIGNATURE_CERT" "ANNUAL_REPORT" "NAME_CHANGE_PROOF" "TRADING_STATUS_PROOF" "ORG_CHART" "COMPANY_ADVERSE_MEDIA" "INDIVIDUAL_ADVERSE_MEDIA" "EMAIL_CHECK" "SOURCE_OF_WEALTH" "OTHER"
filename
string or null <= 100 characters

Responses

Request samples

Content type
application/json
{
  • "type": "INCORPORATION_CERT",
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "INCORPORATION_CERT",
  • "filename": "string",
  • "file": "http://example.com"
}
Delete document - deletes a document associated with the KYB form/company

Delete document

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Responses

Beneficiaries​

It is possible to manage beneficiaries within the KYB form/company. Available endpoints are dedicated to:

List beneficiaries - lists all beneficiaries linked to the KYB form/company.

List beneficiaries

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]
Add new beneficiary - adds a new beneficiary to the KYB form/company.

Add new beneficiary

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
Request Body schema: application/json
parent
string or null non-empty
beneficiaryType
required
string (BeneficiaryTypeEnum)
required
any (RepresentativeInfoCreateRequest)
positions
Array of strings <= 3 items [ items [ 1 .. 50 ] characters ^[^,]+$ ]
Default: []

Positions of the beneficiary. Can be shareholder, director, or any other position.

formFiller
boolean

Indicates whether this beneficiary is the filler of the KYB form.

Responses

Request samples

Content type
application/json
Example
{
  • "parent": "string",
  • "beneficiaryType": "CEO",
  • "info": {
    },
  • "positions": [ ],
  • "formFiller": true
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "parent": "string",
  • "beneficiaryType": "CEO",
  • "info": {
    },
  • "positions": [ ],
  • "formFiller": true
}
Retrieve particular beneficiary - retrieves information on a specific beneficiary within the KYB form/company

Retrieve beneficiary

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this beneficiary.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "parent": "string",
  • "beneficiaryType": "CEO",
  • "info": {
    },
  • "positions": [ ],
  • "formFiller": true,
  • "meta": {
    }
}
Update beneficiary - updates details of an existing beneficiary

Update beneficiary

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this beneficiary.

Request Body schema: application/json
beneficiaryType
required
string (BeneficiaryTypeEnum)
required
any (RepresentativeInfoRequest)
positions
Array of strings <= 3 items [ items [ 1 .. 50 ] characters ^[^,]+$ ]
Deprecated
Default: []

Positions of the beneficiary. Can be shareholder, director, or any other position.

formFiller
boolean

Indicates whether this beneficiary is the filler of the KYB form.

Responses

Request samples

Content type
application/json
Example
{
  • "beneficiaryType": "CEO",
  • "info": {
    },
  • "positions": [ ],
  • "formFiller": true
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "parent": "string",
  • "beneficiaryType": "CEO",
  • "info": {
    },
  • "positions": [ ],
  • "formFiller": true,
  • "meta": {
    }
}
Partially update beneficiary - partially updates information of a specific beneficiary

Partially update beneficiary

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this beneficiary.

Request Body schema: application/json
beneficiaryType
string (BeneficiaryTypeEnum)
any (RepresentativeInfoRequest)
positions
Array of strings <= 3 items [ items [ 1 .. 50 ] characters ^[^,]+$ ]
Deprecated
Default: []

Positions of the beneficiary. Can be shareholder, director, or any other position.

formFiller
boolean

Indicates whether this beneficiary is the filler of the KYB form.

Responses

Request samples

Content type
application/json
Example
{
  • "beneficiaryType": "CEO",
  • "info": {
    },
  • "positions": [ ],
  • "formFiller": true
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "parent": "string",
  • "beneficiaryType": "CEO",
  • "info": {
    },
  • "positions": [ ],
  • "formFiller": true,
  • "meta": {
    }
}
Delete beneficiary - removes a beneficiary from the KYB form/company

Delete beneficiary

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this beneficiary.

Responses

Beneficiaries' Documents​

It is possible to manage beneficiaries' documents using available endpoints to:

List beneficiary documents - lists all documents related to a specific beneficiary within the KYB form/company

List beneficiary documents

Authorizations:
KYB token authAPI key pair
path Parameters
beneficiaryId
required
string
companyId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]
Add new beneficiary document - uploads a new document for a beneficiary

Add new beneficiary document

Authorizations:
KYB token authAPI key pair
path Parameters
beneficiaryId
required
string
companyId
required
string
Request Body schema: application/json
One of
type
required
string (IndividualKybDocTypeEnum)
Enum: "IDENTITY_DOCUMENT" "PROOF_OF_ADDRESS" "OTHER"
filename
string or null <= 100 characters
file
required
string <byte>

Base64 encoded document file. Can be: jpeg, jpg, png, gif, webp, heic, heif, pdf files.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "IDENTITY_DOCUMENT",
  • "filename": "string",
  • "file": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "type": "IDENTITY_DOCUMENT",
  • "filename": "string",
  • "file": "http://example.com"
}
Retrieve particular beneficiary document - retrieves a specific document associated with a beneficiary

Retrieve beneficiary document

Authorizations:
KYB token authAPI key pair
path Parameters
beneficiaryId
required
string
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "type": "IDENTITY_DOCUMENT",
  • "filename": "string",
  • "file": "http://example.com"
}
Update beneficiary document - updates an existing document for a beneficiary

Update beneficiary document

Authorizations:
KYB token authAPI key pair
path Parameters
beneficiaryId
required
string
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Request Body schema: application/json
One of
type
required
string (IndividualKybDocTypeEnum)
Enum: "IDENTITY_DOCUMENT" "PROOF_OF_ADDRESS" "OTHER"
filename
string or null <= 100 characters

Responses

Request samples

Content type
application/json
Example
{
  • "type": "IDENTITY_DOCUMENT",
  • "filename": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "type": "IDENTITY_DOCUMENT",
  • "filename": "string",
  • "file": "http://example.com"
}
Partially updates a beneficiary’s document.

Partially update beneficiary document

Authorizations:
KYB token authAPI key pair
path Parameters
beneficiaryId
required
string
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Request Body schema: application/json
One of
type
string (IndividualKybDocTypeEnum)
Enum: "IDENTITY_DOCUMENT" "PROOF_OF_ADDRESS" "OTHER"
filename
string or null <= 100 characters

Responses

Request samples

Content type
application/json
Example
{
  • "type": "IDENTITY_DOCUMENT",
  • "filename": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "type": "IDENTITY_DOCUMENT",
  • "filename": "string",
  • "file": "http://example.com"
}
Deletes a document linked to a beneficiary

Delete beneficiary document

Authorizations:
KYB token authAPI key pair
path Parameters
beneficiaryId
required
string
companyId
required
string
id
required
string

A unique value identifying this KYB Document.

Responses

Questionnaires​

Questionnaire can be added to the flow, to check whether the form requires the questionnaire to be filled out, use endpoints:

Questionnaire list - lists all available questionnaires associated with the KYB form flow

List questionnaires

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]
Retrieve specific questionnaire - retrieves a particular questionnaire within the KYB process

Retrieve questionnaire

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this questionnaire.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "name": "string",
  • "title": "string",
  • "description": "",
  • "type": "KYC",
  • "sections": [
    ]
}

if there's a need to fill it out, the following endpoints can be used to:

Updates the answers to a questionnaire

Update questionnaire answers

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this questionnaire.

Request Body schema: application/json
required
required
object
pattern property
object

Section keys from a questionnaire.

pattern property
object (QuestionnaireAnswersQuestionRequest)

Question keys from a questionnaire.

value
required
any or null

Question answer. Value depends on the question type.

Responses

Request samples

Content type
application/json
{
  • "sections": { }
}

Response samples

Content type
application/json
{
  • "sections": { }
}
Retrieves the answers provided in a questionnaire

Retrieve questionnaire answers

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this questionnaire.

Responses

Response samples

Content type
application/json
{
  • "sections": { }
}
Retrieves all completed questionnaire answers for a form

Retrieve all questionnaires' answers

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]
Deletes answers provided in a questionnaire

Delete questionnaire answers

Authorizations:
KYB token authAPI key pair
path Parameters
companyId
required
string
id
required
string

A unique value identifying this questionnaire.

Responses

Form Submit​

When the form is filled, it can be submitted:

Submit Form - submits the completed KYB form for review and processing

Submit KYB form

Submit a filled KYB form for review.

The form will be submitted and you will not be able to edit this KYB form any further unless additional information will be requested during a manual review.

After submission, automatic blacklist and automation processes are executed. Then this KYB form will be reviewed by humans. After manual review, you may receive a webhook callback.

Authorizations:
KYB token auth
path Parameters
id
required
string

A unique value identifying this company.

Responses

receiving webhook

Once the form is submited, a webhook notification will be sent to your endpoint.