Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Response XML

Expand

Request

XML

JSON
( **parameters are passed optionally)

Expand
title body:

{

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

</ident>

<!-- Parameters for photo verification -->

<fotoverif freqtype= },

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

},

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

}

}

}

<step name="Step name" stm="Date - stamp of the starting step" ftm="Date - stamp of the ending step

Request XML
( **parameters are passed optionally)

Expand
title body:

<?xml version="1.0" encoding="utf-8"?>

<ubkidata>

<!-- System information block -->

<tech>

<trace>

<doc>

<ubki sessid="Session key (we receive it from the API authorization)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!--

The trace block contains metrics for timing of the steps for components formation <error errtype="Error

Request Parameters -->

</step>

</trace>

<request version="1.0" reqtype="Template code (Code from ref.

0)" errtext="Error text (Value

49): Report 'Photo Verification' - 17" reqreason="Purpose of the request (Code from ref.

0

24)">

<

/error>

<reqinfo reqid="Outstanding ID request, generated by the Ukrainian Bureau of Credit History">

</reqinfo>

!-- Parameters, describing the search criteria-->

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

<!--

The block

Parameters of

information on the current state of the prepaid account </tech>

the subject identification -->

<billing>

<balance value="Balance amount" date="Date" time="Time" />

</billing>

<ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)"

lname="**Last name"

fname="**First name"

mname="**Middle name"

bdate="**Date of birth">

</ident>

<!--

Block “Photo verification”

Parameters for photo verification -->

<comp id

<fotoverif freqtype="

16

Request Type"

descr

inn="

Components name

INN- RNUKPN"

>

<fotoverif freqtype

facelogic="

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>

Example

Request

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

Expand
titlebody:

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

Example

Request JSON

Code Block
{
	"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"
		}
	}
}

Request XML

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

Response XML

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

...