Request params
*обов'язкові поля
<request> (1) Атрибути запиту | ||
---|---|---|
version | Версія xml запиту | [TEXT, 10] текстовий формат змінної довжини, до 10 символів. |
reqtype* | Код шаблону (дов.49) | [TEXT, 10] текстовий формат змінної довжини, до 10 символів |
reqsubtype* | Код підшаблону для 07 - Звіт «Visa Transaction Underwriting Score» (1 - отримання скорингу та атрибутів; 2 - отримання атрибутів; не заповнюється у разі отримання тільки скорингу) | [TEXT, 10] текстовий формат змінної довжини, до 10 символів |
reqreason* | Мета подання запиту (дов.24) | [N,10], числовий формат |
reqdate | Дата і час запиту (виведено з експлуатації 19.05.2022) | [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31) |
reqidout | Ідентифікатор запиту з боку партнера (виведено з експлуатації 19.05.2022) | [TEXT, 50] текстовий формат змінної довжини, до 50 символів |
reqsource | Ініціатор запиту (виведено з експлуатації 19.05.2022) | [N,10], числовий формат |
<i> (1) Атрибути, що описують критерії пошуку | ||
reqlng | Мова критеріїв пошуку (дов.23) | [N,10], числовий формат |
<ident> (1) Атрибути для ідентифікації суб'єкта | ||
okpo* | РНУКПН (ІПН) (для фіз.осіб) / ЄДРПОУ (для юр.осіб) | [N, 10] 10 чисельних символів |
lname* | Прізвище | [TEXT, 40] текстовий формат змінної довжини, до 40 символів |
fname* | Им'я | [TEXT, 40] текстовий формат змінної довжини, до 40 символів |
mname* | По батькові | [TEXT, 40] текстовий формат змінної довжини, до 40 символів |
bdate* | Дата народження | [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31) |
</ident> |
<docs> (0..*) Документи | ||
<doc> | ||
dtype* | Тип документа (дов.7) | [N,10], числовий формат |
dser* | Серія документа | [TEXT, 10] текстовий формат змінної довжини, до 10 символів |
dnom* | Номер документа | [TEXT, 9] текстовий формат змінної довжини, до 9 символів |
</docs> |
<contacts> (0..*) Контакти | ||
<cont> | ||
ctype* | Тип контакту (дов.10) | [N,10], числовий формат |
cval* | Значення контакту (Формат +380...) | [TEXT, 40] текстовий формат змінної довжини, до 40 символів |
</contacts> |
<mvd> (1) Атрибути для пошуку анульованих документів | ||
dtype* | Тип документа, що розшукується. Доступні значення - 1,3, 5, 17 (дов.7). Якщо dtype не заповнений, то по дефолту 1 (зворотна сумісність). | [N,10], числовий формат |
pser* | Серія паспорта або пустий атрибут, якщо ID-карта | [TEXT, 10] текстовий формат змінної довжини, до 10 символів |
pnom* | Номер паспорта або номер ID-карти, що розшукується | [TEXT, 9] текстовий формат змінної довжини, до 9 символів |
plname | Прізвище в паспорті, що розшукується | [TEXT, 40] текстовий формат змінної довжини, до 40 символів |
pfname | Ім'я в паспорті, що розшукується | [TEXT, 40] текстовий формат змінної довжини, до 40 символів |
pmname | По батькові в паспорті, що розшукується | [TEXT, 40] текстовий формат змінної довжини, до 40 символів |
pbdate | Дата народження в паспорті, що розшукується | [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31) |
</mvd> |
<fotoverif> (1) Атрибути для фотоверіфікаціі | ||
freqtype* | Тип запиту: 1 - у власній базі фото 2 - в базі фото інших банків 3 - порівняння двох осіб на фото 4 - зарезервовано 5 - в базі фото скомпрометованих осіб 6 - порівняння з фото з документа 7 - порівняння двох облич на одному фото, наприклад, особа з паспорта і обличчя людини, що тримає паспорт | [N,1] 1 чисельних символів |
inn* | РНУКПН (ІПН) | [N,10] 10 чисельних символів |
facelogic | Тип алгоритму пошуку особи: 1 - пошук особи з найбільшою площею 2 - пошук особи по центру фотографії 3 - пошук особи з перебором всіх осіб, перша особа для роботи вибирається найближче до центру, решта в будь-якому порядку. Якщо міра схожості першої особи вище порога, то далі перебору не буде. При відсутності параметру facelogic, застосовується логіка facelogic = 3 | [N,1] 1 чисельних символів |
foto* | Base64(Фото) вхідної заявки (LHS) | [TEXT,~] ттекстовий формат змінної довжини |
fotoext* | Розширення фото вхідної заявки | [TEXT,10] текстовий формат змінної довжини, до 10 символів |
phone | Телефон для порівняння (Формат +380...) | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
</fotoverif> |
<spd> (1) Атрибути для звіту СПД | ||
inn | ІПН (для фіз.осіб) / ЄДРПОУ (для юр.осіб) | [N,10] 10 чисельних символів |
</spd> |
<telecom> (1) Атрибути для Телеком звіту | ||
phone | Телефон для порівняння (Формат +380...) | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
datecut | Дата розрахунку. Якщо дата = "" - розраховується на зараз, інакше на початок дня зазначеної дати> " | [YYYY-MM-DD], YYYY - год (1920 - 2099), MM - месяц (01 - 12), DD - день (01-31) |
</telecom> |
<drorm> (1) Атрибути для звіту "Інформація з ДРОРМ" | ||
value | Номер виконавчого провадження | [N,10], числовий формат |
</drorm> |
<rrp> (1) Атрибути для звіту "Інформація з РРП" | ||
value | Номер обтяження по суб'єкту | [TEXT,25] текстовий формат змінної довжини, до 25 символів |
</rrp> |
<additionaldata> (1) Атрибути для звіту "Судове рішення" і "Повідомлення в ЗМІ" | ||
courtid | Номер судового документа | [N,10], числовий формат |
smiid | Ідентифікатор новини в базі бюро | [TEXT,40] текстовий |
</additionaldata> |
<phoneverif> Ідентифікації СКІ за номером телефону і датою народження для терміналів самообслуговування | ||
phone | Телефон (Формат +380...) | [N,10], числовий формат |
bdate | Дата народження | [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31) |
reqid | Вихідний ІД запиту, згенерований УБКІ | |
channelotp | Канал відправки отп-пароля | [TEXT,3] текстовий формат змінної довжини, до 3 символів |
otp | Код із смс | [N,10] 10 чисельних символів |
</phoneverif> |
<afsubki> (1) AFS (Anti Fraud System) UBKI | ||
inn | ІПН (для фіз.осіб) / ЄДРПОУ (для юр.осіб) | [N,10] 10 чисельних символів |
<request> (1) Перший запит | ||
mode | Вид звіту ( 'full'-повний 'short'-короткий) якщо не вказано, то вважається full | [TEXT,10] текстовий формат змінної довжини, до 10 символів |
dlrolesub* | Роль суб'єкта. (дов.14.) Уточнення: значення "3" довідника для AFS UBKI не використовується) | [N,10] 10 чисельних символів |
inn* | Ідентифікаційний номер клієнта (для фіз.осіб) | [N,10] 10 чисельних символів |
lname* | Прізвище | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
fname* | Ім'я | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
mname | По батькові | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
bdate* | Дата народження | [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31) |
dser* | Серія паспорта | [TEXT,10] текстовий формат змінної довжини, до 10 символів |
dnom* | Номер паспорта | [TEXT,9] текстовий формат змінної довжини, до 9 символів |
innsp | ІПН дружини | [N,10] 10 чисельних символів |
inncp | Ідентифікаційний номер контактної особи в заявці | [N,10] 10 чисельних символів |
wname* | Назва основного роботодавця (якщо немає роботодавця, передаються одиниці) | [TEXT,100] текстовий формат змінної довжини, до 100 символів |
wokpo* | ЄДРПОУ основного роботодавця | [N,10] 10 чисельних символів |
ureconom | Галузь компанії основного роботодавця (дов.36) | [TEXT,100] текстовий формат змінної довжини, до 100 символів |
wstaff | Кількість працівників основного роботодавця | [N,10], числовий формат |
wcountry | Країна перебування основного роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wstate | Область знаходження основного роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wcity | Населений пункт знаходження основного роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wstreet | Вулиця знаходження основного роботодавця | [TEXT,100] текстовий формат змінної довжини, до 100 символів |
whome | Будинок знаходження основного роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wflat | Офіс знаходження основного роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
windex | Індекс основного роботодавця | [N,5] 5 чисельних символів |
wothername | Назва додаткового роботодавця | [TEXT,250] текстовий формат змінної довжини, до 250 символів |
wotherokpo | ЄДРПОУ додаткового роботодавця | [N,10] 10 чисельних символів |
ureconomother | Галузь компанії додаткового роботодавця | [TEXT,100] текстовий формат змінної довжини, до 100 символів |
wotherstaff | Кількість працівників організації додаткового роботодавця | [N,10], числовий формат |
wothercountry | Країна перебування додаткового роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wotherstate | Область знаходження додаткового роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wothercity | Населений пункт знаходження додаткового роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wotherstreet | Вулиця знаходження додаткового роботодавця | [TEXT,100] текстовий формат змінної довжини, до 100 символів |
wotherhome | Будинок знаходження додаткового роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wotherflat | Офіс знаходження додаткового роботодавця | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wotherindex | Індекс знаходження додаткового роботодавця | [N,5] 5 численних символів |
mphone* | Мобільний телефон (Формат +380...) | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wphone | Робочий телефон 1 | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wphone2 | Робочий телефон 2 | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
wphone3 | Робочий телефон 3 | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
regphone | Телефон за місцем реєстрації | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
livphone | Телефон за місцем проживання | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
contphone | Телефон контактної особи 1 | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
contphone2 | Телефон контактної особи 2 | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
regindex | Індекс за місцем проживання | [N,5] 5 чисельних символів |
regstate | Область за місцем реєстрації | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
regcity | Місто реєстрації | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
regstreet | Вулиця реєстрації | [TEXT,100] текстовий формат змінної довжини, до 40 символів |
regflat | Номер квартири | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
adindex | Індекс за місцем проживання | [N,5] 5 численних символів |
adstate | Область за місцем проживання | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
adcity | Населений пункт проживання | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
adstreet | Назва вулиці | [TEXT,100] текстовий формат змінної довжини, до 100 символів |
adhome | Номер будинку | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
adflat | Номер квартири | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
apnum | № заявки | [TEXT,20] текстовий формат змінної довжини, до 20 символів |
apdate | Дата та час | YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31) |
dlcelcred* | Тип угоди (дов.17. Уточнення: для AFS UBKI використовуються значення: «5», «6», «7», «8», «31») | [N,10], числовий формат |
dlchanel | Канал продажів заявки (дов.44) | [N,10], числовий формат |
dlaask* | Сума кредиту запитана в грн | [N,15,2], числовий формат з плаваючою точкою, 2 цифри після крапки |
dlamt* | Видана сума в грн | [N,15,2], числовий формат з плаваючою точкою, 2 цифри після крапки |
wofdohod* | Щомісячний дохід (офіційний) вказаний аплікантом в грн | [N,15,2], числовий формат з плаваючою точкою, 2 цифри після крапки |
waddohod | Щомісячний дохід додатковий вказаний аплікантом в грн | [N,15,2], числовий формат з плаваючою точкою, 2 цифри після крапки |
appregion* | Регіон закладу заявки (дов.34. Уточнення: Значення, починаючи з «28», довідника не використовуються для AFS UBKI) | [N,10], числовий формат |
appdepart* | Найменування відділення закладу заявки | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
appcredman | Кредитний експерт | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
wtotstag* | Загальний трудовий стаж (у місяцях) | [N,10], числовой формат |
wcurstag* | Поточний стаж (в місяцях) | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
foto | base64(Фото) | [TEXT,~] текстовий формат змінної довжини |
</request> | ||
<update> (1) Оновлення даних за заявкою | ||
uid* | ID заявки, що отримана при першому запиті | [TEXT,50] текстовий формат змінної довжини, до 50 символів |
inn* | Ідентифікаційний номер клієнта (для фіз.осіб) | [N,10], числовий формат |
personfs | Ризик статус клієнта (дов.43) | [N,10], числовий формат |
passportfs | Ризик статус паспорту (дов.43) | [N,10], числовий формат |
spousefs | Ризик статус дружини (дов.43) | [N,10], числовий формат |
cpfs | Ризик статус к.л. (дов.43) | [N,10], числовий формат |
wfs | Ризик статус основного роботодавця (дов.43) | [N,10], числовий формат |
waddfs | Ризик статус адреси основного роботодавця. (дов.43) | [N,10], числовий формат |
wotherfs | Ризик статус додаткового роботодавця (дов.43) | [N,10], числовий формат |
wotheraddfs | Ризик статус адреси додаткового роботодавця (дов.43) | [N,10], числовий формат |
mphonefs | Ризик статус мобільного телефону (дов.43) | [N,10], числовий формат |
wphonefs | Ризик статус робочого телефону (дов.43) | [N,10], числовий формат |
wphone2fs | Ризик статус робочого телефону 2 (дов.43) | [N,10], числовий формат |
wphone3fs | Ризик статус робочого телефону 3 (дов.43) | [N,10], числовий формат |
regphonefs | Ризик статус телефону за місцем реєстрації (дов.43) | [N,10], числовий формат |
livphonefs | Ризик статус телефону за місцем проживання (дов.43) | [N,10], числовий формат |
contphonefs | Ризик статус контактної особи 1 (дов.43) | [N,10], числовий формат |
contphone2fs | Ризик статус контактної особи 2 (дов.43) | [N,10], числовий формат |
contphone3fs | Ризик статус контактної особи 3 (дов.43) | [N,10], числовий формат |
regfs | Ризик статус адреси за місцем реєстрації (дов.43) | [N,10], числовий формат |
adfs | Ризик статус адреси за місцем проживання (дов.43) | [N,10], числовий формат |
apnum* | № заявки | [TEXT,20] текстовий формат змінної довжини, до 20 символів |
apstatus* | Статус кредитної заявки (дов.45) | [N,10], числовий формат |
apdecisdate* | Дата | [YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31) |
appfs* | Ризик статус заявки (дов.43) | [N,10], числовий формат |
dlamt | Видана сума в грн | [N,15,2], числовий формат з плаваючою точкою, 2 цифри після крапки |
</afsubki> | ||
</update> |
<liveness> (1) Атрибути для звіту “Liveness detection” | ||
imgdata0 | Base64(Перше фото з серії ) | [TEXT,~] текстовий формат змінної довжини |
imgdata1 | Base64(Друге фото з серії ) | [TEXT,~] текстовий формат змінної довжини |
imgdata2 | Base64(Третє фото з серії ) | [TEXT,~] текстовий формат змінної довжини |
imgdata3 | Base64(Четверте фото з серії ) | [TEXT,~] текстовий формат змінної довжини |
imgdata4 | Base64(П'яте фото з серії ) | [TEXT,~] текстовий формат змінної довжини |
</liveness> |
<additionaldata> (1) Атрибути для звіту “Інформація про реєстрацію платника податків” (Дані із державних реєстрів тимчасово не надаються) | ||
source | Найменування джерела для перевірки (fiskregistration - реєстр платників податків, edpod - реєстр платників єдиного податку, bpartner - перевірка податкового боргу) | [TEXT,25] текстовий формат змінної довжини, до 25 символів |
</additionaldata> |
<additionaldata> (1) Атрибути для звіту “Visa Cardholder Transaction Score” | ||
pan | Кодований ідентифікатор карти (Шифрується публічним ключем VISA, що надається за запитом) | [TEXT,~] текстовий формат змінної довжини |
</additionaldata> |
<additionaldata> (1) Атрибути для звіту “Скоринг МСБ” | ||
datescore | Дата розрахунку для скоринга | [YYYY-MM-DD], YYYY - год (1920 - 2099), MM - месяц (01 - 12), DD - день (01-31) |
</additionaldata> |
<simCheck> Атрибути для звіту “Інформація про перевипуск sim-карти” | ||
phone | Телефон | [TEXT,40] текстовий формат змінної довжини, до 40 символів |
</simCheck> |
<additionaldata> Атрибути для звіту “Feature Set" | ||
date | Дата для розрахунку показників. Не заповнюється, якщо розраховується на поточний момент | [YYYY-MM-DD], YYYY - год (1920 - 2099), MM - месяц (01 - 12), DD - день (01-31) |
featlist | Перелік показників для розрахунку. Не заповнюється, якщо розраховуються усі доступні показники | [TEXT] текстовий формат змінної довжини |
</additionaldata> |
<additionaldata> Атрибути для звіту “Фінансова звітність" | ||
date | Дата для розрахунку показників. Не заповнюється, якщо розраховується на поточний момент | [YYYY-MM-DD], YYYY - год (1920 - 2099), MM - месяц (01 - 12), DD - день (01-31) |
</additionaldata> |
<photocheck> Атрибути для звіту “Фотоверифікація LIGHT" | ||
photo | Base64(Фото) вхідної заявки | [TEXT,~] ттекстовий формат змінної довжини |
photoext | Розширення до фото вхідної заявки (jpeg/jpg) | [TEXT,~] ттекстовий формат змінної довжини |
</photocheck> |
<declaration> Атрибути для пошуку документа декларацій | ||
documentId | Номер документа декларації | [N,50], числовий формат |
</photocheck> |
</i> |
</request> |
Див. у цьому розділі також