{
"errorCode": "<string>",
"errorDescription": "<string>",
"resultType": "REQUEST_ACCEPTED"
}{
"resultType": "REQUEST_REJECTED",
"errorCode": "O001",
"errorDescription": "CommunicationNumber already used in AMLYZE"
}{
"timestamp": "2024-05-26T16:49:50.237+00:00",
"status": 404,
"error": "Not Found",
"path": "/amlyze-ws-rest/simplifiedCustomer"
}{
"resultType": "REQUEST_REJECTED",
"status": 500,
"error": "Internal Server Error"
}Simplified customer import
This section provides information on how to generate a Simplified Customer for individuals or organizations.
{
"errorCode": "<string>",
"errorDescription": "<string>",
"resultType": "REQUEST_ACCEPTED"
}{
"resultType": "REQUEST_REJECTED",
"errorCode": "O001",
"errorDescription": "CommunicationNumber already used in AMLYZE"
}{
"timestamp": "2024-05-26T16:49:50.237+00:00",
"status": 404,
"error": "Not Found",
"path": "/amlyze-ws-rest/simplifiedCustomer"
}{
"resultType": "REQUEST_REJECTED",
"status": 500,
"error": "Internal Server Error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Unique number of communication. It is used for risk assessment callback.
255Unique external customer identifier. This identifier corresponds to the client's identifier in the financial institution.
"019a5d1b-8c4f-770b-ad70-2f2a6c88aeda"
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 workflowACTIVE- Customer is onboarded and ready for workflowREJECTED- the customer was rejected before account was openedSUSPENDED- Customer's activities for some reasons are restrictedCLOSED- Customer's profile is disabled
ACTIVE, CLOSED, PENDING, REJECTED, SUSPENDED Type of the customer. INDIVIDUAL represents a natural person; ORGANIZATION represents a legal entity such as a company, partnership, or foundation.
â This value drives conditional field requirements:
INDIVIDUALrequiresfirstName,lastNameORGANIZATIONrequirestitle
Fields specific to the other entity type are not allowed. See each affected field's description for its individual constraint.
INDIVIDUAL, ORGANIZATION Name of the system requesting web service.
100Code of risk management category of the object. Value must be from a classifier list personalized to your company.
Description of entity activity.
32768"Financial activity"
Description of entity activity.
32768Whether the person is an AML officer.
Date when customer first applied.
Date of application approval - onboarding date.
Country of birth of the individual entity.
Date of birth of the individual entity
Mandatory field for clients utilizing a multi-organizational solution. It serves to specify the unique identifier for the business unit.
Country of citizenship of individual entity.
âMandatory only when customerStatus = CLOSED. Not used when customerStatus is PENDING, ACTIVE, REJECTED or SUSPENDED.
Value of the company's assets.
Whether cash is the main income source.
Date of establishment of the organization.
First name of the individual.
â This field is mandatory when entityType is INDIVIDUAL.
Global intermediary identification number.
Whether the entity has a multi-layer organizational structure.
Description of income source.
32768Description of incoming payment operation.
Account of initial deposit.
200Initial deposit amount.
Bank of initial deposit.
200Initial deposit currency. Taken from /classifier/currency endpoint.
Source of initial deposit.
200Defines which lists to check during screening process.
SANCTIONS, PEP, ADVERSE_MEDIA, INTERNAL_LIST Whether entity's actual address is declared.
Whether the business entity is audited.
Whether entity's correspondence address is declared.
Whether entity is managed directly.
Whether a family member of the individual is politically exposed.
Whether entity is a financial institution.
Whether the business entity is fined.
Whether there is adverse-media information about the entity.
Whether there is internal-list information about the entity.
Whether the individual is a legal resident.
Whether the entity's activity requires a license.
Whether the business entity is listed on a stock exchange.
Whether the customer is involved in litigation.
Whether the entity is politically exposed.
Whether the business entity is regulated by third-party authorities.
Whether the entity is sanctioned.
Last name of the individual.
â This field is mandatory when entityType is INDIVIDUAL.
Legal form of the organization.
LEI stands for Legal Entity Identifier, which is a unique code used to identify legal entities that participate in financial transactions.
Business entities license description.
32768List of addresses.
Show child attributes
Show child attributes
List of business entity documents.
Show child attributes
Show child attributes
List of contacts.
Show child attributes
Show child attributes
Indicates whether the entity is on a risk-management list.
WHITE- Entity is allow-listed.BLACK- Entity is block-listed.
BLACK, WHITE 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.
100Whether entity has no major shareholders involved.
The number of times a business entity has been audited.
Number of employees.
Description of organizational structure.
32768The number of years that are in question for being audited.
The number of years that are in question for being fined.
Place of birth of individual entity.
Description of the region for activities.
32768Country of registration of organization entity. Value taken from /classifier/country endpoint.
Predefined risk level of imported customer.
EXTREME, HIGH, LOW, MEDIUM, NONE 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.
EVALUATE, IMPORT Whether the entity uses third-party services.
Description of third-party services used by entity.
32768Title (official name) of the organization.
â This field is mandatory when entityType is ORGANIZATION.