13 - Identity document verification

{

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

"plname": "Last name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine",

"pfname": "First name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine",

"pmname": "Middle name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine",

"pbdate": "Date of birth for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine"

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Identity document verification ' – 13",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

{

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

{

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

},

{

"pret": {

"pretension": {

"inn": "INN (for natural persons)/OKPO (for legal entities)",

"crdeal": "Transaction identifier (reference)",

"source": "Disputing type (Code from ref.48)",

"sourceref": "Disputing type (Value from ref.48)",

"claim" : "Subject of dispute (Code from ref. 69)",

                         "claimref": "Subject of dispute (Value from ref. 69)",

"vdate": "Date of the request creation"

},

"commentcki": {

"comment": "Commentary of the subject of credit history",

"vdate": "Date of a comment creation"

},

"plost": {

"pser": "Passport series claimed by the client as lost (theft)",

"pnom": "Passport number declared by the client as lost (theft)",

"crdate": "ДDate of creation of an application for the loss/theft of a client's passport in UBCH",

"ldate": "The date of loss / theft of the client's passport indicated in the application in UBCH"

},

"changedeal": {

"crdeal": "Transaction identifier (reference)",

"changecode": "Code for the reason of correction/deletion of data (Code from ref.62)",

"changeref": "Text of the reason for correcting/deleting data (Value from ref.62)",

"vdate": "Date of data correction/deletion"

},

"freezedate": "FREEZE option connection date",

"nonewdealcomment": "Comment",

"nonewdeal": "Sign of reluctance to draw up new loan products, connection status of the FREEZE option: 0 - not enabled, 1 - enabled",

"nonewdealref": "The value of the sign of unwillingness to draw up new credit products, the connection status of the FREEZE option is 0-no (the option is not connected), 1-yes (the option is connected)",

"inn": "INN (for natural persons)/OKPO (for legal entities)"

},

"fcert": {

"inn": "TIN",

"cert": "Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) ",

"certref": "Availability of a certificate from the UBCH (value from ref. 56)",

"certid": "Certificate number",

"certurl": "Link to the certificate"

},

"maybegone": {

"inn": "TIN",

"vdate": "Application creation date",

"dldonor": "Information provider (code from ref. 54)"

},

"id": "18",

"descr": "Components name"

}

]

}

}

<?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): 'Identity document verification ' – 13" 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, for individuals)"

lname="**Last name"

fname="**First name"

mname="**Middle name"

bdate="**Date of birth">

</ident>

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

<mvd dtype="Document type (code from ref.7)"

pser="Series of the required passport"

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

plname="Last name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine"

pfname="First name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine"

pmname="Middle name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine"

pbdate="Date of birth for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine">

</mvd>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

<?xml version="1.0" encoding="utf-8"?>

<ubkidata>

<tech>

<!-- System information part -->

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

<billing>

<!-- Information about the current status of the prepaid account part-->

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

<!-- 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 DATA.GOV.UA)"

stdate="Cancellation Date (Only for data from 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>

<!-- Alert -->

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

<pret nonewdeal="Sign of reluctance to draw up new loan products, connection status of the FREEZE option: 0 - not enabled, 1 - enabled"

nonewdealref="The value of the sign of unwillingness to draw up new credit products, the connection status of the FREEZE option is 0-no (the option is not connected), 1-yes (the option is connected)"

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

inn="INN (for natural persons)/OKPO (for legal entities)">

<pretension inn="INN (for natural persons)/OKPO (for legal entities)"

crdeal="Transaction identifier (reference)"

source="Disputing type (Code from ref.48)"

sourceref="Disputing type (Value from ref.48)"

claim="Subject of dispute (Code from ref. 69)"

                         claimref="Subject of dispute (Value from ref. 69)"

vdate="Date of the request creation" />

<commentcki comment="Commentary of the subject of credit history"

vdate="Date of a comment creation" />

<plost pser="Passport series claimed by the client as lost (theft)"

pnom="Passport number declared by the client as lost (theft)"

crdate="ДDate of creation of an application for the loss/theft of a client's passport in UBCH"

ldate="The date of loss / theft of the client's passport indicated in the application in UBCH" />

<changedeal crdeal="Transaction identifier (reference)"

changecode="Code for the reason of correction/deletion of data (Code from ref.62)"

changeref="Text of the reason for correcting/deleting data (Value from ref.62)"

vdate="Date of data correction/deletion" />

</pret>

<fcert inn="TIN"

cert="Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) "

certref="Availability of a certificate from the UBCH (value from ref. 56)"

certid="Certificate number"

certurl="Link to the certificate" />

<maybegone inn="TIN"

vdate="Application creation date"

dldonor="Information provider (code from ref. 54)"/>

</comp>

</ubkidata>