1. Maximum size of a request with an encoded photo is 2 Mb

2. File extension - jpeg/jpg

3. XML request - photo base64

4. The higher quality of a face image means the better recognition accuracy: frontal, transparent and face size - 200x200 pixels (100 pixels between the eyes) or more.

5. The face area in the photo has to compose a maximum possible share of the entire image;

6. The photo must be clear, not fuzzy;

7. The color and brightness of the background have to provide a reliable definition of a head contour.

8. Location and lighting:

- The head location - without turning, straight, and the sight has to be directed strictly at the camera. The head bends or turnings in any direction or face focus changing will lead to deformation of the comparison results;

- There has to be no shadows from the head against the background, there has to be no shadows on the face or any objects;

- It isn’t recommended the close eyes on images of face; hair that covers the eyes and face;

- It isn’t recommended any light reflections and shadows at the images of faces;

- It isn’t recommended a photo with background: street, car, fences, trees, etc.

9. Glasses and headwears:

- It isn’t recommended on the images the availability of clothing elements, that cover (partially or completely) a face, i.e. hats, shawls, etc.; the thick frames of glasses, which deform the facial features;

- It is not recommended the reflections of flashes or highlightings reflected in the glasses of lenses or glasses.

10. Expression and frame:

- It is not recommended the availability of other person behind the face image;

- The look at the camera should be with a neutral facial expression and with closed mouth.

{

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

}

}

}

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Step name",

"stm": "Date - stamp of the starting step",

"ftm": "Date - stamp of the ending step"

}

},

"error": {

"errtype": "Error code (code from ref.0)",

"errtext": "Error text (value from ref.0)"

},

"reqinfo": {

"reqid": "Outstanding ID request, generated by the Ukrainian Bureau of Credit History"

},

"billing": {

"balance": {

"value": "Balance amount",

"date": "Date",

"time": "Time"

}

}

},

"comp": [

{

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

},

"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": "A measure of the similarity of individuals when compared with a photo from the registry of requests",

"algsearch": "Search type (1 - for a given TIN, 2 - for a given photo)",

"algsearchdescr": "Type of search in text form"

},

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

},

"id": "16",

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

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

},

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

},

"id": "18",

"descr": "Components name"

}

]

}

}

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

<?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="A measure of the similarity of individuals when compared with a photo from the registry of requests"

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="Transaction identifier (reference)"

source="Disputing type (Code from ref.48)"

sourceref="Disputing type (Value from ref.48)"

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>

</comp>

</ubkidata>

{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "3278508288",
								"mname": "VASYLIVNA",
								"fname": "IRINA",
								"lname": "HARNA",
								"bdate": "1989-10-05"
							},
							"fotoverif": {
								"freqtype": "2",
								"inn": "3278508288",
								"facelogic": "3",
								"fotoext": "jpg",
								"phone": "+380962134234",
								"foto": "/9j/4AAQSkZJRgABAQEASABIAA"
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "17",
						"reqreason": "2"
					}
				}
			},
			"sessid": "6D7D781B1E884A6AB384481804A35EA8"
		}
	}
}

{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-08-25 15:36:10.798",
					"ftm": "2022-08-25 15:36:10.936"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002459882"
			}
		},
		"comp": [
			{
				"fotoverif": {
					"reqtype": "1",
					"bdfd": "1",
					"fotofd": "/9j/4AAQuLr5N2zke9//2Q==",
					"fotoextvc": "jpeg",
					"datefotovc": "2018-11-21",
					"commentvc": "The suspicion is not confirmed by the photo",
					"confidencevc": "0.90923",
					"phonematch": "2",
					"phonematchref": "there is a phone match"
				},
				"id": "16",
				"descr": "Photo Verification"
			},
			{
				"pret": {
					"inn": "3278508288",
					"nonewdeal": "0",
					"nonewdealref": "No",
					"nonewdealcomment": ""
				},
				"id": "18",
				"descr": "Client alert"
			}
		]
	}
}

<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="6D7D781B1E884A6AB384481804A35EA8">
    <req_envelope>
      <req_xml>
        <request version="1.0" reqtype="17" reqreason="2">
          <i reqlng="4">
            <ident okpo="3278508288" mname="VASYLIVNA" fname="IRINA" lname="HARNA" bdate="1989-10-05" />
            <fotoverif freqtype="2" inn="3278508288" facelogic="3" fotoext="jpg" phone="+380962134234" foto="/9j/4AAQSkZJRgABAQEASABIAA" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-08-25 15:36:10.798" ftm="2022-08-25 15:36:10.936" />
    </trace>
    <reqinfo reqid="req2#000002459882" />
  </tech>
  <comp id="16" descr="Photo Verification">
    <fotoverif reqtype="1" bdfd="1" fotofd="/9j/4AAQuLr5N2zke9//2Q==" fotoextvc="jpeg" datefotovc="2018-11-21" commentvc="The suspicion is not confirmed by the photo" confidencevc="0.90923" phonematch="2" phonematchref="there is a phone match" />
  </comp>
  <comp id="18" descr="Client alert">
    <pret inn="3278508288" nonewdeal="0" nonewdealref="No" nonewdealcomment="" />
  </comp>
</ubkidata>