Versions Compared

Version Old Version 2 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/Search for documents by the declarant
( ** parameters are transmitted optionally)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "**RNOKPP (TIN) of the declarant",

"lname": "Last name",

"fname": "Name",

"mname": "Middle Name",

"bdate": "**Date of birth"

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Information from the Unified State Register of Declarations' - 49",

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

{

"id": "Component Number",

"descr": "",

"declaration": {

"found": "Search parameter (1-found, 0-not)",

"foundref": "Text message of the search result",

"persons": [

{

"identId": "Unique number of the declarant",

"names": [

{

"lname": "Last name",

"fname": "Name",

"mname": "Middle Name",

"personName": "Full name"

}

],

"docs": [

{

"documentId": "Document Number",

"year": "Year of the document",

"typeId": "Document Type",

"docType": "Type of declaration",

"docDate": "Date of declaration submission"

}

]

}

]

}

}

]

}

}

...

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>

<!-- List of declarations -->

<comp id="74" descr="List of declarations">

<declaration found="Search parameter (1-found, 0-not)"

foundref="Text message of the search result">

<persons identId="Unique number of the declarant">

<names lname="Last name"

fname="Name"

mname="Middle Name"

personName="Full name"/>

<docs documentId="Document Number"

year="Year of the document"

typeId="Document Type"

docType="Type of declaration"

docDate="Date of declaration submission"/>

</persons>

</declaration>

</comp>

</ubkidata>

...

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

            {

                "id": "Component Number",

                "descr": "",

                "declaration": {

                    "found": "Search parameter (1-found, 0-not)",

                    "foundref": "Text message of the search result",

                    "response": "Detailed information of the declaration document"

                }

            }

        ]

    }

}

...