Page Comparison

...

Http Method	POST
Request URL	https://secure.ubki.ua/b2_api_xml/ubki/xml

Request JSON

Expand

title	body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "INN-RNUKPN (for the natural persons)"

},

"photocheck": {

"photo": "base64(Photo)",

"photoext": "Extension to the photo of the incoming request (jpeg/jpg)"

},

"reqlng": "Search criteria language (Code from ref.23)"

},

"version": "1.0",

"reqtype": "Template code (Code from ref.49): Report 'Photo verification LIGHT' - 43",

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

Expand

title	body:

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

<tech>

<trace>

</step>

</trace>

</error>

</reqinfo>

</billing>

</tech>

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

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

inn="INN (for natural persons)/OKPO (for legal entities)">

<pretension inn="INN (for natural persons)/OKPO (for legal entities)"

Response JSON

Expand

title	body:

{

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

{

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

"claim" : "Subject of dispute (Code from ref. 69)",

"claimref": "Subject of dispute (Value from ref. 69)",

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

},

"freezedate": "FREEZE option connection date",

"nonewdealcomment": "Comment",

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

},

"idfcert": "18",{

"descrinn": "Components nameTIN" }, {

"photocheckcert": { "okpo": "INN-RNUKPN (for the natural persons"Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) ",

"bdfdcertref": "A checking sign by compromised persons’ photo database (Code Availability of a certificate from the UBCH (value from ref. 4756)",

"commentfdcertid": "Comment on comparison resultsCertificate number",

"confidencefdcerturl": "A measure of similarity of persons when compared with a photo of a compromised person", "verifclient": "The sign of the photo match (Code from ref.47)Link to the certificate"

},

"maybegone": {

"inn": "TIN",

"commentvcvdate": "Comment on the results of comparison with the sample photoApplication creation date",

"confidencevcdldonor": "A measure of the similarity of individuals in the customers’ photosInformation provider (code from ref. 54)"

},

"resultsearchid": {"18",

"statedescr": "Status of the natural person"Components name"

},

{

"categoryphotocheck": "Classification of the status of the physical person in text form",{

"lnameuaokpo": "Last Name in UkrainianINN-RNUKPN (for the natural persons)",

"fnameuabdfd": "Name in UkrainianA checking sign by compromised persons’ photo database (Code from ref.47)",

"mnameuacommentfd": "Patronymic in UkrainianComment on comparison results",

"lnameruconfidencefd": "Last Name in RussianA measure of similarity of persons when compared with a photo of a compromised person",

"fnameruverifclient": "Name in Russian", "mnameru": "Patronymic in RussianThe sign of the photo match (Code from ref.47)",

"commentvc": "Comment on the results of comparison with the sample photo",

"bdateconfidencevc": "Date of birth", "lostdateA measure of the similarity of individuals in the customers’ photos"

},

"resultsearch": {

"state": "date Status of disappearancethe natural person",

"lostplacecategory": "Place of ExtinctionClassification of the status of the physical person in text form",

"restraintlnameua": "preventive measureLast Name in Ukrainian",

"contactfnameua": "Contacts to informName in Ukrainian",

"confidencemnameua": "A measure of the similarity of individuals when compared with a photo from the base of the missing personPatronymic in Ukrainian",

"fotolnameru": "base64 (Photo) photographing faces from the base of missing personsLast Name in Russian",

"fotoextfnameru": "Extension to a photo of a person from the base of missing persons" }Name in Russian",

"idmnameru": "65",

"descr": "Components name"

},

{

"person": {Patronymic in Russian",

"bdate": "Date of birth",

"lngreflostdate": "Search/transfer language (ref. 23)date of disappearance",

"lnglostplace": "Part presentation language, value (ref. 23)Place of Extinction",

"mnamerestraint": "Middle namepreventive measure",

"fnamecontact": "First nameContacts to inform",

"lnameconfidence": "Last nameA 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",

"inn fotoext": "TIN of the credit history subject",Extension to a photo of a person from the base of missing persons"

},

"id": "7265",

"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

Expand

title	body:

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

<doc>

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<photocheck photo="base64(Photo)"

photoext="Extension to the photo of the incoming request (jpeg/jpg)" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Components name"

},

{

"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

Expand

title	body:

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

<doc>

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<photocheck photo="base64(Photo)"

photoext="Extension to the photo of the incoming request (jpeg/jpg)" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand

title	body:

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

<tech>

<trace>

</step>

</trace>

</error>

</reqinfo>

</billing>

</tech>

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

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

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

claim="Subject of dispute (Code from ref. 69)"

claimref="Subject of dispute (Value from ref. 69)"

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

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

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

claim="Subject of dispute Code for the reason of correction/deletion of data (Code from ref. 6962)" claimref

changeref="Subject of dispute Text of the reason for correcting/deleting data (Value from ref. 6962)"

vdate="Date of the request creationdata correction/deletion" />

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

</

</pret>

<fcert inn="TIN"

cert="Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) "

certref="Availability of a certificate from the UBCH (value from ref. 56)"

certid="Certificate number"

certurl="Link to the certificate" />

<maybegone inn="TIN"

vdate="Application creation date"

dldonor="Information provider (code from ref. 54)"/>

</comp>

<photocheck okpo="INN-RNUKPN (for the natural persons)"

bdfd="A checking sign by compromised persons’ photo database (Code from ref.47)"

commentfd="Comment on comparison results"

confidencefd="A measure of similarity of persons when compared with a photo of a compromised person"

verifclient="The sign of the photo match (Code from ref.47)"

commentvc="Comment on the results of comparison with the sample photo"

confidencevc="A measure of the similarity of individuals in the customers’ photos" />

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

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

</comp>

</ubkidata>

...

Request JSON

Code Block

{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
				"req_envelope				"okpo": {"3278508288"
				"req_xml": {
			},
							"requestphotocheck": {
								"iphoto": {
"/9j/4AAQSkZJRgABAQEASABI",
								"identphotoext": {
"jpg"
							},
							"okporeqlng": "32785082884"
							},
							"photocheckversion": {
 "1.0",
								"photoreqtype": "/9j/4AAQSkZJRgABAQEASABI43",
								"photoextreqreason": "jpg2"
					}
				}
			},
			"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
		}
	}
}

Response JSON

Code Block
{ "

reqlng

ubkidata": {
		"

4

tech": {
			"trace": {

},

"step": {

version

name": "

1.0

build report",

reqtype

stm": "

43

2022-08-29 14:11:49.048",

reqreason

ftm": "

2

2022-08-29 14:11:49.152"

},

},

"reqinfo": {
				"

sessid

reqid": "

EDF4309796114D6D9B8365370DA2DEE9

req2#000002461683"
			}

} }

Response JSON

Code Block

{	},
		"ubkidatacomp": {[
		"tech": 	{
				"tracepret": {
					"stepinn": {"3278508288",
					"namenonewdeal": "build report0",
					"stmnonewdealref": "2022-08-29 14:11:49.048No",
					"ftmnonewdealcomment": "2022-08-29 14:11:49.152"",
				}
		"freezedate":""
				},
				"reqinfofcert": {
					"reqidinn": "req2#0000024616833278508288",
			}
		}"cert": "0",
					"compcertref": [
			{
"No",
					"pretcertid": {"",
					"inncerturl": "3278508288"
				},
					"nonewdealmaybegone": "0",{
					"nonewdealrefinn": "No3278508288",
					"nonewdealcommentvdate": "" "2022-12-01",
					"freezedatedldonor": "BNK"
				},
				"id": "18",
				"descr": "Alert"
			},
			{
				"photocheck": {
					"okpo": "3278508288",
					"bdfd": "1",
					"commentfd": "The suspicion is confirmed by the photo",
					"confidencefd": "0.73668",
					"verifclient": "2",
					"commentvc": "The suspicion is confirmed by the photo",
					"confidencevc": "0.90923"
				},
				"id": "65",
				"descr": "Photo Verification LIGHT"
			}
		]
	}
}

...

Response XML

Code Block

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-08-29 14:11:49.048" ftm="2022-08-29 14:11:49.152"/>
        </trace>
        <reqinfo reqid="req2#000002461683"/>
    </tech>
    <comp id="18" descr="Alert">
        <pret inn="3278508288" nonewdeal="0" nonewdealref="No"     <reqinfo reqidnonewdealcomment="" freezedate="req2#000002461683" />
     </tech>   <fcert inn="3278508288"  <comp idcert="0" certref="No" certid="18" descrcerturl="Alert" />
        <pret<maybegone inn="3278508288" nonewdealvdate="02022-12-01" nonewdealrefdldonor="No" nonewdealcomment="" freezedate="BNK" />
    </comp>
    <comp id="65" descr="Photo Verification LIGHT">
        <photocheck okpo="3278508288" bdfd="1" commentfd="The suspicion is confirmed by the photo" confidencefd="0.73668" verifclient="2" commentvc="The suspicion is confirmed by the photo" confidencevc="0.90923"/>
    </comp>
</ubkidata>

...

Versions Compared

Old Version 13

New Version Current

Key

Http Method

POST

Request URL

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

Request JSON

Response XML

Response JSON

Request XML

Request XML

Response XML

Request JSON

Response JSON

Response JSON

Response XML