Versions Compared

Old Version 12

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version 13

changes.mady.by.user Оксана Нечепоренко

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
( ** parameters are passed optionally)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)",

"lname": "**Last name",

"fname": "**First name",

"mname": "**Middle name",

"bdate": "**Date of birth"

},

"mvd": {

"dtype": "Document type (code from ref.7)",

"pser": "Series of the required passport",

"pnom": "Number of required passport or ID-card number",

"plname": "**Surname of the required passport",

"pfname": "**Name of the required passport",

"pmname": "**Patronymic of the required passport",

"pbdate": "**Date of birth of the required passport"

},

"reqlng": "Search criteria language (code from ref.23)"

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Identity document verification online ' – 14",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

...

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-25 14:09:30.527",
					"ftm": "2022-08-25 14:09:30.619"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002459786"
			}
		},
		"comp": [
			{
				"mvd": {
					"foundsource": [
						{
							"name": "INFOTECH",
							"found": "1",
							"foundref": "Found",
							"sourcedate": "2022-10-16"
						},
						{
							"name": "UBKI",
							"found": "0",
							"foundref": "Not found",
							"sourcedate": "2022-10-16"
						}
					],
					"found": "1",
					"foundref": "Found",
					"foundtitle": "Ukrainian citizen passportPassport АМ-578072 is found in the list of invalid passports",
					"pser": "АМ",
					"pnom": "578072",
					"plname": "",
					"pfname": "",
					"pmname": "",
					"pbdate": "1989-10-05",
					"dtype": "1",
					"dtyperef": "Ukrainian citizen passport"
				},
				"id": "5",
				"descr": "Checking according to the databases of the invalid documents"
			},
			{
				"wantedmvs": {
					"found": "0",
					"foundref": "No information found",
					"bdate": "1989-10-05",
					"lng": "1",
					"lngref": "Ukrainian",
					"lname": "ГАРНА",
					"fname": "ІРІНА",
					"mname": "ВАСИЛІВНА",
					"url": "",
					"category": "",
					"articlecrim": "",
					"restraint": ""
				},
				"id": "17",
				"descr": "Search in the MIA search database"
			},
			{
				"pret": {
					"inn": "3278508288",
					"nonewdeal": "0",
					"nonewdealref": "No",
					"nonewdealcomment": "",
					"freezedate":""
				},
				"fcert": {
					"inn": "3278508288",
					"cert": "0",
					"certref": "No",
					"certid": "",
					"certurl": ""
				},
				"maybegone": {
					"inn": "3278508288",
					"vdate": "2022-12-01",
					"dldonor": "BNK"
				},
				"id": "18",
				"descr": "Alert"
			}
		]
	}
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-11-25 14:09:30.527" ftm="2022-08-25 14:09:30.619"/>
        </trace>
        <reqinfo reqid="req2#000002459786"/>
    </tech>
    <comp id="5" descr="Checking according to the databases of the invalid documents">
        <mvd found="1" foundref="Found" foundtitle="Ukrainian citizen passportPassport АМ-578072 is found in the list of invalid passports" pser="АМ" pnom="578072" plname="" pfname="" pmname="" pbdate="1989-10-05" dtype="1" dtyperef="Ukrainian citizen passport">
            <foundsource name="INFOTECH" found="1" foundref="Found" sourcedate="2022-10-16"/>
            <foundsource name="UBKI" found="0" foundref="Not found" sourcedate="2022-10-16"/>
        </mvd>
    </comp>
    <comp id="17" descr="Search in the MIA search database">
        <wantedmvs found="0" foundref="No information found" bdate="1989-10-05" lng="1" lngref="Ukrainian" lname="ГАРНА" fname="ІРІНА" mname="ВАСИЛІВНА" url="" category="" articlecrim="" restraint=""/>
    </comp>
    <comp id="18" descr="Alert">
        <pret inn="3278508288" nonewdeal="0" nonewdealref="No" nonewdealcomment="" freezedate="" />
        <fcert inn="3278508288" cert="0" certref="No" certid="" certurl="" />
        <maybegone inn="3278508288" vdate="2022-12-01" dldonor="BNK" />
    </comp>
</ubkidata>

...