...
Info |
---|
The report contains the following components: |
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON |
Expand | ||
---|---|---|
| ||
{ "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 ref.49): 'Identification' report – 12", "reqreason": "Request objective (code from ref.24)" }, "descr": "Request object" }, "descr": "Request envelope" }, "sessid": "Session key (obtained from the authorization API)" } } } |
( ** the parameters are transferred optionally if there is a credit history for this client from your organization)
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 -->
|
|
|
<!-- Parameters describing search criteria-->
<i reqlng="Search criteria language (code from ref.23)">
<!-- Subject identification parameters-->
<ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)"
lname="**Last name"
fname="**First name"
mname="**Middle name"
bdate="**Date of birth">
</ident>
<contacts>
<cont ctype="Contact type (code from ref.10)"
cval="Contact value" />
</contacts>
<docs>
<doc dtype="**Document type (code from ref.7)"
dser="**Document series"
dnom="**Document number" />
</docs>
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc>
Response XML
title | body: |
---|
<?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>
<!-- Identification part -->
<comp id="1" descr="Names of components">
<cki inn="TIN of the credit history subject/EDRPOU of the legal entity"
lname="Last name/Name of the legal entity"
fname="First name"
mname="Middle name"
reqlng="Search language (while searching)/Identification language (during transfer) (code from ref.23)"
reqlngref="Search language (while searching)/Identification language (during transfer) (value from ref.23)"
bdate="Date of birth">
<ident donor="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)"
inn="TIN of the credit history subject"
lname="Last name"
fname="First name"
mname="Middle name"
bdate="Date of birth"
csex="Sex (code from ref.1)"
csexref="Sex (value from ref.1)"
family="Marital status (code from ref.2)"
familyref="Marital status (value from ref.2)"
ceduc="Education (code from ref.3)"
ceducref="Education (value from ref.3)"
cgrag="Citizenship (code from ref.4)"
cgragref="Citizenship (value from ref.4)"
spd="Presence
|
|
|
|
|
<!--This part can and must contain 1..* items-->
</ident>
<!-- History of the Information about Employer part -->
<work wdonor=
|
|
|
|
|
|
|
|
|
|
<!--This part can contain 0..*-->
</work>
<!-- History of the Information about Documents part -->
<doc ddonor=
|
|
|
|
|
|
|
|
|
|
|
|
<!--This part must contain 1..* units and at least one document-->
</doc>
<!-- History of the Information about Addresses part -->
<addr addonor=
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--This part must contain 1..* units and at least 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=
|
|
|
|
<!--This part must contain 1..* units and at least one document -->
</identdocmvd>
</identdocmvds>
</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=
|
|
|
|
vdate="Date of the request creation" />
<commentcki comment="Commentary of the subject of credit history"
vdate="Date of a comment creation" />
<plost pser=
|
|
|
|
|
|
|
|
</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 block has to consist of 1 .. * elements-->
</comp>
<!-- Phone Number Verification part -->
<comp id="44" descr="Names of components">
<contverif phone="Phone number verified"
mathch="Phones verification result (code from ref.56)"
matchref="Phones verification result in text format (ref.56)">
<donortype donor="Source of information (code from ref.54)" />
</contverif>
</comp>
</ubkidata>
Example
Request JSON
Code Block |
---|
{
"doc": {
"ubki": {
"req_envelope": {
"req_xml": {
"request": {
"i": {
"ident": {
"bdate": "1989-10-05",
"mname": "VASYLIVNA",
"fname": "IRINA",
"lname": "HARNA",
"okpo": "3278508288"
},
"docs": {
"doc": {
"dtype": "1",
"dser": "АМ",
"dnom": "578072"
}
},
"contacts": {
"cont": {
"cval": "+380962134234",
"ctype": "3"
}
},
"reqlng": "4"
},
"version": "1.0",
"reqtype": "12",
"reqreason": "2"
}
}
},
"sessid": "6D7D781B1E884A6AB384481804A35EA8"
}
}
} |
Request XML
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<doc>
<ubki sessid="6D7D781B1E884A6AB384481804A35EA8">
<req_envelope>
<req_xml>
<request version="1.0" reqtype="12" reqreason="2">
<i reqlng="4">
<ident bdate="1989-10-05" mname="VASYLIVNA" fname="IRINA" lname="HARNA" okpo="3278508288" />
<docs>
<doc dtype="1" dser="АМ" dnom="578072" />
</docs>
<contacts>
<cont cval="+380962134234" ctype="3" />
</contacts>
</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-11-25 12:15:47.585" ftm="2022-08-25 12:15:47.807"/>
</trace>
<reqinfo reqid="req2#000002459637"/>
</tech>
<comp id="1" descr="Identification of the Credit History Subject (CHS)">
<cki bdate="1989-10-05" reqlngref="Ukrainian" reqlng="1" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" inn="3278508288">
<ident cchild="" sstateref="" sstate="" spdref="natural person" spd="1" cgragref="Ukraine" cgrag="804" ceducref="" ceduc="" familyref="" family="" csexref="woman" csex="2" bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" inn="3278508288" lngref="Ukrainian" lng="1" vdate="2022-02-25" donor="BNK"/>
<ident cchild="" sstateref="" sstate="" spdref="natural person" spd="1" cgragref="" cgrag="802" ceducref="" ceduc="" familyref="" family="" csexref="woman" csex="2" bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРИНА" lname="ГАРНА" inn="3278508288" lngref="Ukrainian" lng="1" vdate="2007-08-04" donor="BNK"/>
<doc dwdt="2002-08-01" dwho="ІВАНГОРОДСЬКИМ" dterm="" dnom="578072" dser="АМ" dtyperef="Passport" dtype="1" lngref="Ukrainian" lng="1" vdate="2022-02-10" eddr_number="19891005-00022" ddonor="BNK"/>
<addr adflat="" adcorp="" adhome="7" adstreet="ТИХА" adcitytyperef="" adcitytype="" adcity="JВDКВJ" adarea="ІВАНГОРОДСКИЙ" adstate="ДНЕПРОПЕТРОВСКАЯ" adindex="23201" adcountry="UA" adtyperef="Address of registration" adtype="2" lngref="Ukrainian" lng="1" vdate="2022-02-25" addonor="BNK"/>
</cki>
<identdocmvds>
<identdocmvd found="1" foundref="Found" foundtitle="Passport АМ-578072 is found in the list of invalid passports." pser="АМ" pnom="578072" dtype="1" dtyperef="Passport">
<foundsource name="MVS" found="1" foundref="Found" sourcedate="2022-10-16"/>
<foundsource name="DMS" found="0" foundref="Not found" sourcedate="2022-10-16"/>
<foundsource name="UBKI" found="0" foundref="Not found" sourcedate="2022-10-16"/>
</identdocmvd>
</identdocmvds>
</comp>
<comp id="18" descr="Client alert">
<pret inn="3278508288" nonewdeal="0" nonewdealref="No" nonewdealcomment=""/>
</comp>
<comp id="40" descr="Information from sanctions lists">
<sanctions found="1" foundRef="Found information" subName="ГАРНА ІРІНА ВАСИЛІВНА" bDate="05.10.1989" position="Народний депутат Верховної Ради IX скликання («Опозиційна платформа — за життя»)" reason="Дестабілізація ситуації в Україні" typeSearch="0" typeSearchText="Found by name and date of birth">
<sanctionsData countryCode="EU" country="ЄВРОПЕЙСЬКИЙ СОЮЗ" sanction="0" date="" url="" />
<sanctionsData countryCode="AU" country="АВСТРАЛІЯ" sanction="1" date="2022-05-18" url="https://www.dfat.gov.au/international-relations/security/sanctions/consolidated-list" />
<sanctionsData countryCode="CH" country="ШВЕЙЦАРІЯ" sanction="0" date="" url="" />
<sanctionsData countryCode="JP" country="ЯПОНІЯ" sanction="0" date="" url="" />
<sanctionsData countryCode="GB" country="СПОЛУЧЕНЕ КОРОЛІВСТВО" sanction="0" date="" url="" />
<sanctionsData countryCode="UA" country="УКРАЇНА" sanction="1" date="2021-02-02" url="https://www.president.gov.ua/documents/432021-36441" />
<sanctionsData countryCode="NZ" country="НОВА ЗЕЛАНДІЯ" sanction="1" date="2022-05-03" url="https://www.mfat.govt.nz/en/countries-and-regions/europe/ukraine/russian-invasion-of-ukraine/sanctions" />
<sanctionsData countryCode="PL" country="ПОЛЬЩА" sanction="0" date="" url="" />
<sanctionsData countryCode="US" country="СПОЛУЧЕНІ ШТАТИ АМЕРИКИ" sanction="1" date="2022-01-20" url="https://home.treasury.gov/policy-issues/financial-sanctions/recent-actions/20220120" />
<sanctionsData countryCode="CA" country="КАНАДА" sanction="1" date="2022-02-24" url="https://gazette.gc.ca/rp-pr/p2/2022/2022-03-16/html/sor-dors30-eng.html" />
</sanctions>
</comp>
<comp id="41" descr="Information from the public register of politically exposed persons of Ukraine">
<pep found="0" foundref="No information found" subname="ГАРНА ІРІНА ВАСИЛІВНА" bdate="1989-10-05" category="" lastpost="" dateofrelease="" isur="" state="" url="" typesearch="-1" typesearchtext="No person was found for any search parameters"/>
</comp>
<comp id="44" descr="Phone number verification">
<contverif phone="+380962134234" mathch="1" matchref="Yes">
<donortype donor="BNK"/>
</contverif>
</comp>
</ubkidata> |
XSD Schema request
https://secure.ubki.ua/b2/js/xsd/request12.xsd
XSD Schema response
https://secure.ubki.ua/b2/js/xsd/response12.xsd
Test URL
https://test.ubki.ua/b2_api_xml/ubki/xml
Test data
bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095" dtype="1" dser="ДО" dnom="270000" cval="+380981220000" ctype="3"
bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593" dtype="17" dser="" dnom="001013900" cval="+380935171868" ctype="3"
bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397" dtype="1" dser="СЕ" dnom="311111" cval="+380506630641" ctype="3"
bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116" dtype="1" dser="КО" dnom="220394" cval="+380971321122" ctype="3"
bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="3333312110" dtype="1" dser="ДД" dnom="222222" cval="+380732144444" ctype="3"
bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" okpo="3112579786" dtype="1" dser="СЮ" dnom="170000" cval="+380981224895" ctype="3"
|
Request XML |
Expand | ||
---|---|---|
| ||
<?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): 'Identification' report – 12" 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="Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)" lname="**Last name" fname="**First name" mname="**Middle name" bdate="**Date of birth"> </ident> <contacts> <cont ctype="Contact type (code from ref.10)" cval="Contact value" /> </contacts> <docs> <doc dtype="**Document type (code from ref.7)" dser="**Document series" dnom="**Document number" /> </docs> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
Example |
---|
Request JSON |
|
Response JSON |
|
Request XML |
|
Response XML |
|
XSD Schema request | https://secure.ubki.ua/b2/js/xsd/request12.xsd |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response12.xsd |
Test URL | https://test.ubki.ua/b2_api_xml/ubki/xml |
---|---|
Test data |
<comp id="18" descr="Alert"> okpo="one of the examples below" lname="Ivanov" fname="Ivan" mname="Ivanovitch" bdate="1975-01-01" dser="AH" dnom="454241" cval="380671234567" ctype="3"
<comp id="18"descr="Alert"> tag <changedeal>
<comp id="40" descr="Information from sanctions lists">
|
<comp id="18" descr="Client alert">
okpo="one of the examples below" lname="Ivanov" fname="Ivan" mname="Ivanovitch" bdate="1975-01-01" dser="AH" dnom="454241" cval="380671234567
|
2230428028
2269501369
2274214699
2293515103
|
descr=" |
Information from the Public Register of Politically Exposed Persons of Ukraine"> |
|
|
|
|
|
|
|
|
|
<comp id="72" descr="Search by full name + inn if more than 1 person is found">
|
76" descr="Information from |
the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)">
|
|
|
|
|
|
|
|
|
|
<comp id="41" descr="Information from the Public Register of Politically Exposed Persons of Ukraine">
|
|
|
|
|
|
|
|
|
|
|