Client. Fetch data by ID GET

Fetch Client data by ID

# ENDPOINT
/model/client/getDb/{id}
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0
M
id
path
0
51 M Id record
# RESPONSE
        						
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M
id id path integer M Id record
Example 51
# 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 customer ID in external system
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": {
        "division_client_code": "",
        "client_code": "EN000127K",
        "full_name": "Inga Krausen",
        "first_name": "Inga",
        "last_name": "Krausen",
        "client_group": "CLIENT",
        "entity_type": "PERSON",
        "external_number": "",
        "date_of_birth": "1980-01-02",
        "place_of_birth": "LV",
        "gender": "F",
        "registration_number": "010180-11111",
        "bic": "",
        "client_status": "RESTRICTED",
        "registration_date": "2021-09-13",
        "registration_user": "jsokol",
        "activation_date": null,
        "activation_user": "",
        "close_date": null,
        "close_user": "",
        "residence_country": "LV",
        "ext_client_id": "",
        "scoring_risk_group": "",
        "scoring_points": 0,
        "communication_language": "",
        "external_systems": "",
        "old_client_status": "RESTRICTED",
        "old_client_group": "CLIENT",
        "full_legal_address": "OGRES 15-23, RIGA, LV1055, Latvia",
        "subscription_code": "",
        "description": "Inga Krausen",
        "create_external_systems": false,
        "uid": "eb7058d5-8e08-3e85-8714-461524f24e3b",
        "id": 2206,
        "version": 967367538,
        "state": 0,
        "create_user": "jsokol",
        "create_date": "2021-09-13T12:00:47.272",
        "modify_user": "root",
        "modify_date": "2021-09-14T15:44:54.020"
    }
}						
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>

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