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": "РНОКПП (ІПН) фізособи",

"lname": "**Прізвище",

"fname": "**Ім'я",

"mname": "**По батькові",

"bdate": "**Дата народження"

},

"mvd": {

"dtype": "Тип розшукуваного документа (Код із дов.7)",

"pser": "Серія розшукуваного паспорта",

"pnom": "Номер розшукуваного паспорта або номер ID-картки",

"plname": "**Прізвище власника розшукуваного паспорта",

"pfname": "**Ім'я власника розшукуваного паспорта",

"pmname": "**По батькові власника розшукуваного паспорта",

"pbdate": "**Дата народження власника розшукуваного паспорта"

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Перевірка посвідчення особи онлайн' - 14",

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

},

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

},

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

},

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

}

}

}

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Найменування кроку",

"stm": "Дата штамп старту кроку",

"ftm": "Дата штамп фінішу кроку"

}

},

"error": {

"errtype": "Код помилки(Код із дов.0)",

"errtext": "Текст помилки(Значення із дов.0)"

},

"reqinfo": {

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

},

"billing": {

"balance": {

"value": "Сума балансу",

"date": "Дата",

"time": "Час"

},

"billdetails": {

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

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

}

}

},

"comp": [

{

"mvd": {

"foundsource": {

"name": "Джерело даних для перевірки (Код із дов.63)",

"found": "0/1 - цифрове позначення наявності недійсного паспорту (Код із дов.27)",

"foundref": "Текстове позначення наявності недійсного паспорту (Значення із дов.27)",

"sourcedate": "Дата оновлення інформації у БД чи отримання відповіді від АПІ першоджерла."

},

"found": "Знайдений? (Код із дов.27)",

"foundref": "Знайдений? (Значение із дов.27)",

"foundtitle": "Опис результату пошуку",

"pser": "Серія розшукуваного паспорта",

"pnom": "Номер розшукуваного паспорта або номер ID-картки",

"plname": "Прізвище власника розшукуваного паспорта",

"pfname": "Ім'я власника розшукуваного паспорта",

"pmname": "По батькові власника розшукуваного паспорта",

"pbdate": "Дата народження власника розшукуваного паспорта",

"dtype": "Тип документа (Код із дов.7)",

"dtyperef": "Паспорт (Значение із дов.7)",

"status": "Причина анулювання (Тільки для даних із http://DATA.GOV.UA )",

"stdate": "Дата анулювання (Тільки для даних із http://DATA.GOV.UA )"

},

"id": "5",

"descr": "Назва компоненти"

},

{

"wantedmvs": {

"found": "0-не знайдений, 1-знайдено",

"foundref": "не знайдений/знайдений",

"bdate": "Дата народження",

"lng": "Мова внадання блоку (Код із дов.23)",

"lngref": "Мова надання блоку (Значення із дов.23)",

"lname": "Прізвище",

"fname": "Ім'я",

"mname": "По батькові",

"url": "Посилання на анкету МВС",

"category": "Категорія",

"articlecrim": "Стаття звинувачення",

"restraint": "Запобіжний захід"

},

"id": "17",

"descr": "Назва компоненти"

},

{

"pret": {

"pretension": {

"inn": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)",

"crdeal": "Ідентифікатор угоди (референс)",

"source": "Вид оскарження (Код із дов.48)",

"sourceref": "Вид оскарження (Значення із дов.48)",

"claim": "Предмет оскарження (Код із дов.69)",

"claimref": "Предмет оскарження (Значення із дов.69)",

"vdate": "Дата створення заявки"

},

"commentcki": {

"comment": "Коментар суб'єкта кредитної історії",

"vdate": "Дата створення коментаря"

},

"plost": {

"pser": "Серія паспорта, заявлено СКІ як загублений (крадіжка)",

"pnom": "Номер паспорта, заявлено СКІ як загублений (крадіжка)",

"crdate": "Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ",

"ldate": "Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ"

},

"changedeal": {

"crdeal": "Ідентифікатор угоди (референс)",

"changecode": "Код причини коригування/видалення даних (Код із дов.62)",

"changeref": "Текст причини коригування/видалення даних (Значення із дов.62)",

"vdate": "Дата коригування/видалення даних"

},

"freezedate": "Дата підключення опції FREEZE",

"nonewdealcomment": "Коментар",

"nonewdeal": "Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена",

"nonewdealref": "Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)",

"inn": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

},

"fcert": {

"inn": "ІПН",

"cert": "Ознака наявності сертифіката від УБКІ (Код із дов. 56) - 0 - ні (немає зареєстрованого сертифіката), 1 - так (є зареєстрований сертифікат) ",

"certref": "Ознака наявності сертифіката від УБКІ (Значення із дов. 56)",

"certid": "Номер сертифіката",

"certurl": "Посилання на сертифікат"

},

"maybegone": {

"inn": "РНОКПП (ІПН) (для фіз. осіб)",

"vdate": "Дата? на яку передана інформація",

"dldonor": "Донор інформації (Значення із дов.54)"

},

"id": "18",

"descr": "Назва компоненти"

}

]

}

}

...

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="5" descr="Назва компоненти">

<mvd found="Знайдений? (Код із дов.27)"

foundref="Знайдений? (Значение із дов.27)"

foundtitle="Опис результату пошуку"

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="17" descr="Назва компоненти">

<wantedmvs found="0-не знайдений, 1-знайдено"

foundref="не знайдений/знайдений"

bdate="Дата народження"

lng="Мова внадання блоку (Код із дов.23)"

lngref="Мова надання блоку (Значення із дов.23)"

lname="Прізвище"

fname="Ім'я"

mname="По батькові"

url="Посилання на анкету МВС"

category="Категорія"

articlecrim="Стаття звинувачення"

restraint="Запобіжний захід" />

</comp>

<!-- Попередження -->

<comp id="18" descr="Назва компоненти">

<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"

nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"

nonewdealcomment="Коментар"

freezedate="Дата підключення опції FREEZE"

inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)">

<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

crdeal="Ідентифікатор угоди (референс)"

source="Вид оскарження (Код із дов.48)"

sourceref="Вид оскарження (Значення із дов.48)"

claim="Предмет оскарження (Код із дов.69)"

claimref="Предмет оскарження (Значення із дов.69)"

vdate="Дата створення заявки" />

<commentcki comment="Коментар суб'єкта кредитної історії"

vdate="Дата створення коментаря" />

<plost pser="Серія паспорта, заявлено СКІ як загублений (крадіжка)"

pnom="Номер паспорта, заявлено СКІ як загублений (крадіжка)"

crdate="Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ"

ldate="Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ" />

<changedeal crdeal="Ідентифікатор угоди (референс)"

changecode="Код причини коригування/видалення даних (Код із дов.62)"

changeref="Текст причини коригування/видалення даних (Значення із дов.62)"

vdate="Дата коригування/видалення даних" />

</pret>

<fcert inn="РНОКПП (ІПН) (для фіз. осіб)"

cert="Ознака наявності сертифіката від УБКІ (Код із дов. 56) - 0 - ні (немає зареєстрованого сертифіката), 1 - так (є зареєстрований сертифікат) "

certref="Ознака наявності сертифіката від УБКІ (Значення із дов. 56)"

certid="Номер сертифіката"

certurl="Посилання на сертифікат" />

<maybegone inn="РНОКПП (ІПН) (для фіз. осіб)"

vdate="Дата, на яку передана інформація"

dldonor="Донор інформації (Значення із дов.54)"/>

</comp>

</ubkidata>

...