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": "Tax/Taxpayer Identification Number (INN-RNUKPN)/EDRPOU"

},

"rrp": {

"value": "Encumbrance number by subject"

},

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

"text": "**"

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Information from the State Register of Real Rights ' – 33",

"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"

},

"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)"

}

}

},

"comp": [

{

"rrp": {

"found": "0/1 – numerical designation of existing objects, by the subject",

"foundref": "Text designation of existing objects, by the subject",

"okpo": "TIN/EDRPOU"

},

"immovables": {

"id": "Object number",

"description": "Object description (address/cadastral number)"

},

"id": "42",

"descr": "Presence of information in the immovable property rights register"

},

{

"rrp": {

"found": "0/1 (0 – no registered property,1 – there is registered property)",

"foundref": "The client has immovable property rights/The client has no immovable property rights",

"okpo": "TIN/EDRPOU",

"response": "Information about the object in the json format"

},

"id": "43",

"descr": "Information about the object from the immovable property rights register"

}

]

}

}

...

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>

<!-- Presence of information in the immovable property rights register -->

<comp id="42" descr="Presence of information in the immovable property rights register">

<rrp found="0/1 – numerical designation of existing objects, by the subject"

foundref="Text designation of existing objects, by the subject"

okpo="TIN/EDRPOU" />

<immovables id="Object number"

description="Object description (address/cadastral number)" />

<!-- This part must contain 0..* items-->

</comp>

<!-- Information about the object from the immovable property rights register -->

<comp id="43" descr="Information about the object from the immovable property rights register">

<rrp found="0/1 (0 – no registered property,1 – there is registered property)"

foundref="The client has immovable property rights/The client has no immovable property rights"

okpo="TIN/EDRPOU"

response="Information about the object in the json format" />

</comp>

</ubkidata>

...