...
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" }, "mvd": { "dtype": "Sought-for document type (code 1, 3, 17 from дов.7)", "pser": "Series of the required passport", "pnom": "Number of required passport or ID-card number", "plname": "Surname of the required passport", "pfname": "Name of the required passport", "pmname": "Patronymic of the required passport", "pbdate": "Date of birth of the required passport" }, "reqlng": "Search criteria language (code from ref.23)" }, "version": "1.0", "reqtype": "Template code (code from ref.49): 'Verification ' – 21", "reqreason": "Request objective (code from ref.24)" }, "descr": "Request object" }, "descr": "Request envelope" }, "sessid": "Session key (obtained from the authorization API)" } } } |
( **parameters are passed optionally)
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
|
|
|
<!-- 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>
<!-- For the requests to search for canceled documents -->
<mvd dtype= "Sought-for document type (code 1, 3, 17 from дов.7)"
pser="Series of the required passport"
pnom="Number of required passport or ID-card number"
plname="Surname of the required passport"
pfname="Name of the required passport"
pmname="Patronymic of the required passport"
pbdate="Date of birth of the required passport">
</mvd>
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc>
Response XML
title | body: |
---|
<?xml version="1.0" encoding="utf-8"?>
<ubkidata>
<tech>
<!-- System information part -->
<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>
<billing>
<!-- Information about the current status of the prepaid account part-->
<balance value="Total assets" date="Date" time="Time" />
</billing>
</tech>
<!-- Search for canceled documents -->
<comp id="5" descr="Components name">
<mvd found="Is it found? (The code from ref.27)"
foundref="Is it found? (Meaning from ref.27)"
foundtitle="Description of the search result"
pser="Series of the required passport"
pnom="Number of the required passport or number of ID-card"
plname="Surname of the required passport"
pfname="Name of the required passport"
pmname="Father’s name of the required passport"
pbdate="Date of birth of the required passport"
status="Reason for cancellation (Only for data from DATA.GOV.UA)"
stdate="Cancellation Date (Only for data from DATA.GOV.UA)">
<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-->
</mvd>
</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
|
|
<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>
<!-- Subject Verification by Full Name+DOB+Passport part -->
<comp id="22" descr="Names of components">
<passportverif coincide="0-no match, 1-match"
coincideref="Yes/No"
lname="Last name"
fname="First name"
mname="Middle name"
bdate="Date of birth"
ser="Sought-for passport series"
nom="Number of the sought-for passport or ID card" />
</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): 'Verification ' – 21" 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> <!-- For the requests to search for canceled documents --> <mvd dtype= "Sought-for document type (code 1, 3, 17 from дов.7)" pser="Series of the required passport" pnom="Number of required passport or ID-card number" plname="Surname of the required passport" pfname="Name of the required passport" pmname="Patronymic of the required passport" pbdate="Date of birth of the required passport"> </mvd> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
Example |
---|
Request JSON |
|
Response JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Request XML |
|
...