Versions Compared

Old Version 5

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.

...

Http Method

POST

Request URL

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

Request JSON
( ** the parameters are transferred optionally if there is a credit history for this client from your organization)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)",

"lname": "**Last name",

"fname": "**First name",

"mname": "**Middle name",

"bdate": "**Date of birth"

},

"contacts": {

"cont": {

"ctype": "**Contact type (code from ref.10)",

"cval": "**Contact value"

}

},

"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 the ref.49): 'Custom credit report' - 48",

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

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (we receive it from the API authorization)"

}

}

}

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

"crdealshort": {

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

"dlds": "Transaction commencement date",

"dldpf": "Transaction closing date under the contract",

"dlamt": "Transaction amount (initial)",

"dlcurr": "Transaction currency (code from ref.12)",

"typedeal": "Transaction type, one of two: CC - credit card, PL - not credit card",

"statedeal": "Transaction status in the current period, one of two: OPEN, CLOSE",

"dldateclc": "Calculation date",

"dlamtexpuah": "Current debt overdue amount, UAH",

"dldayexp": "Current number of days overdue",

"dlflstat": "Transaction status in the current period (code from ref.16)",

"ex60y3uah": "Maximum overdue amount 60+ days in the last 36 months, UAH",

"ex90y3uah": "Maximum overdue amount 90+ days in the last 36 months, UAH",

"paymuah": "Planned compulsory payment amount in the current period (as scheduled). Сalculated as an annuity if 0",

"dlamtcuruah": "Current debt amount, UAH",

"reqyear": "Number of requests per year"

},

"id": "71",

"descr": "The name of the component"

},

{

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

}

]

}

}

...

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>

<!-- Custom credit report -->

<comp id="71" descr="The name of the component">

<crdealshort inn="TIN of the credit history subject"

dlds="Transaction commencement date"

dldpf="Transaction closing date under the contract"

dlamt="Transaction amount (initial)"

dlcurr="Transaction currency (code from ref.12)"

typedeal="Transaction type, one of two: CC - credit card, PL - not credit card"

statedeal="Transaction status in the current period, one of two: OPEN, CLOSE"

dldateclc="Calculation date"

dlamtexpuah="Current debt overdue amount, UAH"

dldayexp="Current number of days overdue"

dlflstat="Transaction status in the current period (code from ref.16)"

ex60y3uah="Maximum overdue amount 60+ days in the last 36 months, UAH"

ex90y3uah="Maximum overdue amount 90+ days in the last 36 months, UAH"

paymuah="Planned compulsory payment amount in the current period (as scheduled). Calculated as an annuity if 0"

dlamtcuruah="Current debt amount, UAH"

reqyear="Number of requests per year">

<!--This block must consist of 0 .. * elements-->

</crdealshort>

</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="72" descr="Search by full name + inn if more than 1 person is found">

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

...

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-09 19:08:22.647",
					"ftm": "2022-01-09 19:08:22.734"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002007797"
			}
		},
		"comp": {
			"crdealshort": [
				{
					"inn": "3278508288",
					"dlds": "2018-02-23",
					"dldpf": "2019-06-23",
					"dlamt": "0.00",
					"dlcurr": "980",
					"typedeal": "CC",
					"statedeal": "CLOSE",
					"dldateclc": "2018-08-03",
					"dlamtexpuah": "0.00",
					"dldayexp": "0",
					"dlflstat": "2",
					"ex60y3uah": "0.00",
					"ex90y3uah": "0.00",
					"paymuah": "0.00",
					"dlamtcuruah": "0.00",
					"reqyear": "0"
				},
				{
					"inn": "3278508288",
					"dlds": "2014-11-25",
					"dldpf": "2113-11-25",
					"dlamt": "0.00",
					"dlcurr": "980",
					"typedeal": "CC",
					"statedeal": "CLOSE",
					"dldateclc": "2017-11-30",
					"dlamtexpuah": "0.00",
					"dldayexp": "0",
					"dlflstat": "2",
					"ex60y3uah": "0.00",
					"ex90y3uah": "0.00",
					"paymuah": "0.00",
					"dlamtcuruah": "0.00",
					"reqyear": "0"
				}
			],
			"id": "71",
			"descr": "Custom credit report"
		}
	}
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<ubkidata>
   <tech>
      <trace>
         <step name="build report" stm="2022-11-09 19:08:22.647" ftm="2022-01-09 19:08:22.734" />
      </trace>
      <reqinfo reqid="req2#000002007797" />
   </tech>
  <comp id="71" descr="Custom credit report">
         <crdealshort inn="3278508288" dlds="2016-08-25" dldpf="2116-09-25" dlamt="0.00" dlcurr="980" typedeal="CC" statedeal="CLOSE" dldateclc="2019-08-28" dlamtexpuah="0.00" dldayexp="0" dlflstat="2" ex60y3uah="0.00" ex90y3uah="0.00" paymuah="0.00" dlamtcuruah="0.00" reqyear="0"/>
        <crdealshort inn="3278508288" dlds="2019-12-23" dldpf="2021-04-23" dlamt="0.00" dlcurr="980" typedeal="PL" statedeal="CLOSE" dldateclc="2020-05-03" dlamtexpuah="0.00" dldayexp="0" dlflstat="2" ex60y3uah="0.00" ex90y3uah="0.00" paymuah="0.00" dlamtcuruah="0.00" reqyear="0"/>
    </comp>
</ubkidata>

XSD Schema request

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

...