Versions Compared

Old Version 6

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version Current

changes.mady.by.user Оксана Нечепоренко

Saved on

Key

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

...

Info

The report contains the following components:

Http Method

POST

Request URL

https://secure.ubki.ua/b2_api_xml/ubki/xml

Request JSON
( ** parameters are passed optionally)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "РНОКПП (ІПН) фізособи",

"lname": "**Прізвище",

"fname": "**Ім'я",

"mname": "**По батькові",

"bdate": "**Дата народження"

},

"liveness": {

"imgdata0": "First photo from series in base64",

"imgdata1": "Second photo from series in base64",

"imgdata2": "The third photo from the series in base64",

"imgdata3": "The fourth photo from the series in base64",

"imgdata4": "Fifth photo from the series in base64"

},

"reqlng": "Language of search criteria (Code from ref.23)"

},

"version": "1.0",

"reqtype": "Template code (Code from ref.49): Photo reality detection service - 3",

"reqreason": "The purpose of the request (Code from ref.24)"

},

"descr": "Request Object"

},

"descr": "Request Envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

Response JSON

Expand
titlebody:

{

"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": "Outbound request ID generated by UBKI"

},

"billing": {

"balance": {

"value": "Balance amount",

"date": "Date",

"time": "Time"

}

}

},

"

comp

billdetails": {

"

liveness

freemon":

{

"inn": "TIN from the request",

"lname": "Last name from request",

"fname": "Name from request",

"mname": "Middle name from request",

"bdate": "Date of birth from request",

"probabilityspoof": "Probability of photo fraud"

},

"id": "47",

"descr": "Liveness detection"

}

}

}

Request XML
( ** parameters are passed optionally)

Expand
title body:

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

<!-- Query parameters -->

<request version="1.0" reqtype="Template code (Code from ref.49): Photo reality detection service - 3" reqreason="The purpose of the request (Code from ref.24)">

<!-- Parameters describing search criteria -->

<i reqlng="Language of search criteria (Code from ref.23)">

<!-- Subject identification parameters -->

<ident okpo="РНОКПП (ІПН) фізособи"

lname="**Прізвище"

fname="**Ім'я"

mname="**По батькові"

bdate="**Дата народження" />

<!-- Query parameters for determining reality -->

<liveness imgdata0="First photo from series in base64"

imgdata1="Second photo from series in base64"

imgdata2="The third photo from the series in base64"

imgdata3="The fourth photo from the series in base64"

imgdata4="Fifth photo from the series in base64" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand

"Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)",

"freemonref": "Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"

}

}

},

},

"comp": {

"liveness": {

"inn": "TIN from the request",

"lname": "Last name from request",

"fname": "Name from request",

"mname": "Middle name from request",

"bdate": "Date of birth from request",

"probabilityspoof": "Probability of photo fraud"

},

"id": "47",

"descr": "Liveness detection"

},

{

"person": {

"bdate": "Date of birth",

"lngref": "Search/transfer language (ref. 23)",

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

"mname": "Middle name",

"fname": "First name",

"lname": "Last name",

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

},

"id": "72",

"descr": "Search by full name + inn if more than 1 person is found (The presence of the component is determined by searching for more than 1 person in the case of searching by full name + inn)"

}

]

}

}

Request XML
( ** parameters are passed optionally)

Expand
title body:

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

><ubkidata>

>

<doc>

<ubki sessid="Session key (obtained from the authorization API)">

<req_envelope descr="Request Envelope">

<req_xml descr="Request Object">

<!--

System information block

Query parameters -->

<tech>

<trace>

<step name

<request version="

Step name" stm="Step start stamp date" ftm="Step finish stamp date

1.0" reqtype="Template code (Code from ref.49): Photo reality detection service - 3" reqreason="The purpose of the request (Code from ref.24)">

<!--

The trace block contains timing metrics for the steps of forming components <!-- Block for determining the reality of a photo

Parameters describing search criteria -->

</step>

</trace>

<error errtype="Error code (Code from ref.0)" errtext="Error text (Value from ref.0)">

</error>

<reqinfo reqid="Outbound request ID generated by UBKI">

</reqinfo>

<!-- Block of information on the current state of the prepaid account -->

<billing>

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

</billing>

</tech>

<i reqlng="Language of search criteria (Code from ref.23)">

<!-- Subject identification parameters -->

<ident okpo="РНОКПП (ІПН) фізособи"

lname="**Прізвище"

fname="**Ім'я"

mname="**По батькові"

bdate="**Дата народження" />

<!-- Query parameters for determining reality -->

<liveness imgdata0="First photo from series in base64"

imgdata1="Second photo from series in base64"

imgdata2="The third photo from the series in base64"

imgdata3="The fourth photo from the series in base64"

imgdata4="Fifth photo from the series in base64" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

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

<ubkidata>

<!-- System information block -->

<tech>

<trace>

<step name="Step name" stm="Step start stamp date" ftm="Step finish stamp date">

<!-- The trace block contains timing metrics for the steps of forming components -->

</step>

</trace>

<error errtype="Error code (Code from ref.0)" errtext="Error text (Value from ref.0)">

</error>

<reqinfo reqid="Outbound request ID generated by UBKI">

</reqinfo>

<!-- Block of information on the current state of the prepaid account -->

<billing>

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

<billdetails freemon="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)"

freemonref="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"/>

</billing>

</tech>

<!-- Block for determining the reality of a photo -->

<comp id="47" descr="Liveness detection">

<liveness inn="TIN from the request"

lname="Last name from request"

fname="Name from request"

mname="Middle name from request"

bdate="Date of birth from request"

probabilityspoof="Probability of photo fraud" />

</comp>

<!-- Search by full name + inn if more than 1 person is found (The presence of the component is determined by searching for more than 1 person in the case of searching by full name + inn)-->

<comp id="

47

72" descr="Search by full name + inn if more than 1 person is found">

<person bdate="Date of birth"

lngref=

"Liveness detection">

<liveness inn="TIN from the request"

lname="Last name from request

"Search/transfer language (ref. 23)"

lng="Part presentation language, value (ref. 23)"

mname="Middle name"

fname="

Name from request

First name"

mname

lname="

Middle

Last name

from request

"

bdate

inn="

Date of birth from request" probabilityspoof="Probability of photo fraud

TIN of the credit history subject" />

</comp>

</ubkidata>

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"bdate": "1957-10-19",
								"mname": "ІГОРЕВНА",
								"fname": "АННА",
								"lname": "РИБАЧКА",
								"okpo": "2111118724"
							},
							"liveness": {
								"imgdata0": "Photo base64",
								"imgdata1": "Photo base64",
								"imgdata2": "Photo base64",
								"imgdata3": "Photo base64",
								"imgdata4": "Photo base64"
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "35",
						"reqreason": "2"
					}
				}
			},
			"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-08-29 10:50:22.526",
					"ftm": "2022-08-29 10:50:22.806"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002461398"
			}
		},
		"comp": {
			"liveness": {
				"inn": "2111118724",
				"lname": "РИБАЧКА",
				"fname": "АННА",
				"mname": "ІГОРЕВНА",
				"bdate": "1957-10-19",
				"probabilityspoof": "0.3"
			},
			"id": "47",
			"descr": "Liveness detection"
		}
	}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="EDF4309796114D6D9B8365370DA2DEE9">
    <req_envelope>
      <req_xml>
        <request version="1.0" reqtype="35" reqreason="2">
          <i reqlng="4">
            <ident bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" />
            <liveness imgdata0="Photo base64" imgdata1="Photo base64" imgdata2="Photo base64" imgdata3="Photo base64" imgdata4="Photo base64" />
          </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-29 10:50:22.526" ftm="2022-08-29 10:50:22.806"/>
        </trace>
        <reqinfo reqid="req2#000002461398"/>
    </tech>
    <comp id="47" descr="Liveness detection">
        <liveness inn="2111118724" lname="РИБАЧКА" fname="АННА" mname="ІГОРЕВНА" bdate="1957-10-19" probabilityspoof="0.3"/>
    </comp>
</ubkidata>

XSD Schema request

https://secure.ubki.ua/b2/js/xsd/request35.xsd

XSD Schema response

https://secure.ubki.ua/b2/js/xsd/response35.xsd

Test URL

https://test.ubki.ua/b2_api_xml/ubki/xml

Test data

  • bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095"

  • bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593"

  • bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397"

  • bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116"

  • bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="3333312110"

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" okpo="3112579786"

  • bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724"

  • bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288"

<comp id="72" descr="Search by full name + inn if more than 1 person is found">

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА"