Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »


Assessment of the probability of default of a SME based on its credit history and data from open sources.


Request JSON

  body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "EDRPOU (for legal entities)"

},

"additionaldata": {

"datescore": "Scoring date. Not filled in if the scoring is currently calculated"

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Information on registration of the taxpayer' - 36",

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

},

"descr": "Request object"

},

"descr": "Request envelope"

},

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

}

}

}

Request XML

  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): 'Information on registration of the taxpayer' - 36" reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

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

<!-- Subject identification parameters-->

<ident okpo="EDRPOU (for legal entities)">

</ident>

<additionaldata datescore="Scoring date. Not filled in if the scoring is currently calculated" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

 body:

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

<ubkidata>

<!-- System information block -->

<tech>

<trace>

<step name="Step name" stm="Date-stamp of the step start" ftm="Date-stamp of the step end">

<!-- The trace block contains the timing metrics of the components formation steps -->

</step>

</trace>

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

</error>

<reqinfo reqid="The outgoing ID request, generated by the Ukrainian Bureau of the Credit History">

</reqinfo>

<!-- Block of information on the current state of the prepaid account-->

<billing>

<balance value="Balance amount" date="Date" time="Time" />

</billing>

</tech>

<!-- Identification block -->

<comp id="1" descr="Components name">

<cki inn="EGPROU of the legal entity"

lname="Name of the legal entity"

reqlng="Search language (during search)/Identification language (during transmission) (Code from ref.23)"

reqlngref="Search language (during search)/Identification language (during transmission) (Meaning from ref.23)">

<!-- Block of the legal entity identification history-->

<urident donor="A source of information (code from ref.54)"

vdate="Date of this block information"

lng="Block representation language (Code from ref.23)"

lngref="Block representation language (Meaning from ref.23)"

okpo="EGRPOU of the legal entity"

urname="Name of the legal entity"

urfrms="Form of ownership (Code from ref.38)"

urfrmsref="Form of ownership (Meaning from ref.38)"

ureconom="Branch of economy (Section KVED2010) (Code from ref.36)"

ureconomref="Branch of economy (Section KVED2010) (Meaning from ref.36)"

urvide="Business activity (KVED2010) (Code from ref.37)"

urvideref="Business activity (KVED2010) (Code from ref.37)"

urdatreg="Date of registration in the Unified State Register"

urdatregnal="Date of registration in the tax inspectorate">

<!--This block can and has to consist of 1 .. * elements-->

</urident>

<!-- Block of the related persons for the legal entities (Director, accountant ...)-->

<linked okpo2="INN/EGRPOU of the related person"

okpo2_name="Full name/Name of the related person"

linkrole="Type of connection (Code from ref.39)"

linkroleref="Type of connection (Meaning from ref.39)"

rdate="Connection updated date">

<!--This block can and has to consist of 1 .. * elements-->

</linked>

<!-- Block of the Information History of addresses -->

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

<!--This block has to consist of 1 .. * elements and has to be filled, at least, with one address-->

</addr>

</cki>

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

<identdocmvds>

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

</identdocmvds>

</comp>

<!-- Block – a register of requests -->

<comp id="4" descr="Components name">

<credres redate="Date of decision"

retime="Time of decision"

inn="INN"

reqid="Request identifier in the Bureau"

result="Report result (Code from ref.19)"

resultref="Report result (Meaning from ref.19)"

reqreason="Reason for the request in to the bureau (Code from ref.24)"

reqreasonref="Reason for the request in to the bureau (Meaning from ref.24)"

org="Initiating agency (code from ref.54)">

<!--This block has to consist of 1 .. * elements -->

</credres>

<reestrtime hr="Number of requests per hour"

da="Number of requests per day"

wk="Number of requests per week"

mn="Number of requests per month"

qw="Number of requests per quarter"

ye="Number of requests per year"

yu="Number of requests per over a year">

<!--This block has to consist of the 1st element-->

</reestrtime>

</comp>

<!-- Block – Monitoring -->

<comp id="6" descr="Components name">

<moncredres org="Initiating organization (code from ref.54)"

resultref="Monitoring result (value from ref.19)"

result="Monitoring result (Code from дов.19)"

monid="Unique Monitoring Identifier"

inn="TIN"

startdate="Monitoring start date"

enddate="Date of last monitoring " />

<!-- This part can contain 0..* items -->

</comp>

<!-- Client alert -->

<comp id="18" descr="Components name">

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

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

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>

</comp>

<!-- SME score -->

<comp id="58" descr="Components name">

<scoremsb>

<!-- Scoring with credit history and open data -->

<msbch modelversion="Version of model "

score="Score"

scoredate="Date of score" />

<features name="Name of predictor"

value="Value of predictor" />

<!--This block has to consist of the 1..* elements-->

<!-- Scoring with open data -->

<msbod modelversion="Version of model "

score="Score"

scoredate="Date of score" />

<features name="Name of predictor"

value="Value of predictor" />

<!--This block has to consist of the 1..* elements-->

</msbod>

</scoremsb>

</comp>

</ubkidata>

Example

Request JSON

{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "12345632"
							},
							"additionaldata": {
								"datescore": ""
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "40",
						"reqreason": "2"
					}
				}
			},
			"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
		}
	}
}

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="EDF4309796114D6D9B8365370DA2DEE9">
    <req_envelope>
      <req_xml>
        <request version="1.0" reqtype="40" reqreason="2">
          <i reqlng="4">
            <ident okpo="12345632" />
            <additionaldata datescore="" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

Response XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2022-08-29 13:53:48.516" ftm="2022-08-29 13:53:49.618"/>
        </trace>
        <reqinfo reqid="req2#000002461660"/>
    </tech>
    <comp id="1" descr="Identification of the Credit History Subject (CHS)">
        <cki reqlngref="Ukrainian" reqlng="1" lname="ТОВ 'ХІМПОБУТ'" inn="12345632">
            <urident vdate="2020-05-12" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="46.75" urvideref="Оптова торгівля хімічними продуктами" urdatreg="2014-07-07" urdatregnal="2014-07-07"/>
            <urident vdate="2020-04-28" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="" urvideref="" urdatreg="2014-07-07" urdatregnal="2014-07-07"/>
            <urident vdate="2020-03-12" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="46.75" urvideref="Оптова торгівля хімічними продуктами" urdatreg="2014-07-08" urdatregnal="2014-07-08"/>
            <urident vdate="2019-09-12" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="46.75" urvideref="Оптова торгівля хімічними продуктами" urdatreg="2014-07-07" urdatregnal="2014-07-07"/>
            <urident vdate="2019-08-28" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="" urvideref="" urdatreg="2014-07-07" urdatregnal="2014-07-07"/>
            <urident vdate="2019-08-01" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="" urvideref="" urdatreg="2014-07-08" urdatregnal="2014-07-08"/>
            <urident vdate="2019-07-12" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="46.75" urvideref="Оптова торгівля хімічними продуктами" urdatreg="2014-07-08" urdatregnal="2014-07-08"/>
            <urident vdate="2018-12-01" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="240" urfrmsref="Товариство з обмеженою відповідальністю" ureconom="G" ureconomref="Оптова та роздрібна торгівля\x09 ремонт автотранспортних засобів і мотоциклів" urvide="" urvideref="" urdatreg="2014-07-08" urdatregnal="2014-07-08"/>
            <urident vdate="2017-03-18" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="100" urfrmsref="Підприємства" ureconom="S" ureconomref="Надання інших видів послуг" urvide="" urvideref="" urdatreg="2014-07-08" urdatregnal="2014-07-08"/>
            <urident vdate="2017-03-17" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="100" urfrmsref="Підприємства" ureconom="S" ureconomref="Надання інших видів послуг" urvide="" urvideref="" urdatreg="2014-07-07" urdatregnal="2014-07-07"/>
            <urident vdate="2016-07-18" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="100" urfrmsref="Підприємства" ureconom="S" ureconomref="Надання інших видів послуг" urvide="" urvideref="" urdatreg="2014-07-08" urdatregnal="2014-07-08"/>
            <urident vdate="2016-07-17" lng="1" lngref="Ukrainian" urname="ТОВ 'ХІМПОБУТ'" urfrms="100" urfrmsref="Підприємства" ureconom="S" ureconomref="Надання інших видів послуг" urvide="" urvideref="" urdatreg="2014-07-07" urdatregnal="2014-07-07"/>
            <linked okpo2="2182717193" okpo2_name="ШЕВЧЕНКО ЮРІЙ ГНАТОВИЧ" linkrole="1" linkroleref="Founder" rdate="2019-08-14"/>
            <linked okpo2="1241105334" okpo2_name="ТКАЧЕНКО БОГДАН ВАСИЛЬОВИЧ" linkrole="1" linkroleref="Founder" rdate="2017-12-26"/>
            <linked okpo2="2141207293" okpo2_name="НЕСТЕРЕНКО АНДРІЙ ІВАНОВИЧ" linkrole="1" linkroleref="Founder" rdate="2017-12-26"/>
            <linked okpo2="2151707293" okpo2_name="СЕМЕРЕНКО АБРАМ ІОАНОВИЧ" linkrole="2" linkroleref="Head" rdate="2017-05-13"/>
            <doc dwdt="2014-07-08" dwho="ВИКОНАВЧИЙ КОМІТЕТ ХАРКІВСЬКОЇ МІСЬКОЇ РАДИ" dterm="" dnom="null" dser="null" dtyperef="Certificate of state registration" dtype="11" lngref="Ukrainian" lng="1" vdate="2018-10-01" ddonor="BNK"/>
            <doc dwdt="2019-03-14" dwho="ДАННЫЕ ЕГРОДИ" dterm="" dnom="12345632" dser="null" dtyperef="Extract from the Unified State Register of Legal Entities and Individual Entrepreneurs" dtype="12" lngref="Ukrainian" lng="1" vdate="2017-06-01" ddonor="BNK"/>
            <doc dwdt="2014-07-08" dwho="ГУ ДФС У ХАРКІВСЬКІЙ ОБЛАСТІ (М.ХАРКІВ)" dterm="" dnom="" dser="" dtyperef="Reference on taxpayer’s registration" dtype="15" lngref="Ukrainian" lng="1" vdate="2020-05-01" ddonor="BNK"/>
            <doc dwdt="2014-07-08" dwho="ДПІ У М. ХАРКІВІ ГУ МІНДОХОДІВ У ХАРКІВС" dterm="" dnom="null" dser="null" dtyperef="Reference on taxpayer’s registration" dtype="15" lngref="Ukrainian" lng="1" vdate="2018-10-01" ddonor="BNK"/>
            <addr adflat="" adcorp="" adhome="16А" adstreet="МИРУ" adcitytyperef="" adcitytype="" adcity="ХАРКІВ" adarea="" adstate="ХАРКІВСЬКА" adindex="" adcountry="UA" adtyperef="Residence address" adtype="1" lngref="Ukrainian" lng="1" vdate="2017-06-28" addonor="BNK"/>
            <addr adflat="" adcorp="" adhome="БУД. 95" adstreet="ПР-Т. МИРУ" adcitytyperef="" adcitytype="" adcity="МІСТО ХАРКІВ" adarea="" adstate="ХАРКІВСЬКА ОБЛАСТЬ" adindex="17000" adcountry="UA" adtyperef="Actual address (legal entity)" adtype="3" lngref="Ukrainian" lng="1" vdate="2020-02-14" addonor="BNK"/>
            <addr adflat="" adcorp="" adhome="БУД. 95" adstreet="ПР-Т. МИРУ" adcitytyperef="" adcitytype="" adcity="МІСТО ХАРКІВ" adarea="" adstate="ХАРКІВСЬКА ОБЛАСТЬ" adindex="17000" adcountry="UA" adtyperef="Legal address (legal entity)" adtype="4" lngref="Ukrainian" lng="1" vdate="2020-02-14" addonor="BNK"/>
            <addr adflat="" adcorp="" adhome="95" adstreet="МИРУ" adcitytyperef="" adcitytype="" adcity="ХАРКОВ" adarea="" adstate="ХАРКОВСКАЯ" adindex="17000" adcountry="UКR" adtyperef="Legal address (legal entity)" adtype="4" lngref="Ukrainian" lng="1" vdate="2020-02-03" addonor="BNK"/>
            <addr adflat="6" adcorp="1" adhome="1/27" adstreet="КОТЛЯРЕВСЬКОГО" adcitytyperef="" adcitytype="" adcity="ХАРКІВ" adarea="" adstate="ХАРКІВСКАЯ" adindex="172" adcountry="UКR" adtyperef="Legal address (legal entity)" adtype="4" lngref="Ukrainian" lng="1" vdate="2017-07-19" addonor="BNK"/>
            <addr adflat="6" adcorp="1" adhome="1/27" adstreet="КОТЛЯРЕВСКОГО" adcitytyperef="" adcitytype="" adcity="ХАРКІВ" adarea="" adstate="ХАРКІВСКАЯ" adindex="17020" adcountry="UA" adtyperef="Legal address (legal entity)" adtype="4" lngref="Ukrainian" lng="1" vdate="2016-04-25" addonor="BNK"/>
        </cki>
        <identdocmvds/>
    </comp>
    <comp id="4" descr="Inquiries registry">
        <credres org="BNK" reqreasonref="Credit request" reqreason="2" resultref="Report provided successfully" result="1" reqid="req2#000002461296" inn="12345632" redate="2022-08-29" retime="01:13:48"/>
        <credres org="BNK" reqreasonref="Credit request" reqreason="2" resultref="Report provided successfully" result="1" reqid="req2#000002461201" inn="12345632" redate="2022-08-28" retime="01:13:48"/>
        <credres org="BNK" reqreasonref="Credit request" reqreason="2" resultref="Report provided successfully" result="1" reqid="req2#000002461162" inn="12345632" redate="2022-08-27" retime="01:13:53"/>
        <credres org="BNK" reqreasonref="Credit request" reqreason="2" resultref="Report provided successfully" result="1" reqid="req2#000002459273" inn="12345632" redate="2022-08-25" retime="01:13:49"/>
        <credres org="BNK" reqreasonref="Credit request" reqreason="2" resultref="Report provided successfully" result="1" reqid="req2#000002458720" inn="12345632" redate="2022-08-24" retime="01:13:50"/>
        <credres org="BNK" reqreasonref="Credit request" reqreason="2" resultref="Report provided successfully" result="1" reqid="req2#000002458128" inn="12345632" redate="2022-08-23" retime="01:13:48"/>
        <reestrtime hr="0" da="1" wk="5" mn="24" qw="56" ye="147" yu="6"/>
    </comp>
    <comp id="6" descr="Monitoring (does not affect credit rating)"/>
    <comp id="18" descr="Client alert">
        <pret inn="12345632" nonewdeal="0" nonewdealref="No" nonewdealcomment=""/>
    </comp>
    <comp id="58" descr="SME score">
        <scoremsb>
            <msbch modelversion="1" score="369" scoredate="2022-08-29">
                <features name="ch110" value="1253"/>
                <features name="ch112" value="0"/>
                <features name="ch114" value="0"/>
                <features name="ch116" value="0"/>
                <features name="ch12" value="5"/>
                <features name="od33" value="-1"/>
                <features name="od35" value="-1"/>
                <features name="od4" value="487"/>
                <features name="od43" value="0"/>
                <features name="od47" value="41"/>
            </msbch>
            <msbod modelversion="1" score="104" scoredate="2022-08-29">
                <features name="od1" value="291"/>
                <features name="od10" value="-1"/>
                <features name="od12" value="-1"/>
                <features name="od15" value="-1"/>
                <features name="od16" value="-1"/>
                <features name="od90" value="4"/>
            </msbod>
        </scoremsb>
    </comp>
</ubkidata>

Test URL

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

Test data

  • okpo="12345632"

  • okpo="12345649"

  • okpo="12345610"

  • okpo="12345632"

<comp id="18" descr="Client alert"> tag <changedeal>

  • 12345626

  • No labels