...
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)" } } } |
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 of the business entity’s registration (code from ref.5)"
spdref="Presence of the business entity’s registration (value from ref.5)"
sstate="Social status (code from ref.6)"
sstateref="Social status (value from ref.6)"
cchild="Number of children">
<!--This part can and must contain 1..* items-->
</ident>
<!-- History of the Information about Employer part -->
<work wdonor="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)"
cdolgn="Official position (code from ref.8)"
cdolgnref="Official position (value from ref.8)"
wokpo="EDRPOU of the employer"
wname="Name of the employer in the base language"
wstag="Length of service, years completed"
wdohod="Client’s monthly income">
<!--This part can contain 0..*-->
</work>
<!-- 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>Response JSON
|
Request XML
( ** the parameters are transferred optionally if there is a credit history for this client from your organization)
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> |
|
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
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"
}
}
} |
Response JSON
|
Example |
---|
Request JSON |
|
Response JSON |
|
Request XML
|
Request XML |
|
Response 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|
---|---|---|
Test data |
18" descr=" НИКИФОРОВНАAlert" fname> okpo=" АННАone of the examples below" lname="Ivanov" fname=" ЯРЦЕВАIvan" okpomname=" 3112579786Ivanovitch" dtypebdate=" 11975-01-01" dser=" СЮAH" dnom ="170000" cval="+380981224895" ctype="3"="454241" cval="380671234567" ctype="3"
<comp id="18"descr="Alert"> tag <changedeal>
descr=" 3")Information from sanctions lists">
<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"
<comp id="1841" descr="AlertInformation from the Public Register of Politically Exposed Persons of Ukraine"> tag <changedeal>
<comp id="72" descr="Search by full name + inn if more than 1 person is found">
<comp id="4076" descr="Information from sanctions liststhe 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">
<comp id="72" descr="Search by full name + inn if more than 1 person is found">
|