...

Info

The report contains the following components:

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

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

},

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

},

"version": "1.0",

"reqtype": "Template code (Code from the ref.49): 'Credit report of a legal entity ' - 15",

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

Expand
titlebody:

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

<!-- History of the Information about Documents part -->

<doc ddonor="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)"

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

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

dser="Document series"

dnom="Document number"

dterm="Expiration date"

dwho="Document issuer"

dwdt="Document issue date"

eddr_number="Unique record number in the Unified State Demographic Register">

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

</doc>

<!-- 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 of information on credit transactions -->

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

<crdeal dlref="Transaction identifier"

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

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

inn="INN SKI / EGRPOU of the legal entity"

lname="Surname/Name of the legal entity"

fname="Name" mname="Father’s name"

bdate="Date of Birth"

dlcelcred="Transaction type (Code from ref.17)"

dlcelcredref="Transaction type (Meaning from ref.17)"

dlvidobes="Type of collateral (Code from ref.15)"

dlvidobesref="Type of collateral (Meaning from ref.15)"

dlporpog="Repayment procedure (Code from ref.18)"

dlporpogref="Repayment procedure (Meaning from ref.18)"

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

dlcurrref="Transaction currency (Meaning from ref.12)"

dlamt="Transaction sum (initial)"

dldonor="Information donor (code from ref.54)"

dlrolesub="Role of the subject (Code from ref.14)"

dlrolesubref="Role of the subject (Meaning from ref.14)"

dlamtobes="Cost of collateral in the base currency">

<!-- Block of variable values of a credit history -->

<deallife dlref="Transaction identifier"

dlmonth="Data period (month)"

dlyear="Data period (year)"

dlds="Date of the transaction beginning"

dldpf="Date of the transaction ending by the agreement"

dldff="Actual date of the transaction ending"

dlflstat="Transaction Status at the current period (Code from ref.16)"

dlflstatref="Transaction status at the current period (Meaning from ref.16)"

dlamtlim="Current transaction limit (for revolving transactions, credit cards)"

dlamtpaym="The amount of the obligatory payment in the current period"

dlamtcur="The sum of the current debt"

dlamtexp="The sum of the current outstanding debt"

dldayexp="Current number of days in arrears"

dlflpay="The sign of payment execution in the current period (the code from ref.13)"

dlflpayref="The sign of payment execution in the current period (Meaning from ref.13)"

dlflbrk="The sign of the existence of an outstanding payment in the current period (the code from ref.13)"

dlflbrkref="The sign of the existence of an outstanding payment in the current period (Meaning from ref.13)"

dlfluse="Characteristics of a credit tranche in the current period (code from ref.13)"

dlfluseref="Characteristics of a credit tranche in the current period (Meaning from ref.13)"

dldateclc="Calculation Date">

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

</deallife>

</crdeal>

</comp>

<!-- Information about Enforcement Proceedings of the Credit History Subject part -->

<comp id="3" descr="Information on the enforcement proceedings of SKI">

<penaltiesCount totalCount="The total number of enforcement proceedings for all time"

activeCount="Number of active enforcement proceedings" />

<susd votesudname="Executor"

votetype="Enforcement type"

votedate="Enforcement start date"

inn="TIN of the debtor"

voteid="Enforcement Number"

votedonor="Source of information"

votesudphone="Executor’s phone"

votesudemail="Executor’s email"

vdate="Record update date"

credname="Creditor name"

credokpo="Creditor`s code"

vpstate="Status of proceedings">

<changes voteid="Enforcement Number"

inn="TIN of the debtor"

votedate="Enforcement start date"

votesudname="Executor"

vdate="Record Date"

credname="Name of creditor"

credokpo="Creditor`s code"

vpstate="Status of proceedings" />

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

</susd>

</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 ref.19)"

monid="Unique Monitoring Identifier"

inn="TIN"

startdate="Monitoring start date"

enddate="Date of last monitoring " />

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

</comp>

<!-- Block – Counterparty Status -->

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

<stcont sinn="OKPO (for legal entities)"

sname="Name of the legal entity"

sdate="Registration date of the legal entity"

snds="VAT payer status (0 - NO/ 1- YES)"

sndsdate="Date updated"

sipn="Individual Tax Number"

saddr="Address"

dreg="Date of registration as VAT payer"

contacts="Contacts">

<state val="Current status (Сode from ref.41)"

valref="Value current status (Value of ref.41)"

setdate="Date updated"

src="A source of information (Сode from ref.42)"

srcref="Value source of information (Value of ref.42)" />

</stcont>

</comp>

<!-- Client alert 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)"

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

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

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

</pret>

</comp>

<!-- Block of information from the list of sanctions -->

<comp id="40" descr="Information from sanctions lists">

<sanctions found="Availability of information (Code from ref. 27)"

foundRef="Text interpretation of available information (Code from ref. 27)"

subName="Subject’s name"

bDate="Subject’s date of birth"

position="Position"

reason="Grounds for imposing sanctions"

typeSearch="Search type (Code from ref. 67)"

typeSearchText="Text interpretation of the type of search (Code from ref. 67)">

<sanctionsData countryCode="Country code"

country="The name of the country"

sanction="Presence of sanctions imposed by the country (Code from ref. 68)"

date="Date of entry into the list"

url="Link to the document – confirmation" />

</sanctions>

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

</comp>

<!-- "Information from the Public Register of Politically Exposed Persons of Ukraine" part-->

<comp id="41" descr="Information from the Public Register of Politically Exposed Persons of Ukraine">

<pep found="0 – not located, 1 – located "

foundref="not located/located"

subname="Subject’s name"

bdate="Subject’s date of birth"

category="Category of the politically exposed person"

lastpost="Last position"

dateofrelease="Date of leaving of the last position"

isur="Indication of legal entity"

state="Status of legal entity"

url="Link to the document – confirmation" />

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

</comp>

<!-- Bankruptcy information-->

<comp id="54" descr="Bankruptcy information">

<bankruptcyinfo found="Availability of information about bankruptcy, numerical designation 0-1"

foundref=" Availability of information about bankruptcy, textual meaning 0-not found / 1-found">

<bankruptcy subname="Subject’s name"

subcode="TIN/EDRPOU"

eventtype="Event type"

eventclaimer="Initiator of the event"

eventcourtcase="Case number"

eventdate="Date of event" />

</bankruptcyinfo>

</comp>

</ubkidata>

...

Test URL

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

Test data

  • okpo="12345632"

  • okpo="12345626"

  • okpo="12345649"

  • okpo="12345610"

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

  • okpo="12345626"

<comp id="40" descr="Information from sanctions lists">, <comp id="54"descr="Bankruptcy information"> 

  • okpo="12345610"

<comp id="41" descr="Information from the Public Register of Politically Exposed Persons of Ukraine">

  • okpo="12345649"

...