...
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON |
Expand | ||
---|---|---|
| ||
{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "okpo": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)", "lname": "**Прізвище", "fname": "**Ім'я", "mname": "**По батькові", "bdate": "**Дата народження" }, "mvd": { "dtype": "Тип розшукуваного документа (Код 1, 3, 17 із дов.7)", "pser": "Серія розшукуваного паспорта", "pnom": "Номер розшукуваного паспорта або номер ID-картки", "plname": "Прізвище власника розшукуваного паспорта", "pfname": "Ім'я власника розшукуваного паспорта", "pmname": "По батькові власника розшукуваного паспорта", "pbdate": "Дата народження власника розшукуваного паспорта" }, "reqlng": "Мова критеріїв пошуку (Код із дов.23)" }, "version": "1.0", "reqtype": "Код шаблону (Код із дов.49): Звіт 'Верифікація' - 21", "reqreason": "Мета подання запиту (Код із дов.24)" }, "descr": "Об'єкт запиту" }, "descr": "Конверт запиту" }, "sessid": "Сесійний ключ (отримуємо із API авторизації)" } } } |
Response XML
title | body: |
---|
<?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="Час" />
</billing>
</tech>
<!-- Пошук анульованих документів -->
<comp id="5" descr="Назва компоненти">
<mvd found="Знайдений? (Код із дов.27)"
foundref="Знайдений? (Значение із дов.27)"
foundtitle="Опис результату пошуку"
pser="Серія розшукуваного паспорта"
Response JSON
|
Request XML
( ** параметри передаються опціонально)
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): Звіт 'Верифікація' - 21" reqreason="Мета подання запиту (Код із дов.24)">
<!-- Параметри, що описують критерії пошуку-->
<i reqlng="Мова критеріїв пошуку (Код із дов.23)">
<!-- Параметри ідентифікації суб'єкта--><ident okpo="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"
lname="**Прізвище"
fname="**Ім'я"
mname="**По батькові"
bdate="**Дата народження">
</ident>
<!-- Для запитів пошуку анульованих документів -->
<mvd dtype="Тип розшукуваного документа (Код 1, 3, 17 із дов.7)"
pser="Серія розшукуваного паспорта"
pnom="Номер розшукуваного паспорта або номер ID-картки"
plname="Прізвище власника розшукуваного паспорта"
pfname="Ім'я власника розшукуваного паспорта"
pmname="По батькові власника розшукуваного паспорта"
pbdate="Дата народження власника розшукуваного паспорта" />
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc>
|
Request XML |
Expand | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <doc> <ubki sessid="Сесійний ключ (отримуємо із API авторизації)"> <req_envelope descr="Конверт запиту"> <req_xml descr="Об'єкт запиту"> <!-- Параметри запиту --> <request version="1.0" reqtype="Код шаблону (Код із дов.49): Звіт 'Верифікація' - 21" reqreason="Мета подання запиту (Код із дов.24)"> <!-- Параметри, що описують критерії пошуку--> <i reqlng="Мова критеріїв пошуку (Код із дов.23)"> <!-- Параметри ідентифікації суб'єкта--> <ident okpo="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)" lname="**Прізвище" fname="**Ім'я" mname="**По батькові" bdate="**Дата народження"> </ident> <!-- Для запитів пошуку анульованих документів --> <mvd dtype="Тип розшукуваного документа (Код 1, 3, 17 із дов.7)" pser="Серія розшукуваного паспорта" pnom="Номер розшукуваного паспорта або номер ID-картки" plname="Прізвище власника розшукуваного паспорта" pfname="Ім'я власника розшукуваного паспорта" pmname="По батькові власника розшукуваного паспорта" pbdate="Дата народження власника розшукуваного паспорта" |
dtype="Тип документа (Код із дов.7)"
dtyperef="Паспорт (Значение із дов.7)"
status="Причина анулювання (Тільки для даних із DATA.GOV.UA)"
stdate="Дата анулювання (Тільки для даних із DATA.GOV.UA)">
<foundsource name="Джерело даних для перевірки (Код із дов.63)"
found="0/1 - цифрове позначення наявності недійсного паспорту (Код із дов.27)"
foundref="Текстове позначення наявності недійсного паспорту (Значення із дов.27)"
sourcedate="Дата оновлення інформації у БД чи отримання відповіді від АПІ першоджерла." />
<!--Даний блок повинен складатись з 1 .. * елементів-->
</mvd>
</comp>
<!-- Попередження-->
<comp id="18" descr="Назва компоненти">
<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"
nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"
nonewdealcomment="Коментар"
freezedate="Дата підключення опції FREEZE"
inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)">
<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"
|
Response XML
|
Приклад |
---|
Request JSON Code Block | |
|
Response JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Response JSON |
|
...
Response XML |
|
...