...
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
Expand | ||
---|---|---|
| ||
<?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> <!-- 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 one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019)"> <!--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="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 --> </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)" freezedate="FREEZE option connection date" nonewdealcomment="Comment" 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)" claim="Subject of dispute (Code from ref. 69)" claimref="Subject of dispute (Value from ref. 69)" 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> <!-- 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> <!-- Search by full name + inn if more than 1 person is found (The presence of the component is determined by searching for more than 1 person in the case of searching by full name + inn)--> <comp id="72" descr="Search by full name + inn if more than 1 person is found"> <person bdate="Date of birth" lngref="Search/transfer language (ref. 23)" lng="Part presentation language, value (ref. 23)" mname="Middle name" fname="First name" lname="Last name" inn="TIN of the credit history subject" /> </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"
}
}
} |
Response JSON
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 |
|
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 datadata |
18" descr=" НИКИФОРОВНАAlert" fname> okpo=" АННАone of the examples below" lname="Ivanov" fname=" ЯРЦЕВАIvan" okpomname=" 3112579786Ivanovitch" dtypebdate=" 11975-01-01" dser=" СЮAH" dnom="454241" cval= "170000" cval="+380981224895" ctype="3""380671234567" ctype="3"
<comp id="18"descr="Alert"> tag <changedeal>
descr=" 3")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" ctype="3"
<comp id="1841"18 - Client alert descr="Client alertInformation from the Public Register of Politically Exposed Persons of Ukraine"> tag <changedeal>
<comp id="4072" descr="Search by full name + inn if more than 1 person is found">
<comp id="76" 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">
|