Versions Compared

Key

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

...

Info

Звіт містить такі компоненти:

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "ЄДРПОУ (для юр.осіб)"

},

"additionaldata": {

"datescore": "Дата для розрахунку скоринга. Не заповнюється, якщо скоринг розраховується на поточний момент"

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Скоринг МСБ' - 40",

"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": "Час"

}

}

},

"comp": [

{

"cki": {

"urident": {

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

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

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

"lngref": "Мова надання блоку (Значення із дов.23)", "okpo": "ЄДРПОУ юрособи",

"urname": "Найменування юрособи",

"urfrms": "Форма власності (Код із дов.38)",

"urfrmsref": "Форма власності (Значення із дов.38)",

"ureconom": "Галузь економіки (Секція КВЕД2010)(Код із дов.36)",

"ureconomref": "Галузь економіки (Секція КВЕД2010) (Значеннч із дов.36)",

"urvide": "Вид діяльності (КВЕД2010) (Код із дов.37)",

"urvideref": "Вид діяльності (КВЕД2010) (Значення із дов.37)",

"urdatreg": "Дата реєстрації в ЄДР",

"urdatregnal": "Дата реєстрації в податковій"

},

"linked": {

"okpo2": "РНОКПП (ІПН) / ЄДРПОУ пов'язаної особи",

"okpo2_name": "ПІБ / Найменування пов'язаної особи",

"linkrole": "Тип зв'язку (Код із дов.39)",

"linkroleref": "Тип зв'язку (Значення із дов.39)",

"rdate": "Дата актуалізації зв'язку"

},

"doc": {

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

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

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

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

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

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

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

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

"dterm": "Термін дії",

"dwho": "Ким виданий документ",

"eddr_number": "Унікальний номер запису в Єдиному державному демографічному реєстрі (ЄДДР)",

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

},

"addr": {

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

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

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

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

"adtype": "Тип адреси (Код із дов.9)",

"adtyperef": "Тип адреси (Значення із дов.9)",

"adcountry": "Країна (однорядкове резюме код з довідника ISO 3166)",

"adindex": "Поштовий індекс",

"adstate": "Область",

"adarea": "Район",

"adcity": "Населений пункт",

"adcitytype": "Тип населеного пункту (Код із дов.22)",

"adcitytyperef": "Тип населеного пункту (Значення із дов.22)",

"adstreet": "Вулиця",

"adhome": "Дім",

"adcorp": "Корпус",

"adflat": "Квартира",

"addrdirt": "Адреса в одному рядку (буде виведений з експлуатації в наступних версіях АPІ, з 13.11.2019 поле вважається неприпустимим)"

},

"inn": "ЄДРПОУ юрособи",

"lname": "Прізвище/Найменування юрособи",

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

"reqlngref": "Мова пошуку (при пошуку)/Мова ідентифікації (при передачі) (Значення із дов.23)"

},

"identdocmvds": {

"identdocmvd": {

"foundsource": {

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

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

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

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

},

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

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

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

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

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

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

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

}

},

"id": "1",

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

},

{

"credres": {

"redate": "Дата рішення",

"retime": "Час рішення",

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

"reqid": "Ідентифікатор запиту в бюро",

"result": "Результат надання звіту (Код із дов.19)",

"resultref": "Результат надання звіту (Значення із дов.19)",

"reqreason": "Причина запиту в бюро (Код із дов.24)",

"reqreasonref": "Причина запиту в бюро (Значення із дов.24)",

"org": "Організація ініціатор (Значення із дов.54)",

"typereport": "Вид наданого звіту (Код із дов.71)",

"typereportref": "Вид наданого звіту (Значення із дов.71)"

},

"reestrtime": {

"hr": "Кількість запитів за годину",

"da": "Кількість запитів за день",

"wk": "Кількість запитів за тиждень",

"mn": "Кількість запитів за місяць",

"qw": "Кількість запитів за квартал",

"ye": "Кількість запитів за рік",

"yu": "Кількість запитів понад рік"

},

"id": "4",

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

},

{

"moncredres": {

"org": "Організація ініціатор (Значення із дов.54)",

"resultref": "Значення з довідника результат надання звіту (Значення із дов.19)",

"result": "Результат моніторингу (Код із дов.19)",

"monid": "Ідентифікатор моніторингу в Бюро",

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

"startdate": "Дата старту моніторингу",

"enddate": "Дата останнього моніторингу "

},

"id": "6",

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

},

{

"bankruptcyinfo": {

"bankruptcy": {

"subname": "Найменування суб'єкта",

"subcode": "ІПН/ЄДРПОУ",

"eventtype": "Подія",

"eventclaimer": "Ініціатор події",

"eventcourtcase": "Номер справи",

"eventdate": "Дата події"

},

"found": "0/1 - чисельне визначення факту наявності інформації про банкрутство",

"foundref": " Не знайдено/ знайдено - текстове визначення факту наявності інформації про банкрутство"

},

"id": "54",

"descr": "Інформація про банкрутство"

},

{

"scoremsb": {

"msbch": {

"modelversion": "Версія моделі",

"score": "Значення скорингу",

"scoredate": "Дата розрахунку"

},

"features": {

"name": "Назва предиктора",

"value": "Значення предиктора"

},

"msbod": {

"features": {

"name": "Назва предиктора",

"value": "Значення предиктора"

},

"modelversion": "Версія моделі",

"score": "Значення скорингу",

"scoredate": "Дата розрахунку"

}

},

"id": "58",

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

}

]

}

}

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): 'Скоринг МСБ' - 40" reqreason="Мета надання запиту (Код із дов.24)">

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

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

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

<ident okpo="ЄДРПОУ (для юр.осіб)" />

<additionaldata datescore="Дата для розрахунку скоринга. Не заповнюється, якщо скоринг розраховується на поточний момент" />

</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="Час" />

</billing>

</tech>

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

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

<cki inn="ЄДРПОУ юрособи"

lname="Прізвище/Найменування юрособи"

reqlng="Мова пошуку (при пошуку)/Мова ідентифікації (при передачі)(Код із дов.23)"

reqlngref="Мова пошуку (при пошуку)/Мова ідентифікації (при передачі) (Значення із дов.23)">

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

<urident donor="Джерело інформації (Значення із дов.54)"

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

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

lngref="Мова надання блоку (Значення із дов.23)" okpo="ЄДРПОУ юрособи" urname="Найменування юрособи"

urfrms="Форма власності (Код із дов.38)"

urfrmsref="Форма власності (Значення із дов.38)"

ureconom="Галузь економіки (Секція КВЕД2010)(Код із дов.36)"

ureconomref="Галузь економіки (Секція КВЕД2010) (Значеннч із дов.36)"

urvide="Вид діяльності (КВЕД2010) (Код із дов.37)"

urvideref="Вид діяльності (КВЕД2010) (Значення із дов.37)"

urdatreg="Дата реєстрації в ЄДР"

urdatregnal="Дата реєстрації в податковій">

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

</urident>

<!-- Блок пов'язаних осіб для юросіб (Директор, бухгалтер ...)-->

<linked okpo2="РНОКПП (ІПН) / ЄДРПОУ пов'язаної особи"

okpo2_name="ПІБ / Найменування пов'язаної особи"

linkrole="Тип зв'язку (Код із дов.39)"

linkroleref="Тип зв'язку (Значення із дов.39)"

rdate="Дата актуалізації зв'язку">

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

</linked>

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

<doc ddonor="Джерело інформації (Значення із дов.54)"

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

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

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

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

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

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

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

dterm="Термін дії"

dwho="Ким виданий документ"

eddr_number="Унікальний номер запису в Єдиному державному демографічному реєстрі (ЄДДР)"

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

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

</doc>

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

<addr addonor="Джерело інформації (Значення із дов.54)"

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

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

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

adtype="Тип адреси (Код із дов.9)"

adtyperef="Тип адреси (Значення із дов.9)"

adcountry="Країна (однорядкове резюме код з довідника ISO 3166)"

adindex="Поштовий індекс"

adstate="Область"

adarea="Район"

adcity="Населений пункт"

adcitytype="Тип населеного пункту (Код із дов.22)"

adcitytyperef="Тип населеного пункту (Значення із дов.22)"

adstreet="Вулиця"

adhome="Дім"

adcorp="Корпус"

adflat="Квартира"

addrdirt="Адреса в одному рядку (буде виведений з експлуатації в наступних версіях АPІ, з 13.11.2019 поле вважається неприпустимим)">

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

</addr>

</cki>

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

<identdocmvds>

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

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

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

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

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

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

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

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

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

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

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

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

</identdocmvd>

</identdocmvds>

</comp>

<!-- Блок реєстр запитів -->

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

<credres redate="Дата рішення"

retime="Час рішення"

inn="ЄДРПОУ"

reqid="Ідентифікатор запиту в бюро"

result="Результат надання звіту (Код із дов.19)"

resultref="Результат надання звіту (Значення із дов.19)"

reqreason="Причина запиту в бюро (Код із дов.24)"

reqreasonref="Причина запиту в бюро (Значення із дов.24)"

org="Організація ініціатор (Значення із дов.54)"

typereport="Вид наданого звіту (Код із дов.71)"

typereportref="Вид наданого звіту (Значення із дов.71)"/>

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

<reestrtime hr="Кількість запитів за годину"

da="Кількість запитів за день"

wk="Кількість запитів за тиждень"

mn="Кількість запитів за місяць"

qw="Кількість запитів за квартал"

ye="Кількість запитів за рік"

yu="Кількість запитів понад рік" />

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

</comp>

<!-- Блок моніторинг -->

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

<moncredres org="Організація ініціатор (Значення із дов.54)"

resultref="Значення з довідника результат надання звіту (Значення із дов.19)"

result="Результат моніторингу (Код із дов.19)"

monid="Ідентифікатор моніторингу в Бюро"

inn="ЄДРПОУ"

startdate="Дата старту моніторингу"

enddate="Дата останнього моніторингу " />

<!--Даний блок може складатися з 0 .. *-->

</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>

<!-- Інформація про банкрутство-->

<comp id="54" descr="Інформація про банкрутство">

<bankruptcyinfo found="0/1 - чисельне визначення факту наявності інформації про банкрутство"

foundref=" Не знайдено/ знайдено - текстове визначення факту наявності інформації про банкрутство">

<bankruptcy subname="Найменування суб'єкта"

subcode="ІПН/ЄДРПОУ"

eventtype="Подія"

eventclaimer="Ініціатор події"

eventcourtcase="Номер справи"

eventdate="Дата події" />

</bankruptcyinfo>

</comp>

<!-- Скоринг МСБ -->

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

<scoremsb>

<!-- Скоринг за даними кредитної історії та відкритими даними -->

<msbch modelversion="Версія моделі"

score="Значення скорингу"

scoredate="Дата розрахунку" />

<features name="Назва предиктора"

value="Значення предиктора" />

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

<!-- Скоринг за відкритими даними -->

<msbod modelversion="Версія моделі"

score="Значення скорингу"

scoredate="Дата розрахунку">

<features name="Назва предиктора"

value="Значення предиктора" />

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

</msbod>

</scoremsb>

</comp>

</ubkidata>

...

Test URL

https://test.ubki.ua/b2_api_xml/ubki/xml

Test data

  • okpo="12345632"

  • okpo="12345649"

  • okpo="12345610"

  • okpo="12345632"

<comp id="18" descr="Попередження"> тег <changedeal>

  • 12345626

<comp id="54" descr="Інформація про банкрутство">

  • okpo="12345610"

...