...
Info |
---|
Звіт містить такі компоненти: |
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": { "phoneverif": { "phone": "Мобільний телефон", "bdate": "Дата народження", **"channelotp": "sms" }, "reqlng": "Мова критеріїв пошуку (Код із дов.23)" }, "version": "1.0", "reqtype": "Код шаблону (Код із дов.49): Звіт 'Ідентифікація СКІ за номером телефону та датою народження' - 34", "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="45" descr="">
<phoneverif phone="Мобільний телефон"
bdate="Дата народження"
mathch="Response JSON
|
<?xml version="1.0" encoding="utf-8"?>
<doc>
<ubki sessid="Сесійний ключ (отримуємо з API авторизації)">
<req_envelope descr="Конверт запиту">
<req_xml descr="Об'єкт запиту">
<!-- Параметри запиту --><request version="1.0" reqtype="Код шаблону (Код із дов.49): Звіт 'Ідентифікація СКІ за номером телефону та датою народження' - 34" reqreason="Мета подання запиту (Код із дов.24)">
<!-- Параметри, що описують критерії пошуку-->
<i reqlng="Мова критеріїв пошуку (Код із дов.23)">
<!-- Параметри ідентифікації суб'єкта-->
<phoneverif phone="Мобільний телефон"
bdate="Дата народження"
**channelotp="sms" />
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc>
|
|
</comp>
</ubkidata>
Request JSON/Отримання даних клієнта після OTP-верифікації
|
Request XML/Перевірка коректної зв'язки телефону і дати народження |
Expand | ||
---|---|---|
|
{
"doc": {
"ubki": {
"req_envelope": {
"req_xml": {
"request": {
"i": {
"phoneverif": {
"phone": "Мобільний телефон",
"bdate": "Дата народження",
"reqid": "Вихідний ІД, згенерований УБКІ при запиті на перевірка коректної зв'язки телефону і дати народження",
**"otp": "Код із смс"
},
|
},
"version": "1.0",
"reqtype": "Код шаблону (Код із дов.49): Звіт 'Ідентифікація СКІ за номером телефону та датою народження' - 34",
"reqreason": "Мета подання запиту (Код із дов.24)"
},
"descr": "Об'єкт запиту"
},
"descr": "Конверт запиту"
},
"sessid": "Сесійний ключ (отримуємо з API авторизації)"
}
}
}
Request XML/Отримання даних клієнта після OTP-верифікації
( ** параметри передаються опціонально)
|
Response XML
|
<doc>
<ubki sessid="Сесійний ключ (отримуємо з API авторизації)">
<req_envelope descr="Конверт запиту">
<req_xml descr="Об'єкт запиту
|
|
|
|
|
|
|
|
|
reqid="Вихідний ІД, згенерований УБКІ при запиті на перевірка коректної зв'язки телефону і дати народження"
**otp="Код із смс
|
|
</req_xml>
</req_envelope>
</ubki>
</doc>
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="1" descr="Назва компоненти">
<cki inn="РНОКПП (ІПН) СКІ/ЕДРППУ юрособи"
lname="Прізвище/Найменування юрособи"
fname="Ім'я"
mname="По батькові"
reqlng="Мова пошуку (при пошуку)/Мова ідентифікації (при передачі)
|
Request JSON/Отримання даних клієнта після OTP-верифікації |
Expand | ||
---|---|---|
| ||
{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "phoneverif": { "phone": "Мобільний телефон", "bdate": "Дата народження", "reqid": "Вихідний ІД, згенерований УБКІ при запиті на перевірка коректної зв'язки телефону і дати народження", **"otp": "Код із смс" }, "reqlng": "Мова критеріїв пошуку (Код із дов.23)" |
reqlngref="Мова пошуку (при пошуку)/Мова ідентифікації (при передачі) (Значення із дов.23)"
bdate="Дата народження">
<ident donor="Джерело інформації (Значення із дов.54)"
vdate="Дата інформації даного блоку"
|
|
lngref="Мова надання блоку (Значення із дов.23)"
inn="РНОКПП (ІПН) СКІ"
lname="Прізвище"
fname="Ім'я"
mname="По батькові"
bdate="Дата народження"
csex="Стать (Код із дов.1)"
csexref="Стать(Значення із дов.1)"
family="Сімейний стан (Код із дов.2)"
familyref="Сімейний стан (Значення із дов.2)"
ceduc="Освіта (Код із дов.3)"
ceducref="Освіта (Значення із дов.3)"
cgrag="Громадянство (Код із дов.4)"
cgragref="Громадянство (Значення із дов.4)"
spd="Наявність реєстрації СПД (Код із дов.5)"
spdref="Наявність реєстрації СПД (Значення із дов.5)"
sstate="Соціальный статус (Код із дов.6)"
sstateref="Соціальный статус (Значення із дов.6)"
cchild="Кількість дітей">
<!--Даний блок може і повинен складатися з 1 .. * елементів-->
</ident>
<!-- Блок історії інформації місця роботи -->
<work wdonor="Джерело інформації (Значення із дов.54)"
vdate="Дата інформації даного блоку"
lng="Мова надання блоку (Код із дов.23)"
lngref="Мова надання блоку (Значення із дов.23)"
cdolgn="Службове становище (Код із дов.8)"
cdolgnref="Службове становище (Значення із дов.8)"
wokpo="ЄДРПОУ місця роботи"
wname="Назва місця роботи оригінальною мовою"
wstag="Стаж роботи, повних років"
wdohod="Щомісячний дохід клієнта">
<!--Даний блок може складатися з 0 .. *-->
</work>
<!-- Блок історії інформації документів -->
<doc ddonor=
|
Response JSON
|
|
|
|
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="18" descr="Назва компоненти">
<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"
nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"
inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)">
<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"
crdeal="Ідентифікатор угоди (референс)"
source="Вид оскарження (Код із дов.48)"
sourceref="Вид оскарження (Значення із дов.48)"
vdate="Дата створення заявки" />
<commentcki comment="Коментар суб'єкта кредитної історії"
vdate="Дата створення коментаря" />
<plost pser="Серія паспорта, заявлено СКІ як загублений (крадіжка)"
pnom="Номер паспорта, заявлено СКІ як загублений (крадіжка)"
crdate="Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ"
ldate="Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ" />
<changedeal crdeal="Ідентифікатор угоди (референс)"
changecode="Код причини коригування/видалення даних (Код із дов.62)"
changeref="Текст причини коригування/видалення даних (Значення із дов.62)"
vdate="Дата коригування/видалення даних" />
</pret>
</comp>
</ubkidata>
Приклад (Перевірка коректної зв'язки телефону і дати народження)
Request JSON
Code Block |
---|
{
"doc": {
"ubki": {
"req_envelope": {
"req_xml": {
"request": {
"i": {
"phoneverif": {
"phone": "+380662134234",
"bdate": "1957-10-19",
"channelotp": "sms"
},
"reqlng": "1"
},
"version": "1.0",
"reqtype": "34",
"reqreason": "2"
},
"descr": "Об`єкт запиту"
},
"descr": "Конверт запиту"
},
"sessid": "4EC8D647B0DB4D9A862CDC25AB00000F"
}
}
} |
Request XML
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<doc>
<ubki sessid="4EC8D647B0DB4D9A862CDC25AB00000F">
<req_envelope descr="Конверт запиту">
<req_xml descr="Об`єкт запиту">
<request version="1.0" reqtype="34" reqreason="2">
<i reqlng="1">
<phoneverif phone="+380662134234" bdate="1957-10-19" channelotp="sms" />
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc> |
Response XML
Code Block |
---|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
<tech>
<trace>
<step name="build report" stm="2022-01-10 10:35:36.495" ftm="2022-01-10 10:35:36.654" />
</trace>
<reqinfo reqid="req2#000002012324" />
</tech>
<comp id="45" descr="Блок звірки телефону і дати народження">
<phoneverif phone="+380662134234" bdate="1957-10-19" mathch="1" matchref="Так" />
</comp>
</ubkidata> |
Приклад (Отримання даних клієнта після OTP-верифікації)
Request JSON
|
Request XML/Отримання даних клієнта після OTP-верифікації |
Expand | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <doc> <ubki sessid="Сесійний ключ (отримуємо з API авторизації)"> <req_envelope descr="Конверт запиту"> <req_xml descr="Об'єкт запиту"> <!-- Параметри запиту--> <request version="1.0" reqtype="Код шаблону (Код із дов.49): Звіт 'Ідентифікація СКІ за номером телефону та датою народження' - 34" reqreason="Мета подання запиту (Код із дов.24)"> <!-- Параметри, що описують критерії пошуку--> <i reqlng="Мова критеріїв пошуку (Код із дов.23)"> <!-- Параметри ідентифікації суб'єкта--> <phoneverif phone="Мобільний телефон" bdate="Дата народження" reqid="Вихідний ІД, згенерований УБКІ при запиті на перевірка коректної зв'язки телефону і дати народження" **otp="Код із смс" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
Приклад (Перевірка коректної зв'язки телефону і дати народження) |
---|
Request JSON |
|
Response JSON |
|
Request XML |
|
Response XML |
|
Приклад (Отримання даних клієнта після OTP-верифікації) |
---|
Request JSON |
|
Response JSON |
|
|
|
|
|
|
Request XML |
|
Response XML |
|
|
|
|
|
XSD Schema request | https://secure.ubki.ua/b2/js/xsd/request34.xsd |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response34.xsd |
Test URL | https://test.ubki.ua/b2_api_xml/ubki/xml |
---|---|
Test data |
|