32 - Identification by passport


Checking the consistency of the passport, against the data of the credit history subject.


Http Method

POST

Request JSON

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"docs": {

"doc": {

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

"dser": "Document series",

"dnom": "Document number"

}

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Identification by passport' – 32",

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

}

}

},

"comp": [

{

"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": "Component name"

},

{

"identdoc": {

"ident": {

"csexref": "Value from the 'Sex' (value from ref.1)",

"csex": "Sex (code from ref.1)",

"bdate": "Date of birth",

"mname": "Middle name",

"fname": "First name",

"lname": "Last name",

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

"lngref": "Value from the 'Part presentation language' reference book (value from ref.23)",

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

"vdate": "Date of the information from this part "

},

"found": "Found? (Code from ref.60)",

"foundref": "Found? (Value from ref.60)",

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

"dtyperef": "Document type (value from ref.7)",

"dser": "Document series",

"dnom": "Document number",

"dwdt": "Document issue date"

},

"identdocmvds": {

"identdocmvd": {

"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": "Found? (Code from ref.27)",

"foundref": "Found? (Value from ref.27)",

"foundtitle": "Search result description",

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

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

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

"dtyperef": "Document type (Meaning from ref.7)"

},

"id": "39",

"descr": "Names of components"

}

]

}

}

Request XML

<?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): 'Identification by passport' – 32" reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

<i reqlng="Search criteria language (code from ref.23)">

<!-- Subject identification parameters-->

<docs>

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

dser="Document series"

dnom="Document number" />

</docs>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

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

</billing>

</tech>

<!-- Alert -->

<comp id="18" descr="Назва компоненти">

<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"

nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

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

<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

crdeal="Ідентифікатор угоди (референс)"

source="Вид оскарження (Код із ref.48)"

sourceref="Вид оскарження (Значення із ref.48)"

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

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

vdate="Дата створення заявки" />

<commentcki comment="Коментар суб'єкта кредитної історії"

vdate="Дата створення коментаря" />

<plost pser="Серія паспорта, заявлено СКІ як загублений (крадіжка)"

pnom="Номер паспорта, заявлено СКІ як загублений (крадіжка)"

crdate="Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ"

ldate="Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ" />

<changedeal crdeal="Ідентифікатор угоди (референс)"

changecode="Код причини коригування/видалення даних (Код із ref.62)"

changeref="Текст причини коригування/видалення даних (Значення із ref.62)"

vdate="Дата коригування/видалення даних" />

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

<!-- Credit history subject identification by Passport part -->

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

<identdoc found="Found? (Code from ref.60)"

foundref="Found? (Value from ref.60)"

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

dtyperef="Document type (value from ref.7)"

dser="Document series"

dnom="Document number"

dwdt="Document issue date">

<ident csexref="Value from the 'Sex' (value from ref.1)"

csex="Sex (code from ref.1)"

bdate="Date of birth"

mname="Middle name"

fname="First name"

lname="Last name"

inn="TIN of the credit history subject"

lngref="Value from the 'Part presentation language' reference book (value from ref.23)"

lng="Part presentation language (code from ref.23)"

vdate="Date of the information from this part " />

</identdoc>

<!-- Block for converting documents for validity -->

<identdocmvd found="Found? (Code from ref.27)"

foundref="Found? (Value from ref.27)"

foundtitle="Search result description"

pser="Series of the required passport"

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

dtype="Document type (Code from ref.7)"

dtyperef="Document type (Meaning from ref.7)">

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

</identdocmvd>

</comp>

</ubkidata>

Example (no passport matches found)

Example (no passport matches found)

Request JSON

{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "docs": { "doc": { "dtype": "1", "dser": "КО", "dnom": "220394" } }, "reqlng": "4" }, "version": "1.0", "reqtype": "32", "reqreason": "2" } } }, "sessid": "EDF4309796114D6D9B8365370DA2DEE9" } } }

Response JSON

{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report", "stm": "2022-11-29 10:17:54.627", "ftm": "2022-08-29 10:17:55.605" } }, "reqinfo": { "reqid": "req2#000002461372" } }, "comp": { "identdoc": { "found": "2", "foundref": "More than one found", "dtype": "1", "dtyperef": "Passport", "dser": "КО", "dnom": "220394", "dwdt": "" }, "id": "39", "descr": "Identification of CHS by passport" } } }

Request XML

<?xml version="1.0" encoding="UTF-8"?> <doc> <ubki sessid="EDF4309796114D6D9B8365370DA2DEE9"> <req_envelope> <req_xml> <request version="1.0" reqtype="32" reqreason="2"> <i reqlng="4"> <docs> <doc dtype="1" dser="КО" dnom="220394" /> </docs> </i> </request> </req_xml> </req_envelope> </ubki> </doc>

Response XML

Example (found matching passport)

Example (found matching passport)

Request JSON

Response JSON

Request XML

Response XML

Test URL

Test data

  • <doc dtype="1" dser="ДО" dnom="270000" />

  • <doc dtype="17" dser="" dnom="001013900" />

  • <doc dtype="1" dser="СЕ" dnom="311111" />

  • <doc dtype="1" dser="ДД" dnom="222222" />

  • <doc dtype="1" dser="ВВ" dnom="142228" />

More than one found

  • <doc dtype="1" dser="КО" dnom="220394" />

  • <doc dtype="1" dser="СЮ" dnom="170000" />

Found in the list of invalid passports

  • <doc dtype="1" dser="АМ" dnom="578072" />