21 - Verification


Checking the consistency of subject’s data (full name+DOB+passport) and validity of the document.


Http Method

POST

Request JSON
( **parameters are passed optionally)

{

"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": "Sought-for document type (code 1, 3, 17 from дов.7)",

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

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

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

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

"pmname": "Patronymic of the required passport",

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

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Verification ' – 21",

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

},

"descr": "Request object"

},

"descr": "Request envelope"

},

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

}

}

}

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"

},

{

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

},

{

"passportverif": {

"coincide": "0-no match, 1-match",

"coincideref": "Yes/No",

"existident": "Indication of the presence of identification data at the client (0-present, 1-missing)",

"existidentref": "Text indication of the presence of client identification data (Yes/No)",

"lname": "Last name",

"fname": "First name",

"mname": "Middle name",

"bdate": "Date of birth",

"ser": "Sought-for passport series",

"nom": "Number of the sought-for passport or ID card"

},

"id": "22",

"descr": "Names of components"

},

{

"person": {

"bdate": "Date of birth",

"lngref": "Search/transfer language (ref. 23)",

"lng": "Part presentation language, value (ref. 23)",

"mname": "Middle name",

"fname": "First name",

"lname": "Last name",

"inn ": "TIN of the credit history subject",

},

"id": "72",

"descr": "Search by full name + inn if more than 1 person is found (The presence of the component is determined by searching for more than 1 person in the case of searching by full name + inn)"

}

]

}

}

Request XML
( **parameters are passed optionally)

<?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): 'Verification ' – 21" 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= "Sought-for document type (code 1, 3, 17 from дов.7)"

pser="Series of the required passport"

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

plname="Surname of the required passport"

pfname="Name of the required passport"

pmname="Patronymic of the required passport"

pbdate="Date of birth of the required passport">

</mvd>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

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>

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

<!-- Subject Verification by Full Name+DOB+Passport part -->

<comp id="22" descr="Names of components">

<passportverif coincide="0-no match, 1-match"

coincideref="Yes/No"

existident="Indication of the presence of identification data at the client (0-present, 1-missing)"

existidentref="Text indication of the presence of client identification data (Yes/No)"

lname="Last name"

fname="First name"

mname="Middle name"

bdate="Date of birth"

ser="Sought-for passport series"

nom="Number of the sought-for passport or ID card" />

</comp>

<!-- Search by full name + inn if more than 1 person is found (The presence of the component is determined by searching for more than 1 person in the case of searching by full name + inn)-->

<comp id="72" descr="Search by full name + inn if more than 1 person is found">

<person bdate="Date of birth"

lngref="Search/transfer language (ref. 23)"

lng="Part presentation language, value (ref. 23)"

mname="Middle name"

fname="First name"

lname="Last name"

inn="TIN of the credit history subject" />

</comp>

</ubkidata>

Example

Example

Request JSON

{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "bdate": "1989-10-05", "mname": "ВАСИЛІВНА", "fname": "ІРІНА", "lname": "ГАРНА", "okpo": "3278508288" }, "mvd": { "dtype": "1", "pser": "АМ", "pnom": "578072", "plname": "ГАРНА", "pfname": "ІРІНА", "pmname": "ВАСИЛІВНА", "pbdate": "1989-10-05" }, "reqlng": "4" }, "version": "1.0", "reqtype": "21", "reqreason": "2" } } }, "sessid": "F936E3872D7740D7910BB32C933318B3" } } }

Response JSON

{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report", "stm": "2022-11-26 09:26:44.35", "ftm": "2022-08-26 09:26:44.44" } }, "reqinfo": { "reqid": "req2#000002460341" } }, "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": "HARNA", "pfname": "IRINA", "pmname": "VASYLIVNA", "pbdate": "1989-10-05", "dtype": "1", "dtyperef": "Ukrainian citizen passport" }, "id": "5", "descr": "Checking according to the databases of the invalid documents" }, { "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" }, { "passportverif": { "coincide": "1", "coincideref": "Yes", "existident": "1", "existidentref": "Yes", "mname": "ВАСИЛІВНА", "fname": "ІРІНА", "lname": "ГАРНА", "bdate": "1989-10-05", "ser": "АМ", "nom": "578072" }, "id": "22", "descr": "Result of verification of Full Name-Passport-DOB" } ] } }

Request XML

<?xml version="1.0" encoding="UTF-8"?> <doc> <ubki sessid="F936E3872D7740D7910BB32C933318B3"> <req_envelope> <req_xml> <request version="1.0" reqtype="21" reqreason="2"> <i reqlng="4"> <ident bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" /> <mvd dtype="1" pser="АМ" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" pbdate="1989-10-05" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc>

Response XML

An example of a successful verification response in the presence of client identification data:

<comp id="22" descr="Result of verification of Full Name-Passport-DOB">

<passportverif coincide="1" coincideref="Yes" existident = "1" existidentref = "Yes" lname="ГАРНА" fname="ІРІНА" mname="ВАСИЛІВНА" bdate="1989-10-05" ser="АМ" nom="578072" ></passportverif>

</comp>

An example of a failed verification response in the presence of client identification data:

<comp id="22" descr="Result of verification of Full Name-Passport-DOB">

<passportverif coincide="0" coincideref="No" existident = "1" existidentref = "Yes" lname="ГАРНА" fname="ІРІНА" mname="ВАСИЛІВНА" bdate="1989-10-05" ser="АМ" nom="578072" ></passportverif>

</comp>

An example of a response in the absence of client identification data:

<comp id="22" descr="Result of verification of Full Name-Passport-DOB">

<passportverif coincide="0" coincideref="No" existident = "0" existidentref = "No" lname="ГАРНА" fname="ІРІНА" mname="ВАСИЛІВНА" bdate="1989-10-05" ser="АМ" nom="578072" ></passportverif>

</comp>

An example of a successful verification response in the presence of client identification data:

<comp id="22" descr="Result of verification of Full Name-Passport-DOB">

<passportverif coincide="1" coincideref="Yes" existident = "1" existidentref = "Yes" lname="ГАРНА" fname="ІРІНА" mname="ВАСИЛІВНА" bdate="1989-10-05" ser="АМ" nom="578072" ></passportverif>

</comp>

An example of a failed verification response in the presence of client identification data:

<comp id="22" descr="Result of verification of Full Name-Passport-DOB">

<passportverif coincide="0" coincideref="No" existident = "1" existidentref = "Yes" lname="ГАРНА" fname="ІРІНА" mname="ВАСИЛІВНА" bdate="1989-10-05" ser="АМ" nom="578072" ></passportverif>

</comp>

An example of a response in the absence of client identification data:

<comp id="22" descr="Result of verification of Full Name-Passport-DOB">

<passportverif coincide="0" coincideref="No" existident = "0" existidentref = "No" lname="ГАРНА" fname="ІРІНА" mname="ВАСИЛІВНА" bdate="1989-10-05" ser="АМ" nom="578072" ></passportverif>

</comp>

Test URL

Test data

  • bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095" dtype="1" dser="ДО" dnom="270000" cval="+380981220000" ctype="3"

  • bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593" dtype="17" dser="" dnom="001013900" cval="+380935171868" ctype="3"

  • bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397" dtype="1" dser="СЕ" dnom="311111" cval="+380506630641" ctype="3"

  • bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116" dtype="1" dser="КО" dnom="220394" cval="+380971321122" ctype="3"

  • bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="3333312110" dtype="1" dser="ДД" dnom="222222" cval="+380732144444" ctype="3"

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" okpo="3112579786" dtype="1" dser="СЮ" dnom="170000" cval="+380981224895" ctype="3"

  • bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" dtype="1" dser="ВВ" dnom="142228" cval="+380662134234" ctype="3"

 

Found in the list of invalid passports

  • bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116" dtype="17" dser="" dnom="123321123" cval="+380971321122" ctype="3"

  • bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІР