Schemas Postman

Customer. Fetch data by Client Code GET

Fetch Customer data by Client Code

# ENDPOINT
/model/customer/getDbByClientCode/{client_code}
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		DEV-SKIP DEV-SKIP M Dev Authentication
client_code
path
0 		EN003H70M M Unique Client Code
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
Example DEV-SKIP
client_code client_code path string M Unique Client Code
Example EN003H70M
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: CustomerData
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
addresses addresses array
clientData clientData object
contacts contacts array
counterpartyData counterpartyData object
services services array
accountReferences accountReferences array
attribute: addresses
Variable Name Type Format Description
action Action string
activation_date Activation Date string DATE Activation date in the system
address_type address_type string The addresses section provides the list of all available addresses a contact has as follows
address_type_description address_type_description string Address type description
apartment apartment string Residence/correspondence number of house
card_code card_code string Card code
city city string Residence/ correspondence address city/town
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_full_name client_full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
counterparty_id counterparty_id integer INT64 Counterparty id
country_code country_code string Two-letter ISO 3166-2 code of a given country
country_description country_description string Country of residence or incorporation
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
expiration_date Expiration Date string DATE Expiration date in the system
form_title form_title string Service field
full_address full_address string Customer full address aggregates [Address Line 1], [Address Line 2], [City], [County], [Post Code] and [Country] fields
house house string Residence/correspondence number of house
house_name house_name string Residence/correspondence name of house
id id integer INT64 Record's sequence number generated in the system.
language language string The language user has specified as the language of service
latitude latitude number decimal A geographic coordinate that specifies the north–south position of a point on the Earth is surface
longitude longitude number decimal A geographic coordinate that specifies the east–west position of a point on the Earth is surface
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
place_code place_code string Residence/correspondence place code
post_code post_code string Shows the value of address postal code, zip code or post code, like CR2 9ER
region region string Residence/ correspondence region
region_code region_code string Region code
state state integer INT64 Record state for replication
street street string Residence/ correspondence name of street
sub_street sub_street string Residence/ correspondence name of substreet
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
attribute: clientData
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
attribute: contacts
Variable Name Type Format Description
action Action string
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
contact_type contact_type string Type of contact data
contact_value contact_value string Data by type of contact
counterparty_id counterparty_id integer INT64 Counterparty id
country_calling_code country_calling_code string Calling code of country
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
description description string Description of a given record
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
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
representative_type representative_type string
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
use_device_for_login Use device for login BOOLEAN
version version integer INT64 Record version for replication
attribute: counterpartyData
Variable Name Type Format Description
action Action string
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_group client_group string Client group
communication_language communication_language string Language for communication
counterparty_status counterparty_status string Counterparty status
create_date Create Date string DATETIME The date entry was created on
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
entity_type entity_type string Customer type
external_counterparty_id external_counterparty_id string External system client id connection
external_number external_number string External client number for client
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.
invitation_token Invitation token string
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
password Password string Client password issued to the client by the external system
place_of_birth place_of_birth string
processing_data processing_data string Data of processing operation
processing_result processing_result string
processing_review Aml system processing status string
processing_status Processing Status string Status of remote client data processing received from the external system
registration_number registration_number string Registration number of a legal entity or personal code of an individual (user)
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
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
attribute: services
Variable Name Type Format Description
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
description description string Description of a given record
name name string Description of a given user
attribute: accountReferences
Variable Name Type Format Description
account_number account_number string Account_number
action Action string
bank_address bank_address string bank address
bank_bic_swift bank_bic_swift string bank bic swift
bank_code bank_code string
bank_code_type Bank Code Type string Bank Code Type
bank_country bank_country string bank country
bank_name bank_name string bank name
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_id Client ID integer
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
description description string Description of a given record
destination_tag Destination tag STRING
digital_asset_address Digital asset address STRING
digital_asset_url Digital asset url STRING
ewallet ewallet string ewallet
external_client_id external_client_id string external client id
form_title form_title string Service field
full_name full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
iban iban string A unique account IBAN generated by the System according to IBAN generation rules
id id integer INT64 Record's sequence number generated in the system.
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
reference reference string reference
scheme_account Account service scheme string This parameter is used when opening new accounts in the System. The parameter allows selecting the underlying accounting scheme that will be used for linking the account balance to a given payment services provider and its available account management end-points.
scheme_name scheme_name string scheme name
state state integer INT64 Record state for replication
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.rest.customer.customerModel",
    "total_records": 1,
    "data": {
        "clientData": {
            "client_code": "EN003H70M",
            "full_name": "Alfie Finch",
            "first_name": "Alfie",
            "last_name": "Finch",
            "client_group": "CLIENT",
            "entity_type": "PERSON",
            "external_number": "e9b30bdd-9fd9-40f5-aec7-b93d97298a05",
            "date_of_birth": "2020-10-19",
            "place_of_birth": "",
            "gender": "E",
            "registration_number": "123456",
            "bic": "",
            "client_status": "RESTRICTED",
            "registration_date": "2020-10-19",
            "registration_user": "root",
            "activation_date": "2020-10-19",
            "activation_user": "7f3b869f-34f3-4f20-ab4d-7480a5fdf647",
            "close_date": null,
            "close_user": null,
            "residence_country": "GB",
            "ext_client_id": "e9b30bdd-9fd9-40f5-aec7-b93d97298a05",
            "scoring_risk_group": "",
            "scoring_points": 0,
            "communication_language": "",
            "external_systems": "",
            "old_client_status": "",
            "old_client_group": "",
            "full_legal_address": "London, United Kingdom",
            "subscription_code": "BASIC",
            "description": "Alfie Finch",
            "create_external_systems": true,
            "uid": "e9b30bdd-9fd9-40f5-aec7-b93d97298a05",
            "id": 2353255,
            "version": 456969690,
            "state": null,
            "create_user": "root",
            "create_date": "2020-10-19T14:32:28.066",
            "modify_user": "root",
            "modify_date": "2020-10-19T14:32:35.886"
        },
        "counterpartyData": null,
        "addresses": [
            {
                "client_code": "EN003H70M",
                "counterparty_id": 2353254,
                "card_code": "",
                "client_full_name": "Alfie Finch",
                "address_type": "Legal",
                "address_type_description": "",
                "language": "en",
                "city": "London",
                "street": "",
                "sub_street": "",
                "region_code": "",
                "region": "",
                "house": "",
                "house_name": "",
                "apartment": "",
                "place_code": "",
                "post_code": "",
                "country_code": "GB",
                "latitude": null,
                "longitude": null,
                "activation_date": null,
                "expiration_date": null,
                "country_description": "United Kingdom",
                "full_address": "London, United Kingdom",
                "uid": "cfba2b7a-326c-b693-7314-7b1370de2648",
                "id": 32346,
                "version": 456969702,
                "state": 0,
                "create_user": "root",
                "create_date": "2020-10-19T14:31:33.432",
                "modify_user": "root",
                "modify_date": "2020-10-19T14:32:39.902"
            }
        ],
        "accountReferences": [],
        "contacts": [],
        "services": [
            {
                "client_code": "EN003H70M",
                "name": "Subscription",
                "description": "Customer subscribtion: BASIC"
            }
        ],
        "uid": "",
        "id": 0,
        "version": 0,
        "state": 0,
        "create_user": "",
        "create_date": null,
        "modify_user": "",
        "modify_date": null
    }
}
# NEGATIVE RESPONSE

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": "[RECORD-NOT-FOUND : Object clientModel cannot find record client.client_code with value test]",
    "error": {},
    "data_type": "system.rest.customer.customerModel",
    "total_records": 1,
    "data": {}
}
# Other endpoints
Name Endpoint
Customer. Fetch data by Counterparty ID /model/customer/getDbByCounterpartyId/{id}
Customer. Fetch data by Counterparty UID /model/customer/getDbByCounterpartyUId/{uid}
Customer. Validate data /model/customer/validate
Customer. Prepare data /model/customer/prepare
Customer. Create/update data /model/customer/putDb