This section provides information how to submit account details to our database.

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/account

ContentType: application/json

Authorization: Bearer Token

​
API requests examples

​
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

businessEntityExtId
string
required

External business entity indicator. Refers to the same value used for the customerExtId, which helps to identify external business entity. This identifier corresponds to the client’s identifier in the financial institution.

Example: IND_A1_TEST

accountExtId
string
required

External account identification number used to track activity regarding the specific account.

Example: ACC_001

accountNumber
string
required

Unique account identification number used in performing operations.

Example: LI9208800274335945522

accountStatus
string from enum
required

Refers to the current condition or state of an account.

Enum class values: ACTIVE, SUSPENDED, CLOSED

ACTIVE - Customer account is in use and ready for workflow

SUSPENDED - Customer’s account is restricted

CLOSED - Customer’s account is disabled

Example: ACTIVE

currencyCode
string from classifier list
required

International currency code.

Value: EUR

openingDate
date
required

Account opening date.

Example: 2023-09-05T08:07:34.605Z

bic
string

❗Mandatory if isOtherFinInstAccount = true.

Bank identifier code for account number.

Example: BICXX22

isOtherFinInstAccount
boolean

Declaring whether the account belongs to other financial institution. If true - bic value needs to be provided.

Example: true

bankTitle
string

Title of the bank with which the operations are happening.

Example: TBC bank

accountPurpose
string

The purpose of owning the account in question.

Example: PURPOSE_INVEST

accountType
string from classifier list
required

Categorizes accounts by their intended purposes and features.

Value: ORG_B2B

closingDate
date

❗Mandatory if accountStatus = CLOSED

Account closing date.

Example: 2022-12-11T12:10:11+02:00

suspensionReasons
string

A reason for suspension can be provided only if accountStatus = SUSPENDED.

Example: Security breach investigation in progress.

​
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/acount" --> 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 account request to the API. A bad request is a request that somehow does not follow the API specifications.

Error Description
AccountExtId is mandatory
AccountNumber is mandatory
BusinessEntityExtId is mandatory
BusinessEntity with given extId does not exist in Amlyze
Cannot register account for lead customer
Currency does not exist in Amlyze
Account already linked with other customer
When using external account, BIC is mandatory
Given BIC does not belong to your institution
OpeningDate is mandatory
Invalid Account status, allowed values: ACTIVE, SUSPENDED, CLOSED
Given AccountType does not exist in Amlyze
CLOSED account requires closingDate
Non-closed account cannot have a closing date
CommunicationNumber is mandatory
Requester is mandatory
CommunicationNumber already used in Amlyze
Tenant header is mandatory
Business unit is mandatory
Tenant business unit does not exist
IntroductionIntroduction