Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

The report contains the following components:

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "Tax/Taxpayer Identification Number (TIN, for individuals)/EDRPOU (for legal entities)"

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Information on registration of the taxpayer' - 37",

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

},

"descr": "Request object"

},

"descr": "Request envelope"

},

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

}

}

}

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Step name",

"stm": "Step start stamp date",

"ftm": "Step finish stamp date"

}

},

"error": {

"errtype": "Error code (code from ref.0)",

"errtext": "Error text (value from ref.0)"

},

"reqinfo": {

"reqid": "Outgoing request ID generated by UBKI"

},

"billing": {

"balance": {

"value": "Total assets",

"date": "Date",

"time": "Time"

}

}

},

"

comp

billdetails": {

"

registeredCars

freemon":

{

"car": {

"operCode": "Transaction code

"Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)",

"

operName

freemonref": "

Decryption

Sign of

the operation"

free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"

}

}

},

"

depName

comp": {

"

Registration authority

registeredCars"

,

: {

"

brand

car":

"Vehicle brand name",

{

"

model

operCode": "Transaction code",

"operName": "Decryption of the operation",

"depName": "Registration authority",

"brand": "Vehicle brand name",

"model": "Vehicle model name",

"makeYear": "Year production",

"capacity": "Engine capacity",

"dreg": "Date of last registration for",

"color": "Vehicle color",

"kind": "Vehicle type",

"body": "Vehicle body type",

"purpose": "Vehicle purpose",

"fuel": "Vehicle fuel type",

"ownWeight": "Vehicle own weight",

"totalWeight": "Total weight of the vehicle",

"gosRegNumber": "State registration number of the car",

"VINNumber": "Unique serial number(Vehicle identification number)"

},

"okpo": "TIN/EDRPOU (Tax/Taxpayer Identification",

"carfound": "0/1/-1 -Numerical designations of availability of motor transport on the subject",

"carfoundref": "Text indication of the presence of vehicles in the subject"

},

"id": "56",

"descr": "Vehicle information"

}

}

}

Request XML

Expand
title body:

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

<doc>

<ubki sessid="Session key (obtained from the authorization API)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request parameters -->

<request version="1.0" reqtype="Template code (code from ref.49): 'Information on registration of the taxpayer' - 37" reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

<i reqlng="Search criteria language (code from ref.23)">

<!-- Subject identification parameters-->

<ident okpo="Tax/Taxpayer Identification Number (TIN, for individuals)/EDRPOU (for legal entities)" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

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

<ubkidata>

<!-- System information part -->

<tech>

<trace>

<step name="Step name" stm="Step start stamp date" ftm="Step finish stamp date">

<!-- The trace part contains timing metrics of components generation steps -->

</step>

</trace>

<error errtype="Error code (code from ref.0)" errtext="Error text (value from ref.0)">

</error>

<reqinfo reqid="Outgoing request ID generated by UBKI">

</reqinfo>

<!-- Information about the current status of the prepaid account part-->

<billing>

<balance value="Total assets" date="Date" time="Time" />

<billdetails freemon="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)"

freemonref="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"/>

</billing>

</tech>

<!-- Vehicle information -->

<comp id="56" descr="Vehicle information">

<registeredCars okpo="TIN/EDRPOU (Tax/Taxpayer Identification"

carfound="0/1/-1 -Numerical designations of availability of motor transport on the subject"

carfoundref="Text indication of the presence of vehicles in the subject">

<car operCode="Transaction code"

operName="Decryption of the operation"

depName="Registration authority"

brand="Vehicle brand name"

model="Vehicle model name"

makeYear="Year production"

capacity="Engine capacity"

dreg="Date of last registration for"

color="Vehicle color"

kind="Vehicle type"

body="Vehicle body type"

purpose="Vehicle purpose"

fuel="Vehicle fuel type"

ownWeight="Vehicle own weight"

totalWeight="Total weight of the vehicle"

gosRegNumber="State registration number of the car"

VINNumber="Unique serial number(Vehicle identification number)" />

</registeredCars>

</comp>

</ubkidata>

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "12345610"
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "37",
						"reqreason": "2"
					}
				}
			},
			"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-08-29 10:54:57.943",
					"ftm": "2022-08-29 10:54:58.267"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002461403"
			}
		},
		"comp": {
			"registeredCars": {
				"car": [
					{
						"operCode": "100",
						"operName": "ПЕРВИННА РЕЄСТРАЦIЯ Б/В ТЗ ПРИДБАНОГО В ТОРГІВЕЛЬНІЙ ОРГАНІЗАЦІЇ, ЯКИЙ ВВЕЗЕНО З-ЗА КОРДОНУ",
						"depName": "ТСЦ 1242",
						"brand": "VOLKSWAGEN",
						"model": "JETTA",
						"makeYear": "2017",
						"capacity": "1390",
						"dreg": "2021-04-14T00:00:00",
						"color": "БІЛИЙ",
						"kind": "ЛЕГКОВИЙ",
						"body": "СЕДАН",
						"purpose": "ЗАГАЛЬНИЙ",
						"fuel": "БЕНЗИН",
						"ownWeight": "1411",
						"totalWeight": "1900",
						"gosRegNumber": "АЕ2615СС",
						"VINNumber": "3VWDB7AJ9HM310108"
					},
					{
						"operCode": "410",
						"operName": "ПЕРЕРЕЄСТРАЦІЯ ПРИ ЗАМІНІ НОМЕРНОГО ЗНАКУ",
						"depName": "ТСЦ 1249",
						"brand": "VOLKSWAGEN",
						"model": "JETTA",
						"makeYear": "2016",
						"capacity": "1395",
						"dreg": "2021-04-15T00:00:00",
						"color": "БІЛИЙ",
						"kind": "ЛЕГКОВИЙ",
						"body": "СЕДАН",
						"purpose": "ЗАГАЛЬНИЙ",
						"fuel": "БЕНЗИН",
						"ownWeight": "1392",
						"totalWeight": "1900",
						"gosRegNumber": "АЕ8512СС",
						"VINNumber": "3VW267AJ1GM380000"
					}
				],
				"okpo": "12345610",
				"carfound": "1",
				"carfoundref": "Information about vehicles was found for the client"
			},
			"id": "56",
			"descr": "Vehicle information"
		}
	}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="EDF4309796114D6D9B8365370DA2DEE9">
    <req_envelope>
      <req_xml>
        <request version="1.0" reqtype="37" reqreason="2">
          <i reqlng="4">
            <ident okpo="12345610" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-08-29 10:54:57.943" ftm="2022-08-29 10:54:58.267"/>
        </trace>
        <reqinfo reqid="req2#000002461403"/>
    </tech>
    <comp id="56" descr="Vehicle information">
        <registeredCars okpo="12345610" carfound="1" carfoundref="Information about vehicles was found for the client">
            <car operCode="100" operName="ПЕРВИННА РЕЄСТРАЦIЯ Б/В ТЗ ПРИДБАНОГО В ТОРГІВЕЛЬНІЙ ОРГАНІЗАЦІЇ, ЯКИЙ ВВЕЗЕНО З-ЗА КОРДОНУ" depName="ТСЦ 1242" brand="VOLKSWAGEN" model="JETTA" makeYear="2017" capacity="1390" dreg="2021-04-14T00:00:00" color="БІЛИЙ" kind="ЛЕГКОВИЙ" body="СЕДАН" purpose="ЗАГАЛЬНИЙ" fuel="БЕНЗИН" ownWeight="1411" totalWeight="1900" gosRegNumber="АЕ2615СС" VINNumber="3VWDB7AJ9HM310108"/>
            <car operCode="410" operName="ПЕРЕРЕЄСТРАЦІЯ ПРИ ЗАМІНІ НОМЕРНОГО ЗНАКУ" depName="ТСЦ 1249" brand="VOLKSWAGEN" model="JETTA" makeYear="2016" capacity="1395" dreg="2021-04-15T00:00:00" color="БІЛИЙ" kind="ЛЕГКОВИЙ" body="СЕДАН" purpose="ЗАГАЛЬНИЙ" fuel="БЕНЗИН" ownWeight="1392" totalWeight="1900" gosRegNumber="АЕ8512СС" VINNumber="3VW267AJ1GM380000"/>
        </registeredCars>
    </comp>
</ubkidata>

Test URL

https://test.ubki.ua/b2_api_xml/ubki/xml

Test data

  • okpo="3332643095"

  • okpo="2525151561"

  • okpo="12345610"

  • okpo="99959222"