Versions Compared

Version Old Version 3 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
( ** the parameters are transferred optionally)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"nameverif": {

"phone": "Contact value",

"lname": "Last name",

"fname": "First name",

"mname": "**Middle name"

},

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

},

"version": "1.0",

"reqtype": "Template code (Code from the ref.49): 'Identification by phone and full name' - 52",

"reqreason": "Purpose of the request (Code from the ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (we receive it from the API authorization)"

}

}

}

...

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-07 14:27:05.229",
					"ftm": "2022-10-07 14:27:05.715"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002481742"
			}
		},
		"comp": [
			{
				"cki": {
					"ident": [
						{
							"cchild": "",
							"sstateref": "",
							"sstate": "",
							"spdref": "natural person",
							"spd": "1",
							"cgragref": "Ukraine",
							"cgrag": "804",
							"ceducref": "",
							"ceduc": "",
							"familyref": "",
							"family": "",
							"csexref": "woman",
							"csex": "2",
							"bdate": "1989-10-05",
							"mname": "ВАСИЛІВНА",
							"fname": "ІРІНА",
							"lname": "ГАРНА",
							"inn": "3278508288",
							"lngref": "Ukrainian",
							"lng": "1",
							"vdate": "2022-04-25",
							"donor": "BNK"
						},
						{
							"cchild": "",
							"sstateref": "",
							"sstate": "",
							"spdref": "natural person",
							"spd": "1",
							"cgragref": "",
							"cgrag": "802804",
							"ceducref": "",
							"ceduc": "",
							"familyref": "",
							"family": "",
							"csexref": "woman",
							"csex": "2",
							"bdate": "1989-10-05",
							"mname": "ВАСИЛІВНА",
							"fname": "ІРИНА",
							"lname": "ГАРНА",
							"inn": "3278508288",
							"lngref": "Ukrainian",
							"lng": "1",
							"vdate": "2007-10-04",
							"donor": "BNK"
						}
					],
					"doc": {
						"dwdt": "2002-08-01",
						"dwho": "ІВАНГОРОДСЬКИМ",
						"dterm": "",
						"dnom": "578072",
						"dser": "АМ",
						"dtyperef": "Ukrainian citizen passport",
						"dtype": "1",
						"lngref": "Ukrainian",
						"lng": "1",
						"vdate": "2022-04-10",
						"eddr_number": "19891005-00022",
						"ddonor": "BNK"
					},
					"addr": {
						"adflat": "",
						"adcorp": "",
						"adhome": "7",
						"adstreet": "ТИХА",
						"adcitytyperef": "",
						"adcitytype": "",
						"adcity": "JВDКВJ",
						"adarea": "ІВАНГОРОДСКИЙ",
						"adstate": "ДНЕПРОПЕТРОВСКАЯ",
						"adindex": "23201",
						"adcountry": "UA",
						"adtyperef": "Address of registration",
						"adtype": "2",
						"lngref": "Ukrainian",
						"lng": "1",
						"vdate": "2022-04-25",
						"addonor": "BNK"
					},
					"bdate": "1989-10-05",
					"reqlngref": "Ukrainian",
					"reqlng": "1",
					"mname": "ВАСИЛІВНА",
					"fname": "ІРІНА",
					"lname": "ГАРНА",
					"inn": "3278508288"
				},
				"identdocmvds": {
					"identdocmvd": {
						"foundsource": [
							{
								"name": "MVS",
								"found": "1",
								"foundref": "Found",
								"sourcedate": "2022-10-16"
							},
							{
								"name": "DMS",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-16"
							},
							{
								"name": "UBKI",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-16"
							}
						],
						"found": "1",
						"foundref": "Found",
						"foundtitle": "Passport АМ-578072 is found in the list of invalid passports",
						"pser": "АМ",
						"pnom": "578072",
						"dtype": "1",
						"dtyperef": "Ukrainian citizen passport"
					}
				},
				"id": "1",
				"descr": "Identification of the Credit History Subject (CHS)"
			},
			{
				"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"
			},
			{
				"contact": [
					{
						"cval": "JOHNDOE@GMAIL.COM",
						"ctype": "4",
						"ctyperef": "email",
						"cstate": "2",
						"cstateref": "Deactualization",
						"vdatestart": "2024-05-07",
						"vdate": "2024-05-09"
					},
					{
						"cval": "+380662134234",
						"ctype": "3",
						"ctyperef": "mobile phone",
						"cstate": "1",
						"cstateref": "Actualization",
						"vdatestart": "2020-09-03",
						"vdate": "2020-09-08"
					},
					{
						"cval": "+380111111111",
						"ctype": "3",
						"ctyperef": "mobile phone",
						"cstate": "2",
						"cstateref": "Deactualization",
						"vdatestart": "2020-06-12",
						"vdate": "2020-08-30"
					}
				],
				"id": "46",
				"descr": "Сontacts confirmation of the subject of the credit history"
			   },
			   {
				"nameverif": {
					"match": "1",
                    "matchref": "Yes",
                    "numclients": "0",
                    "numclientsref": "No"

				},
				"id": "77",
				"descr": "Identification by phone and full name"
               }
           ]
      }
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-11-07 14:27:05.229" ftm="2022-10-07 14:27:05.715"/>
        </trace>
        <reqinfo reqid="req2#000002481742"/>
    </tech>
    <comp id="1" descr="Identification of the Credit History Subject (CHS)">
        <cki bdate="1989-10-05" reqlngref="Ukrainian" reqlng="1" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" inn="3278508288">
            <ident cchild="" sstateref="" sstate="" spdref="natural person" spd="1" cgragref="Ukraine" cgrag="804" ceducref="" ceduc="" familyref="" family="" csexref="woman" csex="2" bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" inn="3278508288" lngref="Ukrainian" lng="1" vdate="2022-04-25" donor="BNK"/>
            <ident cchild="" sstateref="" sstate="" spdref="natural person" spd="1" cgragref="" cgrag="802804" ceducref="" ceduc="" familyref="" family="" csexref="woman" csex="2" bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРИНА" lname="ГАРНА" inn="3278508288" lngref="Ukrainian" lng="1" vdate="2007-10-04" donor="BNK"/>
            <doc dwdt="2002-08-01" dwho="ІВАНГОРОДСЬКИМ" dterm="" dnom="578072" dser="АМ" dtyperef="Ukrainian citizen passport" dtype="1" lngref="Ukrainian" lng="1" vdate="2022-04-10" eddr_number="19891005-00022" ddonor="BNK"/>
            <addr adflat="" adcorp="" adhome="7" adstreet="ТИХА" adcitytyperef="" adcitytype="" adcity="JВDКВJ" adarea="ІВАНГОРОДСКИЙ" adstate="ДНЕПРОПЕТРОВСКАЯ" adindex="23201" adcountry="UA" adtyperef="Address of registration" adtype="2" lngref="Ukrainian" lng="1" vdate="2022-04-25" addonor="BNK"/>
        </cki>
        <identdocmvds>
            <identdocmvd found="1" foundref="Found" foundtitle="Passport АМ-578072 is found in the list of invalid passports" pser="АМ" pnom="578072" dtype="1" dtyperef="Ukrainian citizen passport">
                <foundsource name="MVS" found="1" foundref="Found" sourcedate="2022-10-16"/>
                <foundsource name="DMS" found="0" foundref="Not found" sourcedate="2022-10-16"/>
                <foundsource name="UBKI" found="0" foundref="Not found" sourcedate="2022-10-16"/>
            </identdocmvd>
        </identdocmvds>
    </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>
  <comp id="46" descr="Підтвердження контактів СКІ">
        <contact cval="JOHNDOE@GMAIL.COM" ctype="4" ctyperef="email" cstate="2" cstateref="Deactualization" vdatestart="2024-05-07" vdate="2024-05-09"/>
        <contact cval="+380662134234" ctype="3" ctyperef="mobile phone" cstate="1" cstateref="Actualization" vdatestart="2020-09-03" vdate="2020-09-08"/>
        <contact cval="+380111111111" ctype="3" ctyperef="mobile phone" cstate="2" cstateref="Deactualization" vdatestart="2020-06-12" vdate="2020-08-30"/>
    </comp>
  <comp id="77" descr="Блок звіркиIdentification by phone and full name">
    <nameverif match="1" matchref="Yes" numclients = "0" numclientsref = "No"
  </comp>
</ubkidata>

...