Versions Compared

Key

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

...

Http Method

POST

Request URL

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

Request XML

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

XML

Expand
titlebody:

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

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="Ким виданий документ" 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)" />

<!--Даний блок повинен складатись з 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>

Приклад

Request

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="7BD7E136E3BF470EAA2CFE2E0000000D">
    <req_envelope descr="Конверт запиту">
      <req_xml descr="Об'єкт запиту">
        <request version="1.0" reqtype="04" reqreason="2">
          <i reqlng="1">
            <ident bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" />
            <docs>
              <doc dtype="1" dser="ВВ" dnom="142228" />
            </docs>
            <contacts>
              <cont cval="+380662134234" ctype="3" />
            </contacts>
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

Response

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-01-09 18:37:18.216" ftm="2022-01-09 18:37:18.274" />
    </trace>
    <reqinfo reqid="req2#000002007636" />
  </tech>
  <comp id="1" descr="Ідентифікація Суб'єкта кредитної історії (СКІ)">
    <cki bdate="1957-10-19" reqlngref="Русский" reqlng="2" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" inn="2111118724">
      <ident cchild="" sstateref="" sstate="" spdref="физическое лицо" spd="1" cgragref="" cgrag="802" ceducref="" ceduc="" familyref="" family="" csexref="женщина" csex="2" bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" inn="2111118724" lngref="Русский" lng="2" vdate="2021-07-06" donor="BNK" />
      <work wdohod="" wstag="" wname="ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ 'УКРАЇНСЬКА КОМПАНІЯ 'О'" wokpo="34745377" cdolgnref="Рабочий\специалист\исполнитель" cdolgn="3" lngref="Украинский" lng="1" vdate="2021-04-07" wdonor="BNK" />
      <doc dwdt="2004-03-10" dwho="ХЕРСОНСКИМ ГО УМВД" dterm="" dnom="142228" dser="ВВ" dtyperef="Паспорт" dtype="1" lngref="Украинский" lng="1" vdate="2021-04-21" ddonor="BNK" />
      <addr adflat="81" adcorp="" adhome="11" adstreet="ВУЛ.ЕЖЕЛЕ" adcitytyperef="" adcitytype="" adcity="М.ХЕРСОН" adarea="" adstate="ХЕРСОНСЬКА" adindex="10000" adcountry="UA" adtyperef="Адрес регистрации" adtype="2" lngref="Украинский" lng="1" vdate="1900-01-01" addonor="BNK" />
    </cki>
    <identdocmvds>
      <identdocmvd found="0" foundref="Не знайдено" foundtitle="Паспорт ВВ-142228 не знайдено у списку анульованих." pser="ВВ" pnom="142228" dtype="1" dtyperef="Паспорт">
        <foundsource name="MVS" found="0" foundref="Не знайдено" />
        <foundsource name="DMS" found="0" foundref="Не знайдено" />
        <foundsource name="UBKI" found="0" foundref="Не знайдено" />
      </identdocmvd>
    </identdocmvds>
  </comp>
  <comp id="10" descr="Контакти">
    <cont cval="+380931656411" ctyperef="домашній тел." ctype="1" vdate="2021-07-13" cdonor="BNK" />
    <cont cval="+380662134234" ctyperef="мобільний тел." ctype="3" vdate="2021-04-08" cdonor="BNK" />
    <cont cval="+380992254422" ctyperef="мобільний тел." ctype="3" vdate="2021-01-14" cdonor="BNK" />
  </comp>
  <comp id="46" descr="Підтвердження контактів СКІ">
    <contact cval="+380662134234" ctype="3" ctyperef="мобільний тел." cstate="2" cstateref="Деактуалізація" vdatestart="2020-08-03" vdate="2020-10-08" />
    <contact cval="+380661111111" ctype="3" ctyperef="мобільний тел." cstate="1" cstateref="Актуалізація" vdatestart="2020-05-12" vdate="2020-09-30" />
  </comp>
</ubkidata>

...