Versions Compared

Old Version 5

changes.mady.by.user Zlata

Saved on

compared with

New Version 6

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

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"telecom": {

"phone": "Mobile phone number in +380999999999 format",

"datecut": "Date of the report calculation. If the date = '' – calculated for today, otherwise – for the beginning of the day specified"

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Telecom Report' report – 30",

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

},

"descr": "Request object"

},

"descr": "Request envelope"

},

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

}

}

}

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): 'Telecom Report' report – 30" reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

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

<!-- Search options -->

<telecom phone="Mobile phone number in +380999999999 format"

datecut="Date of the report calculation. If the date = '' – calculated for today, otherwise – for the beginning of the day specified" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

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

</tech>

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

<telecom phone="Mobile phone number in +380900000009 format"

uo="Qty of unique organizations that have transferred credit histories with a phone number or a credit application with a phone number" />

<conth vdate="Date of the information from this part"

innm="Labeled TIN (*******111)"

tcsource="Source of the 'Telecom Report' part (code from ref.52)"

tcsourceref="Reference for source of the 'Telecom Report' part (code from ref.52)"

tctype="Contact type in the 'Telecom Report' part (code from ref.53)"

tctyperef="Reference for contact type in the 'Telecom Report' part (code from ref.53)"

tcdonor="Provider (code from ref.54)" />

<scores innm="Labeled TIN (*******111)"

score="Credit score (0-700, NA)"

agerange="Age range (0_17, 18_24, 25_34, 35_44, 45_54, 55_64, 65_more)" />

</comp>

</ubkidata>

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"telecom": {
								"phone": "+380962134234",
								"datecut": ""
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "30",
						"reqreason": "2"
					}
				}
			},
			"sessid": "F936E3872D7740D7910BB32C933318B3"
		}
	}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="F936E3872D7740D7910BB32C933318B3">
    <req_envelope>
      <req_xml>
        <request version="1.0" reqtype="30" reqreason="2">
          <i reqlng="4">
            <telecom phone="+380962134234" datecut="" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-08-26 09:58:11.722" ftm="2022-08-26 09:58:11.839"/>
        </trace>
        <reqinfo reqid="req2#000002460378"/>
    </tech>
    <comp id="35" descr="Telecom report">
        <telecom phone="+380962134234" datecut="2021-11-29 10:30:47" uo="1">
            <conth vdate="2021-05-25" innm="*******288" tcsource="1" tcsourceref="Credit history" tctype="1" tctyperef="Personal mobile phone" tcdonor="BNK"/>
            <conth vdate="2016-04-29" innm="*******288" tcsource="4" tcsourceref="Payment service provider" tctype="1" tctyperef="Personal mobile phone" tcdonor="PSP"/>
            <conth vdate="2015-10-18" innm="*******288" tcsource="4" tcsourceref="Payment service provider" tctype="1" tctyperef="Personal mobile phone" tcdonor="PSP"/>
            <conth vdate="2013-09-04" innm="*******223" tcsource="1" tcsourceref="Credit history" tctype="1" tctyperef="Personal mobile phone" tcdonor="BNK"/>
            <conth vdate="2010-09-23" innm="*******223" tcsource="1" tcsourceref="Credit history" tctype="1" tctyperef="Personal mobile phone" tcdonor="BNK"/>
            <conth vdate="2009-09-30" innm="*******619" tcsource="1" tcsourceref="Credit history" tctype="1" tctyperef="Personal mobile phone" tcdonor="BNK"/>
            <scores innm="*******288" score="446" agerange="25_34"/>
            <scores innm="*******223" score="NA" agerange="45_54"/>
            <scores innm="*******619" score="0" agerange="0_17"/>
        </telecom>
    </comp>
</ubkidata>

...