Versions Compared

Old Version 25

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version 26

changes.mady.by.user Оксана Нечепоренко

Saved on

Key

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

...

Info

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

Http Method

POST

Request URL

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

Request JSON
( ** параметри передаються опціонально при наявністі кредитної історії по даному клієнту від Вашої організації)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "РНОКПП (ІПН) фіз.особи",

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

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

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

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

},

"contacts": {

"cont": {

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

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

}

},

"docs": {

"doc": {

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

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

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

}

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): Звіт 'Контакти' - 04",

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

},

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

},

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

},

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

}

}

}

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

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

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

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

<ident okpo="РНОКПП (ІПН) фіз.особи"

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

fname="**Ім'я"

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

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

</ident>

<contacts>

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

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

</contacts>

<docs>

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

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

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

</docs>

</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="Прізвище/Найменування юрособи"

fname="Ім'я"

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

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

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

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

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

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

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

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="Джерело інформації (Значення із дов.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="10" descr="Назва компоненти">

<cont inn="РНОКПП (ІПН) СКІ/ЕДРППУ юрособи"

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

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

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

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

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

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

</cont>

</comp>

<!-- Блок підтвердження контактів СКІ -->

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

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

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

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

cstate="Статус контакту (Код із дов.57)"

cstateref="Статус контакту (Текстове значення із дов.57)"

vdatestart="Дата першої актуалізації"

vdate="Дата останньої актуалізації" />

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

</comp>

</ubkidata>

...

Test URL

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

Test data

  • bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095" dtype="1" dser="ДО" dnom="270000" cval="+380981220000" ctype="3"

  • bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593" dtype="17" dser="" dnom="001013900" cval="+380935171868" ctype="3"

  • bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397" dtype="1" dser="СЕ" dnom="311111" cval="+380506630641" ctype="3"

  • bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116" dtype="1" dser="КО" dnom="220394" cval="+380971321122" ctype="3"

  • bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="3333312110" dtype="1" dser="ДД" dnom="222222" cval="+380732144444" ctype="3"

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" okpo="3112579786" dtype="1" dser="СЮ" dnom="170000" cval="+380981224895" ctype="3"

  • bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" dtype="1" dser="ВВ" dnom="142228" cval="+380662134234" ctype="3"

  • bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" dtype="1" dser="АМ" dnom="578072" cval="+380962134234" ctype="3"

<comp id="46" descr="Підтвердження контактів СКІ">

  • bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" dtype="1" dser="ВВ" dnom="142228" cval="+380662134234" ctype="3"

  • bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" dtype="1" dser="АМ" dnom="578072" cval="+380962134234" ctype="3"

...