...
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)" } } } |
Response JSON
|
Request XML
( **parameters are passed optionally)
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
title | body: |
---|
|
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" |
|
<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
|
Response XML
|
freqtype | Description | Reconciliation of incoming photos only, without connection of internal bases | Search in the database of creditor reference photos | Search in the fraud database | Search in the Register of application photos | Search in the database of missing people | Persons wanted | |
---|---|---|---|---|---|---|---|---|
At its own base photo | 1 | Checking the incoming photo with your own photo, which was previously submitted to the bureau | - | - | - | - | - | - |
In the base of the photos of the other banks | 2 | The incoming photo is checked against the historical photos of all donor organizations except our own | - | + | + | + | + | + |
Comparison of two persons on the photo | 3 | Two photos are sent to the entrance. The person in the first photo is compared with the person in the second photo, in the request you need to send additional parameters for the second photo fotodocext="extension to photo", fotodoc ="photo in base64" | + | - | - | - | - | - |
In the base of the photo of the compromised individuals | 5 | The face in the input photo is checked only against the fraud database. | - | - | + | - | - | - |
Check the photo of the document | 6 | Only a photo of the document without the identity of the client is sent to the entrance. The reconciliation comes with historical photos of all photo donor organizations. | - | + | + | + | + | + |
Comparison of two faces in one photo | 7 | At the entrance, one photo with two people is sent (for example, the client is holding a passport). These two people are reconciled. | + | - | - | - | - | - |
Example |
---|
Request JSON Code Block | JSON |
|
Response JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Response JSON |
|
...
Response XML |
|
XSD Schema request | https://secure.ubki.ua/b2/js/xsd/request17.xsd |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response17.xsd |
...