...
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)/EDRPOU (for legal entities)", "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): 'Contacts' report – 04", "reqreason": "Request objective (code from ref.24)" }, "descr": "Request object" }, "descr": "Request envelope" }, "sessid": "Session key (obtained from the authorization API)" } } } |
Request XML
( **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 --><request version="1.0" reqtype="Template code (code from ref.49): 'Contacts' report – 04" 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)/EDRPOU (for legal entities)"
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=
|
|
|
|
inn="TIN of the credit history subject"
lname="Last name"
fname="First name"
mname="Middle name"
bdate="Date of birth"
csex="Sex
|
|
|
|
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=
|
|
|
|
|
|
|
|
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>
<!-- History of the Information about Addresses part -->
<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
|
<!--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="Data source for verification (Code from ref.63)"
found="
|
|
|
<!--This part must contain 1..* units and at least one document -->
</identdocmvd>
</identdocmvds>
</comp>
<!-- History of the Information about Contacts part -->
<comp id="10" descr="Names of components">
<cont inn="TIN of the credit history subject/EDRPOU of the legal entity"
cdonor="Source of information"
vdate="Date of the information from this part"
ctype="Contact type (code from ref.10)"
ctyperef="Contact type (value from ref.10)"
cval="Contact value">
<!--This part must contain 1..* units and at least one contact-->
</cont>
</comp>
<!-- Confirmation of the credit history subject’s contacts part -->
<comp id="46" descr="Names of components">
<contact cval="Contact value"
ctype=
|
|
|
|
|
cstateref="Contact’s status (text value from ref.57)"
vdatestart="First actualization date"
vdate=
|
<!--This part can contain 0..* items -->
</comp>
</ubkidata>
Example
Request JSON
|
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): 'Contacts' report – 04" 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)/EDRPOU (for legal entities)" 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 |
|
...