Page Comparison

...

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

Request JSON/Checking if the combination of the phone and date of birth is correct
( parameters are passed optionally)**

Expand

title	body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"phoneverif": {

"phone": "Mobile phone",

"bdate": "Date of birth",

"**channelotp": "sms"

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Identification by phone number and date of birth' report – 34",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

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

}

Response JSON

Expand

title	body:

{

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

},

"billing": {

"balance": {

"value": "Total assets",

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

}

},

"comp": {

"phoneverif": {

"phone": "Mobile phone",

"bdate": "Date of birth",

"mathch": "Phones verification result (code from ref.56)",

"matchref": "Phones verification result in text format (ref.56)"

},

"id": "45",

"descr": ""

}

...

Response XML

Expand

title	body:

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

<tech>

<trace>

</step>

</trace>

</error>

</reqinfo>

</billing>

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

<phoneverif phone="Mobile phone"

bdate="Date of birth"

mathch="Phones verification result (code from ref.56)"

matchref="Phones verification result in text format (ref.56)" />

</comp>

</ubkidata>

...

Response JSON

Expand

title	body:

{

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

},

"billing": {

"balance": {

"value": "Total assets",

"date": "Date",

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

}

},

"comp": [

{

"cki": {

"ident": {

"donor": "Source of information (code from ref. 54)",

"vdate": "Date of the information from this part",

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

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

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

"lname": "Last name",

"fname": "First name",

"mname": "Middle name",

"bdate": "Date of birth",

"csex": "Sex (code from ref.1)",

"csexref": "Sex (value from ref.1)",

"family": "Marital status (code from ref.2)",

"familyref": "Marital status (value from ref.2)",

"ceduc": "Education (code from ref.3)",

"ceducref": "Education (value from ref.3)",

"cgrag": "Citizenship (code from ref.4)",

"cgragref": "Citizenship (value from ref.4)",

"spd": "Presence of the business entity’s registration (code from ref.5)",

"spdref": "Presence of the business entity’s registration (value from ref.5)",

"sstate": "Social status (code from ref.6)",

"sstateref": "Social status (value from ref.6)",

"cchild": "Number of children"

},

"work": {

"wdonor": "Source of information (code from ref. 54)",

"vdate": "Date of the information from this part",

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

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

"cdolgn": "Official position (code from ref.8)",

"cdolgnref": "Official position (value from ref.8)",

"wokpo": "EDRPOU of the employer",

"wname": "Name of the employer in the base language",

"wstag": "Length of service, years completed",

"wdohod": "Client’s monthly income"

},

"doc": {

"ddonor": "Source of information (code from ref. 54)",

"vdate": "Date of the information from this part",

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

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

"dtype": "Document type (code from ref.7)",

"dtyperef": "Document type (value from ref.7)",

"dser": "Document series",

"dnom": "Document number",

"dterm": "Expiration date",

"dwho": "Document issuer",

"dwdt": "Document issue date",

"eddr_number": "Unique record number in the Unified State Demographic Register"

},

"addr": {

"addonor": "Source of information (code from ref. 54)",

"vdate": "Date of the information from this part",

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

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

"adtype": "Address type (code from ref.9)",

"adtyperef": "Address type (value from ref.9)",

"adcountry": "Country (two-character code from ISO 3166 reference book)",

"adindex": "Postal code",

"adstate": "Region",

"adarea": "District",

"adcity": "Locality",

"adcitytype": "Locality type (code from ref.22)",

"adcitytyperef": "Locality type (value from ref.22)",

"adstreet": "Street",

"adhome": "House",

"adcorp": "Block",

"adflat": "Flat",

"addrdirt": "Address in one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019)"

},

"inn": "TIN of the credit history subject/EDRPOU of the legal entity",

"lname": "Last name/Name of the legal entity",

"fname": "First name",

"mname": "Middle name",

"reqlng": "Search language (while searching)/Identification language (during transfer) (code from ref.23)",

"reqlngref": "Search language (while searching)/Identification language (during transfer) (value from ref.23)",

"bdate": "Date of birth"

},

"identdocmvds": {

"identdocmvd": {

"foundsource": {

"name": "Data source for verification (Code from ref.63)",

"found": "0/1 - digital indication of the presence of an invalid passport (Code from ref.27)",

"foundref": "Text indication of the presence of an invalid passport (Value from ref.27)",

"sourcedate": "The date of updating the information in the database or receiving a response from the API of the original source"

},

"found": "Found? (Code from ref.27)",

"foundref": "Found? (Value from ref.27)",

"foundtitle": "Search result description",

"pser": "Series of the required passport",

"pnom": "Number of required passport or ID-card number",

"dtype": "Document type (Code from ref.7)",

"dtyperef": "Document type (Meaning from ref.7)"

}

},

"id": "1",

"descr": "Names of components"

},

{

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

},

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

},

"id": "18",

"descr": "Components name"

}

]

}

...

Response XML

Expand

title	body:

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

<tech>

<trace>

</step>

</trace>

</error>

</reqinfo>

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

<cki inn="TIN of the credit history subject/EDRPOU of the legal entity"

lname="Last name/Name of the legal entity"

fname="First name"

mname="Middle name"

reqlng="Search language (while searching)/Identification language (during transfer) (code from ref.23)"

reqlngref="Search language (while searching)/Identification language (during transfer) (value from ref.23)"

bdate="Date of birth">

<ident donor="Source of information (code from ref.54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

inn="TIN of the credit history subject"

lname="Last name"

fname="First name"

mname="Middle name"

bdate="Date of birth"

csex="Sex (code from ref.1)"

csexref="Sex (value from ref.1)"

family="Marital status (code from ref.2)"

familyref="Marital status (value from ref.2)"

ceduc="Education (code from ref.3)"

ceducref="Education (value from ref.3)"

cgrag="Citizenship (code from ref.4)"

cgragref="Citizenship (value from ref.4)"

spd="Presence of the business entity’s registration (code from ref.5)"

spdref="Presence of the business entity’s registration (value from ref.5)"

sstate="Social status (code from ref.6)"

sstateref="Social status (value from ref.6)"

cchild="Number of children">

</ident>

<work wdonor="Source of information (code from ref.54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

cdolgn="Official position (code from ref.8)"

cdolgnref="Official position (value from ref.8)"

wokpo="EDRPOU of the employer"

wname="Name of the employer in the base language"

wstag="Length of service, years completed"

wdohod="Client’s monthly income">

</work>

<doc ddonor="Source of information (code from ref.54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

dtype="Document type (code from ref.7)"

dtyperef="Document type (value from ref.7)"

dser="Document series"

dnom="Document number"

dterm="Expiration date"

dwho="Document issuer"

dwdt="Document issue date"

eddr_number="Unique record number in the Unified State Demographic Register">

</doc>

<addr addonor="Source of information (code from ref.54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

adtype="Address type (code from ref.9)"

adtyperef="Address type (value from ref.9)"

adcountry="Country (two-character code from ISO 3166 reference book)"

adindex="Postal code"

adstate="Region"

adarea="District"

adcity="Locality"

adcitytype="Locality type (code from ref.22)"

adcitytyperef="Locality type (value from ref.22)"

adstreet="Street"

adhome="House"

adcorp="Block"

adflat="Flat"

addrdirt="Address in one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019)">

</addr>

</cki>

<identdocmvd found="Found? (Code from ref.27)"

foundref="Found? (Value from ref.27)"

foundtitle="Search result description"

pser="Series of the required passport"

pnom="Number of required passport or ID-card number"

dtype="Document type (Code from ref.7)"

dtyperef="Document type (Meaning from ref.7)">

<foundsource name="Data source for verification (Code from ref.63)"

found="0/1 - digital indication of the presence of an invalid passport (Code from ref.27)"

foundref="Text indication of the presence of an invalid passport (Value from ref.27)"

sourcedate="The date of updating the information in the database or receiving a response from the API of the original source" />

</identdocmvd>

</identdocmvds>

</comp>

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

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>

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

</ubkidata>

...

Response JSON

Code Block

{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-29 10:42:49.713",
					"ftm": "2022-08-29 10:42:49.998"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002461391"
			}
		},
		"comp": [
			{
				"cki": {
					"ident": {
						"cchild": "",
						"sstateref": "",
						"sstate": "",
						"spdref": "natural person",
						"spd": "1",
						"cgragref": "",
						"cgrag": "802804",
						"ceducref": "",
						"ceduc": "",
						"familyref": "",
						"family": "",
						"csexref": "woman",
						"csex": "2",
						"bdate": "1957-10-19",
						"mname": "ІГОРЕВНА",
						"fname": "АННА",
						"lname": "РИБАЧКА",
						"inn": "2111118724",
						"lngref": "Russian",
						"lng": "2",
						"vdate": "2022-02-06",
						"donor": "BNK"
					},
					"work": {
						"wdohod": "",
						"wstag": "",
						"wname": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ 'УКРАЇНСЬКА КОМПАНІЯ 'О'",
						"wokpo": "34745377",
						"cdolgnref": "Worker/specialist/performer",
						"cdolgn": "3",
						"lngref": "Ukrainian",
						"lng": "1",
						"vdate": "2021-11-07",
						"wdonor": "BNK"
					},
					"doc": {
						"dwdt": "2004-03-10",
						"dwho": "ХЕРСОНСКИМ ГО УМВД",
						"dterm": "",
						"dnom": "142228",
						"dser": "ВВ",
						"dtyperef": "Ukrainian citizen passport",
						"dtype": "1",
						"lngref": "Ukrainian",
						"lng": "1",
						"vdate": "2021-08-01",
						"eddr_number": "19571019-00027",
						"ddonor": "BNK"
					},
					"addr": {
						"adflat": "81",
						"adcorp": "",
						"adhome": "11",
						"adstreet": "ВУЛ.ЕЖЕЛЕ",
						"adcitytyperef": "",
						"adcitytype": "",
						"adcity": "М.ХЕРСОН",
						"adarea": "",
						"adstate": "ХЕРСОНСЬКА",
						"adindex": "10000",
						"adcountry": "UA",
						"adtyperef": "Address of registration",
						"adtype": "2",
						"lngref": "Ukrainian",
						"lng": "1",
						"vdate": "1900-01-01",
						"addonor": "BNK"
					},
					"bdate": "1957-10-19",
					"reqlngref": "Russian",
					"reqlng": "2",
					"mname": "ІГОРЕВНА",
					"fname": "АННА",
					"lname": "РИБАЧКА",
					"inn": "2111118724"
				},
				"identdocmvds": {
					"identdocmvd": {
						"foundsource": [
							{
								"name": "DMS",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-26"
							},
							{
								"name": "MVS",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-26"
							},
							{
								"name": "UBKI",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-26"
							}
						],
						"found": "0",
						"foundref": "Not found",
						"foundtitle": "Ukrainian citizenPassport passport ВВ-142228 is not found in the list of invalid passports",
						"pser": "ВВ",
						"pnom": "142228",
						"dtype": "1",
						"dtyperef": "Ukrainian citizen passport"
					}
				},
				"id": "1",
				"descr": "Identification of the Credit History Subject (CHS)"
			},
			{
				"pret": {
					"inn": "2111118724",
					"nonewdeal": "0",
					"nonewdealref": "No",
					"nonewdealcomment": "",
					"freezedate":""
				},
				"fcert": {
					"inn": "3278508288",
					"cert": "0",
					"certref": "No",
					"certid": "",
					"certurl": ""
				},
				"maybegone": {
					"inn": "3278508288",
					"vdate": "2022-12-01",
					"dldonor": "BNK"
				},
				"id": "18",
				"descr": "Alert"
			}
		]
	}
}

...

Response XML

Code Block

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-11-29 10:42:49.713" ftm="2022-08-29 10:42:49.998"/>
        </trace>
        <reqinfo reqid="req2#000002461391"/>
    </tech>
    <comp id="1" descr="Identification of the Credit History Subject (CHS)">
        <cki bdate="1957-10-19" reqlngref="Russian" reqlng="2" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" inn="2111118724">
            <ident cchild="" sstateref="" sstate="" spdref="natural person" spd="1" cgragref="" cgrag="802804" ceducref="" ceduc="" familyref="" family="" csexref="woman" csex="2" bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" inn="2111118724" lngref="Russian" lng="2" vdate="2022-02-06" donor="BNK"/>
            <work wdohod="" wstag="" wname="ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ 'УКРАЇНСЬКА КОМПАНІЯ 'О'" wokpo="34745377" cdolgnref="Worker/specialist/performer" cdolgn="3" lngref="Ukrainian" lng="1" vdate="2021-11-07" wdonor="BNK"/>
            <doc dwdt="2004-03-10" dwho="ХЕРСОНСКИМ ГО УМВД" dterm="" dnom="142228" dser="ВВ" dtyperef="Ukrainian citizen passport" dtype="1" lngref="Ukrainian" lng="1" vdate="2021-08-01" eddr_number="19571019-00027" ddonor="BNK"/>
            <addr adflat="81" adcorp="" adhome="11" adstreet="ВУЛ.ЕЖЕЛЕ" adcitytyperef="" adcitytype="" adcity="М.ХЕРСОН" adarea="" adstate="ХЕРСОНСЬКА" adindex="10000" adcountry="UA" adtyperef="Address of registration" adtype="2" lngref="Ukrainian" lng="1" vdate="1900-01-01" addonor="BNK"/>
        </cki>
        <identdocmvds>
            <identdocmvd found="0" foundref="Not found" foundtitle="Ukrainian citizen passportPassport ВВ-142228 is not found in the list of invalid passports" pser="ВВ" pnom="142228" dtype="1" dtyperef="Ukrainian citizen passport">
                <foundsource name="DMS" found="0" foundref="Not found" sourcedate="2022-10-26"/>
                <foundsource name="MVS" found="0" foundref="Not found" sourcedate="2022-10-26"/>
                <foundsource name="UBKI" found="0" foundref="Not found" sourcedate="2022-10-26"/>
            </identdocmvd>
        </identdocmvds>
    </comp>
    <comp id="18" descr="Alert">
        <pret inn="2111118724" nonewdeal="0" nonewdealref="No" nonewdealcomment="" freezedate="" />
        <fcert inn="3278508288" cert="0" certref="No" certid="" certurl="" />
        <maybegone inn="3278508288" vdate="2022-12-01" dldonor="BNK" />
    </comp>
</ubkidata>

...

Versions Compared

Old Version 16

New Version Current

Key

Http Method

POST

Request URL

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

Request JSON/Checking if the combination of the phone and date of birth is correct
( parameters are passed optionally)**

Response JSON

Response XML

Response JSON

Response XML

Response JSON

Response XML

Page Comparison

Versions Compared

Old Version 16

New Version Current

Key

Http Method

POST

Request URL

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

Request JSON/Checking if the combination of the phone and date of birth is correct( ** parameters are passed optionally)

Response JSON

Response XML

Response JSON

Response XML

Response JSON

Response XML

Request JSON/Checking if the combination of the phone and date of birth is correct
( parameters are passed optionally)**