Schemas Postman

Client. Prepare data POST

Prepare Client data

# ENDPOINT
/model/client/prepare
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M
# REQUEST BODY
Schema: client
Type: object
Variable Name Type Format Usage Description
action Action string
activation_date Activation Date string DATE Activation date in the system
activation_user Activation User string The username of ABS user who has activated client in the system
bic bic string M Bank Identification Code / Swift Code as for the International payment standard
client_code Client code string M Unique client identifier. Issued automatically by the System upon new Customer registration.
client_group client_group string M Client group
List of allowed values in field (value=>name):
  • 0
    AGENT
  • 1
    APPLICANT
  • 2
    BENEFICIARY
  • 3
    BRANCH
  • 4
    CHALLENGER
  • 5
    CLIENT
  • 6
    CLIENT
  • 7
    COMPANY
  • 8
    CONTACT
  • 9
    COUNTERPARTY
  • 10
    EMPLOYEE
  • 11
    PROVIDER
  • 12
    PSP
  • 13
    RECIPIENT
  • 14
    REGULATOR
  • 15
    RELATED_PERSON
  • 16
    SUPPLIER
  • 17
    USER
client_status Client Status string M Client status
List of allowed values in field (value=>name):
  • 0
    ACTIVATING
  • 1
    ACTIVE
  • 2
    ACTIVE_INTERNAL
  • 3
    BLACKLIST
  • 4
    CHECKING
  • 5
    CLOSED
  • 6
    PENDING
  • 7
    RESTRICTED
  • 8
    SUSPENDED
close_date Close Date string DATE Client close date in the system
close_user Close User string The username of ABS user who has closed client in the system
communication_language communication_language string Language for communication
create_date Create Date string DATETIME The date entry was created on
create_external_systems Create external systems boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
create_user Create User string The username of ABS user who has created an entry
date_of_birth date_of_birth string DATE M Customer date of birthday
description description string Description of a given record
division_client_code Division client code string
enableCounterpertyRegistration Clients boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
entity_type entity_type string M Customer type
List of allowed values in field (value=>name):
  • 0
    BUSINESS
  • 1
    PERSON
ext_client_id ext_client_id string External system client id connection
external_number external_number string External client number for client
external_systems external_systems string External systems
first_name first_name string M First name of a given customer (user)
form_title form_title string Service field
full_legal_address full_legal_address string Customer full address aggregates [Address Line 1], [Address Line 2], [City], [County], [Post Code] and [Country]
full_name full_name string M Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
gender gender string Customer gender
List of allowed values in field (value=>name):
  • 0
    E
  • 1
    F
  • 2
    M
id id integer INT64 Record's sequence number generated in the system.
last_name last_name string M Last name of a given customer (user)
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
old_client_group old_client_group string
old_client_status Old Client Status string Old client status
place_of_birth place_of_birth string
registration_date Registration Date string DATE The date client was registered in system. It is filled automatically
registration_number registration_number string Registration number of a legal entity or personal code of an individual (user)
registration_user Registration User string The username of ABS user who has registered client in the system.
residence_country residence_country string M Country of residence of the client. Two-letter country code (ISO country)
scoring_points scoring_points integer INTEGER M Client AML scoring points
scoring_risk_group scoring_risk_group string Client AML scoring group
state state integer INT64 Record state for replication
subscription_code Subscription Code string Subscription code
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# REQUEST BODY EXAMPLE
							{        
        "client_code": "EN00070JY",
        "full_name": "ELCOIN",
        "first_name": "ELCOIN",
        "last_name": "",
        "client_group": "CLIENT",
        "entity_type": "BUSINESS",
        "external_number": "",
        "date_of_birth": "2019-01-02",
        "gender": "E",
        "registration_number": "12345678",
        "bic": "",
        "client_status": "ACTIVE",
        "registration_date": "2019-07-01",
        "registration_user": "Administrator",
        "activation_date": null,
        "activation_user": "",
        "close_date": null,
        "close_user": "",
        "residence_country": "LT",
        "ext_client_id": "",
        "scoring_risk_group": "",
        "scoring_points": 0,
        "communication_language": "",
        "external_systems": "",
        "old_client_status": "ACTIVE",
        "old_client_group": "CLIENT",
        "full_legal_address": "",
        "subscription_code": "SMALL",
        "description": "ELCOIN",
        "create_external_systems": false,
        "uid": "af3fc011-afb5-2fbd-5514-a1b1f4418b3c",
        "id": 51,
        "version": 388462382,
        "create_user": "Administrator",
        "create_date": "2019-07-01T23:54:36.251",
        "modify_date": "2020-03-12T21:58:39.958"
}
# POSITIVE RESPONSE

200 - Response successfully when status is OK

200 - Response successfully when status is OK

Schema: client
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object data of Response
attribute: data
Variable Name Type Format Description
action Action string
activation_date Activation Date string DATE Activation date in the system
activation_user Activation User string The username of ABS user who has activated client in the system
bic bic string Bank Identification Code / Swift Code as for the International payment standard
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_group client_group string Client group
client_status Client Status string Client status
close_date Close Date string DATE Client close date in the system
close_user Close User string The username of ABS user who has closed client in the system
communication_language communication_language string Language for communication
create_date Create Date string DATETIME The date entry was created on
create_external_systems Create external systems boolean
create_user Create User string The username of ABS user who has created an entry
date_of_birth date_of_birth string DATE Customer date of birthday
description description string Description of a given record
division_client_code Division client code string
enableCounterpertyRegistration Clients boolean
entity_type entity_type string Customer type
ext_client_id ext_client_id string External system client id connection
external_number external_number string External client number for client
external_systems external_systems string External systems
first_name first_name string First name of a given customer (user)
form_title form_title string Service field
full_legal_address full_legal_address string Customer full address aggregates [Address Line 1], [Address Line 2], [City], [County], [Post Code] and [Country]
full_name full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
gender gender string Customer gender
id id integer INT64 Record's sequence number generated in the system.
last_name last_name string Last name of a given customer (user)
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
old_client_group old_client_group string
old_client_status Old Client Status string Old client status
place_of_birth place_of_birth string
registration_date Registration Date string DATE The date client was registered in system. It is filled automatically
registration_number registration_number string Registration number of a legal entity or personal code of an individual (user)
registration_user Registration User string The username of ABS user who has registered client in the system.
residence_country residence_country string Country of residence of the client. Two-letter country code (ISO country)
scoring_points scoring_points integer INTEGER Client AML scoring points
scoring_risk_group scoring_risk_group string Client AML scoring group
state state integer INT64 Record state for replication
subscription_code Subscription Code string Subscription code
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "system.api.clients.clientModel",
    "total_records": 1,
    "data": {
        "client_code": "EN00070JY",
        "full_name": "ELCOIN",
        "first_name": "ELCOIN",
        "last_name": "",
        "client_group": "CLIENT",
        "entity_type": "BUSINESS",
        "external_number": "",
        "date_of_birth": "2019-01-02",
        "gender": "E",
        "registration_number": "12345678",
        "bic": "",
        "client_status": "ACTIVE",
        "registration_date": "2019-07-01",
        "registration_user": "Administrator",
        "activation_date": null,
        "activation_user": "",
        "close_date": null,
        "close_user": "",
        "residence_country": "LT",
        "ext_client_id": "",
        "scoring_risk_group": "",
        "scoring_points": 0,
        "communication_language": "",
        "external_systems": "",
        "old_client_status": "ACTIVE",
        "old_client_group": "CLIENT",
        "full_legal_address": "",
        "subscription_code": "SMALL",
        "description": "ELCOIN",
        "create_external_systems": false,
        "uid": "af3fc011-afb5-2fbd-5514-a1b1f4418b3c",
        "id": 51,
        "version": 388462382,
        "create_user": "Administrator",
        "create_date": "2019-07-01T23:54:36.251",
        "modify_date": "2020-03-12T21:58:39.958"
    }
}
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# RESPONSE NEGATIVE EXAMPLE
							{
    "status": "error",
    "error_description": "Json Parser Error at offset 53: parse error: invalid object key (must be a string). (16068)",
    "error": {},
    "data_type": "system.api.clients.clientModel",
    "total_records": 1,
    "data": {}
}
# Other endpoints
Name Endpoint
Client. Fetch data by request /api/client/getData/clientSearchRequest
Client. Fetch data by ID /model/client/getDb/{id}
Client. Validate data /model/client/validate
Client. Create/update data /model/client/putDb
Client. Delete item by ID /api/client/deleteItem/{id}