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(256)
required
Unique number of communication. It is used for risk assessment callback.Example: Test_ComNr_002mHzZZ
​
requester
string(100)
required
Name of the system requesting web service.Example: Amlyze
​
businessUnit
string(255) 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
​
action
string from enum
Element is used to indicate whether an account needs to be created or the existing account’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
​
businessEntityExtId
string(255)
required
External business entity indicator. Refers to the same value used for the customerExtId,which links an account to customer. This identifier corresponds to the client’s identifier in the financial institution.Example: IND_A1_TEST
​
accountExtId
string(255)
required
External account identification number used to track activity regarding the specific account.Example: ACC_001
​
accountNumber
string(255)
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, CLOSEDACTIVE - Customer account is in use and ready for workflowSUSPENDED - Customer’s account is restrictedCLOSED - Customer’s account is disabledExample: ACTIVE
​
currencyCode
string(255) from classifier list
required
International currency code.Value: EUR
​
openingDate
date
required
Account opening date.Example: 2023-09-05T08:07:34.605Z
​
bic
string(255)
❗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(255)
Title of the bank with which the operations are happening.Example: TBC bank
​
accountPurpose
string(255)
The purpose of owning the account in question.Example: PURPOSE_INVEST
​
accountType
string(255) from classifier list
Categorizes accounts by their intended purposes and features.Value: ORG_B2B
​
closingDate
date
❗Mandatory if accountStatus = CLOSEDAccount closing date.Example: 2022-12-11T12:10:11+02:00
​
suspensionReasons
string(32768)
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