Versions Compared

Key

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

...

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "РНОКПП (ІПН) (для фіз.осіб)"

},

"photocheck": {

"photo": "base64(Фото)",

"photoext": "Розширення до фото вхідної заявки (jpeg/jpg)"

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): Звіт 'Фотоверифікація LIGHT' - 43",

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

},

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

},

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

},

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

}

}

}

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Найменування кроку",

"stm": "Дата штамп старту кроку",

"ftm": "Дата штамп фінішу кроку"

}

},

"error": {

"errtype": "Код помилки(Код із дов.0)",

"errtext": "Текст помилки(Значення із дов.0)"

},

"reqinfo": {

"reqid": "Вихідний ІД запиту, згенерований УБКІ"

},

"billing": {

"balance": {

"value": "Сума балансу",

"date": "Дата",

"time": "Час"

}

}

},

"compbilldetails": [ {

"pretfreemon": {

"pretension": {

"inn": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), код (0 - Ні, 1 - Так)",

"crdealfreemonref": "Ідентифікатор угоди (референс)",

"source": "Вид оскарження (Код із дов.48)",

"sourceref": "Вид оскарження (Значення із дов.48)",

"claim": "Предмет оскарження (Код із дов.69)",

"claimref": "Предмет Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), значення (0 - Ні, 1 - Так)"

}

}

},

},

"comp": [

{

"pret": {

"pretension": {

"inn": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)",

"crdeal": "Ідентифікатор угоди (референс)",

"source": "Вид оскарження (Код із дов.48)",

"sourceref": "Вид оскарження (Значення із дов.6948)",

"vdateclaim": "Дата створення заявки" }Предмет оскарження (Код із дов.69)",

"commentckiclaimref": { "comment": ""Предмет оскарження (Значення із дов.69)",

"vdate": "Дата створення заявки"

},

"commentcki": {

"comment": "Коментар суб'єкта кредитної історії",

"vdate": "Дата створення коментаря"

},

"plost": {

"pser": "Серія паспорта, заявлено СКІ як загублений (крадіжка)",

"pnom": "Номер паспорта, заявлено СКІ як загублений (крадіжка)",

"crdate": "Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ",

"ldate": "Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ"

},

"changedeal": {

"crdeal": "Ідентифікатор угоди (референс)",

"changecode": "Код причини коригування/видалення даних (Код із дов.62)",

"changeref": "Текст причини коригування/видалення даних (Значення із дов.62)",

"vdate": "Дата коригування/видалення даних"

},

"freezedate": "Дата підключення опції FREEZE",

"nonewdealcomment": "Коментар",

"nonewdeal": "Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена",

"nonewdealref": "Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)",

"inn": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

},

"idfcert": "18",{

"descrinn": "Назва компонентиІПН" },

{

"photocheckcert": {

"resultsearch": {

"state": "Статус фіз.особи (missed- зниклий безвісти, wanted - особа, які переховуються від органів влади (в розшуку)"Ознака наявності сертифіката від УБКІ (Код із дов. 56) - 0 - ні (немає зареєстрованого сертифіката), 1 - так (є зареєстрований сертифікат) ",

"categorycertref": "Класифікація статусу фіз.особи в текстовому виглядіОзнака наявності сертифіката від УБКІ (Значення із дов. 56)",

"lnameuacertid": "Прізвище українськоюНомер сертифіката",

"fnameuacerturl": "Ім'я українською"Посилання на сертифікат"

},

"mnameuamaybegone": "По батькові українською",{

"lnameruinn": "Прізвище російськоюРНОКПП (ІПН) (для фіз. осіб)",

"fnameruvdate": "Ім'я російськоюДата? на яку передана інформація",

"mnamerudldonor": "По батькові російською"Донор інформації (Значення із дов.54)"

},

"bdateid": "Дата народження18",

"lostdatedescr": "Дата зникненняНазва компоненти"

},

{

"lostplacephotocheck": {

"Місце зникненняresultsearch",: {

"restraintstate": "Запобіжний західСтатус фіз.особи (missed- зниклий безвісти, wanted - особа, які переховуються від органів влади (в розшуку))",

"contactcategory": "Контакти для інформуванняКласифікація статусу фіз.особи в текстовому вигляді",

"confidencelnameua": "Міра схожості осіб при порівнянні з фото з бази зниклих безвістиПрізвище українською",

"fotofnameua": "base64 (Фото) фотографія особи з бази зниклих безвістиІм'я українською",

"fotoextmnameua": "Розширення до фото особи з бази зниклих безвісти" }По батькові українською",

"okpolnameru": "РНОКПП(ІПН) (для фіз.осіб)Прізвище російською",

"bdfdfnameru": "Ознака перевірки по БД фото скомпрометованих осіб (Код із дов.47)Ім'я російською",

"commentfdmnameru": "Коментар за результатами порівнянняПо батькові російською",

"confidencefdbdate": "Міра схожості осіб при порівнянні з фото скомпрометованої особиДата народження",

"verifclientlostdate": "Ознака збігу фото (Код із дов.47)Дата зникнення",

"commentvclostplace": "Коментар за результатами порівняння з еталонною фотографієюМісце зникнення",

"confidencevcrestraint": "Міра схожості осіб на фотографіях клієнтів" }Запобіжний захід",

"idcontact": "65Контакти для інформування",

"descrconfidence": "Назва компоненти"

},

{

"person": {

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

"lngref": "Мова надання блоку (Значення із дов.23Міра схожості осіб при порівнянні з фото з бази зниклих безвісти",

"foto": "base64 (Фото) фотографія особи з бази зниклих безвісти",

"fotoext": "Розширення до фото особи з бази зниклих безвісти"

},

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

"lngbdfd": "Мова надання блоку Ознака перевірки по БД фото скомпрометованих осіб (Код із дов.2347)",

"mnamecommentfd": "По батьковіКоментар за результатами порівняння",

"fnameconfidencefd": "Ім'яМіра схожості осіб при порівнянні з фото скомпрометованої особи",

"lnameverifclient": "ПрізвищеОзнака збігу фото (Код із дов.47)",

"inn commentvc": "РНОКПП (ІПН) СКІКоментар за результатами порівняння з еталонною фотографією",

"confidencevc": "Міра схожості осіб на фотографіях клієнтів"

},

"id": "7265",

"descr": "Пошук по ПІБ+ДР при результаті більше 1 особи (Наявність компоненти визначається знаходженням більше 1 людини у разі пошуку за ПІБ+ДР)Назва компоненти"

},

]

}

}

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="Код шаблону

{

"person": {

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

"lngref": "Мова надання блоку (Значення із дов.23)",

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

49): Звіт 'Фотоверифікація LIGHT' - 43" reqreason="Мета подання запиту (Код із дов.24)"><!-- Параметри, що описують критерії пошуку-->

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

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

<ident okpo="РНОКПП (ІПН) (для фіз.осіб)" />

<!-- Параметри для фотоверифікації-->

<photocheck photo="base64(Фото)"

photoext="Розширення до фото вхідної заявки (jpeg/jpg)" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response

23)",

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

"fname": "Ім'я",

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

"inn ": "РНОКПП (ІПН) СКІ",

},

"id": "72",

"descr": "Пошук по ПІБ+ДР при результаті більше 1 особи (Наявність компоненти визначається знаходженням більше 1 людини у разі пошуку за ПІБ+ДР)"

}

]

}

}

Request XML

Expand
title body:

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

<ubkidata>

<!-- Блок системної інформації -->

<tech>

<trace>

<step name="Найменування кроку" stm="Дата штамп старту кроку" ftm="Дата штамп фінішу кроку"

<doc>

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

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

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

<!--

Блок trace містить метрики таймінгу кроків формування компонентів <error errtype="Код помилки

Параметри запиту -->

</step>

</trace>

<request version="1.0" reqtype="Код шаблону (Код із дов.

0)" errtext="Текст помилки (Значення

49): Звіт 'Фотоверифікація LIGHT' - 43" reqreason="Мета подання запиту (Код із дов.

0

24)">

<

/error> <reqinfo reqid="Вихідний ІД запиту, згенерований УБКІ

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

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

<

/reqinfo> <

!--

Блок інформації щодо поточного стану рахунку припейд <balance value="Сума балансу" date="Дата" time="Час

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

<billing>

<ident okpo="РНОКПП (ІПН) (для фіз.осіб)" />

<

/billing>

</tech>

<

!--

Попередження

Параметри для фотоверифікації-->

<comp id

<photocheck photo="

18" descr="Назва компоненти">

<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"

nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"

nonewdealcomment="Коментар"

freezedate="Дата підключення опції FREEZE"

base64(Фото)"

photoext="Розширення до фото вхідної заявки (jpeg/jpg)" />

</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="Час" />

<billdetails freemon="Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), код (0 - Ні, 1 - Так)"

freemonref="Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), значення (0 - Ні, 1 - Так)"/>

</billing>

</tech>

<!-- Попередження -->

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

<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"

nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"

nonewdealcomment="Коментар"

freezedate="Дата підключення опції FREEZE"

inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)">

<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

crdeal="Ідентифікатор угоди (референс)"

source="Вид оскарження (Код із дов.48)"

sourceref="Вид оскарження (Значення із дов.48)"

claim="Предмет оскарження (Код із дов.69)"

claimref="Предмет оскарження (Значення із дов.69)"

vdate="Дата створення заявки" />

<commentcki comment="Коментар суб'єкта кредитної історії"

vdate="Дата створення коментаря" />

<plost pser="Серія паспорта, заявлено СКІ як загублений (крадіжка)"

pnom="Номер паспорта, заявлено СКІ як загублений (крадіжка)"

crdate="Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ"

ldate="Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ" />

<changedeal crdeal="Ідентифікатор угоди (референс)"

changecode="Код причини коригування/видалення даних (Код із дов.62)"

changeref="Текст причини коригування/видалення даних (Значення із дов.62)"

vdate="Дата коригування/видалення даних" />

</pret>

<fcert inn="РНОКПП (ІПН) (для фіз. осіб)/ЄДРПОУ (для юр.осіб)">

<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

crdeal="Ідентифікатор угоди (референс)"

source="Вид оскарження (Код із дов.48)"

sourceref="Вид оскарження (Значення із дов.48)"

claim="Предмет оскарження (Код із дов.69)"

claimref="Предмет оскарження (Значення із дов.69)"

vdate="Дата створення заявки" />

<commentcki comment="Коментар суб'єкта кредитної історії"

vdate="Дата створення коментаря" />

<plost pser="Серія паспорта, заявлено СКІ як загублений (крадіжка)"

pnom="Номер паспорта, заявлено СКІ як загублений (крадіжка)"

crdate="Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ"

ldate="Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ" />

<changedeal crdeal="Ідентифікатор угоди (референс)"

changecode="Код причини коригування/видалення даних (Код із дов.62)"

changeref="Текст причини коригування/видалення даних (Значення із дов.62)"

vdate="Дата коригування/видалення даних" />

</pret>

</comp>

<!-- Блок "фотоверифікації LIGHT" -->

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

<photocheck okpo="РНОКПП(ІПН) (для фіз.осіб)"

bdfd="Ознака перевірки по БД фото скомпрометованих осіб (Код із дов.47)"

commentfd="Коментар за результатами порівняння"

confidencefd="Міра схожості осіб при порівнянні з фото скомпрометованої особи"

verifclient="Ознака збігу фото (Код із дов.47)"

commentvc="Коментар за результатами порівняння з еталонною фотографією"

confidencevc="Міра схожості осіб на фотографіях клієнтів">

<!-- Блок "Пошук в базі зниклих безвісти і осіб, та тих, які переховуються від органів влади" -->

<resultsearch state="Статус фіз.особи (missed- зниклий безвісти, wanted - особа, які переховуються від органів влади (в розшуку))"

category="Класифікація статусу фіз.особи в текстовому вигляді"

lnameua="Прізвище українською"

fnameua="Ім'я українською"

mnameua="По батькові українською"

lnameru="Прізвище російською"

fnameru="Ім'я російською"

mnameru="По батькові російською"

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

lostdate="Дата зникнення"

lostplace="Місце зникнення"

restraint="Запобіжний захід"

contact="Контакти для інформування"

confidence="Міра схожості осіб при порівнянні з фото з бази зниклих безвісти"

foto="base64 (Фото) фотографія особи з бази зниклих безвісти"

fotoext="Розширення до фото особи з бази зниклих безвісти" />

</photocheck>

</comp>

<!-- Пошук по ПІБ+ДР при результаті більше 1 особи (Наявність компоненти визначається знаходженням більше 1 людини у разі пошуку за ПІБ+ДР)-->

<comp id="72" descr="Пошук по ПІБ+ДР при результаті більше 1 особи">

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

lngref="Мова надання блоку (Значення із дов.23)"

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

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

fname="Ім'я"

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

inn="РНОКПП (ІПН) СКІ" />

</comp>

</ubkidata>

Приклад

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "3278508288"
							},
							"photocheck": {
								"photo": "/9j/4AAQSkZJRgABAQEASABI",
								"photoext": "jpg"
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "43",
						"reqreason": "2"
					},
					"descr": "Об'єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "7BD7E136E3BF470EAA2CFE2E000000ED"
		}
	}
}

Response JSON

Code Block{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report

"

cert="Ознака наявності сертифіката від УБКІ (Код із дов. 56) - 0 - ні (немає зареєстрованого сертифіката), 1 - так (є зареєстрований сертифікат) "

certref="Ознака наявності сертифіката від УБКІ (Значення із дов. 56)"

certid="Номер сертифіката"

certurl="Посилання на сертифікат" />

<maybegone inn="РНОКПП (ІПН) (для фіз. осіб)"

vdate="Дата, на яку передана інформація"

dldonor="Донор інформації (Значення із дов.54)"/>

</comp>

<!-- Блок "фотоверифікації LIGHT" -->

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

<photocheck okpo="РНОКПП(ІПН) (для фіз.осіб)"

bdfd="Ознака перевірки по БД фото скомпрометованих осіб (Код із дов.47)"

commentfd="Коментар за результатами порівняння"

confidencefd="Міра схожості осіб при порівнянні з фото скомпрометованої особи"

verifclient="Ознака збігу фото (Код із дов.47)"

commentvc="Коментар за результатами порівняння з еталонною фотографією"

confidencevc="Міра схожості осіб на фотографіях клієнтів">

<!-- Блок "Пошук в базі зниклих безвісти і осіб, та тих, які переховуються від органів влади" -->

<resultsearch state="Статус фіз.особи (missed- зниклий безвісти, wanted - особа, які переховуються від органів влади (в розшуку))"

category="Класифікація статусу фіз.особи в текстовому вигляді"

lnameua="Прізвище українською"

fnameua="Ім'я українською"

mnameua="По батькові українською"

lnameru="Прізвище російською"

fnameru="Ім'я російською"

mnameru="По батькові російською"

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

lostdate="Дата зникнення"

lostplace="Місце зникнення"

restraint="Запобіжний захід"

contact="Контакти для інформування"

confidence="Міра схожості осіб при порівнянні з фото з бази зниклих безвісти"

foto="base64 (Фото) фотографія особи з бази зниклих безвісти"

fotoext="Розширення до фото особи з бази зниклих безвісти" />

</photocheck>

</comp>

<!-- Пошук по ПІБ+ДР при результаті більше 1 особи (Наявність компоненти визначається знаходженням більше 1 людини у разі пошуку за ПІБ+ДР)-->

<comp id="72" descr="Пошук по ПІБ+ДР при результаті більше 1 особи">

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

lngref="Мова надання блоку (Значення із дов.23)"

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

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

fname="Ім'я"

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

inn="РНОКПП (ІПН) СКІ" />

</comp>

</ubkidata>

Приклад

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "3278508288"
							},
							"photocheck": {
								"photo": "/9j/4AAQSkZJRgABAQEASABI",
								"photoext": "jpg"
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "43",
						"reqreason": "2"
					},
					"descr": "Об'єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "7BD7E136E3BF470EAA2CFE2E000000ED"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-01-09 21:52:29.631",
					"ftm": "2022-01-09 21:52:29.699"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002008590"
			}
		},
		"comp": [
			{
				"pret": {
					"inn": "3278508288",
					"nonewdeal": "0",
					"stmnonewdealref": "2022-01-09 21:52:29.631Ні",
					"ftmnonewdealcomment": "2022-01-09 21:52:29.699"",
				}
	"freezedate":""
				},
				"reqinfofcert": {
					"reqidinn": "req2#0000020085903278508288",
			}
		}"cert": "0",
					"compcertref": [
			{
"Ні",
					"pretcertid": {"",
					"inncerturl": "3278508288"
				},
					"nonewdealmaybegone": "0",{
					"nonewdealrefinn": "Ні3278508288",
					"nonewdealcommentvdate": "2022-12-01",
					"freezedatedldonor": "BNK"
				},
				"id": "18",
				"descr": "Попередження"
			},
			{
				"photocheck": {
					"okpo": "3278508288",
					"bdfd": "1",
					"commentfd": "Підозра по фото підтверджується",
					"confidencefd": "0.73668",
					"verifclient": "2",
					"commentvc": "Підозра по фото не підтверджується",
					"confidencevc": "0.90923"
				},
				"id": "65",
				"descr": "Фотоверифікація LIGHT"
			}
		]
	}
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-01-09 21:52:29.631" ftm="2022-01-09 21:52:29.699" />
    </trace>
    <reqinfo reqid="req2#000002008590" />
  </tech>
  <comp id="18" descr="Попередження">
    <pret inn="3278508288" nonewdeal="0" nonewdealref="Ні" nonewdealcomment="" freezedate="" />
    <fcert inn="3278508288" cert="0" certref="Ні" certid="" certurl="" />
    <maybegone inn="3278508288" vdate="2022-12-01" dldonor="BNK" />
  </comp>
  <comp id="65" descr="Фотоверифікація LIGHT">
    <photocheck okpo="3278508288" bdfd="1" commentfd="Підозра по фото підтверджується" confidencefd="0.73668" verifclient="2" commentvc="Підозра по фото не підтверджується" confidencevc="0.90923" />
  </comp>
</ubkidata>

...