Versions Compared

Key

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

...

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"docs": {

"doc": {

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

"dser": "Document series",

"dnom": "Document number"

}

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Identification by passport' – 32",

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

},

"billing": {

"balance": {

"value": "Total assets",

"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": "Component nameTIN" },

{

"identdoccert": {

"ident": {

"csexref": "Value from the 'Sex' (value from ref.1"Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) ",

"csexcertref": "Sex (code Availability of a certificate from the UBCH (value from ref. 156)",

"bdatecertid": "Date of birthCertificate number",

"mnamecerturl": "Middle name"Link to the certificate"

},

"fnamemaybegone": "First name",{

"lnameinn": "Last nameTIN",

"innvdate": "TIN of the credit history subjectApplication creation date",

"lngrefdldonor": "Value from the 'Part presentation language' reference book (value Information provider (code from ref. 2354)"

},

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

"vdatedescr": "Date of the information from this part Component name"

},

{

"foundidentdoc": "Found? (Code from ref.60)", "foundref": "Found? (Value from ref.60{

"ident": {

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

"dtypecsex": "Document type Sex (code from ref.71)",

"dtyperefbdate": "Document type (value from ref.7)Date of birth",

"dsermname": "Document seriesMiddle name",

"dnomfname": "Document numberFirst name",

"dwdtlname": "Document issue date" }Last name",

"identdocmvdsinn": {

"identdocmvd": {

"foundsource": {

"name": "Data source for verification (Code from ref.63"TIN of the credit history subject",

"lngref": "Value from the 'Part presentation language' reference book (value from ref.23)",

"foundlng": "0/1 - digital indication of the presence of an invalid passport (Code Part presentation language (code from ref.2723)",

"foundrefvdate": "Text indication Date of the presence of an invalid passport (Value from ref.27)"information from this part "

},

"sourcedatefound": "The date of updating the information in the database or receiving a response from the API of the original source" }Found? (Code from ref.60)",

"foundfoundref": "Found? (Code Value from ref.2760)",

"foundrefdtype": "Found? Document type (Value code from ref.277)",

"foundtitledtyperef": "Search result descriptionDocument type (value from ref.7)",

"pserdser": "Series of the required passportDocument series",

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

"dtypedwdt": "Document type issue date"

},

"identdocmvds": {

"identdocmvd": {

"foundsource": {

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

"dtypereffound": "Document type (Meaning 0/1 - digital indication of the presence of an invalid passport (Code from ref.727)" },

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

"descrsourcedate": "Names of componentsThe date of updating the information in the database or receiving a response from the API of the original source"

}

]

}

}

Request XML

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

<!-- Request parameters -->

<request version="1.0" reqtype="Template code (code from ref.49): 'Identification by passport' – 32" reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

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

<!-- Subject identification parameters-->

<docs>

<doc dtype="Document type (code Response

,

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

dser="Document series"

dnom="Document number" />

</docs>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

},

"id": "39",

"descr": "Names of components"

}

]

}

}

Request XML

Expand
title body:

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

<ubkidata>

<!-- System information part -->

<tech>

<trace>

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

<doc>

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

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!--

The trace part contains timing metrics of components generation steps <error errtype="Error

Request parameters -->

</step>

</trace>

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

0)" errtext="Error text (value

49): 'Identification by passport' – 32" reqreason="Request objective (code from ref.

0

24)">

<

/error>

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

</reqinfo>

!-- Parameters describing search criteria-->

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

<!--

Information about the current status of the prepaid account part

Subject identification parameters-->

<billing>

<docs>

<balance value

<doc dtype="

Total assets" date="Date" time="Time

Document type (code from ref.7)"

dser="Document series"

dnom="Document number" />

</

billing>

docs>

</

tech>

i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

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

<ubkidata>

<!-- Alert System information part --> <comp id

<tech>

<trace>

<step name="18Step name" descrstm="Назва компоненти">

<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"

nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

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

<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

Step start stamp date" ftm="Step finish stamp date">

<!-- The trace part contains timing metrics of components generation steps -->

</step>

</trace>

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

</error>

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

</reqinfo>

<!-- Information about the current status of the prepaid account part-->

<billing>

<balance value="Total assets" date="Date" time="Time" />

</billing>

</tech>

<!-- Alert -->

<comp id="18" descr="Назва компоненти">

<pret nonewdeal="Ознака небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE: 0 - не включена, 1 - включена"

nonewdealref="Значення ознаки небажання оформлювати нові кредитні продукти, статус підключення опції FREEZE - 0-ні (не підключена опція), 1-так (підключена опція)"

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

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

<pretension inn="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

crdeal="Ідентифікатор угоди (референс)"

source="Вид оскарження (Код із ref.48)"

sourceref="Вид оскарження (Значення із ref.48)"

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

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

vdate="Дата створення заявки" />

<commentcki comment="Коментар суб'єкта кредитної історії"

vdate="Дата створення коментаря" />

<plost pser="Серія паспорта, заявлено СКІ як загублений (крадіжка)"

pnom="Номер паспорта, заявлено СКІ як загублений (крадіжка)"

crdate="Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ"

ldate="Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ" />

<changedeal crdeal="Ідентифікатор угоди (референс)"

source changecode="Вид оскарження Код причини коригування/видалення даних (Код із ref.4862)" sourceref

changeref="Вид оскарження Текст причини коригування/видалення даних (Значення із ref.48)"

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

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

vdate="Дата створення заявки" />

<commentcki comment="Коментар суб'єкта кредитної історії.62)"

vdate="Дата створення коментарякоригування/видалення даних" />

<plost pser="Серія паспорта, заявлено СКІ як загублений (крадіжка)"

pnom="Номер паспорта, заявлено СКІ як загублений (крадіжка)"

crdate="Дата створення заявки на втрату/крадіжку паспорта СКІ в УБКІ"

ldate="Зазначена в заявці дата втрати/крадіжки паспорта СКІ в УБКІ" />

<changedeal crdeal="Ідентифікатор угоди (референс)"

changecode="Код причини коригування/видалення даних (Код із ref.62)"

changeref="Текст причини коригування/видалення даних (Значення із ref.62)"

vdate="Дата коригування/видалення даних" />

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

<!-- Credit history subject identification by Passport part -->

<comp id="39" descr="Names of components">

<identdoc found="Found? (Code from ref.60)"

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

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

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

dser="Document series"

dnom="Document number"

dwdt="Document issue date">

<ident csexref="Value from the 'Sex' (value from ref.1)"

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

bdate="Date of birth"

mname="Middle name"

fname="First name"

lname="Last name"

inn="TIN of the credit history subject"

lngref="Value from the 'Part presentation language' reference book (value from ref.23)"

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

vdate="Date of the information from this part " />

</identdoc>

<!-- Block for converting documents for validity -->

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

<!--This part must contain 1..* units and at least one document -->

</identdocmvd>

</comp>

</ubkidata>

...

Example (found matching passport)

Request JSON

{ "doc
Code Block
Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ubkidocs": {
			"req_envelope					"doc": {
									"req_xml"dtype": "1",
									"dser": {
"АМ",
									"requestdnom": {
"578072"
								}
							"i": {
},
							"docsreqlng": {"4"
								"doc": {
			},
						"dtypeversion": "1.0",
									"dserreqtype": "АМ32",
									"dnomreqreason": "5780722"
					}
				}
			},
			"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
		}
	},}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			
"
reqlng
trace": 
"4"
{
				
},
"step": {
					"
version
name": "
1.0
build report",
					"
reqtype
stm": "
32
2022-11-29 10:24:23.353",
					
"
reqreason
ftm": "
2
2022-08-29 10:24:24.523"
				}
			},
			
} },
"reqinfo": {
				"
sessid
reqid": "
EDF4309796114D6D9B8365370DA2DEE9
req2#000002461377"
			}
		}
}

Response JSON

Code Block
{
,
		"ubkidatacomp": {[
		"tech": 	{
				"tracepret": {
					"stepinn": {"3278508288",
					"namenonewdeal": "build report0",
					"stmnonewdealref": "2022-11-29 10:24:23.353No",
					"ftmnonewdealcomment": "2022-08-29 10:24:24.523"
 "",
					}"freezedate":""
				},
				"reqinfofcert": {
					"reqidinn": "req2#0000024613773278508288",
			}
		}"cert": "0",
					"compcertref": ["No",
			{
				"pretcertid": {"",
					"inncerturl": "3278508288"
				},
					"nonewdealmaybegone": "0",{
					"nonewdealrefinn": "No3278508288",
					"nonewdealcommentvdate": ""2022-12-01",
					"freezedatedldonor": "BNK"
				},
				"id": "18",
				"descr": "Alert"
			},
			{
				"identdoc": {
					"ident": {
						"csexref": "woman",
						"csex": "2",
						"bdate": "1989-10-05",
						"mname": "ВАСИЛІВНА",
						"fname": "ІРІНА",
						"lname": "ГАРНА",
						"inn": "3278508288",
						"lngref": "Ukrainian",
						"lng": "1",
						"vdate": "2022-02-25"
					},
					"found": "1",
					"foundref": "Found",
					"dtype": "1",
					"dtyperef": "Passport",
					"dser": "АМ",
					"dnom": "578072",
					"dwdt": ""
				},
				"identdocmvd": {
					"foundsource": [
						{
							"name": "MVS",
							"found": "1",
							"foundref": "Found",
							"sourcedate": "2022-10-16"
						},
						{
							"name": "DMS",
							"found": "0",
							"foundref": "Not found",
							"sourcedate": "2022-10-16"
						},
						{
							"name": "UBKI",
							"found": "0",
							"foundref": "Not found",
							"sourcedate": "2022-10-16"
						}
					],
					"found": "1",
					"foundref": "Found",
					"foundtitle": "Passport АМ-578072 is found in the list of invalid passports.",
					"pser": "АМ",
					"pnom": "578072",
					"dtype": "1",
					"dtyperef": "Passport"
				},
				"id": "39",
				"descr": "Identification of CHS by passport"
			}
		]
	}
}

...

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:24:23.353" ftm="2022-08-29 10:24:24.523"/>
        </trace>
        <reqinfo reqid="req2#000002461377"/>
    </tech>
    <comp id="18" descr="Alert">
        <pret inn="3278508288" 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>
    <comp id="39" descr="Identification of CHS by passport">
        <identdoc found="1" foundref="Found" dtype="1" dtyperef="Passport" dser="АМ" dnom="578072" dwdt="">
            <ident csexref="woman" csex="2" bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" inn="3278508288" lngref="Ukrainian" lng="1" vdate="2022-02-25"/>
        </identdoc>
        <identdocmvd found="1" foundref="Found" foundtitle="Passport АМ-578072 is found in the list of invalid passports." pser="АМ" pnom="578072" dtype="1" dtyperef="Passport">
            <foundsource name="MVS" found="1" foundref="Found" sourcedate="2022-10-16"/>
            <foundsource name="DMS" found="0" foundref="Not found" sourcedate="2022-10-16"/>
            <foundsource name="UBKI" found="0" foundref="Not found" sourcedate="2022-10-16"/>
        </identdocmvd>
    </comp>
</ubkidata>

...