Versions Compared

Version Old Version 7 New Version Current
Changes made by

Оксана Нечепоренко

Оксана Нечепоренко

Saved on

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/xml

Request JSON

( ** параметри передаються опціонально)
Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

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

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

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

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

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

},

"liveness": {

"imgdata0": "Перше фото із серії в base64",

"imgdata1": "Друге фото із серії в base64",

"imgdata2": "Третє фото із серії в base64",

"imgdata3": "Четверте фото із серії в base64",

"imgdata4": "П'яте фото із серії в base64"

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Liveness detection' - 35",

"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": {

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

"lnamefreemonref": "Прізвище із запиту",

"fname": "Ім'я із запиту",

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

}

}

},

"comp": {

"liveness": {

"inn": "РНОКПП (ІПН) із запиту",

"bdatelname": "Дата народження Прізвище із запиту",

"probabilityspooffname": "Ім'я із запиту",

"mname": "По батькові із запиту",

"bdate": "Дата народження із запиту",

"probabilityspoof": "Імовірність шахрайства з фото"

},

"id": "47",

"descr": "Liveness detection"

},

{

"person": {

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

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

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

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

"fname": "Ім'я",

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

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

},

"id": "72",

"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="Код шаблону (Код із дов.49): 'Liveness detection' - 35" reqreason="Мета надання запиту (Код із дов.24)">

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

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

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

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

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

fname="**Ім'я"

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

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

<!-- Параметри пошуку по визначенню реальності -->

<liveness imgdata0="Перше фото із серії в base64"

imgdata1="Друге фото із серії в base64"

imgdata2="Третє фото із серії в base64"

imgdata3="Четверте фото із серії в base64"

imgdata4="П'яте фото із серії в base64" />

</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="47" descr="Liveness detection">

<liveness inn="РНОКПП (ІПН) із запиту"

lname="Прізвище із запиту"

fname="Ім'я із запиту"

mname="По батькові із запиту"

bdate="Дата народження із запиту"

probabilityspoof="Імовірність шахрайства з фото" />

</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": {
								"bdate": "1957-10-19",
								"mname": "ІГОРЕВНА",
								"fname": "АННА",
								"lname": "РИБАЧКА",
								"okpo": "2111118724"
							},
							"liveness": {
								"imgdata0": "Фото в base64",
								"imgdata1": "Фото в base64",
								"imgdata2": "Фото в base64",
								"imgdata3": "Фото в base64",
								"imgdata4": "Фото в base64"
							},
							"reqlng": "2"
						},
						"version": "1.0",
						"reqtype": "35",
						"reqreason": "2"
					},
					"descr": "Об`єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "4EC8D647B0DB4D9A862CDC25AB00000F"
		}
	}
}

...