Validate batch of accounts without saving This method sends data only for validating JSON.
HTTP Method: POST
Path: {{baseUrl}}/amlyze-ws-rest/validate-batch-accounts
ContentType: application/json
Authorization: Basic Auth/Bearer Token
Validate batch of accounts with saving This method sends data and imports accounts in Amlyze.
HTTP Method: POST
Path: {{baseUrl}}/amlyze-ws-rest/batch-accounts
ContentType: application/json
Authorization: Basic Auth/Bearer Token
The minimalistic request represents scenario of already onboarded customer (INDIVIDUAL or ORGANIZATION ), to whom a new IBAN account (Not necessarily ) is being attached.
All payload fields & descriptions suitable for request.
API requests example Show Mandatory fields example | CUSTOMER import - BATCH
{ "accounts" :[ { "communicationNumber" : "comNumber0" , "requester" : "Company Name Amlyze" , "businessEntityExtId" : "businessEntityExtId0" , // --> must match customer identification from /amlyze-ws-rest/customer "customerExtId" "accountExtId" : "accountExtId0" , "accountNumber" : "LI9208800274335945522" , "accountStatus" : "ACTIVE" , "currencyCode" : "EUR" , "openingDate" : "2023-09-05T08:07:34.605Z" , "bic" : "AmlyzeXX22" , "isOtherFinInstAccount" : true // --> whether account for customer's upcoming operations exists outside your company }, { "communicationNumber" : "comNumber1" , "requester" : "Company Name Amlyze" , "businessEntityExtId" : "businessEntityExtId1" , // --> must match customer identification from /amlyze-ws-rest/customer "customerExtId" "accountExtId" : "accountExtId1" , "accountNumber" : "LI9208800274335945523" , "accountStatus" : "ACTIVE" , "currencyCode" : "EUR" , "openingDate" : "2023-09-05T08:07:34.605Z" , "bic" : "AmlyzeXX22" } ] } Fields The data documentation can be found here.
List of possible responses 200 OK { "results" : [ { "resultType" : "REQUEST_ACCEPTED" , "communicationNumber" : "comNumber0" , "accountExtId" : "accountExtId0" , "businessUnit" : "businessUnit0" , "timeElapsedMs" : 203 }, { "resultType" : "REQUEST_ACCEPTED" , "communicationNumber" : "comNumber1" , "accountExtId" : "accountExtId0" , "businessUnit" : "businessUnit1" , "timeElapsedMs" : 203 }, ], "timeElapsedMs" : 408 } 200 OK { "results" : [ { "resultType" : "REQUEST_ACCEPTED" , "communicationNumber" : "comNumber0" , "accountExtId" : "accountExtId0" , "businessUnit" : "businessUnit0" , "timeElapsedMs" : 203 }, { "resultType" : "REQUEST_REJECTED" , "communicationNumber" : "comNumber1" , "accountExtId" : "accountExtId1" , "businessUnit" : "businessUnit1" , "errorCode" : "O005" , "errorDescription" : "CommunicationNumber already used in amlyze" , "timeElapsedMs" : 20 }, ], "timeElapsedMs" : 223 } 400 Bad Request (Invalid json body) { "timestamp" : "2024-05-26T16:49:50.237+00:00" , "status" : 400 , "error" : "Bad Request" , "path" : "/amlyze-ws-rest/batch-accounts" } 500 Internal Server Error { "errorCode" : "500" , "errorDescription" : "Processing failed" , "timeElapsedMs" : 172 } 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
