13 - Identity document verification
Checking if a passport (identity card) is registered as invalid in the corresponding database.
The report contains the following components:
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON |
Response JSON{ "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": "0-not found, 1-found", "foundref": "not found/found", "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" }, "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" } ] } } |
Request XML |
Response XML<?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> <!-- Block - Search for wanted persons in the Ministry of Internal Affairs database --> <comp id="17" descr="Components name"> <wantedmvs found="0-not found, 1-found" foundref="not found/found" 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" /> </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> |
Example |
---|
Request JSON | {
"doc": {
"ubki": {
"req_envelope": {
"req_xml": {
"request": {
"i": {
"ident": {
"bdate": "1989-10-05",
"mname": "VASYLIVNA",
"fname": "IRINA",
"lname": "HARNA",
"okpo": "3278508288"
},
"mvd": {
"dtype": "1",
"pser": "АМ",
"pnom": "578072",
"mname": "VASYLIVNA",
"fname": "IRINA",
"lname": "HARNA",
"pbdate": "1989-10-05"
},
"reqlng": "4"
},
"version": "1.0",
"reqtype": "13",
"reqreason": "2"
}
}
},
"sessid": "6D7D781B1E884A6AB384481804A35EA8"
}
}
} |
Response JSON | {
"ubkidata": {
"tech": {
"trace": {
"step": {
"name": "build report",
"stm": "2022-11-25 14:09:30.527",
"ftm": "2022-08-25 14:09:30.619"
}
},
"reqinfo": {
"reqid": "req2#000002459786"
}
},
"comp": [
{
"mvd": {
"foundsource": [
{
"name": "UBKI",
"found": "0",
"foundref": "Not found",
"sourcedate": "2022-10-16"
},
{
"name": "MVS",
"found": "1",
"foundref": "Found",
"sourcedate": "2022-10-16"
},
{
"name": "DMS",
"found": "0",
"foundref": "Not found",
"sourcedate": "2022-10-16"
}
],
"found": "1",
"foundref": "Found",
"foundtitle": "Passport АМ-578072 is found in the list of invalid passports",
"pser": "АМ",
"pnom": "578072",
"plname": "",
"pfname": "",
"pmname": "",
"pbdate": "1989-10-05",
"dtype": "1",
"dtyperef": "Ukrainian citizen passport"
},
"id": "5",
"descr": "Checking according to the databases of the invalid documents"
},
{
"wantedmvs": {
"found": "0",
"foundref": "No information found",
"bdate": "1989-10-05",
"lng": "1",
"lngref": "Ukrainian",
"lname": "ГАРНА",
"fname": "ІРІНА",
"mname": "ВАСИЛІВНА",
"url": "",
"category": "",
"articlecrim": "",
"restraint": ""
},
"id": "17",
"descr": "Search in the MIA search database"
},
{
"pret": {
"inn": "3278508288",
"nonewdeal": "0",
"nonewdealref": "No",
"nonewdealcomment": "",
"freezedate":""
},
"fcert": {
"inn": "3278508288",
"cert": "0",
"certref": "No",
"certid": "",
"certurl": ""
},
"maybegone": {
"inn": "3278508288",
"vdate": "2022-12-01",
"dldonor": "BNK"
},
"id": "18",
"descr": "Alert"
}
]
}
} |
Request XML | <?xml version="1.0" encoding="UTF-8"?>
<doc>
<ubki sessid="6D7D781B1E884A6AB384481804A35EA8">
<req_envelope>
<req_xml>
<request version="1.0" reqtype="13" reqreason="2">
<i reqlng="4">
<ident bdate="1989-10-05" mname="VASYLIVNA" fname="IRINA" lname="HARNA" okpo="3278508288" />
<mvd dtype="1" pser="АМ" pnom="578072" mname="VASYLIVNA" fname="IRINA" lname="HARNA" pbdate="1989-10-05" />
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc> |
Response XML |
XSD Schema request | |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response13.xsd |
Test URL | |
---|---|
Test data | Not found in the list of invalid passports
Found in the list of invalid passports
<comp id="17" descr="Search for Wanted Persons in the Ministry of Internal Affairs Database part">
<comp id="18" descr="Alert"> tag <changedeal>
|