Customer import - Individual with risk assessment

This section provides information how to submit customer details to our database and is focused on individuals requiring risk assessment. It includes examples of API requests with mandatory and optional fields, a comprehensive list of all available fields, common responses and error descriptions. HTTP Method: POST Path: {{baseUrl}}/amlyze-ws-rest/customer ContentType: application/json Authorization: Bearer Token

API requests examples

Show Mandatory fields example | CUSTOMER import - individual with risk assessment

{
  "communicationNumber" : "Test_ComNr_002mHzZZ",
  "requester" : "Company Name Amlyze",
  "businessUnit" : "sandbox",
  "sourceOfRiskLevel" : "EVALUATE",
  "riskManagementCategory": "IND",
  "entityType" : "INDIVIDUAL",
  "customerExtId" : "IND_IMPORT_B1_TEST",
  "applicationDate": "2023-10-01",
  "firstName" : "Lukas",
  "lastName" : "Garcia"
}

Show Mandatory fields example | CUSTOMER import - individual with risk assessment with screening

{
  "communicationNumber" : "Test_ComNr_002mHzZZ",
  "requester" : "Company Name Amlyze",
  "businessUnit" : "sandbox",
  "sourceOfRiskLevel" : "EVALUATE",
  "riskManagementCategory": "IND",
  "entityType" : "INDIVIDUAL",
  "customerExtId" : "IND_IMPORT_B1_TEST",
  "applicationDate": "2023-10-01",
  "firstName" : "Lukas",
  "lastName" : "Garcia",

  "initializeScreeningProcesses": [
      "SANCTIONS",
      "PEP",
      "ADVERSE_MEDIA",
      "INTERNAL_LIST"
  ]
}

Show All fields example | CUSTOMER import - individual with risk assessment

{
  "communicationNumber" : "Test_ComNr_002mHzZZZ",
  "requester" : "Company Name Amlyze",
  "businessUnit" : "sandbox",
  "action" : "CREATE",
  "sourceOfRiskLevel" : "EVALUATE",
  "customerStatus" : "CLOSED",
  "riskManagementCategory": "IND",
  "entityType" : "INDIVIDUAL",
  "customerExtId" : "IND_EVALUATE_A3_TEST",
  "applicationDate": "2023-10-01",
  "firstName" : "Mikas",
  "lastName" : "Garcia",
  "citizenshipCountry" : "LT",

  "initializeScreeningProcesses": [
      "SANCTIONS",
      "ADVERSE_MEDIA",
      "PEP",
      "INTERNAL_LIST"
  ],

  "birthDate" : "2000-01-01",
  "approvalDate" : "2023-10-01T09:45:00.000+02:00",
  "closingDate" : "2023-10-02",
  "birthCountry" : "ES",
  "placeOfBirth": "Vilnius",
  "nationalCode" : "9000000485",
  "secondCitizenshipCountry" : "ES",
  "permanentResidenceCountry" : "LT",
  "isLegalResident" : true,
  "isPEP": false,
  "isSanctioned": false,
  "isInAdverseMedia": false,
  "isInInternalList": false,
  "isFamilyPEP" : false,
  "isLitigated" : false,
  "amlOfficer" : false,
  "listPurpose" : "WHITE",

  "fieldOfActivity": {
      "student": {
        "isStudent": true,
        "higherSchoolTitle": "Uni",
        "higherSchoolCountry": "LT"
      },
      "pension": {
        "isPensioner": false,
        "pensionCountry": "LT"
      },
      "employment": {
        "isUnemployed": false,
        "isSelfEmployed": false,
        "isEmployee": false,
        "employerTitle": "company A",
        "employmentPositionDescription": "Sales intern"
      },
      "other": {
        "isOtherStatus": false,
        "otherStatusDescription": "None"
      }
    },

  "isActualAddressDeclared" : true,
  "isCorrespondenceAddressDeclared" : false,
  "activityDescription" : "Financial activity",
  "incomeSourceDescription" : "Job Salary",
  "initialDepositSource": "Salary",
  "initialDepositBank" : "ABC",
  "initialDepositAccount" : "LT0089500500000070",
  "initialDepositAmount" : 100000,
  "initialDepositCurrency" : "EUR",
  "doesCashDominate" : false,

"listContact": [
      {
          "contactType": "MOBILEPHONE",
          "contactDetails": "860123123",
          "useForCommunication": true
      },
      {
          "contactType": "EMAIL",
          "contactDetails": "personal@gmail.com",
          "useForCommunication": true
      }
  ],
"listAddress": [
      {
          "addressDetails": "Pilies g. 19",
          "addressType": "RESIDENCE",
          "city": "Vilnius",
          "country": "LT",
          "region": "EU",
          "streetAddress": "Pilies g.",
          "useForCorrespondence": true,
          "zipCode": "04457"
      }
  ],
"listBusinessEntityDocument": [
      {
          "entityType": "INDIVIDUAL",
          "identityDocumentType": "OTHER",
          "documentNumber": "L548:15447651",
          "documentIssueDate": "2020-01-01",
          "documentExpiryDate": "2025-01-01",
          "documentIssueCountry": "LT",
          "documentIssueAuthority": "Migration office",
          "description": "agreement"
      }
  ],
"listAppealReason": [
      {
          "appealReasonType": "PURPOSE_GET_LOAN,PURPOSE_MAKE_PAYMENTS,PURPOSE_OTHER"
      }
  ],
"listIntroductionSource": [
      {
          "introductionSource": "Internet"
      }
  ],
"listOrderedService": [
      {
      "serviceType": "LOANS"
      }
  ],
"listDeclaredTurnover": [
      {
          "from": 5000,
          "to": 6000,
          "turnoverRange": "MONTHLY",
          "turnoverType": "OPERATION_AMOUNT_MONTHLY"
      }
  ],
"listIncomeSource": [
      {
          "incomeSourceType": "DIVIDENDS",
          "incomePercentage": 10,
          "from": 10,
          "to": 100
      }
  ],
"listPaymentPurpose": [
      {
          "paymentPurposeType": "TAXES",
          "turnoverDirection": "OUT"
      }
  ],
"listSourceOfWealth": [
      {
          "amount": 20000,
          "code": "ADULT",
          "comment": "text"
      }
  ],
"listPaymentCountry": [
      {
          "country": "LT",
          "turnoverDirection": "OUT"
      }
  ],
"listActivity": [
      {
          "activityType": "NACE_B",
          "incomePercentage": 50
      }
  ],
"listRegionOfActivity": [
      {
          "region": "EU"
      }
  ],
"listCountryOfActivity": [
      {
          "country": "LV"
      }
  ],
"listCountryOfTaxPayment": [
      {
          "country": "LT",
          "taxpayerNumber": "23846"
      }
  ],
"listAdditionalValues": [
      {
          "code": "relation_us",
          "description": "Has a relation to USA.",
          "datatype": "STRING",
          "value" : "true"
      }
  ],

  "listRelatedEntity": [
      {
          "entityType": "INDIVIDUAL",
          "relationType": "DIRECTOR",
          "relationDescription": "founder",
          "extId": "Rel_entity_ExtID_4051",
          "share": 75,
          "votePercentage": 10,
          "nationalCode": "123456789",
          "activityDescription": "Represents an organization",
          "country": "AF",
          "birthCountry": "LT",
          "firstName": "Teodor",
          "lastName": "Mariko",
          "birthDate": "1998-04-07",
          "isPEP": true,
          "isSanctioned": false,
          "isInAdverseMedia": false,
          "isInInternalList": false,
          "regionOfActivityDescription": "Western Region",
          "listContact": [
              {
                  "contactType": "EMAIL",
                  "contactDetails": "personalemail@gmail.com",
                  "useForCommunication": true
              }
          ],
          "listAddress": [
              {
                  "addressType": "HEADQUARTERS",
                  "addressDetails": "Lvovo g. 15/4",
                  "country": "LT",
                  "region": "EU",
                  "city": "Vilnius",
                  "streetAddress": "Lvovo g.",
                  "zipCode": "04127",
                  "useForCorrespondence": true
              }
          ],
          "listBusinessEntityDocument": [
              {
                  "entityType": "INDIVIDUAL",
                  "identityDocumentType": "OTHER",
                  "documentNumber": "L548:154477425",
                  "documentIssueDate": "2020-01-03",
                  "documentExpiryDate": "2025-01-03",
                  "documentIssueCountry": "LT",
                  "documentIssueAuthority": "Migration office",
                  "description": "agreement"
              }
          ],
          "listIncomeSource": [
              {
                  "incomeSourceType": "BUSINESS_REVENUE_OR_ASSET_SALE",
                  "incomePercentage": 10,
                  "from": 10,
                  "to": 100
              }
          ],
          "listActivity": [
              {
                  "activityType": "NACE_C",
                  "incomePercentage": 50
              }
          ],
          "listRegionOfActivity": [
              {
                  "region": "EU"
              }
          ],
          "listCountryOfActivity": [
              {
                  "country": "LV"
              }
          ],
          "listAdditionalValues": [
              {
                  "code": "relation_us",
                  "description": "Is related to US?",
                  "datatype": "BOOLEAN",
                  "value": "false"
              }
          ]
      },
  	{
          "entityType": "ORGANIZATION",
          "relationType": "HOST",
          "relationDescription": "founder",
  		  "extId": "Rel_entity_ExtID_4052",
          "share": 10,
          "votePercentage": 10,
          "nationalCode": "50007422259",
          "activityDescription": "BEARER",
          "country": "LT",
          "registrationCountry": "LT",
          "isPEP": false,
          "isSanctioned": true,
          "isInAdverseMedia": true,
          "isInInternalList": true,
          "regionOfActivityDescription": "Eastern region",
          "title": "LTD 'VitaGold'",
          "legalForm": "LTD",
          "establishmentDate": "1998-04-07",

          "listContact": [
              {
                  "contactType": "EMAIL",
                  "contactDetails": "vitaGold.info@gmail.com",
                  "useForCommunication": true
              }
          ],
          "listAddress": [
              {
                  "addressType": "HEADQUARTERS",
                  "addressDetails": "Panemunių g. 15-4",
                  "country": "LT",
                  "region": "EU",
                  "city": "Vilnius",
                  "streetAddress": "Panemunių g.",
                  "useForCorrespondence": true,
                  "zipCode": "048715"
              }
          ],
          "listBusinessEntityDocument": [
              {
                  "entityType": "ORGANIZATION",
                  "identityDocumentType": "REGISTRATIONCERTIFICATE",
                  "documentNumber": "LT-4574551121",
                  "documentIssueDate": "2015-01-03",
                  "documentExpiryDate": "2020-01-03",
                  "documentIssueCountry": "LT",
                  "documentIssueAuthority": "VMI",
                  "description": "Certificate of Registration"
              }
          ],
          "listIncomeSource": [
              {
                  "incomeSourceType": "DIVIDENDS",
                  "incomePercentage": 10,
                  "from": 10,
                  "to": 100
              }
          ],
          "listActivity": [
              {
                  "activityType": "NACE_D",
                  "incomePercentage": 50
              }
          ],
          "listRegionOfActivity": [
              {
                  "region": "EU"
              }
          ],
          "listCountryOfActivity": [
              {
                  "country": "LV"
              }
          ],
          "listAdditionalValues": [
              {
                  "code": "relation_russia",
                  "description": "Related to Russia?",
                  "datatype": "BOOLEAN",
                  "value": "false"
              }
          ]
      }
  ]
}

Fields

communicationNumber

string

required

Unique number of communication. It is used for risk assessment callback. This field can store up to 256 characters.Example: Test_ComNr_002mHzZZ

requester

string

required

Name of the system requesting web service.Example: Amlyze

businessUnit

string from classifier list

❗Mandatory field for clients utilizing a multi-organizational solution. Omit this parameter unless instructed about it.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.Example: BUSINESS_UNIT_NAME

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/businessUnit

action

string from enum

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 values is set as default.❗ By UPDATEing, all data will be replaced with newly received oneEnum class values: CREATE, UPDATEExample: UPDATE

sourceOfRiskLevel

string

required

The value EVALUATE is used for initiating a customer risk assessment.Value: EVALUATE

customerStatus

string from enum

required

Customer’s predefined status represents the current standing or state of a customer’s relationship with a business or organizationEnum class values: PENDING, ACTIVE, REJECTED, SUSPENDED, CLOSEDPENDING - Customer application is received but not yet prepared for upcoming workflowACTIVE - Customer is onboarded and ready for workflowREJECTED- the customer for some reasons was rejected before opening an account for himSUSPENDED - Customer’s activities for some reasons are restrictedCLOSED - Customer’s profile is disabledExample: ACTIVE

riskManagementCategory

string from classifier list

required

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

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/riskManagementCategory

entityType

string

required

Notifies about customer type.Value: INDIVIDUAL

customerExtId

string

required

Unique external customer identifier. This identifier corresponds to the client’s identifier in the financial institution.Example: cust_1232

applicationDate

date

required

Date when customer first applied.Example: 2020-01-03

firstName

string

required

First name of individual entity.Example: Jose

lastName

string

required

Last name of individual entity.Example: Rodriguez

citizenshipCountry

string (ISO 3166-1 alpha-2) from classifier list

Country of citizenship of individual entity.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: LT

initializeScreeningProcesses

list[]

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

Show list[]

   "initializeScreeningProcesses": [
       "SANCTIONS",
       "PEP",
       "ADVERSE_MEDIA",
       "INTERNAL_LIST"
   ]

Example: PEP, ADVERSE_MEDIA

birthDate

date

Date of birth of individual entityExample: 2000-01-01

approvalDate

date

Date of application approval - onboarding date.Example: 2023-10-01T09:45:00.000+02:00

closingDate

date

❗Mandatory only when customerStatus = CLOSED. Not used when customerStatus is PENDING, ACTIVE, REJECTED or SUSPENDED.Example: 1995-05-24

birthCountry

string (ISO 3166-1 alpha-2) from classifier list

Country of birth of individual entity.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: LT

placeOfBirth

varchar

Place of birth of individual entity.Example: Vilnius

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
A number of taxpayer or registration certificate of the company

Example: 50001010022

secondCitizenshipCountry

string (ISO 3166-1 alpha-2) from classifier list

Country of second citizenship of individual entity.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Value: LV

permanentResidenceCountry

string (ISO 3166-1 alpha-2) from classifier list

Country of permanent residency of an individual entity.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Value: LT

isLegalResident

boolean

Indicator for whether individual entity is a legal resident.Example: true

isPEP

boolean

Identification for whether a person is politically exposed.Example: true

isSanctioned

boolean

Identification for whether a person is sanctioned.Example: false

isInAdverseMedia

boolean

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

isInInternalList

boolean

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

isFamilyPEP

boolean

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

isLitigated

boolean

Indicator if the customer is being litigated.Example: false

amlOfficer

boolean

Indicator for the person being AML officer.Example: false

listPurpose

string from enum

Indicator whether entity is white/black listed.Enum class values: WHITE, BLACKExample: WHITE

fieldOfActivity

object{}

Information about the activities. Fields of the object properties are described in the dropdown below.

Show fieldOfActivity object{} fields

student

object{}

Show student object{} fields

isStudent

boolean

Indicator of whether the customer is a student.Example: true

higherSchoolTitle

string

Name of the higher school where customer is studying.Example: Uni University

higherSchoolCountry

string (ISO 3166-1 alpha-2) from classifier list

Country of higher school of the student.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: US

pension

object{}

Show pension object{} fields

isPensioner

boolean

Indicator of whether the customer is a pensioner.Example: false

pensionCountry

string (ISO 3166-1 alpha-2) from classifier list

The country responsible for paying an individual’s pension.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: DE

employment

object{}

Show employment object{} fields

isUnemployed

boolean

Indicator for the individual entity being unemployed.Example: true

isSelfEmployed

boolean

Indicator for the individual entity being self-employed.Example: true

isEmployee

boolean

Indicator for the individual entity being an employee.Example: false

employerTitle

string

Title of the individual employer.Example: CompanyB

employmentPositionDescription

string

Description of the individual employment position.Example: Software tester

other

object{}

Show other object{} fields

isOtherStatus

boolean

Indicator for individual other status.Example: true

otherStatusDescription

string

Description of other status.Example: Specific description about the other status

isActualAddressDeclared

boolean

Indicator for actual address declaration.Example: true

isCorrespondenceAddressDeclared

boolean

Indicator for actual address declaration.Example: false

activityDescription

string

Description of entity activity.Example: Financial activity

incomeSourceDescription

string

Description of income source of the entity.Example: Job salary

initialDepositSource

string

Source of initial deposit.Example: Salary

initialDepositBank

string

Bank of the initial depositExample: TBC

initialDepositAccount

string

Account of initial depositExample: LT0089500500000070

initialDepositAmount

double

Amount of initial deposit.Example: 8500.48

initialDepositCurrency

string from classifier list

This currency field notifies about initial deposit currency.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/currency

Example: EUR

doesCashDominate

boolean

Indicator for cash being the main income source.Example: true

listContact

list[]

Show listContact list[] fields

contactType

string from enum

required

Way of contacting entity. This field is not mandatory if listContact field is not provided at all.Enum class values: MOBILEPHONE, FIXEDPHONE, EMAIL, WEBSITEExample: MOBILEPHONE

contactDetails

string

required

Details of contact. This field is not mandatory if listContact field is not provided at all.Examples: 868758585, hello@gmail.com, www.website.com

useForCommunication

boolean

Indicator for the usage of communication way.Example: true

listAddress

list[]

Show listAddress list[] fields

addressDetails

string

Full address description.Example: Building B

addressType

string from classifier list

Type of entity address.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/addressType

Example: RESIDENCE

city

string

City of the given address.Example: Vilnius

country

string (ISO 3166-1 alpha-2) from classifier list

required

Country of the given address. This field is not mandatory if listAddress field is not provided at all.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: LT

region

string

Region of the given address.Example: EU

streetAddress

string

Street, house, and flat number of the given address.Example: Verkių g. 1-9

useForCorrespondence

boolean

Indicator for using the address in correspondence.Example: true

zipCode

string

Zip code of the address.Example: 12345

listBusinessEntityDocument

list[]

Show listBusinessEntityDocument list[] fields

entityType

string

required

Entity type describes the client status. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Value: INDIVIDUAL

identityDocumentType

string from enum

required

Identification document type. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Enum class values: PASSPORT, IDENTITYCARD, RESIDENCEPERMIT, DRIVINGLICENSE, REGISTRATIONCERTIFICATE, OTHERExample: PASSPORT

documentNumber

string

required

The number of the document in question. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Example: 0123456789

documentIssueDate

date

required

The issue date of the document in question. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Example: 2022-01-15

documentExpiryDate

date

The expiry date of the document in question.Example: 2032-01-15

documentIssueCountry

string (ISO 3166-1 alpha-2) from classifier list

required

The country that issued the document. This field is not mandatory if listBusinessEntityDocument field is not provided at all.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: LT

documentIssueAuthority

string

required

An authority that issued the document. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Example: Migration office

description

string

Document description.Example: passport

listAppealReason

list[]

Show listAppealReason list[] fields

appealReasonType

string from classifier list

required

Appeal reason type. This field is not mandatory if listAppealReason field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/appealReasonType

Example: PRICING

listIntroductionSource

list[]

Show listIntroductionSource list[] fields

introductionSource

string from classifier list

required

Introduction source. This field is not mandatory if listIntroductionSource field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/introductionSourceType

Examples: INTERNET, INTRODUCER

listOrderedService

list[]

Show listOrderedService list[] fields

serviceType

string from classifier list

required

Service type. This field is not mandatory if listOrderedService field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/serviceType

Examples: LOANS, DEPOSITS

listDeclaredTurnover

list[]

Show listDeclaredTurnover list[] fields

from

integer

required

Amount range from. This field is not mandatory if listDeclaredTurnover field is not provided at all or to field is provided.Example: 1000

integer

required

Amount range to. At least one value (from or to) must be specified. This field is not mandatory if listDeclaredTurnover field is not provided at all or to field is provided.Example: 5000

turnoverRange

string from enum

required

Range of declared turnover.Enum class values: SINGLE, DAILY, MONTHLY, ANNUALExample: MONTHLY

turnoverType

string from classifier list

required

Type of declared turnover.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/turnoverType

Example: TURNOVER_PER_MONTH

listIncomeSource

list[]

Show listIncomeSource list[] fields

incomeSourceType

string from classifier list

required

Type of income source.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/incomeSourceType

Example: SALARY

incomePercentage

integer

required

Percentage of income from the source.Example: 5

from

integer

Amount from.Example: 100

integer

Amount to.Example: 1000

listPaymentPurpose

list[]

Show listPaymentPurpose list[] fields

paymentPurposeType

string from classifier list

required

Type of payment purpose. This field is not mandatory if paymentPurposeType field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/paymentPurposeType

Example: TAXES

turnoverDirection

string from enum

required

Direction of payment turnover. This field is not mandatory if paymentPurposeType field is not provided at all.Enum class values: IN, OUTExample: OUT

listSourceOfWealth

list[]

Show listSourceOfWealth list[] fields

amount

decimal

Collected monetary amount.Example: 100000

code

string from classifier list

required

Source of wealth code. This field is not mandatory if listSourceOfWealth field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/sourceOfWealth

Example: INHERITANCE

comment

string

Additional details about the source of wealth.Example: text

listPaymentCountry

list[]

Show listPaymentCountry list[] fields

country

string (ISO 3166-1 alpha-2) from classifier list

required

Country code. This field is not mandatory if listPaymentCountry field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Example: US

turnoverDirection

string from enum

required

Direction of payment turnover. This field is not mandatory if listPaymentCountry field is not provided at all.Enum class values: IN, OUTExample: OUT

listActivity

list[]

Show listActivity list[] fields

activityType

string from classifier list

required

Type of business activity. This field is not mandatory if listActivity field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/activityType

Example: ACTIVITY_OTHER

incomePercentage

integer

Percentage of income from this activity.Example: 15

listRegionOfActivity

list[]

Show listRegionOfActivity list[] fields

region

string from classifier list

required

Region where the activity takes place. This field is not mandatory if region field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Examples: AU, EU

listCountryOfActivity

list[]

Show listCountryOfActivity list[] fields

country

string (ISO 3166-1 alpha-2) from classifier list

required

Country where the activity takes place. This field is mandatory.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Example: US, LT

listCountryOfTaxPayment

list[]

Show listCountryOfTaxPayment list[] fields

country

string (ISO 3166-1 alpha-2) from classifier list

required

Country where the tax payment is made. This field is not mandatory if listCountryOfTaxPayment field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Example: LT

taxpayerNumber

string

The tax identification number of the taxpayer.Example: 5541245574

listAdditionalValues

list[]

Show listAdditionalValue list[] fields

code

string

required

Identifier for the additional field. This field is not mandatory if listAdditionalValue field is not provided at all.Example: related_to_usa

description

string

required

Human readable description of the field. This field is not mandatory if listAdditionalValue field is not provided at all.Example: Entity has relation to USA

datatype

string from enum

required

Type of provided value. This field is not mandatory if listAdditionalValue field is not provided at all.Enum class values: STRING, INTEGER, DECIMAL, DATE, TIMESTAMP, BOOLEANExample: STRING

value

string

required

Value of the field. This field is not mandatory if listAdditionalValue field is not provided at all.Example: true

List for related business entities. Fields of the list are described in the dropdown below.

Show listRelatedEntity list[] fields

customerExtId

string

Fill when related entity is also a customer in Amlyze. Example: ind1234567

entityType

string from enum

required

Type of entity describing client status. This field is not mandatory if listRelatedEntity field is not provided at all.Enum class values: INDIVIDUAL, ORGANIZATIONExample: INDIVIDUAL

relationType

string from classifier list

required

Type of relationship between entities. This field is not mandatory if listRelatedEntity field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/relationType

Example: OWNER

relationDescription

string

Description of the relationship between entities.Example: Founder

extId

string

Identifier used for screening callbacks to identify the entity.Example: Related_extID_000

Shares owned by shareholders in the organization of the business entity.Example: 75

votePercentage

integer

Vote percentage of shareholders in the organization of the business entity.Example: 99

nationalCode

string

National code or national identification number of the individual or organization.Example: 123456789

activityDescription

string

Activity description of the related entity.Example: Financial activity

country

string (ISO 3166-1 alpha-2) from classifier list

If entityType is INDIVIDUAL, the country refers to the citizenship of the individual. If entityType is ORGANIZATION, the country refers to the country of registration of the organization.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Example: LT

birthCountry

string (ISO 3166-1 alpha-2) from classifier list

Birth country of the related entity.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Example: LT

firstName

string

❗This field is mandatory when entityType is INDIVIDUAL.First name of the related entity.Example: John

lastName

string

❗This field is mandatory when entityType is INDIVIDUAL.Last name of the related entity.Example: Rodriguez

birthDate

date

Birth date of the related individual entity.Example: 2000-05-28

isPEP

boolean

Indicator if the related individual entity is a politically exposed person.Example: false

isSanctioned

boolean

Indicator if sanctions are applied to the entity.Example: false

isInAdverseMedia

boolean

Indicator if there is information for an adverse media entity.Example: false

isInInternalList

boolean

Indicator if there is information for an internal list entity.Example: false

regionOfActivityDescription

string

Description of the activity region of the related entity.Example: EU

listContact

list of ContactApi

listContact

list[]

List for contacts. Fields of the list are described in the dropdown below.

Show listContact list[] fields

contactType

string from enum

required

Way of contacting entity. This field is not mandatory if listContact field is not provided at all.Enum class values: MOBILEPHONE, FIXEDPHONE, EMAIL, WEBSITEExample: MOBILEPHONE

contactDetails

string

required

Details of contact. This field is not mandatory if listContact field is not provided at all.Examples: 868758585, hello@gmail.com, www.website.com

useForCommunication

boolean

Indicator for the usage of communication way.Example: true

listAddress

list[]

List of addresses. Fields of the list are described in the dropdown below.

Show listAddress list[] fields

addressType

string from classifier list

Type of entity address.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/addressType

Example: RESIDENCE

addressDetails

string

Full address description.Example: Building B

country

string (ISO 3166-1 alpha-2) from classifier list

required

Country of the given address. This field is not mandatory if listAddress field is not provided at all.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: LT

region

string

Region of the given address.Example: EU

city

string

City of the given address.Example: Vilnius

streetAddress

string

Street, house, and flat number of the given address.Example: Verkių g. 1-9

useForCorrespondence

boolean

Indicator for using the address in correspondence.Example: true

zipCode

string

Zip code of the address.Example: 12345

listBusinessEntityDocument

list[]

List of related entity documents. Fields of the list are described in the dropdown below.

Show listBusinessEntityDocument list[] fields

entityType

string

required

Entity type describes the client status. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Value: INDIVIDUAL

identityDocumentType

string from enum

required

documentNumber

string

required

The number of the document in question. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Example: 0123456789

documentIssueDate

date

required

The issue date of the document in question. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Example: 2022-01-15

documentExpiryDate

date

The expiry date of the document in question.Example: 2032-01-15

documentIssueCountry

string (ISO 3166-1 alpha-2) from classifier list

required

The country that issued the document. This field is not mandatory if listBusinessEntityDocument field is not provided at all.

Show Path to extract classifier values

HTTP Method: GETPath: {{baseUrl}}/classifier/country

Example: LT

documentIssueAuthority

string

required

An authority that issued the document. This field is not mandatory if listBusinessEntityDocument field is not provided at all.Example: Migration office

description

string

Document description.Example: passport

listIncomeSource

list[]

List of income sources. Fields of the list are described in the dropdown below.

Show listIncomeSource list[] fields

incomeSourceType

string from classifier list

required

Type of income source.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/incomeSourceType

Example: SALARY

incomePercentage

integer

required

Percentage of income from the source.Example: 5

from

integer

Amount from.Example: 100

integer

Amount to.Example: 1000

listActivity

list[]

List of activities. Fields of the list are described in the dropdown below.

Show listActivity list[] fields

activityType

string from classifier list

required

Type of business activity. This field is not mandatory if listActivity field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/activityType

Example: ACTIVITY_OTHER

incomePercentage

integer

Percentage of income from this activity.Example: 15

listRegionOfActivity

list[]

List of activity countries of related entity. Fields of the list are described in the dropdown below.

Show listRegionOfActivity list[] fields

region

string (ISO 3166-1 alpha-2) from classifier list

required

Region where the activity takes place. This field is not mandatory if region field is not provided at all.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Examples: AU, EU

listCountryOfActivity

list[]

List of activity regions. Fields of the list are described in the dropdown below.

Show listCountryOfActivity list[] fields

country

string (ISO 3166-1 alpha-2) from classifier list

required

Country where the activity takes place. This field is mandatory.

Show Path to extract classifier values

HTTP Method: GET
Path: {{baseUrl}}/classifier/country

Example: US, LT

listAdditionalValue

list[]

Additional information about customer. Fields of the list are described in the dropdown below. This list can be used to provide data, e.g. relation to Lithuania. The provided classification codes must be unique for one client or related entity and apply to all clients in the same way.

Show listAdditionalValue list[] fields

code

string

required

Identifier for the additional field. This field is not mandatory if listAdditionalValue field is not provided at all.Example: related_to_usa

description

string

required

Human readable description of the field. This field is not mandatory if listAdditionalValue field is not provided at all.Example: Entity has relation to USA

datatype

string from enum

required

value

string

required

Value of the field. This field is not mandatory if listAdditionalValue field is not provided at all.Example: true

List of possible responses

This part lists common responses after the submission of the request.

200 OK
  "resultType": "REQUEST_ACCEPTED"


400 Bad Request
    "resultType": "REQUEST_REJECTED",
    "errorCode": "O001",
    "errorDescription": "CommunicationNumber already used in amlyze"


404 Not Found
    "timestamp": "2024-05-26T16:49:50.237+00:00",
    "status": 404,
    "error": "Not Found",
    "path": "/amlyze-ws-rest/customerr" --> mistake inside the endpoint


500 Internal Server Error
  "resultType": "REQUEST_REJECTED"
  "status": 500,
  "error": "Internal Server Error"

List of possible errors

This section lists the possible errors that can occur when making a bad customer request to the API. A bad request is a request that somehow does not follow the API specifications.

Error Code	Error Description
	ActivityType is mandatory
	ActivityType must be defined in Amlyze
	AddressType is mandatory.
	AddressType is not defined in Amlyze.
	Country is mandatory and can’t be empty
	Country is mandatory and must exist in Amlyze
	AdditionalValue.Code is mandatory
	AdditionalValue.Description is mandatory
	AdditionalValue.Value is mandatory
	AdditionalValue.Datatype is mandatory
	Duplicate code in additionalValues
	Bad datatype valueCode:
	Bad value for valueCode:
	Bad value for (format: ‘yyyy-MM-dd’) valueCode:
	Bad value for (format: ‘yyyy-MM-dd HH:mm:ss.SSSZ’) valueCode:
	Bad value for (values: true false’) valueCode:
	EntityType is mandatory. values: INDIVIDUAL, ORGANIZATION
	DocumentNumber is mandatory.
	DocumentIssueDate is mandatory.
	DocumentIssueCountry is mandatory and must exist in Amlyze
	DocumentIssueAuthority is mandatory
	CustomerExtId is mandatory.
	DELETE not yet implemented, contact Amlyze support
	Customer already exists
C004	Cannot update not existing customer, use Action = CREATE
	Requester is mandatory.
	RiskManagementCategory is mandatory.
C007	RiskManagementCategory does not exist in Amlyze
	Given RiskManagementCategory not supported for Customer
	SourceOfRiskLevel is mandatory. Values: IMPORT, EVALUATE
	Cannot demote existing customer to Lead riskManagementCategory
	EntityType is mandatory.
	When importing, CustomerStatus is mandatory.
C008.I02	When source of risk level IMPORT. ‘Lead’ risk management category is forbidden
	When source of risk level IMPORT. RiskLevel is mandatory, values: NONE, LOW, MEDIUM, HIGH, EXTREME
	When source of risk level EVALUATE. RiskLevel can’t be provided
C012	ApplicationDate is mandatory
C013	ClosingDate is mandatory for CLOSED CustomerStatus
C013a	ClosingDate can not exist for not CLOSED CustomerStatus
	Field not allowed for INDIVIDUAL. Field:
	For INDIVIDUAL type customer
C016.I06	Problem with field for INDIVIDUAL type customer. CitizenshipCountry not found in amlyze
	InitialDepositCurrency not found in amlyze
	BirthCountry not defined in Amlyze
	CitizenshipCountry not defined in Amlyze
C016.I08	SecondCitizenshipCountry not defined in Amlyze
	PermanentResidenceCountry not defined in Amlyze
	Problem with field for INDIVIDUAL type customer.
FOA01	FieldOfActivity.Student.Country is invalid
FOA02	PensionCountry is invalid
	registrationCountry is invalid
REG	registrationCountry must exist in Amlyze
	LegalForm must exist in Amlyze
	TurnoverType is mandatory
	TurnoverType must exist in amlyze
	At least one value must be specified (FROM, TO)
	Problem with DeclaredTurnover (index: ).
	PaymentPurposeType does not exist in Amlyze
	TurnoverDirection is invalid
	Problem with PaymentPurpose (index: ).
	ServiceType not found in Amlyze
	Problem with OrderedService (index: ).
	Problem with Customer Contact index = .
	Problem with Customer BusinessEntityDocument index = .
	Problem with relatedEntity (index: ).
	Problem with relatedEntities.
	Problem with Address (index: ).
	screening process is undefined:
	PaymentCountry can’t be empty
	PaymentCountry not found in Amlyze
	TurnoverDirection is invalid
	Problem with PaymentCountry (index: ).
	IntroductionSource not found in amlyze
	Problem with IntroductionSource (index: ).
	Problem with IncomeSource (index: ).
	AppealReasonType is mandatory and can’t be empty
	AppealReasonType is mandatory and must be defined in Amlyze
	Problem with ListAppealReason (index: ).
	Problem with activity (index: ).
	Problem with RegionOfActivity (index: ).
	CountryOfTaxPayment can’t be empty
	CountryOfTaxPayment not found in Amlyze
	CountryOfTaxPayment (index: ).
	Problem with CountryOfActivity (index: ).
	Title is mandatory
	RegistrationCountry is mandatory
	LegalForm is mandatory
	FirstName is mandatory
	LastName is mandatory
AV07	Bad value for TIMESTAMP (format: ‘yyyy-MM-dd HH:mm:ss.SSSZ’) valueCode: lastonlinesupport
C014	Field not allowed for INDIVIDUAL. Field: CompanyAssetValue
SCR01	Screening process is undefined: NOT_EXISTS
Q004.ADR02	Problem with Address (index: 0 ). Country is mandatory and must exist in Amlyze
Q014.RC01	Problem with PaymentCountry (index: 0 ). PaymentCountry not found in Amlyze
C014	Field not allowed for INDIVIDUAL. Field: NumberOfEmployees
AV07	Bad value for BOOLEAN (values: true false’) valueCode: isvip
C002	CustomerExtId is mandatory
Q002.DOC06	Problem with Customer BusinessEntityDocument index = 0 . DocumentIssueCountry is mandatory and must exist in Amlyze
Q017.COTP01	CountryOfTaxPayment (index: 0 ). CountryOfTaxPayment not found in Amlyze
C014	Field not allowed for INDIVIDUAL. Field: LicenseDescription
C014	Field not allowed for INDIVIDUAL. Field: NumberOfAudits
C014	Field not allowed for INDIVIDUAL. Field: RegionOfActivityDescription
C014	Field not allowed for INDIVIDUAL. Field: Title
AV07	Bad value for INTEGER valueCode: number_users
C010	EntityType is mandatory
C014	Field not allowed for INDIVIDUAL. Field: LegalForm
C014	Field not allowed for INDIVIDUAL. Field: ThirdPartyServicesUsedDescription
C014	Field not allowed for INDIVIDUAL. Field: GIIN
C014	Field not allowed for INDIVIDUAL. Field: PeriodsOfAuditsInYears

API Documentation

​API requests examples

​Fields

​List of possible responses

​List of possible errors

API requests examples

Fields

List of possible responses

List of possible errors