Фізична особа


Http Method

POST

Http Method

POST

Request URL

https://secure.ubki.ua/upload/data

Request JSON (headers: "SessId: Сесійний ключ (отримуємо з API авторизації)", "Content-Type: application/json")

{

"reqtype": "Режим обробки інформації (Код із дов.50)",

"reqidout": "ІД запиту організації",

"reqreason": "Мета подачі запиту (Код із дов.24): Передача даних - 0",

"delreason": "Причина видалення даних, при режимі d (Код із дов.62)",

"data": {

"fo_cki": {

"inn": "ІПН СКІ",

"person_id":  "Унікальний ідентифікатор людини",

     "is_gone”: “Позначка про смерть людини, де 0 - жива, 1 - померла (обов'язкове для передачі) (Код із дов.56)",

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

"fname": "Ім'я",

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

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

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

"idents": [

{

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

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

"inn": "ІПН СКІ",

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

"fname": "Ім'я",

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

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

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

"family": "Сімейний стан (Код із дов.2)",

"ceduc": "Освіта (Код із дов.3)",

"cgrag": "Громадянство (Код із дов.4 (ISO 3166))",

"spd": "Наявність реєстрації СПД (Код із дов.5)",

"sstate": "Соціальний статус (Код із дов.6)",

"cchild": "Кількість дітей"

}

],

"docs": [

{

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

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

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

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

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

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

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

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

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

}

],

"addrs": [

{

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

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

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

"adcountry": "Країна (Цифровий код із ISO 3166)",

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

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

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

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

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

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

"adhome": "Будинок",

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

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

"addrdirt": "Адреса в одному рядку за погодженням з УБКІ"

}

],

"works": [

{

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

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

"cdolgn": "Службове положення (Код із дов.8)",

"wokpo": "ЄДРПОУ місця роботи",

"wname": "Назва місця роботи в базовій мові",

"wstag": "Стаж роботи, повних років",

"wdohod": "Щомісячний дохід клієнта"

}

],

"fotos": [

{

"foto": "base64 (Фото)",

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

}

],

"deals": [

{

"dlref": "Ідентифікатор угоди ",

"dlds": "Дата початку угоди",

"dlcelcred": "Тип угоди (Код із дов.17)",

"dlvidobes": "Вид забезпечення (Код із дов.15)",

"dlporpog": "Порядок погашення (Код із дов.18)",

"dlcurr": "Валюта угоди (Код із дов.12)",

"dlamt": "Сума (початкова) угоди",

"dlrolesub": "Роль суб'єкта (Код із дов.14)",

"dlamtobes": "Вартість забезпечення",

"deallife": [

{

"dlmonth": "Період даних (місяць)",

"dlyear": "Період даних (рік) ",

"dlflstat": "Статус угоди в пот.періоді (Код із дов.16)",

"dldpf": "Дата закінчення угоди за договором",

"dldff": "Фактична дата закінчення угоди",

"dlkontragent": "ЄДРПОУ нового кредитора/старого кредитора (обов'язкове при статусі угоди проданий/куплений)",

"dlsale_date": "Дата продажу (обов'язково при продажу/купівлі угоди з 15.03.2021)",

"dlsale_name": "Повне найменування юридичної особи (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)",

"dlsale_addr": "Місцезнаходження юридичної особи (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)",

"dlsale_email": "Адреса електронної пошти (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)",

"dlsale_phone": "Номер телефону (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)",

"dlamtlim": "Поточний ліміт угоди (для поновлюваних угод, кредитних карток)",

"dlamtpaym": "Сума планового обов'язкового платежу в пот.періоді ",

"dlamtcur": "Сума пот. заборгованості",

"dlamtexp": "Сума пот. проср. заборгованості",

"dldayexp": "Поточна кількість днів прострочення",

"dlflpay": "Ознака викон. платежу в пот.періоді (Код із дов.13)",

"dlflbrk": "Ознака наявності прострочення в пот.періоді (Код із дов.13)",

"dlfluse": "Ознака кредитний транш в пот.періоді (Код із дов.13)",

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

}

]

}

],

"contacts": [

{

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

"ctype": "Тип контакту (Код із дов.10)",

"cval": "Значення контакту"

}

]

}

}

}

Response JSON

{

"reqinfo": {

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

"reqidout": "ІД запиту, згенерований організацією"

},

"http_status": "http код відповіді",

"sentdatainfo": {

"state": "Стан пакета (sy - системна помилка в сервісах УБКІ, ok - успіх, er - помилка, nt - успіх з позначкою)",

"main_errcode": "Найкритичніший код помилки з усіх валідацій пакета",

"inn": "ІПН кредитора",

"ok": "кількість компонент, прийнятих без зауважень",

"nt": "кількість компонент, прийнятих із зауваженнями",

"ig": "кількість не прийнятих компонент, пакет прийнято",

"er": "кількість не прийнятих компонент, пакет забраковано",

"sy": "кількість не прийнятих компонент внаслідок помилок сервера УБКІ",

"items": [

{

"compid": "Номер групи компонент",

"tag": "Тег",

"errtype": "Рівень помилки чи зауваження",

"errcode": "Номер помилки чи зауваження",

"attr": "Атрибут",

"msg": "Текст повідомлення"

}

]

},

"trace": {

"steps": [

{

"name": "Назва етапа",

"start": "Час початку обробки цього етапа",

"finish": "Час завершення обробки цього етапа",

"duration": "Тривалість обробки етапа"

}

]

}

}

Request XML

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

<doc>

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

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

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

<!-- Параметри пошуку -->

<request version="1.0"

reqtype="Режим обробки інформації (Код із дов.50)"

delreason="Причина видалення даних, при режимі d (Код із дов.62)"

reqreason="Мета подачі запиту (Код із дов.24): Передача даних - 0">

<ubkidata>

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

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

<!-- Даний блок повинен складатися з одного елемента -->

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

person_id =  "Унікальний ідентифікатор людини"

     is_gone = “Позначка про смерть людини, де 0 - жива, 1 - померла (обов'язкове для передачі) (Код із дов.56)"

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

fname="Ім'я"

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

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

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

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

<ident vdate="Дата верифікації даних кредитором"

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

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

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

fname="Ім'я"

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

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

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

family="Сімейний стан (Код із дов.2)"

ceduc="Освіта (Код із дов.3)"

cgrag="Громадянство (Код із дов.4 (ISO 3166))"

spd="Наявність реєстрації СПД (Код із дов.5)"

sstate="Соціальний статус (Код із дов.6)"

cchild="Кількість дітей">

</ident>

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

<!-- Блок працевлаштування може складатися з 0 .. * -->

<work vdate="Дата верифікації даних кредитором"

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

cdolgn="Службове становище (Код із дов.8)"

wokpo="ЄДРПОУ місця роботи"

wname="Назва місця роботи базовою мовою"

wstag="Стаж роботи, повних років"

wdohod="Щомісячний дохід клієнта">

</work>

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

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

<doc vdate="Дата верифікації даних кредитором"

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

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

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

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

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

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

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

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

</doc>

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

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

<addr vdate="Дата верифікації даних кредитором"

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

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

adcountry="Країна (Цифровий код із ISO 3166)"

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

adstate="Область"

adarea="Район"

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

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

adstreet="Вулиця"

adhome="Дім"

adcorp="Корпус"

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

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

</addr>

<!-- Блок історії фото -->

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

<foto vdate="Дата верифікації даних кредитором"

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

foto="base64 (Фото)">

</foto>

</cki>

</comp>

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

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

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

<crdeal dlref="Ідентифікатор угоди"

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

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

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

fname="Ім'я"

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

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

dlcelcred="Тип операції (Код із дов.17)"

dlvidobes="Вид забезпечення (Код із дов.15)"

dlporpog="Порядок погашення (Код із дов.18)"

dlcurr="Валюта угоди (Код із дов.12)"

dlamt="Сума (початкова) угоди"

dlrolesub="Роль суб'єкта (Код із дов.14)"

dlamtobes="Вартість забезпечення в базовій валюті">

<!-- Блок змінних значень кредитної історії -->

<deallife dlref="Ідентифікатор угоди"

dlmonth="Період даних (місяць)"

dlyear="Період даних (рік)"

dlds="Дата початку операції"

dldpf="Дата закінчення угоди за договором"

dldff="Фактична дата закінчення угоди"

dlflstat="Статус угоди в поточному періоди (Код із дов.16)"

dlkontragent="ЄДРПОУ нового кредитора/старого кредитора (обов'язкове при статусі угоди проданий/куплений)"

dlsale_date="Дата продажу (обов'язково при продажу/купівлі угоди з 15.03.2021)"

dlsale_name="Повне найменування юридичної особи (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)"

dlsale_addr="Місцезнаходження юридичної особи (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)"

dlsale_email="Адреса електронної пошти (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)"

dlsale_phone="Номер телефону (обов'язково при продажу/купівлі договору юридичній особі з 15.03.2021)"

dlamtlim="Поточний ліміт угоди (для поновлюваних угод, кредитних карт)"

dlamtpaym="Сума планового обов'язкового платежу в поточному періоді"

dlamtcur="Сума поточної заборгованості"

dlamtexp="Сума поточної простроченої заборгованості"

dldayexp="Поточна кількість днів прострочення"

dlflpay="Озанка виконання платежу в поточному періоді (Код із дов.13)"

dlflbrk="Ознака наявності прострочення в поточному періоді (Код із дов.13)"

dlfluse="Ознака кредитного траншу в поточному періоді (Код із дов.13)"

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

</deallife>

</crdeal>

</comp>

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

<!-- Блок історії своїх контактних даних -->

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

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

vdate="Дата верифікації даних кредитором"

ctype="Тип контакту (Код із дов.10)"

cval="Значення контакту">

</cont>

</comp>

</ubkidata>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

<TECH>

<!-- Звіт про результат запиту-передачі даних буде знаходитися у відповідному XML, тег-->

<!-- Блок статистики часу відпрацювання на стороні УБКІ-->

<trace>

<step name="START" stm="1574049134.650" ftm="1574049134.651"/>

<step name="FINISH" stm="1574049134.650" ftm="1574049135.224"/>

</trace>

<!-- Заповнюється в разі системної помилки і неможливості продовження успішної передачі пакетів (наприклад при закінченні дії сесійного ключа) -->

<error errtext="" errtype="числовий код помилки з довідника errtype дов.0"/>

<!--Звіт про результат запиту-передачі даних-->

<sentdatainfo reqid="Вихідний ІД запиту, згенерований УБКІ" state = "Стан пакета (sy - системна помилка в сервісах УБКІ, ok - успіх, er - помилка, nt - успіх з позначкою)"

sy = "системна помилка в сервісах УБКІ, повторіть відправку пакета, при повторенні помилки призупиніть відправку нових пакетів до з'ясування причин з бюро"

ok = "кількість прийнятих компонент без зауважень"

nt = "кількість прийнятих компонент із зауваженнями"

ig = "кількість не прийнятих/відхилених/проігнорованих компонент"

er = "кількість компонент з критичною помилкою, призводять до відбраковування всього пакету"

errtype = "Максимальний код помилки з усіх помилок компонент">

<item compid="ІД компоненти" tag="Тег" attr="Атрибут" code="sy - системна помилка в сервісах УБКІ, er - критична помилка, ig - відхилено з зауваженням, nt - прийнято з зауваженням" msg="Текст повідомлення" errtype="Всі помилки і/або нотифікації з довідника"/>

</sentdatainfo>

</TECH>

Приклад

Приклад

Request JSON

{ "reqtype": "i", "reqidout": "c9a961b00b8245b9af6d63d9db1", "reqreason": "0", "data": { "fo_cki": { "reqlng": "1", "inn": "1234567890", "person_id": "1-АА-111111", "is_gone": "0", "lname": "Іванов", "fname": "Іван", "mname": "Іванович", "bdate": "1981-04-16", "idents": [ { "lng": "1", "vdate": "2019-02-19", "inn": "1234567890", "lname": "Іванов", "fname": "Іван", "mname": "Іванович", "bdate": "1981-04-16", "csex": "1", "cgrag": "804", "family": "2", "ceduc": "3", "spd": "1", "sstate": "3", "cchild": "0" } ], "docs": [ { "lng": "1", "vdate": "2017-04-07", "dtype": "1", "dser": "АА", "dnom": "111111", "eddr_number": "19810416-07789", "dwho": "Луцкім МВ УДМС України у Волинській області", "dterm": "", "dwdt": "2014-10-01" } ], "addrs": [ { "vdate": "2017-04-07", "lng": "1", "adtype": "2", "adcountry": "UA", "adindex": "43000", "adstate": "Волинська", "adarea": "Луцьк (служ.)", "adcity": "Луцьк м.", "adcitytype": "4", "adstreet": "Науки просп.", "adhome": "1", "adcorp": "", "adflat": "83", "addrdirt": "25012, м.Луцьк, вул.Волинська буд.1 кв.83" } ], "deals": [ { "dlref": "1254789/1", "dlds": "2018-12-03", "dlcelcred": "10", "dlvidobes": "90", "dlporpog": "8", "dlcurr": "980", "dlamt": "1000.00", "dlrolesub": "1", "dlamtobes": "1000.00", "deallife": [ { "dlmonth": "12", "dlyear": "2018", "dldpf": "2018-12-18", "dldff": "", "dlflstat": "1", "dlamtlim": "1000.00", "dlamtpaym": "793.20", "dlamtcur": "1793.20", "dlamtexp": "1793.20", "dldayexp": "13", "dlflpay": "0", "dlflbrk": "1", "dlfluse": "0", "dldateclc": "2019-02-19" } ] } ], "contacts": [ { "vdate": "2019-02-13", "ctype": "3", "cval": "380710000000" } ] } } }

Response JSON

{ "reqinfo": { "reqid": "IN#O381G01204940", "reqidout": "c9a961b00b8245b9af6d63d9db1" }, "http_status": 200, "sentdatainfo": { "inn": "1234567890", "ok": 7, "nt": 0, "ig": 0, "er": 0, "sy": 0, "items": [], "reqid": "IN#O381G01204940", "reqidout": "c9a961b00b8245b9af6d63d9db1", "state": "ok", "main_errcode": 0 }, "trace": { "steps": [ { "name": "START", "start": "2023-07-26 17:06:33", "finish": "2023-07-26 17:06:33", "duration": 1 }, { "name": "FINISH", "start": "2022-08-01 16:40:05", "finish": "2022-08-01 16:40:05", "duration": 1014 } ] } }

Request XML

<!--?xml version="1.0" encoding="UTF-8"?--> <doc> <ubki sessid="BB0CC999E5024D01B125EC1060000B09"> <req_envelope> <req_xml> <request version="1.0" reqtype="i" reqreason="0"> <ubkidata> <comp id="1"> <cki reqlng="1" inn="1234567890" person_id="1-АА-111111" is_gone="0" lname="Іванов" fname="Іван" mname="Іванович" bdate="1981-04-16"> <doc lng="1" vdate="2017-04-07" dtype="1" dser="АА" dnom="111111" eddr_number="12345678-12345" dwho="Луцкім МВ УДМС України у Волинській області" dwdt="2014-10-01" > </doc> <ident lng="1" vdate="2019-02-19" inn="1234567890" lname="Іванов" fname="Іван" mname="Іванович" bdate="1981-04-16" csex="1" cgrag="804"> </ident> <addr vdate="2017-04-07" lng="1" adtype="2" adcountry="UA" adindex="43000" adstate="Волинська" adarea="Луцьк (служ.)" adcity="Луцьк м." adcitytype="4" adstreet="Науки просп." adhome="1" adcorp="" adflat="83" /> </cki> </comp> <comp id="2"> <crdeal dlref="1254789/1" lng="1" inn="1234567890" lname="Іванов" fname="Іван" mname="Іванович" bdate="1981-04-16" dlcelcred="10" dlvidobes="90" dlporpog="8" dlcurr="980" dlamt="1000.00" dlrolesub="1" dlamtobes="1000.00"> <deallife dlref="1254789/1" dlmonth="12" dlyear="2018" dlds="2018-12-03" dldpf="2018-12-18" dldff="" dlflstat="1" dlkontragent="" dlamtlim="1000.00" dlamtpaym="793.20" dlamtcur="1793.20" dlamtexp="1793.20" dldayexp="13" dlflpay="0" dlflbrk="1" dlfluse="0" dldateclc="2019-02-19"> </deallife> </crdeal> </comp> <comp id="10"> <cont inn="1234567890" vdate="2019-02-13" ctype="3" cval="380710000000"> </cont> </comp> </ubkidata> </request> </req_xml> </req_envelope> </ubki> </doc>

Response XML


Див. у цьому розділі також

Юридична особа

Параметри запиту передачі даних

API отримання реєстру передачі даних

Помилки і нотифікації при передачі даних

Журнал версій API


Вступ

Авторизація

Отримання інформації із бюро

Моніторинг

Тестове середовище

Довідники

Журнал змін