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": {

"docs": {

"doc": {

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

"dser": "Серія документа",

"dnom": "Номер документа"

}

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): Звіт 'Ідентифікація СКІ по паспорту' - 32",

"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": [

{

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

},

{

"identdoc": {

"ident": {

"csexref": "Значення з довідника статі (Значення із дов.1)",

"csex": "Стать (Код із дов.1)",

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

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

"fname": "Ім'я",

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

"inn": "РНОКПП (ІПН) СКІ",

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

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

"vdate": "Дата інформації даного блоку"

},

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

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

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

"dtyperef": "Тип документа (Значення із дов.7)",

"dser": "Серія документа",

"dnom": "Номер документа",

"dwdt": "Дата видачі документа"

},

"identdocmvds": {

"identdocmvd": {

"foundsource": {

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

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

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

},

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

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

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

"pser": "Серія паспорта",

"pnom": "Номер паспорта або номер ID-картки",

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

"dtyperef": "Тип документа (Значення із дов.7)"

}

},

"id": "39",

"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="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>

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

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

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

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

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

dtyperef="Тип документа (Значення із дов.7)"

dser="Серія документа"

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

dwdt="Дата видачі документа">

<ident csexref="Значення з довідника статі (Значення із дов.1)"

csex="Стать (Код із дов.1)"

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

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

fname="Ім'я"

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

inn="РНОКПП (ІПН) СКІ"

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

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

vdate="Дата інформації даного блоку" />

</identdoc>

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

<identdocmvds>

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

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

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

pser="Серія паспорта"

pnom="Номер паспорта або номер ID-картки"

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

dtyperef="Тип документа (Значення із дов.7)">

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

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

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

<!--Даний блок повинен складатись з 1 .. * елементів-->

</identdocmvd>

</identdocmvds>

</comp>

</ubkidata>

...