Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "ЄДРПОУ юридичної особи"

},

"additionaldata": {

"decode": "Необов’язковий параметр, що визначає формат повернення даних у відповіді: true — у відповіді повертаються окремі файли, розпаковані з архіву; false (за замовчуванням) — відповідь містить один архів, закодований у форматі Base64",

"contentMode": "Необов’язковий параметр, що визначає, до якої компоненти звіту здійснюється звернення: statutory — лише до компоненти 86 - Статутні документи юридичної особи, structure — лише до компоненти 87 - Структура власності юридичної особи, all — до обох компонент одночасно (значення за замовчуванням). У разі надсилання кількох запитів щодо одного суб’єкта протягом календарного дня тарифікація відбувається лише один раз"

},

"reqlng": "Мова критеріїв пошуку (Код із дов.23)"

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): Звіт 'Установчі документи юридичної особи' - 55",

"reqreason": "Мета надання запиту (Код із дов.24)"

},

"descr": "Об'єкт запиту"

},

"descr": "Конверт запиту"

},

"sessid": "Сесійна ключ (отримуємо із API авторизації)"

}

}

}

...

Request XML

Expand
title body:

<?xml version="1.0" encoding="UTF-8"?>

<doc>

<ubki sessid="Сесійна ключ (отримуємо із API авторизації)">

<req_envelope descr="Конверт запиту">

<req_xml descr="Об'єкт запиту">

<!-- Параметри запиту -->

<request version="1.0"

reqtype="Код шаблону (Код із дов.49): Звіт 'Установчі документи юридичної особи' - 55"

reqreason="Мета надання запиту (Код із дов.24)">

<!-- Параметри, що описують критерії пошуку-->

<i reqlng="Мова критеріїв пошуку (Код із дов.23)">

<!-- Параметри ідентифікації суб'єкта-->

<ident okpo="ЄДРПОУ юридичної особи" />

<!-- Параметри налаштування відповіді-->

<additionaldata decode="Необов’язковий параметр, що визначає формат повернення даних у відповіді: true — у відповіді повертаються окремі файли, розпаковані з архіву; false (за замовчуванням) — відповідь містить один архів, закодований у форматі Base64"

contentMode="Необов’язковий параметр, що визначає, до якої компоненти звіту здійснюється звернення: statutory — лише до компоненти 86 - Статутні документи юридичної особи, structure — лише до компоненти 87 - Структура власності юридичної особи, all — до обох компонент одночасно (значення за замовчуванням). У разі надсилання кількох запитів щодо одного суб’єкта протягом календарного дня тарифікація відбувається лише один раз."/>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<?xml version="1.0" encoding="utf-8"?>

<ubkidata>

<!-- Блок системної інформації -->

<tech>

<trace>

<step name="Найменування кроку" stm="Дата штамп старту кроку" ftm="Дата штамп фінішу кроку">

<!-- Блок trace містить метрики таймінгу кроків формування компонентів -->

</step>

</trace>

<error errtype="Код помилки(Код із дов.0)" errtext="Текст помилки(Значення із дов.0)">

</error>

<reqinfo reqid="Вихідний ІД запиту, згенерований УБКІ">

</reqinfo>

<!-- Блок інформації щодо поточного стану рахунку припейд-->

<billing>

<balance value="Сума балансу" date="Дата" time="Час" />

<billdetails freemon="Ознака безоплатності за типом запиту 'Моніторинг клієнта організації' (reqreason=1), код (0 - Ні, 1 - Так)"

freemonref="Ознака безоплатності за типом запиту 'Моніторинг клієнта організації' (reqreason=1), значення (0 - Ні, 1 - Так)"/>

</billing>

</tech>

<!-- Блок інформації про статутні документи-->

<comp id="86" descr="Статутні документи юридичної особи">

<statutoryinfo edrpou="Код ЄДРПОУ, за яким здійснювався пошук"

found="Код наявності інформації"

foundref="Наявність інформації">

<filesDescription code="Код ЄДРПОУ, за яким здійснювався пошук у ЄДР"

name="Назва компанії"

absentReason="Причина відсутності сканованих копій статутних документів">

<documents docName="Назва документа"

fileType="Тип файлів документа (PDF або TIFF)"

docSize="Розмір файлу/файлів документа"

number="Номер документа"

dateFrom="Дата документа"/>

</filesDescription>

<!-- Для режиму true : блок із закодованими файлами з архіву-->

<documentFile fileName="Назва файлу"

fileType="Тип файлу"

fileData="Закодований у Base64 контент файлу"/>

<!-- Для режиму false (за замовчуванням): блок із закодованим архівом-->

<documentZipFile fileData="Закодований у Base64 контент zip архіву"/>

</statutoryinfo>

</comp>

<!-- Блок інформації про структуру власності-->

<comp id="87" descr="Структура власності юридичної особи">

<structureinfo edrpou="Код ЄДРПОУ, за яким здійснювався пошук"

found="Код наявності інформації"

foundref="Наявність інформації">

<filesDescription code="Код ЄДРПОУ, за яким здійснювався пошук у ЄДР"

name="Назва компанії"

absentReason="Причина відсутності сканованих копій статутних документівструктури власності">

<documents docName="Назва документа"

fileType="Тип файлів документа (PDF або TIFF)"

docSize="Розмір файлу/файлів документа"

number="Номер документа"

dateFrom="Дата документа"/>

</filesDescription>

<!-- Для режиму true : блок із закодованими файлами з архіву-->

<documentFile fileName="Назва файлу"

fileType="Тип файлу"

fileData="Закодований у Base64 контент файлу"/>

<!-- Для режиму false (за замовчуванням): блок із закодованим архівом-->

<documentZipFile fileData="Закодований у Base64 контент zip архіву"/>

</structureinfo>

</comp>

</ubkidata>

...