Client
Get Client
• Client should exist in the system
Get Clients
• Page number should be equal or bigger then 1.
• Records per page should be between 10 and 1000.
Get Users
• Listing is restricted, if client is created without identity user or client type is RetailOnBehalf or BusinessOnBehalf
Create Client
• Client Email is optional for External clients, while it is required for remaining clients.
• Client LEI and default decision maker LEI cannot be empty for Business clients.
• Client LEI and default decision maker LEI should be in the format of:
^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}$
• Surname, Nationality,Date of birth, Place of birth , marital status , title , birthname ,gender and salutation is not applicable for Business clients.
• Client LEI, default decision maker LEI and establish date is not applicable for Retail clients.
• Client key will be used as customer id. Customer id can be sent in this field.
• Client key is mandatory for all clients.
• Marital status and surname required for Retail clients.
• If gender is not sent for Retail clients then it will be set as "Unspecified" as default.
• At least one communication method(Post,Phone,Email) is mandatory for all clients.
• Nationality and date of birth is required for retail clients.
• Identity number type should be national id number for the retail clients of Estonia,Iceland,Malta and Poland.
• Identity number is required for the retail clients of Estonia,Iceland,Malta and Poland.
Update Client
• Client Email is optional for External clients, while it is required for remaining clients.
• Client LEI and default decision maker LEI cannot be empty for Business clients.
• Client LEI and default decision maker LEI should be in the format of:
^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}$
• marital status, title , birthname , gender and salutation is not applicable for Business clients.
• Client LEI is not applicable for Retail clients.
• Marital status and surname required for Retail clients.
• if client has defined tax identifier or exemption order then client cannot be update as “not liable to tax”.
• If gender is not sent for Retail clients then it will be set as "Unspecified" as default.
• At least one communication method(Post,Phone,Email) is mandatory for all clients.
• Nationality and date of birth is required for retail clients.
• Identity number type should be national id number for the retail clients of Estonia,Iceland,Malta and Poland.
• Identity number is required for the retail clients of Estonia,Iceland,Malta and Poland.
Add Client Photo
• Client photo is not mandatory.
• Client can have only one photo at the same time
• Client photo should be max 2MB.
Update Client Photo
• Client photo is not mandatory.
• Client photo should be max 2MB.
Add User
• Retail clients can only have 1 user.
• If client is created without identity user then add user is restricted for this client.
Add Document
• Client should exist in the system.
• ValidFrom and ValidUntil fields should be dates and format should be yyyy-MM-dd.
• ValidUntil field can not be a date before now.
• ValidFrom cannot be later than ValidUntil.
• Document should be max 5MB.
Remove Document
• Requested document should exist in the system for requested client.
Get Internal Account
• Requested bank account should exist in the system for requested client.
Get Deposit Account
• Requested deposit account should exist in the system for requested client.
Get Authorized People
• If client type is not Business then listing is restricted.
Add Authorized Person
• Authorized person can only add for Business clients.
• ValidFrom and ValidUntil fields of certificate of incumbency, should be dates and format should be yyyy-MM-dd.
• ValidUntil field of certificate of incumbency can not be a date before now.
• ValidFrom field of certificate of incumbency cannot be later than ValidUntil.
• Certificate of incumbency document should be max 5MB.
Delete Authorized Person
• If client type is not Business then delete is restricted.
• Requested authorized person should exist in the system
Update Authorized Person
• Authorized person can be updated only for Business clients.
• ValidFrom and ValidUntil fields of certificate of incumbency, should be dates and format should be yyyy-MM-dd.
• ValidUntil field of certificate of incumbency can not be a date before now.
• ValidFrom field of certificate of incumbency cannot be later than ValidUntil.
• Certificate of incumbency document should be max 5MB.
Update Phone Number
• Requested phone number should exist in the system.
Get Phone Number
• Requested phone number should exist in the system.
Add Address
• ValidFrom and InvalidFrom fields should be in date time format.
• InvalidFrom field can not be a date time before now.
• ValidFrom field cannot be later than InvalidFrom.
Update Address
• Address should exist in the system.
• ValidFrom and InvalidFrom fields should be in date time format.
• InvalidFrom field can not be a date time before now.
• ValidFrom field cannot be later than InvalidFrom.
Get Address
• Address should exist in the system
Set Default Bank Account
• Requested bank account should be defined for the requested client.
Set Default Internal Account
• Requested internal account should be defined for the requested client.
Set Default Deposit Account
• Requested deposit account should be defined for the requested client.
Add Tax Identifier
• Requested client should be liable to tax.
Update Tax Identifier
• Tax identifier should exist in the system.
Get Tax Identifier
• Tax identifier should exist in the system.
Validate Client
• Client account should exist in the system.
• Client should have documents uploaded.
• Deleted and suspended clients cannot be validated.
Update Client Status
• Client should exist in the system.
• If existing status and the requested status is initial, conflict occurs.
• If account status is deleted and the requested status is onboarded, conflict occurs.
• If account status is initial or deleted, status cannot update to suspended and deleted.
• Retail clients of Italy and Spain should have tax identification number if requested status is Active.
• Retail clients of Estonia,Iceland,Malta and Poland should have national id number if requested status is Active.
Add NonAssessment Certificate
• ValidFrom and ValidUntil fields should be dates and format should be yyyy-MM-dd.
• ValidUntil field can not be a date before now.
• ValidFrom cannot be later than ValidUntil.
• ValidFrom can only be 1st of January.
• ValidUntil can only be 31st of December.
• ValidFrom field must be before than the 1st of January of the current year.
• ValidUntil field must be later than the 31st of December of the previous year.
• Nonassessment certificate can be valid for 3 years.
• A client can only have 1 nonassessment certificate.
• Only legal nonassessment certificate types are applicable for Business clients.
• Only natural person nonassessment certificate type is applicable for retail clients.
Revoke NonAssessment Certificate
• Requested nonassessment certificate should exist for the requested client.
• ValidUntil can only be 31st of December
• ValidFrom cannot be later than the ValidUntil.
• Nonassessment certificate can be valid for max 3 years.
Get NonAssessment Certificate
• Requested nonassessment certificate should exist for the requested client
Add Employment
• Employment section and division should exist in the system.
• Employment sections are available on employment/sector endpoint of helper api
• Employment divisions are available on employment/classificationCode/division endpoint of helper api.
• classificationCode from the employment/sector endpoint should send to employment/classificationCode/division endpoint in path
• ValidUntil is not mandatory. but if it is sent then it should be a valid date and should be bigger than the ValidFrom
Update Employment
• Client employment definition should exist in the system.
• Employment section and division should exist in the system.
• Employment sections are available on employment/sector endpoint of helper api
• Employment divisions are available on employment/classificationCode/division endpoint of helper api.
• classificationCode from the employment/sector endpoint should send to employment/classificationCode/division endpoint in path
• ValidUntil is not mandatory. but if it is sent then it should be a valid date and should be bigger than the ValidFrom
Get Employment
• Client employment definition should exist in the system
Get Church Tax Information
• Only retail clients can have church tax information
OnDemand KISTAM Query
• Client should exist in the system
• KISTAM query can be done for only retail clients