ERD
Description#
ERD is a comprehensive service that integrates with various open and closed data sources, providing access to a wide range of information about citizens of the Republic of Kazakhstan.
For convenient integration via the Backend API, please use Swagger (OpenAPI)
Although the ERD service is essentially similar to KZ-Info (both provide information about debtors), it offers more up-to-date data, an official source of information, and an expanded set of fields, making it the preferred choice for integrations and automated checks.
Terms#
- IIN, Personal Number - Individual Identification Number of a citizen of the Republic of Kazakhstan.
- Subject - A person who is the object of a request for information from open sources about them. источников о нем.
- AIS EP - Automated Information System of Executive Proceedings.
Stages:#
1. Obtaining the Organization's API-KEY#
The first step in using the technology is to obtain your organization's API-KEY. To get the API-KEY, log in to your Personal Account via this link. The API-KEY can be found in the Backend API Key field.
Example of an organization's API-KEY:
API-KEY: Efy202XKbVAWRu...
Note
For illustration purposes, a shortened API KEY is shown.
The actual length is 47 or more characters.
2. Sending a request to check for presence in the debtors’ registry via AIS EP#
When sending a request to obtain an electronic document, the data must be in JSON format.
Important
To use this service, you must have an active subscription. More information about subscriptions can be found here.
Request URL:
https://kyc.biometric.kz/api/v1/backend/erd/retrieve/
| Request Format | Request Method |
|---|---|
| JSON | POST |
It is required to pass API KEY in the body of the request:
| Field Name | Type | Required | Description |
|---|---|---|---|
| api_key | String | Да | API KEY of organization in the personal account |
| personal_number | String | Да | IIN / Personal Number of the subject |
Request examples:
import requests
url = 'https://kyc.biometric.kz/api/v1/backend/erd/retrieve/'
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = {
'api_key': '<organization_api_key>',
'iin': '<subjects_iin>',
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const url = 'https://kyc.biometric.kz/api/v1/backend/erd/retrieve/';
const apiKey = '<organization_api_key>';
const headers = {
'Accept': 'application/json',
'Content-Type': 'application/json'
};
const data = {
api_key: apiKey,
iin: '<subjects_iin>',
};
fetch(url, {
method: 'POST',
headers: headers,
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));
The response will be a JSON object with the following fields:
- debtor_iin - Debtor’s IIN;
- debtor_surname - Debtor’s surname;
- debtor_name - Debtor’s first name;
- debtor_patronymic - Debtor’s patronymic;
- debtor_birth_data – Debtor’s date of birth;
- debtor_doc_number – Debtor’s document number;
- issue_organ_code – Code of the issuing authority;
- issue_organ_name_ru – Name of the issuing authority (in Russian);
- issue_organ_name_kz – Name of the issuing authority (in Kazakh);
- exec_proc_num – Enforcement proceeding number;
- exec_proc_data – Enforcement proceeding date;
- exec_proc_status – Enforcement proceeding status;
- exec_doc_num – Enforcement document number;
- exec_doc_issue_date – Date of issuance of the enforcement document;
- essence_requirements_ru – Requirements (in Russian);
- essence_requirements_kz – Requirements (in Kazakh);
- executor_surname – Executor’s surname;
- executor_name – Executor’s first name;
- executor_patronymic – Executor’s patronymic;
- executor_contacts – Executor’s contact details;
- executor_address – Executor’s address;
- disa_code – Code of the division carrying out the recovery;
- to_name_ru – Name of the division carrying out the recovery (in Russian);
- to_name_kz – Name of the division carrying out the recovery (in Kazakh);
- to_address – Address of the division carrying out the recovery;
- record_id – Record ID;
- recover_amount – Recovery amount;
Response example:
{
"backend_session": "00000000-0000-0000-0000-000000000000",
"status": "RECEIVED",
"personal_number": "010203040506",
"result_json": [
{
"debtor_iin": "010203040506",
"debtor_surname": "ФАМИЛИЯ",
"debtor_name": "ИМЯ",
"debtor_patronymic": "ОТЧЕСТВО",
"debtor_birth_data": "1970-01-01+00:00",
"debtor_doc_number": "12345678",
"issue_organ_code": "12345",
"issue_organ_name_ru": "Нотариальная палата по г.Астана",
"issue_organ_name_kz": "Нотариальная палата по г.Астана",
"exec_proc_num": "000/00-00-0000",
"exec_proc_date": "1970-01-01+00:00",
"exec_proc_status": "3",
"exec_doc_num": "12345678",
"exec_doc_issue_date": "1970-01-01+00:00",
"essence_requirements_ru": "Взыскании с --- в пользу --- задолженность в размере 100 тенге",
"essence_requirements_kz": "Взыскании с --- в пользу --- задолженность в размере 100 тенге",
"executor_surname": "ФАМИЛИЯ",
"executor_name": "ИМЯ",
"executor_patronymic": "ОТЧЕСТВО",
"executor_contacts": "+77001234567",
"executor_address": "г. Алматы, --- район, ул. --- д. 0, офис 0.",
"disa_code": "935",
"to_name_ru": "Частные судебные исполнители г.Алматы",
"to_name_kz": "Алматы қаласының жеке сот орындаушылары",
"to_address": "Алматы қ.",
"record_id": "12345678",
"recover_amount": "100.00"
}
]
}
Possible Errors#
| Код состояния | Ответ | Описание |
|---|---|---|
| 400 | Subscription has not started | Подписка еще не активировалась |
| 400 | No active or future subscription for technology | Нет активной или будущей подписки на технологию |
| 400 | Client does not have subscription | У клиента отсутствует подписка, подробнее о подписках можно прочитать здесь |
| 400 | Client does not have access to ERD technology | У клиента нет доступа к технологии. Причины: подписка отсутствует, либо она истекла, или технология не активна |
| 404 | Subject not found in ERD | Данные по субъекту не найдены |
| 503 | ERD service not available now | Сервис ERD в данное время не доступен |