...
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON |
Expand | ||
---|---|---|
| ||
{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "okpo": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)", "lname": "**Прізвище", "fname": "**Ім'я", "mname": "**По батькові", "bdate": "**Дата народження" }, "fotoverif": { "freqtype": "Тип запиту", "inn": "РНОКПП (ІПН)", "facelogic": "Тип алгоритму пошуку особи", "foto": "base64(Фото)", "fotoext": "Розширення до фото вхідної заявки (jpeg)", "phone": "Телефон для порівняння" }, "reqlng": "Мова критеріїв пошуку (Код із дов.23)" }, "version": "1.0", "reqtype": "Код шаблону (Код із дов.49): Звіт 'Фотоверифікація' - 17", "reqreason": "Мета подання запиту (Код із дов.24)" }, "descr": "Об'єкт запиту" }, "descr": "Конверт запиту" }, "sessid": "Сесійний ключ (отримуємо із API авторизації)" } } } |
Response JSON
|
Request XML
( ** параметри передаються опціонально)
title | body: |
---|
<?xml version="1.0" encoding="utf-8"?>
<doc>
<ubki sessid="Сесійний ключ (отримуємо із API авторизації)">
<req_envelope descr="Конверт запиту">
<req_xml descr="Об'єкт запиту">
<!-- Параметри запиту -->
<request version="1.0" reqtype="Код шаблону
|
<i reqlng="Мова критеріїв пошуку (Код із дов.23)">
<!-- Параметри ідентифікації суб'єкта--><ident okpo="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"
lname="**Прізвище"
fname="**Ім'я"
mname="**По батькові"
bdate="**Дата народження">
</ident>
<!-- Параметри для фотоверифікації -->
<fotoverif freqtype="Тип запиту"
inn="РНОКПП (ІПН)"
facelogic="Тип алгоритму пошуку особи"
foto="base64(Фото)"
fotoext="Розширення до фото вхідної заявки (jpeg)"
phone="Телефон для порівняння" />
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc>
Response XML
title | body: |
---|
<?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="16" descr="Назва компоненти">
<fotoverif freqtype="Тип запиту (1 - у своїй базі фото, 2 - в базі фото інших банків, 3 - порівняння двох осіб на фото, 4 - зарезервовано, 5 - в базі фото скомпрометованих осіб, 6 - порівняння з фото з документа, 7 - порівняння двох облич на одному фото, наприклад, особа з паспорта і обличчя людини, що тримає паспорт)"
bdfd="Ознака перевірки по БД фото скомпрометованих осіб (Код із дов.47)"
fotofd="base64 (Фото) фотографія скомпрометованої особи" fotoextfd="Розширення до фото скомпрометованої особи"
commentfd="Коментар за результатами порівняння"
verifclient="Ознака збігу фото (Код із дов.47)"
fotovc="base64 (Фото) еталонної фотографії"
fotoextvc="Розширення до фото еталонної фотографії"
commentvc="Коментар за результатами порівняння з еталонною фотографією"
confidencefd="Міра схожості осіб при порівнянні з фото скомпрометованої особи"
confidencevc="Міра схожості осіб на фотографіях клієнтів"
datefotovc="Дата еталонної фотографії"
phonematch="Результат звірки телефонів"
phonematchref="Результат звірки телефонів в текстовому вигляді">
<!-- Блок "Пошук в Реєстрі заявочних фото" --><grey inn="РНОКПП (ІПН), за яким спрацював реєстр запитів"
foto="base64 (Фото) фотографія особи з реєстру запитів"
fotoext="Розширення до фото особи з реєстру запитів"
datefoto="Дата фотографії з реєстру запитів"
confidence="Міра схожості осіб при порівнянні з фото з реєстру запитів"
algsearch="Тип пошуку (1 - по заданому РНОКПП (ІПН), 2 - по заданій фотографії)"
algsearchdescr="Тип пошуку в текстовому вигляді" />
<!-- Блок "Пошук в базі зниклих безвісти і осіб, та тих, які переховуються від органів влади" -->
<resultsearch state="Статус фіз.особи (missed- зниклий безвісти, wanted - особа, які переховуються від органів влади (в розшуку))"
category="Класифікація статусу фіз.особи в текстовому вигляді"
lnameua="Прізвище українською"
fnameua="Ім'я українською"
mnameua="По батькові українською"
lnameru="Прізвище російською"
fnameru="Ім'я російською"
mnameru="По батькові російською"
bdate="Дата народження"
lostdate="Дата зникнення"
lostplace="Місце зникнення"
restraint="Запобіжний захід"
contact="Контакти для інформування"
confidence="Міра схожості осіб при порівнянні з фото з бази зниклих безвісти
|
Request XML |
Expand | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <doc> <ubki sessid="Сесійний ключ (отримуємо із API авторизації)"> <req_envelope descr="Конверт запиту"> <req_xml descr="Об'єкт запиту"> <!-- Параметри запиту --> <request version="1.0" reqtype="Код шаблону (Код із дов.49): Звіт 'Фотоверифікація' - 17" reqreason="Мета подання запиту (Код із дов.24)"> <!-- Параметри, що описують критерії пошуку--> <i reqlng="Мова критеріїв пошуку (Код із дов.23)"> <!-- Параметри ідентифікації суб'єкта--> <ident okpo="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)" lname="**Прізвище" fname="**Ім'я" mname="**По батькові" bdate="**Дата народження"> </ident> <!-- Параметри для фотоверифікації --> <fotoverif freqtype="Тип запиту" inn="РНОКПП (ІПН)" facelogic="Тип алгоритму пошуку особи" foto="base64(Фото)" fotoext="Розширення до фото вхідної заявки (jpeg)" phone="Телефон для порівняння" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
freqtype
Опис
Звірка лише вхідних фото, без підключення внутрішніх баз
База еталонних фото кредиторів
База шахраїв
Реєстр заявочних фото
Зниклі безвісти
Особи в розшуку
У своїй базі фото
1
Перевірка вхідної фотографії з власною фотографією, яка раніше передавалась в бюро
-
-
-
-
-
-
В базі фото інших банків
2
Вхідне фото звіряється з історичними фотографіями всіх організацій-донорів, крім власної
-
+
+
+
+
+
Порівняння двох осіб на фото
3
На вхід передається дві фотографії. Особа на першому фото порівнюється з особою на другому фото, у запиті потрібно відправляти додаткові параметри для другої фотографії fotodocext="розширення до фото", fotodoc ="фото в бейс64"
+
-
-
-
-
-
В базі фото скомпрометованих осіб
5
Обличчя на вхідному фото звіряється тільки з базою шахраїв.
-
-
+
-
-
-
Порівняння з фото з документа
6
На вхід передається лише фото документа без особи самого клієнта. Звірка йде з історичними фотографіями всіх організацій-донорів фото.
-
+
+
+
+
+
Порівняння двох облич на одному фото
7
На вхід передається одне фото із двома особами (наприклад, клієнт тримає паспорт у руках). Відбувається звірка цих двох осіб.
+
-
-
-
-
-
Приклад
Request JSON
|
freqtype | Опис | Звірка лише вхідних фото, без підключення внутрішніх баз | База еталонних фото кредиторів | База шахраїв | Реєстр заявочних фото | Зниклі безвісти | Особи в розшуку | |
---|---|---|---|---|---|---|---|---|
У своїй базі фото | 1 | Перевірка вхідної фотографії з власною фотографією, яка раніше передавалась в бюро | - | - | - | - | - | - |
В базі фото інших банків | 2 | Вхідне фото звіряється з історичними фотографіями всіх організацій-донорів, крім власної | - | + | + | + | + | + |
Порівняння двох осіб на фото | 3 | На вхід передається дві фотографії. Особа на першому фото порівнюється з особою на другому фото, у запиті потрібно відправляти додаткові параметри для другої фотографії fotodocext="розширення до фото", fotodoc ="фото в бейс64" | + | - | - | - | - | - |
В базі фото скомпрометованих осіб | 5 | Обличчя на вхідному фото звіряється тільки з базою шахраїв. | - | - | + | - | - | - |
Порівняння з фото з документа | 6 | На вхід передається лише фото документа без особи самого клієнта. Звірка йде з історичними фотографіями всіх організацій-донорів фото. | - | + | + | + | + | + |
Порівняння двох облич на одному фото | 7 | На вхід передається одне фото із двома особами (наприклад, клієнт тримає паспорт у руках). Відбувається звірка цих двох осіб. | + | - | - | - | - | - |
Приклад |
---|
Request JSON |
|
Response JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Response JSON |
|
...
Response XML |
|
XSD Schema request | https://secure.ubki.ua/b2/js/xsd/request17.xsd |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response17.xsd |
...