Simplified customer import

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

communicationNumber

string

required

Unique number of communication. It is used for risk assessment callback.

Maximum string length: 255

customerExtId

string

required

Unique external customer identifier. This identifier corresponds to the client's identifier in the financial institution.

Example:

"019a5d1b-8c4f-770b-ad70-2f2a6c88aeda"

customerStatus

enum<string>

required

Customer's predefined status represents the current standing or state of a customer's relationship with a business or organization.

PENDING - Customer application is received but not yet prepared for upcoming workflow
ACTIVE - Customer is onboarded and ready for workflow
REJECTED- the customer was rejected before account was opened
SUSPENDED - Customer's activities for some reasons are restricted
CLOSED - Customer's profile is disabled

Available options:

ACTIVE,

CLOSED,

PENDING,

REJECTED,

SUSPENDED

entityType

enum<string>

required

Entity type. This field is not mandatory if listBusinessEntityDocument field is not provided at all.

Available options:

INDIVIDUAL,

ORGANIZATION

requester

string

required

Name of the system requesting web service.

Maximum string length: 100

riskManagementCategory

string

required

Code of risk management category of the object. Value must be from a classifier list personalized to your company.

activityDescription

string

Description of entity activity.

Maximum string length: 32768

Example:

"Financial activity"

activityInRestrictedRegionDescription

string

Description of entity activity.

Maximum string length: 32768

amlOfficer

boolean

Indicator for the person being AML officer.

applicationDate

string<date-time>

Date when customer first applied.

approvalDate

string<date-time>

Date of application approval - onboarding date.

birthCountry

string

Country of birth country of the individual entity.

birthDate

string<date-time>

Date of birth of the individual entity

businessUnit

string

Mandatory field for clients utilizing a multi-organizational solution. It serves to specify the unique identifier for the business unit.

citizenshipCountry

string

Country of citizenship of individual entity.

closingDate

string<date-time>

❗Mandatory only when customerStatus = CLOSED. Not used when customerStatus is PENDING, ACTIVE, REJECTED or SUSPENDED.

companyAssetValue

integer

Value of companies assets.

doesCashDominate

boolean

Indicator for cash being the main income source.

establishmentDate

string<date-time>

Date of establishment of the organization.

firstName

string

First name of individual entity. ❗This field is mandatory when entityType is INDIVIDUAL.

giin

string

Global intermediary identification number.

hasMultiLayerStructure

boolean

Check for multi-layer organizational structure.

incomeSourceDescription

string

Description of income source.

Maximum string length: 32768

incomingPaymentDescription

string

Description of incoming payment operation.

initialDepositAccount

string

Account of initial deposit.

Maximum string length: 200

initialDepositAmount

number<double>

Initial deposit amount.

initialDepositBank

string

Bank of initial deposit.

Maximum string length: 200

initialDepositCurrency

string

Initial deposit currency. Taken from /classifier/currency endpoint.

initialDepositSource

string

Source of initial deposit.

Maximum string length: 200

initializeScreeningProcesses

string[]

Defines which lists to check during screening process. Strings of the list are noted in the dropdown below.

isActualAddressDeclared

boolean

Whether entity's actual address is declared.

isAudited

boolean

Indicator for the business entity is audited.

isCorrespondenceAddressDeclared

boolean

Whether entity's correspondence address is declared.

isDirectlyManaged

boolean

Whether entity is managed directly.

isFamilyPEP

boolean

Identification of whether a family member of an individual entity is politically exposed.

isFinancialInstitution

boolean

Whether entity is a financial institution.

isFined

boolean

Indicator for the business entity is fined.

isInAdverseMedia

boolean

An indication of the existence of information on adverse media about the entity.

isInInternalList

boolean

An indication of the existence of information on internal list about the entity.

isLegalResident

boolean

Indicator for whether individual entity is a legal resident.

isLicenseRequired

boolean

Whether entity activity requires license.

isListed

boolean

Indicator for the business entity is listed in stock exchange companies.

isLitigated

boolean

Indicator if the customer is being litigated.

isPEP

boolean

Identification for whether a person is politically exposed.

isRegulated

boolean

Indicator for the business entity being regulated by third-party authorities.

isSanctioned

boolean

Identification for whether a person is sanctioned.

lastName

string

Last name of individual entity. ❗This field is mandatory when entityType is INDIVIDUAL.

legalForm

string

Legal form of the organization.

lei

string

LEI stands for Legal Entity Identifier, which is a unique code used to identify legal entities that participate in financial transactions.

licenseDescription

string

Business entities license description.

Maximum string length: 32768

listAddress

object[]

Show child attributes

listBusinessEntityDocument

object[]

Show child attributes

listContact

object[]

Show child attributes

listPurpose

enum<string>

Indicator whether entity is white/black listed.

Available options:

BLACK,

WHITE

nationalCode

string

National code or national identification number of individual. If a country does not issue national code, any other unique identifier can be used: Passport number, Social security number of person, A number of taxpayer or registration certificate of the company, etc.

Maximum string length: 100

Whether entity has no major shareholders involved.

numberOfAudits

integer

The number of times a business entity has been audited

numberOfEmployees

integer

Number of employees.

organizationalStructureDescription

string

Description of organizational structure.

Maximum string length: 32768

periodsOfAuditsInYears

integer

The number of years that are in question for being audited.

periodsOfFiningInYears

integer

The number of years that are in question for being fined.

placeOfBirth

string

Place of birth of individual entity.

regionOfActivityDescription

string

Description of the region for activities.

Maximum string length: 32768

registrationCountry

string

Country of registration of organization entity. Value taken from /classifier/country endpoint

riskLevel

enum<string>

Predefined risk level of imported customer.

Available options:

EXTREME,

HIGH,

LOW,

MEDIUM,

NONE

sourceOfRiskLevel

enum<string>

The value EVALUATE is used for initiating a customer risk assessment. The value IMPORT should be used for migration only - the customer and it's questionnaire will be imported without risk assessment.

Available options:

EVALUATE,

IMPORT

thirdPartyServicesUsed

boolean

Whether entity is using third-party services.

thirdPartyServicesUsedDescription

string

Description of third-party services used by entity.

Maximum string length: 32768

title

string

Title of organization entity.

Response

errorCode

string

errorDescription

string

resultType

enum<string>

Available options:

REQUEST_ACCEPTED,

REQUEST_REJECTED

API Reference

Endpoints

Webhooks

Simplified customer import

Authorizations

Body

Response