Versions Compared

Key

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

...

Request JSON
( **

параметри передаються опціонально

the parameters are transferred optionally)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "**Tax/Taxpayer Identification Number (INN-RNUKPN)/EDRPOU",

"lname": "**Last name",

"fname": "**First 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): Related persons' - 53",

"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 ‘Monitoring the client of the organization" organization’ (reqreason=1), code (0 - No, 1 - Yes)",

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

}

}

},

"comp": {

"relatedPersons": {

"related": {

"relations": {

"accuracy": "The accuracy of the relationship found, from 0 to 1",

"role": "Description of the relationship between the search subject and the found person",

"source": "The source in which the relation was found (Code from ref.72)"

},

"code": "EDRPOU code of a person, if it is a legal entity",

"name": "The name of the legal entity or the full name of the natural person related to the subject"

},

"bdate": "Date of birth",

"lname": "Last name",

"fname": "First name",

"mname": "Middle name",

"subjectCode": "TIN/EDRPOU of the subject"

},

"id": "79",

"descr": "Related persons"

}

}

}

Request XML
( **

параметри передаються опціонально

the parameters are transferred optionally)

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): Related persons' - 53"

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 (INN-RNUKPN)/EDRPOU" 

                     lname="**Last name" 

                     fname="**First name" 

                     mname="**Middle name"

bdate="**Date of birth"/>

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

<!-- Related persons-->

<comp id="79" descr="Related persons">

<relatedPersons bdate="Date of birth"

lname="Last name"

fname="First name"

mname="Middle name"

subjectCode="TIN/EDRPOU of the subject" >

<related code="EDRPOU code of a person, if it is a legal entity"

name="The name of the legal entity or the full name of the natural person related to the subject" >

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

<relations accuracy="The accuracy of the relationship found, from 0 to 1"

role="Description of the relationship between the search subject and the found person"

source="The source in which the relation was found (Code from ref.72)" />

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

</related>

</relatedPersons>

</comp>

</ubkidata>

Приклад

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "1234567890"
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "53",
						"reqreason": "2"
					},
					"descr": "Об'єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "7BD7E136E3BF470EAA2CFE2E8700000D"
		}
	}
}

...