...
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON |
Expand | ||
---|---|---|
| ||
{ "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" }, "fotoverif": { "freqtype": "Request Type", "inn": "INN- RNUKPN", "facelogic": "Type of algorithm for a person search", "foto": "base64(Photo)", "fotoext": "Extension to the photo of the incoming request (jpeg)", "phone": "Phone for comparison" }, "reqlng": "Search criteria language (Code from ref.23)" }, "version": "1.0", "reqtype": "Template code (Code from ref.49): Report 'Photo Verification' - 17", "reqreason": "Purpose of the request (Code from ref.24)" }, "descr": "Request object" }, "descr": "Request envelope" }, "sessid": "Session key (we receive it from the API authorization)" } } } |
( **parameters are passed optionally)
Response JSON
|
<?xml version="1.0" encoding="utf-8"?>
<doc>
<ubki sessid="Session key (we receive it from the API authorization)">
<req_envelope descr="Request envelope">
<req_xml descr="Request object">
<!-- Request Parameters -->
<request version="1.0" reqtype="Template code (Code from ref.49): Report 'Photo Verification' - 17" reqreason="Purpose of the request (Code from ref.24)">
<!-- Parameters, describing the search criteria-->
<i reqlng="Search criteria language (Code from ref.23)">
<!-- Parameters of the subject identification -->
<ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)"
lname="**Last name"
fname="**First name"
mname="**Middle name"
bdate="**Date of birth">
</ident>
<!-- Parameters for photo verification -->
<fotoverif freqtype="Request Type"
inn="INN- RNUKPN"
facelogic="Type of algorithm for a person search"
foto="base64(Photo)"
fotoext="Extension to the photo of the incoming request (jpeg)"
phone="Phone for comparison" />
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc>
Request type "freqtype" -
1 - at its own base photo (the conversion of the input photo from the photo, which was previously transferred to the bureau)
2 - in the base of the photos of the other banks (reconversion of the input photograph with the photographs, which were transferred to the bureau by other organizations, the Crimean authorities)
3 - adjusting two particulars in the photo (revision of 2 input photos from your organization, you need to adjust additional parameters for another photo if you supply them fotodocext = "extended to a photo", fotodoc "=" photo in
4 - reserved
5 - in the base of the photo of the compromised individuals (re-copying of the photo at the base of the compromised individuals - shakhrai, anger, individuals that move from the authorities)
6 - check the photo of the document (the photo of the client's document is entered to check the photographs of the individual in the base of the bureau)
7 - two faces in one photo, for example, a person from a passport and revealing a people, who trim a passport.
Response XML
title | body: |
---|
<?xml version="1.0" encoding="utf-8"?>
<ubkidata>
<!-- System information block -->
<tech>
<trace>
<step name="Step name" stm="Date - stamp of the starting step" ftm="Date - stamp of the ending step">
<!-- The trace block contains metrics for timing of the steps for components formation -->
</step>
</trace>
<error errtype="Error code (Code from ref.0)" errtext="Error text (Value from ref.0)">
</error>
<reqinfo reqid="Outstanding ID request, generated by the Ukrainian Bureau of Credit History">
</reqinfo>
<!-- The block of information on the current state of the prepaid account-->
<billing>
<balance value="Balance amount" date="Date" time="Time" />
</billing>
</tech>
<!-- Block “Photo verification” -->
<comp id="16" descr="Components name">
<fotoverif freqtype="Request type (1 – in the in-house photo-database, 2 – in photo-databases of other banks, 3 – comparison of two persons on the photo (for example, face in the passport and face of the person holding it), 4 – reserved, 5 – in the photo-database of compromised persons, 6 – comparison with the photo from the document)"
bdfd="A checking sign by compromised persons’ photo database (Code from ref.47)"
fotofd="base64(Photo) photo of a compromised person"
fotoextfd="Expansion to the photo of a compromised person"
commentfd="Commentary on the results of comparison"
verifclient="The sign of the photo match (Code from ref.47)"
fotovc="base64(Photo) sample photo"
fotoextvc="Extension to the photo of the sample photo"
commentvc="Comment on the results of comparison with the sample photo"
confidencefd="A measure of similarity of persons when compared with a photo of a compromised person"
confidencevc="A measure of the similarity of individuals in the customers’ photos"
datefotovc="Date of a sample photo"
phonematch="Result of phones checking"
phonematchref="Result of phones checking in text form" />
<!-- Block "Search in the Register of application photos" -->
<gray inn="TIN, according to which the query register worked"
foto="base64 (Photo) photographing faces from the registry of requests"
fotoext="Extension to the photo of a person from the registry of requests"
datefoto="Date photos from the registry of requests"
confidence=
|
|
|
algsearch="Search type (1 - for a given TIN, 2 - for a given photo)"
algsearchdescr="Type of search in text form" />
<!-- Block "Search in the database of missing people" -->
<resultsearch state="Status of the natural person"
category="Classification of the status of the physical person in text form"
lnameua="Last Name in Ukrainian"
fnameua="Name in Ukrainian"
mnameua="Patronymic in Ukrainian"
lnameru="Last Name in Russian"
fnameru="Name in Russian"
mnameru="Patronymic in Russian"
bdate="Date of birth"
lostdate="date of disappearance"
lostplace="Place of Extinction"
restraint="preventive measure"
contact="Contacts to inform"
confidence="A measure of the similarity of individuals when compared with a photo from the base of the missing person"
foto="base64 (Photo) photographing faces from the base of missing persons"
fotoext="Extension to a photo of a person from the base of missing persons" />
</comp>
<!-- Client 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)"
inn="INN (for natural persons)/OKPO (for legal entities)">
<pretension inn="INN (for natural persons)/OKPO (for legal entities)"
crdeal=
|
source="Disputing type (Code from ref.48)"
sourceref="Disputing type
|
|
|
<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>
</comp>
</ubkidata>
Example
Request JSON
|
Request XML |
Expand | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <doc> <ubki sessid="Session key (we receive it from the API authorization)"> <req_envelope descr="Request envelope"> <req_xml descr="Request object"> <!-- Request Parameters --> <request version="1.0" reqtype="Template code (Code from ref.49): Report 'Photo Verification' - 17" reqreason="Purpose of the request (Code from ref.24)"> <!-- Parameters, describing the search criteria--> <i reqlng="Search criteria language (Code from ref.23)"> <!-- Parameters of the subject identification --> <ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)" lname="**Last name" fname="**First name" mname="**Middle name" bdate="**Date of birth"> </ident> <!-- Parameters for photo verification --> <fotoverif freqtype="Request Type" inn="INN- RNUKPN" facelogic="Type of algorithm for a person search" foto="base64(Photo)" fotoext="Extension to the photo of the incoming request (jpeg)" phone="Phone for comparison" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
Request type "freqtype" -
1 - at its own base photo (the conversion of the input photo from the photo, which was previously transferred to the bureau)
2 - in the base of the photos of the other banks (reconversion of the input photograph with the photographs, which were transferred to the bureau by other organizations, the Crimean authorities)
3 - adjusting two particulars in the photo (revision of 2 input photos from your organization, you need to adjust additional parameters for another photo if you supply them fotodocext = "extended to a photo", fotodoc "=" photo in
4 - reserved
5 - in the base of the photo of the compromised individuals (re-copying of the photo at the base of the compromised individuals - shakhrai, anger, individuals that move from the authorities)
6 - check the photo of the document (the photo of the client's document is entered to check the photographs of the individual in the base of the bureau)
7 - two faces in one photo, for example, a person from a passport and revealing a people, who trim a passport.
Example |
---|
Request JSON |
|
Response JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Request XML |
|
...