API - Automated information exchange toolkit

  1. API - Automated information exchange toolkit
Description of the API section - API - Automated information exchange toolkit
A toolkit to ensure automated information exchange with other national electronic information resources and public electronic registers, in particular for processing information on blocking assets of persons subject to sanctions as provided for in clause 1 of part one of Article 1 of the Law "On Sanctions".

API - Automated information exchange toolkit

General information:

Base URL:http://www.sanctions.pp.ua:8043
Path:described separately
Method:GET (unless specified separately)
Parameters:none (unless specified separately)
Success status code:200
Error status code:any
Response data type:JSON

Search:

Path: /api/search.php?search=<search> Search of persons or legal entities
Parameters: <search> Search string - person`s name or company name
Example of an API request in PHP:

$url = "http://www.sanctions.pp.ua:8043/api/search.php?search=ЯКУНІН%20Вадим%20Сергійович";
echo "\$url=[$url]<br>";
$data = json_decode(file_get_contents($url), true);
echo "<pre>".print_r($data, 1)."</pre>";
Response description:
data
 
Array of Object<Person | Company>
 searching results

Object<Person | Company>:
OBJ_ID
 
Int8
 internal Person or Company ID 
OBJ_TYPE_NAME
 
String(32)
 Type title of object 
REG_NUM
 
String(64)
 Registration or taxpayer ID 
OBJ_FOTO
 
String(1024)
 Photo or logo link of object 
OBJ_STATUS
 
Int3
 Status of object (1 - under sanctions; 2 - identified for application of sanctions; 3 - related person) 
OBJ_WANTED
 
Int3
 Wanted (0 - no; 1 - yes) 
OBJ_NAME_UA
 
String(1024)
 name in Ukrainian 
OBJ_NAME_RU
 
String(1024)
 name in Russian 
OBJ_NAME_EN
 
String(1024)
 name in English 
OBJ_BORN_DATE
 
String(128)
 Date of Birthor or registration 
OBJ_DEAD_DATE
 
String(32)
 Date of death or liquidation 
OBJ_BORN_DESC_UA
 
String(1024)
 Place of Birth or registration in Ukrainian 
OBJ_BORN_DESC_RU
 
String(1024)
 Place of Birth or registration in Russian 
OBJ_BORN_DESC_EN
 
String(1024)
 Place of Birth or registration in English 
category
 
String(255)
 category in Ukrainian or null 
subcategory_1
 
String(255)
 subcategory (level 1) in Ukrainian or null 
subcategory_2
 
String(255)
 subcategory (level 2) in Ukrainian or null 
subcategory_3
 
String(255)
 subcategory (level 3) in Ukrainian or null 
OBJ_POSITION_UA
 
String(4000)
 position in Ukraninian 
OBJ_POSITION_RU
 
String(4000)
 position in Russian 
OBJ_POSITION_EN
 
String(4000)
 position in English 
OBJ_REASON_UA
 
String(4000)
 reason for imposing sanctions in Ukrainian 
OBJ_REASON_RU
 
String(4000)
 reason for imposing sanctions in Russian 
OBJ_REASON_EN
 
String(4000)
 reason for imposing sanctions in English 
OBJ_ADDR_UA
 
String(1024)
 Legal address of registration in Ukrainian 
OBJ_ADDR_RU
 
String(1024)
 Legal address of registration in Russian 
OBJ_ADDR_EN
 
String(1024)
 Legal address of registration in English 
OBJ_FADDR
 
String(1024)
 Actual address in Ukrainian 
OBJ_DESC
 
Longtext
 Additional Information in Ukrainian 
country_arr
 
Array of Object <CountriesRegistration>
 List of countries registration 
ukaz_arr
 
Array of Object <DecreesSanctions>
 List of Decrees on sanctions 
country_sanc_arr
 
Array of Object <CountriesImposedSanction>
 List of countries that imposed sanctions

Object <CountriesRegistration>:
COUNTRY_ID
 
Int8
 ID of the country registration 
COUNTRY_NAME
 
String(1024)
 Name of the country registration 
PASSPORT
 
String(1024)
 Citizen`s passport in the country of registration 
REG_NUM
 
String(64)
 Company registration code in the country 
INN
 
String(64)
 Individual tax number in the country 
KPP
 
String(64)
 Registration reason code

Object <DecreesSanctions>:
O_U_LNK_ID
 
Int8
 ID of the object`s position in the sanctions list 
UKAZ_NUM
 
String(32)
 Decree number 
UKAZ_TYPE_NAME
 
String(64)
 Type of Decree 
O_U_NUM
 
Int4
 Number of the object in the sanctions list 
DATE_START
 
Date (yyyy-mm-dd)
 Sanctions start date 
DATE_END
 
Date (yyyy-mm-dd)
 Sanctions end date 
PERIOD
 
Int3
 Deadline for imposing sanctions is years 
PERIOD_DAY
 
Int3
 Sanction period days 
OBJ_UKAZ_BASE
 
String(4000)
 Commentary on the sanctions list 
sanc_arr
 
Array of Object <ListTypesSanctions>
 List of Types of Sanctions

Array <ListTypesSanctions>:
[number_sanc_id]
 
Int3
 Sanction ID 
sanction_name
 
String(1024)
 Type of sanctions

Object <CountriesImposedSanction>:
COUNTRY_ID
 
Int8
 ID of the country that imposed sanctions 
COUNTRY_NAME
 
String(1024)
 Name of the country that imposed sanctions 
SANC_DATE
 
Date (yyyy-mm-dd) | Null
 Date of the imposition of sanctions 
SANC_URL
 
String(1024)
 Link to official notification

Stop Hybrid Threats