API Docs. Elcoin Ltd

AML Black List. Fetch data by ID / UID POST

Fetch AML Black List data by ID

# ENDPOINT

/model/blocklist/getDb/{id}

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0	DEV-SKIP	DEV-SKIP	M	Dev Authentication
id path 0		1232 - for ID ff17e35d-5a29-819b-7614-a7b308521d94 - for UID	M	Record ID or UID

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M	Dev Authentication
Example	DEV-SKIP
id	Record ID or UID	path	integer	M	Record ID or UID
Example	1232 - for ID ff17e35d-5a29-819b-7614-a7b308521d94 - for UID

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: blocklist

Type: application/json

Variable	Name	Type	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
account_number	account_number	string		Account_number
action	Action	string
activation_date	Activation Date	string	DATE	Activation date in the system
bank_code	bank_code	string
blacklist_code	blacklist_code	string
counterparty_id	counterparty_id	integer	INT64	Counterparty id
counterparty_name	counterparty_name	string
counterparty_uid	Counterparty uid	string
country_code	country_code	string		Two-letter ISO 3166-2 code of a given 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
expiration_date	Expiration Date	string	DATE	Expiration date in the system
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
old_blacklist_code	Old blacklist code	string
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": "solutions.Aml.api.counterpartyBlacklist.blacklistModel",
    "total_records": 1,
    "data": {
        "blacklist_code": "WHITELIST_PERSON",
        "counterparty_name": "Å½aklÄ«ne LiepiÅ†a",
        "counterparty_uid": "BPWfjIYtjoMBtT5k",
        "counterparty_id": 2357939,
        "account_number": "",
        "bank_code": "",
        "country_code": "",
        "activation_date": "2021-01-20",
        "expiration_date": "2021-01-20",
        "uid": "ff17e35d-5a29-819b-7614-a7b308521d94",
        "id": 1232,
        "version": 421790277,
        "create_user": "root",
        "create_date": "2020-12-17T14:56:18.663",
        "modify_date": "2021-01-20T11:51:25.681"
    }
}

# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError

Type: application/json

Variable	Name	Type	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

# Other endpoints

Name	Endpoint
AML Black List. Fetch data by request	/api/blocklist/getData/blocklistSearchRequest
AML Black List. Validate data	/model/blocklist/validate
AML Black List. Prepare data	/model/blocklist/prepare
AML Black List. Create/update data	/model/blocklist/putDb
AML Black List. Delete item by ID	/api/blocklist/deleteItem/{id}