...
Info |
---|
The report contains the following components: |
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON
|
Response JSON
|
<?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
title | 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=
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--This block can and has to consist of 1 .. * elements-->
</urident>
<!-- Block of the related persons for the legal entities (Director, accountant ...)-->
<linked okpo2=
|
|
|
|
|
<!--This block can and has to consist of 1 .. * elements-->
</linked>
<!-- Block of the Information History of addresses -->
<addr addonor=
|
|
|
|
|
|
|
|
adcountry="Country (two-character code from ISO 3166 reference book)"
adindex="Postal code"
adstate="Region"
adarea="District"
adcity="Locality"
adcitytype="Locality type
|
|
|
|
|
|
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)" />
<!--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
|
Request XML
|
Response XML
|
Example |
---|
Request JSON |
|
Response JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Request XML |
|
Response XML |
|
|
|
|
|
|
|
|
|
|
|
XSD Schema request | https://secure.ubki.ua/b2/js/xsd/request40.xsd |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response40.xsd |
Test URL | https://test.ubki.ua/b2_api_xml/ubki/xml |
---|---|
Test data |
<comp id="18" descr=" |
Alert"> tag <changedeal>
<comp id="54" descr="Information bankruptcy"> okpo="12345610" |