ЕСОЗ - публічна документація
EDR data validation
«ППІ ЄДР» - комп’ютерна програма, що виконує обробку та перетворення даних, які надаються безкоштовно з Єдиного державного реєстру юридичних осіб, фізичних осіб-підприємців та громадських формувань (далі - Єдиний державний реєстр) через портал електронних сервісів, для їх подальшого сприйняття автоматизованими та інформаційними системами Користувачів.
General
This page describes key features and main principles of EDR integration. It also includes configuration, data flow, data mapping, error handling etc.
Data flow
Configuration
Add the following environment variables
Variable | Description |
---|---|
EDR_URL | EDR URL |
EDR_API_KEY | EDR Authorization token |
Search for LE or private entrepreneur
Specification
Endpoint | <version>/subjects |
Method | GET |
Format | JSON |
Query parameters |
passport format: AANNNNNN AA - 2 cyrillic characters NNNNNN - 6 digits Note: One of code or passport is required |
Headers | Authorization: Token <EDR_API_KEY> |
Response (200)
Attribute | Description |
---|---|
id (integer, optional) | Унікальний ідентифікатор суб’єкта |
state (integer, optional) | Стан суб’єкта |
state_text (string, optional) | Текстове відображення стану суб’єкта |
code (string, optional) | ЄДРПОУ; якщо суб’єкт - фізична особа підприємець - замість ІПНа система поверне десять нулів, бо ці дані є конфіденційною інформацією |
name (string, optional) | Назва |
url (string, optional) | Посилання на екземпляр з деталізованою інформацію |
Process result
# | Result | Action |
---|---|---|
1 | Http code: 200 Response contains 1 entity | using $.[0].url from response |
2 | Http code: 200 Response contains 0 | Return error 409, EDR validation failed |
3 | Http code: 200 Response contains more than 1 entity | Get only active entity (state in 1, 2, 4, 5) 1) Active entity found - Get detailed information 2) Active entity not found - Return error |
4 | Any other http code | Return error 409, EDR validation failed |
Example
Get detailed information
Specification
Endpoint | <version>/subjects/<id> |
Method | GET |
Format | JSON |
Query parameters | |
Headers | Authorization: Token <EDR_API_KEY> |
Response (200)
id (integer, optional) | Унікальний ідентифікатор суб’єкта |
state (integer, optional) | Стан суб’єкта |
state_text (string, optional) | Текстове відображення стану суб’єкта |
code (string, optional) | ЄДРПОУ; якщо суб’єкт - фізична особа-підприємець, замість ІПН система поверне десять нулів, бо ці дані є конфіденційною інформацією |
names (inline_model, optional): | |
olf_code (string, optional) | Код організаційно-правової форми суб’єкта, якщо суб’єкт – юридична особа |
olf_name (string, optional) | Назва організаційно-правової форми суб’єкта, якщо суб’єкт – юридична особа |
founding_document (string, optional) | Назва установчого документа, якщо суб’єкт – юридична особа |
executive_power (inline_model_0, optional) | Центральний чи місцевий орган виконавчої влади, до сфери управління якого належить державне підприємство або частка держави у статутному капіталі юридичної особи, якщо ця частка становить не менше 25 відсотків |
object_name (string, optional) | Місцезнаходження реєстраційної справи |
founders (Array[Founder], optional) | Перелік засновників (учасників) юридичної особи, у тому числі прізвище, ім’я, по батькові, якщо засновник – фізична особа; найменування, місцезнаходження та ідентифікаційний код юридичної особи, якщо засновник – юридична особа |
branches (Array[Branch], optional) | Перелік відокремлених підрозділів юридичної особи |
authorised_capital (inline_model_1, optional) | Дані про розмір статутного капіталу (статутного або складеного капіталу) та про дату закінчення його формування, якщо суб’єкт – юридична особа |
management (string, optional) | Відомості про органи управління юридичної особи |
managing_paper (string, optional) | Найменування розпорядчого акта, якщо суб’єкт – юридична особа |
is_modal_statute (boolean, optional) | Дані про наявність відмітки про те, що юридична особа створюється та діє на підставі модельного статуту |
activity_kinds (Array[ActivityKind], optional) | Перелік видів економічної діяльності |
heads (Array[Head], optional) | Прізвище, ім’я, по батькові, дата обрання (призначення) осіб, які обираються (призначаються) до органу управління юридичної особи, уповноважених представляти юридичну особу у правовідносинах з третіми особами, або осіб, які мають право вчиняти дії від імені юридичної особи без довіреності, у тому числі підписувати договори та дані про наявність обмежень щодо представництва від імені юридичної особи |
address (Address, optional) | |
registration (inline_model_2, optional) | Дата державної реєстрації, дата та номер запису в Єдиному державному реєстрі про включення до Єдиного державного реєстру відомостей про юридичну особу |
bankruptcy (inline_model_3, optional) | Дані про перебування юридичної особи в процесі провадження у справі про банкрутство, санації |
termination (inline_model_4, optional) | Дата та номер запису про державну реєстрацію припинення юридичної особи, підстава для його внесення |
termination_cancel (inline_model_5, optional) | Дата та номер запису про відміну державної реєстрації припинення юридичної особи, підстава для його внесення |
assignees (Array[RelatedSubject], optional) | Дані про юридичних осіб-правонаступників: повне найменування та місцезнаходження юридичних осіб-правонаступників, їх ідентифікаційні коди |
predecessors (Array[RelatedSubject], optional) | Дані про юридичних осіб, правонаступником яких є зареєстрована юридична особа |
registrations (Array[inline_model_6], optional) | Відомості, отримані в порядку взаємного обміну інформацією з відомчих реєстрів органів статистики, Міндоходів, Пенсійного фонду України |
primary_activity_kind (inline_model_7, optional) | Дані органів статистики про основний вид економічної діяльності юридичної особи, визначений на підставі даних державних статистичних спостережень відповідно до статистичної методології за підсумками діяльності за рік |
prev_registration_end_term (string, optional) | Термін, до якого юридична особа перебуває на обліку в органі Міндоходів за місцем попередньої реєстрації, у разі зміни місцезнаходження юридичної особи |
contacts (Contacts, optional) | |
open_enforcements (Array[string], optional) | Дата відкриття виконавчого провадження щодо юридичної особи (для незавершених виконавчих проваджень) |
| |
name (string, optional) | Повна назва суб’єкта |
include_olf (boolean, optional) | Вказує, чи треба додавати організаційно-правову форму до назви, якщо суб’єкт – юридична особа |
display (string, optional) | Назва для відображення (з ОПФ чи без, в залежності від параметру include_olf), якщо суб’єкт – юридична особа |
short (string, optional) | Коротка назва, якщо суб’єкт – юридична особа |
name_en (string, optional) | Повна назва суб’єкта англійською мовою, якщо суб’єкт – юридична особа |
short_en (string, optional) | Коротка назва англійською мовою, якщо суб’єкт – юридична особа |
| |
name (string, optional) | |
code (string, optional) | |
| |
name (string, optional) | Повна назва суб’єкта |
code (string, optional) | ЄДРПОУ код, якщо суб’єкт – юридична особа |
address (Address, optional) | |
last_name (string, optional) | Прізвище (якщо суб’єкт - приватна особа); |
first_middle_name (string, optional) | Ім’я та по-батькові (якщо суб’єкт – приватна особа) |
role (integer, optional) | Роль по відношенню до пов’язаного суб’єкта |
role_text (string, optional) | Текстове відображення ролі |
id (integer, optional) | Ідентифікатор суб'єкта |
url (string, optional) | Посилання на сторінку з детальною інформацією про суб'єкт |
capital (string, optional) | Розмір частки у статутному капіталі пов’язаного суб’єкта (лише для засновників) |
| |
name (string, optional) | Повна назва суб’єкта |
code (string, optional) | ЄДРПОУ код, якщо суб’єкт - юр.особа |
role (integer, optional) | Роль по відношенню до пов’язаного суб’єкта |
role_text (string, optional) | Текстове відображення ролі |
type (integer, optional) | Тип відокремленого підрозділу |
type_text (string, optional) | Текстове відображення типу відокремленого підрозділу |
address (Address, optional) | |
| |
value (string, optional) | |
date (string, optional) | |
| |
code (string, optional): | Код згідно КВЕД |
name (string, optional) | Найменування виду діяльності |
is_primary (boolean, optional) | Вказує, чи є вид діяльності основним (згідно даних органів статистики про основний вид економічної діяльності юридичної особи) |
| |
name (string, optional) | Повна назва суб’єкта |
code (string, optional): | ЄДРПОУ код, якщо суб’єкт - юр.особа |
address (Address, optional) | |
last_name (string, optional) | Прізвище (якщо суб’єкт - приватна особа) |
first_middle_name (string, optional) | Ім’я та по-батькові (якщо суб’єкт - приватна особа) |
role (integer, optional) | Роль по відношенню до пов’язаного суб’єкта |
role_text (string, optional) | Текстове відображення ролі |
id (integer, optional) | Ідентифікатор суб'єкта |
url (string, optional) | Посилання на сторінку з детальною інформацією про суб'єкт |
appointment_date (string, optional): | Дата призначення |
restriction (string, optional) | Обмеження |
| |
zip (string, optional) | Поштовий індекс |
country (string, optional) | Назва країни |
address (string, optional) | Адреса |
parts (inline_model_8, optional) | Адреса у розгорнутому вигляді |
| |
date (string, optional) | Дата державної реєстрації |
record_number (string, optional) | Номер запису в Єдиному державному реєстрі про включення до Єдиного державного реєстру відомостей про юридичну особу |
record_date (string, optional) | Дата запису в Єдиному державному реєстрі |
is_separation (boolean, optional) | Державна реєстрація юридичної особи шляхом виділу |
is_division (boolean, optional) | Державна реєстрація юридичної особи шляхом поділу |
is_merge (boolean, optional) | Державна реєстрація юридичної особи шляхом злиття |
is_transformation (boolean, optional) | Державна реєстрація юридичної особи шляхом перетворення |
| |
date (string, optional) | Дата запису про державну реєстрацію провадження у справі про банкрутство |
state (integer, optional) | Стан суб’єкта |
state_text (string, optional) | Текстове відображення стану суб’єкта |
doc_number (string, optional) | Номер провадження про банкрутство |
doc_date (string, optional) | Дата провадження про банкрутство |
date_judge (string, optional) | Дата набуття чинності |
court_name (string, optional) | Найменування суду |
| |
date (string, optional) | Дата запису про державну реєстрацію припинення юридичної особи, або початку процесу ліквідації в залежності від поточного стану («в стані припинення», «припинено») |
state (integer, optional) | Стан суб’єкта |
state_text (string, optional) | Текстове відображення стану суб’єкта |
record_number (string, optional) | Номер запису про державну реєстрацію припинення юридичної особи (якщо в стані «припинено»); |
requirement_end_date (string, optional) | Відомості про строк, визначений засновниками (учасниками) юридичної особи, судом або органом, що прийняв рішення про припинення юридичної особи, для заявлення кредиторами своїх вимог |
cause (string, optional) | Підстава для внесення запису про державну реєстрацію припинення юридичної особи |
| |
date (string, optional) | Дата запису про відміну державної реєстрації припинення юридичної особи |
record_number (string, optional) | Номер запису про відміну державної реєстрації припинення юридичної особи |
doc_number (string, optional) | Номер провадження про банкрутство |
doc_date (string, optional) | Дата провадження про банкрутство |
date_judge (string, optional) | Дата набуття чинності |
court_name (string, optional) | Найменування суду |
| |
name (string, optional) | Повна назва суб’єкта |
code (string, optional) | ЄДРПОУ код, якщо суб’єкт – юридична особа |
address (Address, optional) | |
last_name (string, optional) | Прізвище (якщо суб’єкт - приватна особа) |
first_middle_name (string, optional) | Ім’я та по-батькові (якщо суб’єкт - приватна особа) |
role (integer, optional) | Роль по відношенню до пов’язаного суб’єкта |
role_text (string, optional) | Текстове відображення ролі |
id (integer, optional) | Ідентифікатор суб'єкта |
url (string, optional) | Посилання на сторінку з детальною інформацією про суб'єкт |
| |
name (string, optional) | Назва органу |
code (string, optional) | Ідентифікаційний код органу |
type (string, optional) | Тип відомчого реєстру |
description (string, optional) | Назва відомчого реєстру |
start_date (string, optional) | Дата взяття на облік |
start_num (string, optional) | Номер взяття на облік |
end_date (string, optional) | Дата зняття з обліку |
end_num (string, optional): | Номер зняття з обліку |
| |
name (string, optional) | Назва КВЕД |
code (string, optional) | Код КВЕД |
reg_number (string, optional) | Дані про реєстраційний номер платника єдиного внеску |
class (string, optional) | Дані про реєстраційний номер платника єдиного внеску |
| |
email (string, optional) | Електронна адреса |
tel (Array[string], optional) | Перелік контактних телефонів |
fax (string, optional) | Номер факсимільного апарату |
web_page (string, optional) | Інтернет сайт |
| |
atu (string, optional) | Адміністративна територіальна одиниця |
street (string, optional) | Вулиця |
house_type (string, optional) | Тип будівлі ('буд.', 'інше') |
house (string, optional) | Номер будинку, якщо тип - 'буд.' |
building_type (string, optional) | Тип будівлі |
building (string, optional) | Номер будівлі |
num_type (string, optional) | Тип приміщення |
num (string, optional) | Номер приміщення |
Process result
# | Result | Action |
---|---|---|
1 | Http code: 200 | Return entity to consumer |
2 | Any other http code | Return error 409, EDR validation failed |
Example
Dictionaries
States
Endpoint: <version>/subjects/states
State | Description |
---|---|
-1 | «скасовано» |
1 | «зареєстровано» |
2 | «в стані припинення» |
3 | «припинено» |
4 | «порушено справу про банкрутство» |
5 | «порушено справу про банкрутство (санація)» |
6 | «зареєстровано, свідоцтво про державну реєстрацію недійсне» |
Roles
Endpoint: <version>/subjects/roles
Role | Description |
---|---|
1 | «cуб’єкт підприємницької діяльності» |
2 | «підписант» |
3 | «керівник» |
4 | «засновник» |
5 | «відокремлений підрозділ» |
6 | «особа - управитель майна» |
7 | «комісія з припинення (комісія з реорганізації, ліквідаційна комісія)» |
8 | «голова комісії з припинення або ліквідатор» |
9 | «правонаступник» |
10 | «попередник» |
11 | «керівник комісії з виділу» |
12 | «член комісії з виділу» |
13 | «ліквідатор» |
14 | «керуючий санацією» |
15 | «Розпорядник майна» |
16 | «Заявник» |
17 | «Керівний орган» |
18 | «Уповноважена особа Фонду гарантування вкладів фізичних осіб» |
Response codes defined by EDR
Code | Text | Description |
---|---|---|
200 | OK | Запит успішно оброблено і повернуто результат |
400 | Bad Request | Запит має помилку або не може бути оброблений. Відповідне повідомлення з поясненнями додане до відповіді. |
401 | Unauthorized | Параметри авторизації не правильні, або не вказані взагалі. |
402 | PaymentRequired | Для виконання запиту необхідна оплата. |
403 | Forbidden | Запит вірний але в обробці відмовлено. Відповідне повідомлення з поясненнями додано до відповіді. |
404 | Not Found | Адреса не правильна або ресурс до якого йде запит не існує. |
406 | Not Acceptable | Дані передані в запиті мають не зрозумілий формат. |
429 | Many Requests | API повертає таку відповідь коли вичерпано обмеження запитів до ресурсу. |
500 | Internal Server Error | Щось зламалось. |
502 | Bad Gateway | Сервіс вимкнено або проходить оновлення. |
Files
Attachment | Description |
---|---|
20180605100922-87.docx | EDR API specification |
References
ЕСОЗ - публічна документація