...

Request JSON
** search can be done by TIN or by full name + date of birth

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

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

"lname": "**Last name",

"fname": "**First name",

"mname": "**Middle name",

"bdate": "**Date of birth"

},

"mvd": {

"dtype": "Document type (code from ref.7)",

"pser": "Series of the required passport",

"pnom": "Number of required passport or ID-card number"

},

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

},

"version": "1.0",

"reqtype": "Template code (Code from the ref.49): 'Check of an individual' - 54",

"reqreason": "Purpose of the request (Code from the ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (we receive it from the API authorization)"

}

}

}

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

{

"penaltiesCount": {

"totalCount": "The total number of enforcement proceedings for all time",

"activeCount": "Number of active enforcement proceedings"

},

"susd": {

"changes": {

"voteid": "Enforcement Number",

"inn": "TIN of the debtor",

"votedate": "Enforcement start date",

"votesudname": "Executor",

"vdate": "Record Date",

"credname": "Name of creditor",

"credokpo": "Creditor`s code",

"vpstate": "Status of proceedings"

},

"votesudname": "Executor",

"votetype": "Enforcement type",

"votedate": "Enforcement start date",

"inn": "TIN of the debtor",

"voteid": "Enforcement Number",

"votedonor": "Source of information",

"votesudphone": "Executor’s phone",

"votesudemail": "Executor’s email",

"vdate": "Record update date",

"credname": "Creditor name",

"credokpo": "Creditor`s code",

"vpstate": "Status of proceedings"

},

"id": "3",

"descr": "Information on the enforcement proceedings of SKI"

},

{

"mvd": {

"foundsource": {

"name": "Data source for verification (Code from ref. 63)",

"found": "0/1 - digital indication of the presence of an invalid passport (Code from ref.27)",

"foundref": "Text indication of the presence of an invalid passport (Value from ref.27)",

"sourcedate": "The date of updating the information in the database or receiving a response from the API of the original source"

},

"found": "Is it found? (The code from ref.27)",

"foundref": "Is it found? (Meaning from ref.27)",

"foundtitle": "Description of the search result",

"pser": "Series of the required passport",

"pnom": "Number of the required passport or number of ID-card",

"plname": "Surname of the required passport",

"pfname": "Name of the required passport",

"pmname": "Father’s name of the required passport",

"pbdate": "Date of birth of the required passport",

"status": "Reason for cancellation (Only for data from DATA.GOV.UA)",

"stdate": "Cancellation Date (Only for data from DATA.GOV.UA)"

},

"id": "5",

"descr": "Components name"

},

{

"wantedmvs": {

"found": "-2-To check the wanted persons database, make a request by full name and date of birth, 0-No information found, 1-Found information",

"foundref": "To check the wanted persons database, make a request by full name and date of birth/No information found/Found information",

"bdate": "Date of Birth",

"lng": "Block representation language (Code from ref.23)",

"lngref": "Block representation language (Meaning from ref.23)",

"lname": "Surname",

"fname": "Name",

"mname": "Father’s name",

"url": "Link to the Ministry of Internal Affairs questionnaire",

"category": "Category",

"articlecrim": "Article of accusation",

"restraint": "Preventive measure",

"lostdate": "Disappearance date"

},

"wantedsbu": {

"found": "-2-To check the wanted persons database, make a request by full name and date of birth, 0-No information found, 1-Found information",

"foundref": "To check the wanted persons database, make a request by full name and date of birth/No information found/Found information",

"bdate": "Date of Birth",

"lname": "Surname",

"fname": "Name",

"mname": "Father’s name",

"url": "Link to the SBU database",

"category": "Category",

"articlecrim": "Article of accusation",

"restraint": "Preventive measure",

"lostdate": "Disappearance date"

},

"wantedterrorist": {

"terrorists": [
{

"addresses": [

{

"country": "Country of address",

"address": "Full address"

}

],

"additionDate": "Date added to the list",

"court": "Listing authority",

"comments": "Comments",

"name": "Full name or aliases",

"bDate": "Date of birth",

"bPlace": "Place of birth"

},

],

"found": "Result (0 – not located; 1 – located)",

"foundref": "Text description of the result (0 – not located; 1 – located)",

"searchType": "Search type (1 – By full name, 2 – By full name and date of birth)",

"searchTypeText": "Description of search type"
},

"id": "17",

"descr": "Components name"

},

{

"lawyerinfo": {

"registration": {

"numsv": "Number of the certificate of the right to practice law",

"datesv": "Certificate issue date",

"issuedsv": "Issuing authority",

"numdec": "Number of the decision on issuing a certificate",

"datedec": "Date of decision",

"stopinfo": "Information on the termination of the right to advocate"

},

"found": "Availability of information (Code from ref.27)",

"foundref": "Availability of information, decoding",

"typesearch": "Search type (Code from ref.67)",

"typesearchtext": "Search type, decoding",

"lname": "Subject's last name",

"fname": "Subject's first name",

"mname": "Subject's patronymic",

"vdate": "Version date (date of update of information for this subject)"

},

"notaryinfo": {

"found": "Availability of information (Code from ref.27)",

"foundref": "Availability of information, decoding",

"typesearch": "Search type (Code from ref.67)",

"typesearchtext": "Search type, decoding",

"lname": "Subject's last name",

"fname": "Subject's first name",

"mname": "Subject's patronymic",

"vdate": "Version date (date of update of information for this subject)",

"numsv": "Number of the certificate on the right to engage in notarial activity",

"registeredin": "Place of registration",

"nameoffice": "Name of the registered institution"

},

"id": "27",

"descr": "Information from the register of lawyers and notaries"

},

{

"sanctions": {

"sanctionsData": {

"countryCode": "Country code",

"country": "The name of the country",

"sanction": "Presence of sanctions imposed by the country (Code from ref. 68)",

"date": "Date of entry into the list",

"url": "Link to the document – confirmation"

},

"found": "Availability of information (Code from ref. 27)",

"foundRef": "Text interpretation of available information (Code from ref. 27)",

"subName": "Subject’s name",

"bDate": "Subject’s date of birth",

"position": "Position",

"reason": "Grounds for imposing sanctions",

"endDate": "Expiration date of restrictions",

"sanctionsTerm": "The term of imposing the sanction",

"sanctionsNo": "Type of imposed restrictions, numbers",

"sanctions ": "The type of constraints imposed is Expanded",

"address": "Location",

"typeSearch": "Search type (Code from ref. 67)",

"typeSearchText": "Text interpretation of the type of search (Code from ref. 67)"

},

"id": "40",

"descr": "Information from sanctions lists"

},

{

"bankruptcyinfo": {

"bankruptcy": {

"subname": "Subject’s name",

"subcode": "TIN/EDRPOU",

"eventtype": "Event type",

"eventclaimer": "Initiator of the event",

"eventcourtcase": "Case number",

"eventdate": "Date of event",

"typeSearch": "Search type (Code from ref. 67)",

"typeSearchText": "Text interpretation of the type of search (Code from ref. 67)"

},

"found": "Availability of information about bankruptcy, numerical designation 0-1",

"foundref": " Availability of information about bankruptcy, textual meaning 0-not found / 1-found"

},

"id": "54",

"descr": "Bankruptcy information"

},
{

"pepinfo": {

"pepdata": [

{

"subName": "Name of the subject",

"source": "Data source http:// pep.org.ua, declaration or declarationdeputat_list",

"bDate": "Subject's date of birth",

"category": "Category of public figure (related person/public figure)",

"workPost": "Position",

"workPlace": "Place of work",

"postType": "Type of position",

"lastPost": "Last position",

"dateOfRelease": "Date of dismissal from the last position",

"url": "Link to the confirmation document",

"dateOfDoc": "Document creation date"

}

],

"found": "Availability of information (code from ref.27)",

"foundRef": "Text interpretation of the availability of information (value from ref.27)",

"typeSearch": "Type search (code from ref.75)",

"typeSearchText": "Text interpretation of the type search (value from ref.75)"

},

"id": "81",

"descr": "Information about politically significant persons of Ukraine"

},

{

"clientextradata": {

"presencech": {

"presence": "Indicator of credit history associated with the CHS in the database, code (0 – credit history absent, 1 – credit history present))",

"presenceref": "Indicator of credit history associated with the CHS in the database, value (Yes/No)"

},

"drorm": {

"found": "Indicator of movable property encumbrances associated with the CHS, code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)",

"foundref": "Indicator of movable property encumbrances associated with the CHS, value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

},

"rrp": {

"found": "Indicator of real property rights associated with the CHS, code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)",

"foundref": "Indicator of real property rights associated with the CHS, value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

},

"spd": {

"found": "Indicator of individual entrepreneur status for the subject, code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)",

"foundref": "Indicator of individual entrepreneur status for the subject, value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

},

"connection": {

"found": "Indicator of related persons associated with the subject, code (0 – Information not found, 1 – Information found)",

"foundref": "Indicator of related persons associated with the subject, value (0 – Information not found, 1 – Information found)"

},

"declaration": {

"found": "Indicator of the subject’s presence in declarations, code (0 – Information not found, 1 – Information found)",

"foundref": "Indicator of the subject’s presence in declarations, value (0 – Information not found, 1 – Information found)"

},

"autocar": {

"found": "Indicator of a vehicle associated with the subject (cached data), code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)",

"foundref": "Indicator of a vehicle associated with the subject (cached data), value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)",

"cachedate": "Data сaching date",

"iscache": "Indicator of the subject’s data presence in cache, code (0 – cache absent, 1 – cache present)",

"iscacheref": "Indicator of the subject’s data presence in cache, value (No/Yes)"

}

},

"id": "82",

"descr": "Additional information about the credit history subject"

}

]

}

}

...

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>

<!-- Information block on enforcement proceedings SKI -->

<comp id="3" descr="Information on the enforcement proceedings of SKI">

<penaltiesCount totalCount="The total number of enforcement proceedings for all time"

activeCount="Number of active enforcement proceedings" />

<susd votesudname="Executor"

votetype="Enforcement type"

votedate="Enforcement start date"

inn="TIN of the debtor"

voteid="Enforcement Number"

votedonor="Source of information"

votesudphone="Executor’s phone"

votesudemail="Executor’s email"

vdate="Record update date"

credname="Creditor name"

credokpo="Creditor`s code"

vpstate="Status of proceedings">

<changes voteid="Enforcement Number"

inn="TIN of the debtor"

votedate="Enforcement start date"

votesudname="Executor"

vdate="Record Date"

credname="Name of creditor"

credokpo="Creditor`s code"

vpstate="Status of proceedings" />

<!-- This block should consist of 0 .. * elements -->

</susd>

</comp>

<!-- Checking according to the databases of the invalid documents -->

<comp id="5" descr="Components name">

<mvd found="Is it found? (The code from ref.27)"

foundref="Is it found? (Meaning from ref.27)"

foundtitle="Description of the search result"

pser="Series of the required passport"

pnom="Number of the required passport or number of ID-card"

plname="Surname of the required passport"

pfname="Name of the required passport"

pmname="Father’s name of the required passport"

pbdate="Date of birth of the required passport"

status="Reason for cancellation (Only for data from http://DATA.GOV.UA )"

stdate="Cancellation Date (Only for data from http://DATA.GOV.UA )">

<foundsource name="Data source for verification (Code from ref. 63)"

found="0/1 - digital indication of the presence of an invalid passport (Code from ref.27)"

foundref="Text indication of the presence of an invalid passport (Value from ref.27)"

sourcedate="The date of updating the information in the database or receiving a response from the API of the original source" />

<!--This part must contain 1..* units and at least one document-->

</mvd>

</comp>

<!-- Searching(Ministry of Internal Affairs, SBU)-->

<comp id="17" descr="Components name">

<wantedmvs found="-2-To check the wanted persons database, make a request by full name and date of birth, 0-No information found, 1-Found information"

foundref="To check the wanted persons database, make a request by full name and date of birth/No information found/Found information"

bdate="Date of Birth"

lng="Block representation language (Code from ref.23)"

lngref="Block representation language (Meaning from ref.23)"

lname="Surname"

fname="Name"

mname="Father’s name"

url="A reference to the Ministry of Internal Affairs form"

category="Category"

articlecrim="Article of accusation"

restraint="Preventive measure"

lostdate="Disappearance date"/>

<wantedsbu found="-2-To check the wanted persons database, make a request by full name and date of birth, 0-No information found, 1-Found information"

foundref="To check the wanted persons database, make a request by full name and date of birth/No information found/Found information"

bdate="Date of Birth"

lname="Surname"

fname="Name"

mname="Father’s name"

url="A reference to the Ministry of Internal Affairs form"

category="Category"

articlecrim="Article of accusation"

restraint="Preventive measure"

lostdate="Disappearance date"/>

<wantedterrorist found="Result (0 – not located, 1 – located)"

foundref="Text description of the result (0 – not located, 1 – located)"

searchType="Search type (1 – By full name, 2 – By full name and date of birth)"

searchTypeText="Description of search type">

<terrorists additionDate="Date added to the list"

court="Listing authority"

comments="Comments"

name="Full name or aliases"

bDate="Date of birth"

bPlace="Place of birth">

<addresses country="Country of address"

address="Full address"/>

</terrorists>

</wantedterrorist>

</comp>

<!-- Information from the register of lawyers and notaries -->

<comp id="27" descr="Information from the register of lawyers and notaries">

<lawyerinfo found="Availability of information (Code from ref.27)"

foundref="Availability of information, decoding"

typesearch="Search type (Code from ref.67)"

typesearchtext="Search type, decoding "

lname="Subject's last name"

fname="Subject's first name"

mname="Subject's patronymic"

vdate="Version date (date of update of information for this subject)">

<registration numsv="Number of the certificate of the right to practice law"

datesv="Certificate issue date"

issuedsv="Issuing authority"

numdec="Number of the decision on issuing a certificate"

datedec="Date of decision"

stopinfo="Information on the termination of the right to advocate"/>

</lawyerinfo>

<notaryinfo found="Availability of information (Code from ref.27)"

foundref="Availability of information, decoding"

typesearch="Search type (Code from ref.67)"

typesearchtext="Search type, decoding "

lname="Subject's last name"

fname="Subject's first name"

mname="Subject's patronymic"

vdate="Version date (date of update of information for this subject)"

numsv="Number of the certificate on the right to engage in notarial activity"

registeredin="Place of registration"

nameoffice="Name of the registered institution"/>

</comp>

<!-- Block of information from the list of sanctions -->

<comp id="40" descr="Information from sanctions lists">

<sanctions found="Availability of information (Code from ref. 27)"

foundRef="Text interpretation of available information (Code from ref. 27)"

subName="Subject’s name"

bDate="Subject’s date of birth"

position="Position"

reason="Grounds for imposing sanctions"

endDate = "Expiration date of restrictions"

        sanctionsTerm = "The term of imposing the sanction"

        sanctionsNo = "Type of imposed restrictions, numbers"

        sanctions = "The type of constraints imposed is Expanded"

        address = "Location"

typeSearch="Search type (Code from ref. 67)"

typeSearchText="Text interpretation of the type of search (Code from ref. 67)">

<sanctionsData countryCode="Country code"

country="The name of the country"

sanction="Presence of sanctions imposed by the country (Code from ref. 68)"

date="Date of entry into the list"

url="Link to the document – confirmation" />

</sanctions>

<!--This block has to consist of 1 .. * elements -->

</comp>

<!-- Bankruptcy information-->

<comp id="54" descr="Bankruptcy information">

<bankruptcyinfo found="Availability of information about bankruptcy, numerical designation 0-1"

foundref=" Availability of information about bankruptcy, textual meaning 0-not found / 1-found">

<bankruptcy subname="Subject’s name"

subcode="TIN/EDRPOU"

eventtype="Event type"

eventclaimer="Initiator of the event"

eventcourtcase="Case number"

eventdate="Date of event"

typeSearch="Search type (Code from ref. 67)"

typeSearchText="Text interpretation of the type of search (Code from ref. 67)"/>

</bankruptcyinfo>

</comp>

<!-- Information about politically significant persons of Ukraine -->

<comp id="81" descr="The name of the component">

<pepinfo found="Availability of information (code from ref.27)"

foundRef="Text interpretation of the availability of information (value from ref.27)"

typeSearch="Type search (code from ref.75)"

typeSearchText="Text interpretation of the type search (value from ref.75)">

<pepdata subName="Name of the subject"

source="Data source http:// pep.org.ua, declaration or declaration deputat_list"

bDate="Subject's date of birth"

category="Category of public figure (related person/public figure)"

workPost="Position"

workPlace="Place of work"

postType="Type of position"

lastPost="Last position"

dateOfRelease="Date of dismissal from the last position"

url="Link to the confirmation document"

dateOfDoc="Document creation date"/>

</pepinfo>

</comp>

<!-- Additional information about the credit history subject -->

<comp id="82" descr="Additional information about the credit history subject">

<clientextradata>

<presencech presence="Indicator of credit history associated with the CHS in the database, code (0 – credit history absent, 1 – credit history present)"

presenceref="Indicator of credit history associated with the CHS in the database, value (Yes/No)"/>

<drorm found="Indicator of movable property encumbrances associated with the CHS, code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

foundref="Indicator of movable property encumbrances associated with the CHS, value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"/>

<rrp found="Indicator of real property rights associated with the CHS, code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

foundref="Indicator of real property rights associated with the CHS, value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"/>

<spd found="Indicator of individual entrepreneur status for the subject, code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

foundref="Indicator of individual entrepreneur status for the subject, value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"/>

<connection found="Indicator of related persons associated with the subject, code (0 – Information not found, 1 – Information found)"

foundref="Indicator of related persons associated with the subject, value (0 – Information not found, 1 – Information found)"/>

<declaration found="Indicator of the subject’s presence in declarations, code (0 – Information not found, 1 – Information found)"

foundref="Indicator of the subject’s presence in declarations, value (0 – Information not found, 1 – Information found)"/>

<autocar found="Indicator of a vehicle associated with the subject (cached data), code (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

foundref="Indicator of a vehicle associated with the subject (cached data), value (-3 – To verify, make a request using TIN, 0 – Information not found, 1 – Information found)"

cachedate="Data сaching date"

iscache="Indicator of the subject’s data presence in cache, code ( 0 – cache absent, 1 – cache present)"

iscacheref="Indicator of the subject’s data presence in cache, value (No/Yes)"/>

</clientextradata>

</comp>

</ubkidata>

...