Versions Compared

Key

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

...

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

The report contains the following components:

Http Method

POST

Request URL

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

Request XML

Expand
title body:

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

<doc>

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

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

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

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

<request version="1.0"

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

delreason="Причина видалення даних, при режимі d (Код із довThe reason for deleting data, in mode d(code from ref.62)"

reqreason="Мета подачі запиту (Код із довRequest objective (code from ref.24): Передача даних - Data transfer – 0">

<ubkidata>

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

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

<!-- Даний блок повинен складатися з одного елемента This part must contain one item -->

<cki inn="РНОКПП (ІПН) СКІTIN of the credit history subject/EDRPOU of the legal entity"

lname="Прізвище/Найменування юрособиLast name/Name of the legal entity"

fname="Ім'яFirst name"

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

reqlng="Мова пошуку (при пошукуSearch language (while searching)/Мова ідентифікації (при передачі) (Код із довIdentification language (during transfer) (code from ref.23)"

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

<!-- Даний блок може і повинен складатися з This part can and must contain 1..* елементів items -->

<ident vdate="Дата верифікації даних кредиторомDate of the information from this part"

lng="Мова надання блоку (Код із довPart presentation language (code from ref.23)"

inn="РНОКПП (ІПН) СКІTIN of the credit history subject"

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

fname="Ім'яFirst name"

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

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

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

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

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

cgrag="Громадянство (Код із довCitizenship (code from ref.4)"

spd="Наявність реєстрації СПД (Код із довPresence of the business entity’s registration (code from ref.5)"

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

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

</ident>

<!-- Блок історії інформації про працевлаштування History of the Information about Employment part -->

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

<work vdate="Дата верифікації даних кредиторомDate of the information from this part"

lng="Мова надання блоку (Код із довPart presentation language (code from ref.23)"

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

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

wname="Назва місця роботи базовою мовоюName of the employer in the base language"

wstag="Стаж роботи, повних роківLength of service, years completed"

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

</work>

<!-- Блок історії інформації про документи History of the Information about Documents part -->

<!-- Даний блок повинен складатися з This part must contain 1..* елементів і заповнений принаймні одним документом units and at least one document-->

<doc vdate="Дата верифікації даних кредиторомDate of the information from this part"

lng="Мова надання блоку (Код із довPart presentation language (code from ref.23)"

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

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

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

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

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

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

</doc>

<!-- Блок історії інформації про адреси History of the Information about Addresses part -->

<!-- Даний блок повинен складатися з This part must contain 1..* елементів і заповнений принаймні однією адресою units and at least one address-->

<addr vdate="Дата верифікації даних кредиторомDate of the information from this part"

lng="Мова надання блоку (Код із довPart presentation language (code from ref.23)"

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

adcountry="Країна (однорядкове резюме код з довідника Country (two-character code from ISO 3166 reference book)"

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

adstate="ОбластьRegion"

adarea="РайонDistrict"

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

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

adstreet="ВулицяStreet"

adhome="ДімHouse"

adcorp="КорпусBlock"

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

addrdirt="Адреса в одному рядку (буде виведений з експлуатації в наступних версіях АPІ, з Address in one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019 поле вважається неприпустимим)">

</addr>

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

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

<foto vdate="Дата верифікації даних кредиторомDate of the information from this part"

inn="РНОКПП (ІПН) СКІTIN of the credit history subject"

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

</foto>

</cki>

</comp>

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

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

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

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

lng="Мова надання блоку (Код із довPart presentation language (code from ref.23)"

inn="РНОКПП (ІПН) СКІTIN of the credit history subject/EDRPOU of the legal entity"

lname="ПрізвищеLast name/Name of the legal entity"

fname="Ім'яFirst name"

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

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

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

dlvidobes="Вид забезпечення (Код із довType of collateral (code from ref.15)"

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

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

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

dlrolesub="Роль суб'єкта (Код із довSubject’s role (code from ref.14)"

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

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

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

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

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

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

dldpf="Дата закінчення угоди за договоромTransaction closing date under the contract"

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

dlflstat="Статус угоди в поточному періоди (Код із довTransaction status in the current period (code from ref.16)"

dlkontragent="ЄДРПОУ нового кредитора/старого кредитора (обов'язкове при статусі угоди проданий/купленийOKPO of a new lender/old lender (mandatory if the transaction status is sold / bought)"

dlsale_date="Дата продажу (обов'язково при продажу/купівлі угоди з 15Date of sale (required for sale from 15.03.2021)"

dlsale_name="Повне найменування юридичної особи (обов'язково при продажу/купівлі договору юридичній особі з Full name of the legal entity (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlsale_addr="Місцезнаходження юридичної особи (обов'язково при продажу/купівлі договору юридичній особі з Location of a legal entity (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlsale_email="Адреса електронної пошти (обов'язково при продажу/купівлі договору юридичній особі з E-mail address (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlsale_phone="Номер телефону (обов'язково при продажу/купівлі договору юридичній особі з Phone number (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlamtlim="Поточний ліміт угоди (для поновлюваних угод, кредитних картCurrent transaction limit (for renewable transactions, credit cards)"

dlamtpaym="Сума планового обов'язкового платежу в поточному періодіPlanned compulsory payment amount in the current period"

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

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

dlflpay="Озанка виконання платежу в поточному періоді (Код із довIndication of payment made in the current period (code from ref.13)"

dlflbrk="Ознака наявності прострочення в поточному періоді (Код із довIndication of arrears present in the current period (code from ref.13)"

dlfluse="Ознака кредитного траншу в поточному періоді (Код із довIndication of the credit tranche in the current period (code from ref.13)"

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

</deallife>

</crdeal>

</comp>

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

<!-- Блок історії своїх контактних даних History of the Information about Contacts part -->

<!-- Даний блок повинен складатися з This part must contain 1..* елементів і заповнений принаймні одним контактом units and at least one contact-->

<cont inn="РНОКПП (ІПН) СКІTIN of the credit history subject/EDRPOU of the legal entity"

vdate="Дата верифікації даних кредиторомDate of the information from this part"

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

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

</cont>

</comp>

</ubkidata>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<TECH>

<!-- Звіт про результат запиту-передачі даних буде знаходитися у відповідному XML, тегA report on data request-to-send result will be included in the response XML, tag-->

<!-- Блок статистики часу відпрацювання на стороні УБКІDevelopment Time Statistics from the UBKI Side part-->

<trace>

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

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

</trace>

<!-- Заповнюється в разі системної помилки і неможливості продовження успішної передачі пакетів (наприклад при закінченні дії сесійного ключаshould be completed if a system error occurs, and it is impossible to continue successful transfer of batches (for example, when the session key expires) -->

<error errtext="" errtype="числовий код помилки з довідника errtype довnumeric error code from the errtype reference book ref. 0" />

<!--Звіт про результат запиту-передачі данихReport on data request-to-send result-->

<sentdatainfo reqid="Вихідний ІД запиту, згенерований УБКІ" Outgoing request ID generated by UBKI"

state="Стан пакета (sy - системна помилка в сервісах УБКІ, ok - успіх, er - помилка, nt - успіх з позначкоюBatch status (sy – system error in UBKI services, ok – success, er – error, nt – success with a remark)"

sy="системна помилка в сервісах УБКІ, повторіть відправку пакета, при повторенні помилки призупиніть відправку нових пакетів до з'ясування причин з бюроsystem error of the UBKI services, send the batch again, if the error repeats, suspend sending new batches, until you clarify the reasons with the Bureau"

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

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

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

er="кількість компонент з критичною помилкою, призводять до відбраковування всього пакетуnumber of components with critical errors, leading to rejection of the whole batch"

errtype="Максимальний код помилки з усіх помилок компонентMaximum error code of all component errors">

<item compid="ІД компонентиComponent ID"

tag="ТегTag"

attr="АтрибутAttribute"

code="sy - системна помилка в сервісах УБКІ, er - критична помилка, ig - відхилено з зауваженням, nt - прийнято з зауваженням" msg="Текст повідомлення" errtype="Всі помилки і/або нотифікації з довідника– system error of the UBKI services, er – critical error, ig – declined with a remark, nt – accepted with a remark"

msg="Message text"

errtype="All errors and/or notifications from the directory" />

</sentdatainfo>

</TECH>

Приклад

Example

Request

Code Block
<!--?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" lname="Іванов" fname="Іван" mname="Іванович" bdate="1981-04-16">
                <doc lng="1" vdate="2017-04-07" dtype="1" dser="АА" dnom="111111" 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" dldonor="BNK" 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

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<doc>
  <tech>
    <trace>
      <step name="START" stm="1659361205.224" ftm="1659361205.224" start="2022-08-01 16:40:05" finish="2022-08-01 16:40:05" duration="0000000" />
      <step name="FINISH" stm="1659361205.224" ftm="1659361205.653" start="2022-08-01 16:40:05" finish="2022-08-01 16:40:05" duration="0000429" />
    </trace>
    <reqinfo reqid="IN#O381G01204940" />
    <error errtype="" />
    <sentdatainfo reqid="IN#O381G01204940" state="ok" errtype="0" inn="1234567890" reqidout="" ok="6" nt="0" ig="0" er="0" sy="0" />
  </tech>
</doc>

...

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

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

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

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

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

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

...

Вступ

Авторизація

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

Моніторинг

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

Довідники

Журнал змін