Evaluate customer
To initiate the scoring process, the sourceOfRiskLevel field in the API payload must be set to EVALUATE. This instructs the Amlyze engine to run the customer’s data through the active risk matrix. In contrast, sending the value IMPORT will only update the customer’s data in the system without triggering a new risk evaluation.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Date when customer first applied.
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"
Entity type. This field is not mandatory if listBusinessEntityDocument field is not provided at all.
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.
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 Element is used to indicate whether a client needs to be created or the existing customer's data to be updated. As this field is not mandatory and if not provided, CREATE value is set as default.
❗ By UPDATEing, all data will be replaced with newly received one
CREATE, UPDATE Description of entity activity.
32768Description of business entities' activities in a restricted region.
32768Indicator for the person being AML officer.
Date of application approval - onboarding date.
Country of birth of individual entity.
Date of birth of individual entity
It serves to specify the unique identifier for the business unit. Business units are logical groupings of users and data. Each business unit can have its own set of users, permissions, and data access rules. Value is taken from /classifier/businessUnit endpoint.❗Mandatory field for clients utilizing a multi-organizational solution. Omit this parameter unless instructed about it.
255Country of citizenship of individual entity.
❗Mandatory only when customerStatus = CLOSED. Not used when customerStatus is PENDING, ACTIVE, REJECTED or SUSPENDED.
Value of companies assets.
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 Indicator for cash being the main income source.
Date of establishment of the organization.
Information about the activities. Fields of the object properties are described in the dropdown below.
First name of individual entity.
❗This field is mandatory when entityType is INDIVIDUAL.
Global intermediary identification number.
Check for 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. Strings of the list are noted in the dropdown below.
ADVERSE_MEDIA, INTERNAL_LIST, PEP, SANCTIONS Whether entity's actual address is declared.
Indicator for the business entity is audited.
Whether entity's correspondence address is declared.
Whether entity is managed directly.
Identification of whether a family member of an individual entity is politically exposed.
Whether entity is a financial institution.
Indicator for the business entity is fined.
An indication of the existence of information on adverse media about the entity.
An indication of the existence of information on internal list about the entity.
Indicator for whether individual entity is a legal resident.
Whether entity activity requires license.
Indicator for the business entity is listed in stock exchange companies.
Indicator if the customer is being litigated.
Identification for whether a person is politically exposed.
Indicator for the business entity being regulated by third-party authorities.
Identification for whether a person is sanctioned.
Last name of individual entity.
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.
32768Indicator whether entity is white/black 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.
32768Description of outgoing payment operation.
The number of years that are in question for being audited.
The number of years that are in question for being fined.
Country of permanent residence of individual entity.
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 Country of second citizenship of individual entity.
Whether entity is using third-party services.
Description of third-party services used by entity.
32768Title of organization entity.
Trading name of the organization.