Versions Compared

Key

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

...

Info

The report contains the following components:

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 XML

Expand
titlebody:

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

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

<!-- Client alert 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="Ідентифікатор угоди (референс)"

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

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

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

</pret>

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

...

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-29 10:24:23.353",
					"ftm": "2022-08-29 10:24:24.523"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002461377"
			}
		},
		"comp": [
			{
				"pret": {
					"inn": "3278508288",
					"nonewdeal": "0",
					"nonewdealref": "No",
					"nonewdealcomment": "",
					"freezedate":""
				},
				"id": "18",
				"descr": "Client alertAlert"
			},
			{
				"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="Client alertAlert">
        <pret inn="3278508288" nonewdeal="0" nonewdealref="No" nonewdealcomment="" freezedate="" />
    </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>

...