Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Додано поле код ролі

...

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

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

"roleCode": "Code describing the relationship between the search subject and the person found (Code from ref.73)",

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

}

}

}

...

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"

roleCode="Code describing the relationship between the search subject and the person found (Code from ref.73)"

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

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

</related>

</relatedPersons>

</comp>

</ubkidata>

...

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step":  [
                    {
					"name": "build report",
					"stm": "2022-11-09 19:22:31.946",
					"ftm": "2022-01-09 19:22:32.021"
				}
			 ]
            },
            "error": [],
			"reqinfo": {
				"reqid": "req2#000002007864"
			}
		},
		"comp": [
            {
                "id": "79",
                "descr": "Пов'язані особи",
                "relatedPersons": {
                    "bdate": "1974-08-20",
                    "fname": "БОГДАН",
                    "lname": "БОГДАНОВ",
                    "mname": "БОГДАНОВИЧ",
                    "subjectCode": "2726020593",
                    "related": [
                        {
                            "code": "44011074",
                            "name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ \"ЛИМАК ГРУП\"",
                            "relations": [
                                {
                                    "accuracy": 1.0,
                                    "role": "представниксуб'єкт юридичноїє керівником особи",
                                    "roleCode": "203",
                                    "source": "EDR_links""
                                },
                                {
    },                                 {"accuracy": 1.0,
                                    "accuracyrole": 1.0"суб'єкт є засновником особи",
                                    "roleroleCode": "є засновником202",
                                    "source": "EDR_links"
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    }
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-11-09 19:22:31.946" ftm="2022-01-09 19:22:32.021" />
    </trace>
    <reqinfo reqid="req2#000002007864" />
  </tech>
   <comp id="79" descr="Пов'язані особи">
        <relatedPersons bdate="1974-08-20" fname="БОГДАН" lname="БОГДАНОВ" mname="БОГДАНОВИЧ" subjectCode="2726020593">
            <related code="44011074" name="ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ &quot;ЛИМАК ГРУП&quot;">
                <relations accuracy="1.0" roleCode="203" role="представник юридичноїсуб'єкт є керівником особи" source="EDR_links"/>
                <relations accuracy="1.0" roleCode="202" role="суб'єкт є засновником особи" source="EDR_links"/>
            </related>
        </relatedPersons>
    </comp>
</ubkidata>

...