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": "РНОКПП (ІПН) фізособи",

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

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

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

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

},

"mvd": {

"dtype": "Тип розшукуваного документа (Код із дов.7)",

"pser": "Серія розшукуваного паспорта",

"pnom": "Номер розшукуваного паспорта або номер ID-картки",

"plname": "**Прізвище власника розшукуваного паспорта",

"pfname": "**Ім'я власника розшукуваного паспорта",

"pmname": "**По батькові власника розшукуваного паспорта",

"pbdate": "**Дата народження власника розшукуваного паспорта"

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Перевірка посвідчення особи' - 13",

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

},

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

},

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

},

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

}

}

}

Request XML
( ** параметри передаються опціонально)

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

</billing>

</tech>

<!-- Пошук анульованих документів -->

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

<mvd found="Знайдений? (Код із дов.27)"

foundref="Знайдений? (Значение із дов.27)"

foundtitle="Опис результату пошуку"

pser="Серія розшукуваного паспорта"

pnom="Номер розшукуваного паспорта або номер ID-картки"

plname="Прізвище власника розшукуваного паспорта"

pfname="Ім'я власника розшукуваного паспорта"

pmname="По батькові власника розшукуваного паспорта"

pbdate="Дата народження власника розшукуваного паспорта"

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

dtyperef="Паспорт (Значение із дов.7)"

status="Причина анулювання (Тільки для даних із DATA.GOV.UA)"

stdate="Дата анулювання (Тільки для даних із DATA.GOV.UA)">

<foundsource name="Джерело даних для перевірки (Код із дов.63)"

found="0/1 - цифрове позначення наявності недійсного паспорту (Код із дов.27)"

foundref="Текстове позначення наявності недійсного паспорту (Значення із дов.27)"

sourcedate="Дата оновлення інформації у БД чи отримання відповіді від АПІ першоджерла." />

<!--Даний блок повинен складатись з 1 .. * елементів-->

</mvd>

</comp>

<!-- Блок пошуку розшукуваних в базі МВС-->

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

<wantedmvs found="0-не знайдений, 1-знайдено"

foundref="не знайдений/знайдений"

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

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

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

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

fname="Ім'я"

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

url="Посилання на анкету МВС"

category="Категорія"

articlecrim="Стаття звинувачення"

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

</comp>

<!-- Попередження від СКІ -->

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</pret>

</comp>

</ubkidata>

Приклад

Request JSON

Code Block{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident

Response JSON

Expand
titlebody:

{

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

<doc>

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

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

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

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

<request version="1.0" reqtype="Код шаблону (Код із дов.49): 'Перевірка посвідчення особи' - 13" reqreason="Мета надання запиту (Код із дов.24)">

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

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

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

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

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

fname="**Ім'я"

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

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

<!-- Для запитів пошуку анульованих документів -->

<mvd dtype="Тип розшукуваного документа (Код із дов.7)"

pser="Серія розшукуваного паспорта"

pnom="Номер розшукуваного паспорта або номер ID-картки"

plname="**Прізвище власника розшукуваного паспорта"

pfname="**Ім'я власника розшукуваного паспорта"

pmname="**По батькові власника розшукуваного паспорта"

pbdate="**Дата народження власника розшукуваного паспорта" >

</mvd>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

"ubkidata": {

"tech": {

"trace": {

"step": {

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

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

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

}

},

"error": {

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

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

},

"reqinfo": {

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

},

"billing": {

"balance": {

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

"date": "Дата",

"time": "Час"

}

}

},

"comp": [

{

"mvd": {

"foundsource": {

"name": "Джерело даних для перевірки (Код із дов.63)",

"found": "0/1 - цифрове позначення наявності недійсного паспорту (Код із дов.27)",

"foundref": "Текстове позначення наявності недійсного паспорту (Значення із дов.27)",

"sourcedate": "Дата оновлення інформації у БД чи отримання відповіді від АПІ першоджерла."

},

"found": "Знайдений? (Код із дов.27)",

"foundref": "Знайдений? (Значение із дов.27)",

"foundtitle": "Опис результату пошуку",

"pser": "Серія розшукуваного паспорта",

"pnom": "Номер розшукуваного паспорта або номер ID-картки",

"plname": "Прізвище власника розшукуваного паспорта",

"pfname": "Ім'я власника розшукуваного паспорта",

"pmname": "По батькові власника розшукуваного паспорта",

"pbdate": "Дата народження власника розшукуваного паспорта",

"dtype": "Тип документа (Код із дов.7)",

"dtyperef": "Паспорт (Значение із дов.7)",

"status": "Причина анулювання (Тільки для даних із http://DATA.GOV.UA )",

"stdate": "Дата анулювання (Тільки для даних із http://DATA.GOV.UA )"

},

"id": "5",

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

},

{

"wantedmvs": {

"found": "0-не знайдений, 1-знайдено",

"foundref": "не знайдений/знайдений",

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

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

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

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

"fname": "Ім'я",

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

"url": "Посилання на анкету МВС",

"category": "Категорія",

"articlecrim": "Стаття звинувачення",

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

},

"id": "17",

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

},

{

"pret": {

"pretension": {

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

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

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

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

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

},

"commentcki": {

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

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

},

"plost": {

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

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

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

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

},

"changedeal": {

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

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

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

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

},

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

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

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

},

"id": "18",

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

}

]

}

}

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): 'Перевірка посвідчення особи' - 13" reqreason="Мета надання запиту (Код із дов.24)">

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

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

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

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

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

fname="**Ім'я"

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

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

<!-- Для запитів пошуку анульованих документів -->

<mvd dtype="Тип розшукуваного документа (Код із дов.7)"

pser="Серія розшукуваного паспорта"

pnom="Номер розшукуваного паспорта або номер ID-картки"

plname="**Прізвище власника розшукуваного паспорта"

pfname="**Ім'я власника розшукуваного паспорта"

pmname="**По батькові власника розшукуваного паспорта"

pbdate="**Дата народження власника розшукуваного паспорта" >

</mvd>

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

</billing>

</tech>

<!-- Пошук анульованих документів -->

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

<mvd found="Знайдений? (Код із дов.27)"

foundref="Знайдений? (Значение із дов.27)"

foundtitle="Опис результату пошуку"

pser="Серія розшукуваного паспорта"

pnom="Номер розшукуваного паспорта або номер ID-картки"

plname="Прізвище власника розшукуваного паспорта"

pfname="Ім'я власника розшукуваного паспорта"

pmname="По батькові власника розшукуваного паспорта"

pbdate="Дата народження власника розшукуваного паспорта"

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

dtyperef="Паспорт (Значение із дов.7)"

status="Причина анулювання (Тільки для даних із DATA.GOV.UA)"

stdate="Дата анулювання (Тільки для даних із DATA.GOV.UA)">

<foundsource name="Джерело даних для перевірки (Код із дов.63)"

found="0/1 - цифрове позначення наявності недійсного паспорту (Код із дов.27)"

foundref="Текстове позначення наявності недійсного паспорту (Значення із дов.27)"

sourcedate="Дата оновлення інформації у БД чи отримання відповіді від АПІ першоджерла." />

<!--Даний блок повинен складатись з 1 .. * елементів-->

</mvd>

</comp>

<!-- Блок пошуку розшукуваних в базі МВС-->

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

<wantedmvs found="0-не знайдений, 1-знайдено"

foundref="не знайдений/знайдений"

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

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

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

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

fname="Ім'я"

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

url="Посилання на анкету МВС"

category="Категорія"

articlecrim="Стаття звинувачення"

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

</comp>

<!-- Попередження від СКІ -->

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</pret>

</comp>

</ubkidata>

Приклад

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"bdate": "1989-10-05",
								"mname": "ВАСИЛІВНА",
								"fname": "ІРІНА",
								"lname": "ГАРНА",
								"okpo": "3278508288"
							},
							"mvd": {
								"dtype": "1",
								"pser": "АМ",
								"pnom": "578072",
								"plname": "ГАРНА",
								"pfname": "ІРІНА",
								"pmname": "ВАСИЛІВНА",
								"pbdate": "1989-10-05"
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "13",
						"reqreason": "2"
					},
					"descr": "Об'єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "7BD7E136E3BF470EAA2CFE2E8000000D"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-09 19:31:09.087",
					"ftm": "2022-01-09 19:31:09.143"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002007904"
			}
		},
		"comp": [
			{
				"mvd": {
					"foundsource": [
						{
							"name": "UBKI",
							"found": "0",
							"foundref": "Не знайдений",
							"sourcedate": "2022-10-16"
						},
						{
							"name": "MVS",
							"found": "1",
							"foundref": "Знайдений",
							"sourcedate": "2022-10-16"
						},
						{
							"name": "DMS",
							"found": "0",
							"foundref": "Не знайдений",
							"sourcedate": "2022-10-16"
						}
					],
					"found": "1",
					"foundref": "Знайдений",
					"foundtitle": "Паспорт АМ-578072 знайдено в списку недійсних паспортів.",
					"pser": "АМ",
					"pnom": "578072",
					"plname": "ГАРНА",
					"pfname": "ІРІНА",
					"pmname": "ВАСИЛІВНА",
					"pbdate": "1989-10-05",
					"dtype": "1",
					"dtyperef": "Паспорт"
				},
				"id": "5",
				"descr": "Пошук анульованих документів"
			},
			{
				"wantedmvs": {
					
"
bdate
found": "
1989-10-05
0",
					
"
mname
foundref": "
ВАСИЛІВНА
Інформація не знайдена",
					
"
fname
bdate": "
ІРІНА
1989-10-05",
					
"
lname
lng": "
ГАРНА
2",
					
"
okpo
lngref": "
3278508288" }
Русский",
					
"
mvd
lname": 
{
"ГАРНА",
					
"
dtype
fname": "
1
ІРІНА",
					"
pser
mname": "
АМ
ВАСИЛІВНА",
					
"
pnom
url": "
578072
",
					
"
plname
category": "
ГАРНА
",
					
"
pfname
articlecrim": "
ІРІНА
",
					"
pmname
restraint": "
ВАСИЛІВНА
"
,

				},
				"
pbdate
id": "
1989-10-05
17",
				
"descr": "Пошук у розшуковій базі даних МВС"
			},
			{
				"
reqlng
pret": 
"1"
{
					
}
"inn": "3278508288",
					
"
version
nonewdeal": "
1.
0",
					"
reqtype
nonewdealref": "
13
Ні",
					"
reqreason
nonewdealcomment": "
2
"
				},
				"
descr
id": "
Об'єкт запиту" }
18",
				"descr": "
Конверт
Попередження від 
запиту
СКІ"
			}
,

		
"sessid": "7BD7E136E3BF470EAA2CFE2E8000000D" }
]
	}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="7BD7E136E3BF470EAA2CFE2E8000000D">
    <req_envelope descr="Конверт запиту">
      <req_xml descr="Об'єкт запиту">
        <request version="1.0" reqtype="13" reqreason="2">
          <i reqlng="1">
            <ident bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" />
            <mvd dtype="1" pser="АМ" pnom="578072" plname="ГАРНА" pfname="ІРІНА" pmname="ВАСИЛІВНА" pbdate="1989-10-05" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

...