Schemas Postman

AML Black List. Fetch data by request POST

Get AML Black List data by request

# ENDPOINT
/api/blocklist/getData/blocklistSearchRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
# REQUEST BODY
Schema: blockListSearchRequest

{
    "country_code": "BE"
}

Type: object
Variable Name Type Format Usage Description
account_number account_number string Account_number
account_number_iban Account number iban string
bank_code bank_code string
blacklist_code blacklist_code string
List of allowed values in field (value=>name):
  • 0
    BLACKLIST_COUNTRY
  • 1
    BLACKLIST_DETAILS
  • 2
    BLACKLIST_FI
  • 3
    BLACKLIST_PERSON
  • 4
    WHITELIST_COUNTRY
  • 5
    WHITELIST_PERSON
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
counterparty_id counterparty_id integer INT64 Counterparty id
counterparty_name counterparty_name string
country_code country_code string Two-letter ISO 3166-2 code of a given country
details details string Details of payment
from_expiration_date From expiration date string
limit limit integer int64 Count records for part data to get
offset_version Offset version INTEGER
offsetid Offsetid integer
page page integer int64 Part data with number of page
page_changes_version_offset Page changes version offset INTEGER
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
to_expiration_date To expiration date string
# REQUEST BODY EXAMPLE
							{
    "country_code": "BE"
}
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: blocklist
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 array 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": "",
    "total_records": 3,
    "data": [
        {
            "id": 390,
            "uid": "da815fcd-f98e-c09f-6d14-5ebdd8b8367d",
            "version": 392940633,
            "state": 0,
            "modify_date": "2020-07-24T16:20:10.697",
            "modify_user": "root",
            "create_date": "2020-07-24T16:20:10.696",
            "create_user": "root",
            "counterparty_name": "BELGIAN CHOCOLATE",
            "account_number": "",
            "bank_code": "",
            "country_code": "BE",
            "activation_date": "2020-07-24",
            "blacklist_code": "WHITELIST_PERSON",
            "expiration_date": "2020-07-24",
            "counterparty_uid": "9eef6f82-ca94-75be-6d14-5bbdd855f164",
            "counterparty_id": 2351381
        },
        {
            "id": 488,
            "uid": "8b1f45ba-de8e-73b2-6e14-aac8782c86df",
            "version": 393148236,
            "state": 0,
            "modify_date": "2020-08-10T16:31:39.057",
            "modify_user": "root",
            "create_date": "2020-08-10T16:31:39.057",
            "create_user": "root",
            "counterparty_name": "GREEN BOTLLE LTD.",
            "account_number": "",
            "bank_code": "",
            "country_code": "BE",
            "activation_date": "2020-08-10",
            "blacklist_code": "WHITELIST_PERSON",
            "expiration_date": "2020-08-10",
            "counterparty_uid": "e84386ed-ec23-19a6-6e14-64c830b5174a",
            "counterparty_id": 2351794
        },
        {
            "id": 713,
            "uid": "cd6a3f10-7350-04a8-7014-928d386d0c23",
            "version": 393348719,
            "state": 0,
            "modify_date": "2020-09-08T12:09:21.741",
            "modify_user": "root",
            "create_date": "2020-09-08T12:09:21.740",
            "create_user": "root",
            "counterparty_name": "OSKAR MCGREGOR",
            "account_number": "",
            "bank_code": "",
            "country_code": "BE",
            "activation_date": "2020-09-08",
            "blacklist_code": "WHITELIST_PERSON",
            "expiration_date": "2020-09-08",
            "counterparty_uid": "f1c12fd6-3354-fdb9-7014-578db8758f7f",
            "counterparty_id": 2352111
        }
    ]
}
# 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
# Other endpoints
Name Endpoint
AML Black List. Fetch data by ID / UID /model/blocklist/getDb/{id}
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}