Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

The report contains the following components:

Request JSON
( ** the parameters are transferred optionally if there is a credit history for this client from your organization)

Expand
title body:

{

"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
titlebody:

<?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="

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Step name",

"stm": "Step start stamp date",

"ftm": "Step finish stamp date"

}

},

"error": {

"errtype": "Error code (code from ref.0)",

"errtext": "Error text (value from ref.0)"

},

"reqinfo": {

"reqid": "Outgoing request ID generated by UBKI"

},

"billing": {

"balance": {

"value": "Total assets",

"date": "Date",

"time": "Time"

}

}

},

"compbilldetails": [ {

"ckifreemon": {

"ident": {

"donor": "Source of information (code from ref. 54"Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)",

"vdatefreemonref": "Date of the information from this part", "lng": "Part presentation language (code from ref.Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"

}

}

},

"comp": [

{

"cki": {

"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"

},

"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"

},

"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"

},

"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)"

},

"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"

},

"identdocmvds": {

"identdocmvd": {

"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"

},

"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)"

}

},

"id": "1",

"descr": "Names of components"

},

{

"pret": {

"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"

},

"freezedate": "FREEZE option connection date",

"nonewdealcomment": "Comment",

"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)"

},

"idfcert": "18",{

"descrinn": "Components nameTIN" }, {

"sanctions": {

"sanctionsData": {

"countryCode": "Country code",

"country": "The name of the country",

"sanction": "Presence of sanctions imposed by the country (Code from ref. 68cert": "Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) ",

"certref": "Availability of a certificate from the UBCH (value from ref. 56)",

"datecertid": "Date of entry into the listCertificate number",

"urlcerturl": "Link to the document – confirmationcertificate"

},

"foundmaybegone": "Availability of information (Code from ref. 27)",{

"foundRefinn": "Text interpretation of available information (Code from ref. 27)TIN",

"subNamevdate": "Subject’s nameApplication creation date",

"bDatedldonor": "Subject’s date of birth",

"position": "Position",

"reason": "Grounds for imposing sanctions",

"typeSearch": "Search type (Code Information provider (code from ref. 6754)",

"typeSearchText": "Text interpretation of the type of search (Code from ref. 67)"

},

"id": "4018",

"descr": "Information from sanctions listsComponents name"

},

{

"pepsanctions": {

"foundsanctionsData": "0 – not located, 1 – located ",{

"foundrefcountryCode": "not located/locatedCountry code",

"subnamecountry": "Subject’s The name of the country",

"bdatesanction": "Subject’s date of birthPresence of sanctions imposed by the country (Code from ref. 68)",

"categorydate": "Category Date of entry into the politically exposed personlist",

"lastposturl": "Last position"Link to the document – confirmation"

},

"dateofreleasefound": "Date of leaving of the last positionAvailability of information (Code from ref. 27)",

"foundRef": "Text interpretation of available information (Code from ref. 27)",

"isursubName": "Indication of legal entitySubject’s name",

"statebDate": "Status Subject’s date of legal entitybirth",

"urlposition": "Link to the document – confirmation" }Position",

"idreason": "41Grounds for imposing sanctions",

"descrendDate": "Information from the Public Register of Politically Exposed Persons of Ukraine"

},

{

"contverif": {

"donortype": {

"donor": "Source of information (code from ref.54)"

},

"phone": "Phone number verified",

"mathch": "Phones verification result (code from ref.56Expiration date of restrictions",

"sanctionsTerm": "The term of imposing the sanction",

"sanctionsNo": "Type of imposed restrictions, numbers",

"sanctions ": "The type of constraints imposed is Expanded",

"address": "Location",

"typeSearch": "Search type (Code from ref. 67)",

"matchreftypeSearchText": "Phones verification result in text format (ref.56Text interpretation of the type of search (Code from ref. 67)"

},

"id": "4440",

"descr": "Names of componentsInformation from sanctions lists"

},

{

"personpep": {

"bdatefound": "Date of birth0 – not located, 1 – located ",

"lngreffoundref": "Search/transfer language (ref. 23)not located/located",

"lngsubname": "Part presentation language, value (ref. 23)Subject’s name",

"mnamebdate": "Middle nameSubject’s date of birth",

"fnamecategory": "First nameCategory of the politically exposed person",

"lnamelastpost": "Last nameposition",

"inn dateofrelease": "TIN of the credit history subject",Date of leaving of the last position",

"isur": "Indication of legal entity",

"state": "Status of legal entity",

"url": "Link to the document – confirmation"

},

"id": "7241",

"descr": "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)"

}

]

}

}

Request XML
( ** the parameters are transferred optionally if there is a credit history for this client from your organization)

Expand
title body:

<?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>

Information from the Public Register of Politically Exposed Persons of Ukraine"

},

{

"contverif": {

"donortype": {

"donor": "Source of information (code from ref.54)"

},

"phone": "Phone number verified",

"mathch": "Phones verification result (code from ref.56)",

"matchref": "Phones verification result in text format (ref.56)"

},

"id": "44",

"descr": "Names of components"

},

{

"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",

},

"id": "72",

"descr": "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)"

},

{

"ludomans":{

"found": "Numerical indication of whether a person is found in the register - 0/1",

"foundref": "Textual definition of whether a person is found in the register: Not found (0)/Found (1)",

"information": {

"searchType": "Search type - 0/1/2/3",

"searchTypeRef": "Text definition of search type: No matches found (0)/Found by TIN (1)/Found by name and date of birth (2)/Found by last name, first name and date of birth (3)",

"lastName": "Last name",

"firstName": "Name",

"middleName": "Middle name",

"dateOfBirth": "Date of birth",

"inn": "TIN",

"documentSeries": "Document series",

"documentNumber": "Document number",

"documentIssuedDate": "Document issue date",

"documentIssuedBy": "Issuer",

"documentOtherData": "Other information about the document",

"passport": "Passport",

"gender": "Sex",

"address": "Address",

"communication": "Contacts",

"stateCode": "Country code",

"rDateFrom": "Period start date",

"rDateTill": "Period end date",

"reason": "Reason"

}

},

"id": "76",

"descr": "Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)"

}

}

}

Request XML
( ** the parameters are transferred optionally if there is a credit history for this client from your organization)

Expand
title body:

<?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)"

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)"

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>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<?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" />

<billdetails freemon="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)"

freemonref="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)

</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>

<!-- 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>

<fcert inn="TIN"

cert="Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) "

certref="Availability of a certificate from the UBCH (value from ref. 56)"

certid="Certificate number"

certurl="Link to the certificate" />

<maybegone inn="TIN"

vdate="Application creation date"

dldonor="Information provider (code from ref. 54)"/>

</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"

endDate = "Expiration date of restrictions"

      sanctionsTerm = "The term of imposing the sanction"

         sanctionsNo = "Type of imposed restrictions, numbers"

        sanctions = "The type of constraints imposed is Expanded"

        address = "Location"

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>

<!-- Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds) -->

<comp id="76" descr="The name of the component">

<ludomans found="Numerical indication of whether a person is found in the register - 0/1"

foundref="Textual definition of whether a person is found in the register:Not found (0)/Found (1)" >

<information searchType="Search type - 0/1/2/3"

searchTypeRef="Text definition of search type: No matches found (0)/Found by TIN (1)/Found by name and date of birth (2)/Found by last name, first name and date of birth (3)"

lastName="Last name"

firstName="Name"

middleName="Middle name"

dateOfBirth="Date of birth"

inn="TIN"

documentSeries="Document series"

documentNumber="Document number"

documentIssuedDate="Document issue date"

documentIssuedBy="Issuer"

documentOtherData="Other information about the document"

passport="Passport"

gender="Sex"

address="Address"

communication="Contacts"

stateCode="Country code"

rDateFrom="Period start date"

rDateTill="Period end date"

reason="Reason" />

<!--This block must consist of 0 .. * elements-->

</ludomans>

</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

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-25 12:15:47.585",
					"ftm": "2022-08-25 12:15:47.807"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002459637"
			}
		},
		"comp": [
			{
				"cki": {
					"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"
						},
						{
							"cchild": "",
							"sstateref": "",
							"sstate": "",
							"spdref": "natural person",
							"spd": "1",
							"cgragref": "",
							"cgrag": "804",
							"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": "Ukrainian citizen 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"
					},
					"bdate": "1989-10-05",
					"reqlngref": "Ukrainian",
					"reqlng": "1",
					"mname": "ВАСИЛІВНА",
					"fname": "ІРІНА",
					"lname": "ГАРНА",
					"inn": "3278508288"
				},
				"identdocmvds": {
					"identdocmvd": {
						"foundsource": [
							{
								"name": "MVS",
								"found": "1",
								"foundref": "Found",
								"sourcedate": "2022-10-16"
							},
							{
								"name": "DMS",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-16"
							},
							{
								"name": "UBKI",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-16"
							}
						],
						"found": "1",
						"foundref": "Found",
						"foundtitle": "Passport АМ-578072 is found in the list of invalid passports",
						"pser": "АМ",
						"pnom": "578072",
						"dtype": "1",
						"dtyperef": "Ukrainian citizen passport"
					}
				},
				"id": "1",
				"descr": "Identification of the Credit History Subject (CHS)"
			},
			{
				"pret": {
					"inn": "3278508288",
					"nonewdeal": "0",
					"nonewdealref": "No",
					"nonewdealcomment": "",
					"freezedate":""
				},
				"fcert": {
					"inn": "3278508288",
					"cert": "0",
					"certref": "No",
					"certid": "",
					"certurl": ""
				},
				"maybegone": {
					"inn": "3278508288",
					"vdate": "2022-12-01",
					"dldonor": "BNK"
				},
				"id": "18",
				"descr": "Alert"
			},
			{
				"sanctions": {
					"sanctionsData": [
						{
							"countryCode": "EU",
							"country": "ЄВРОПЕЙСЬКИЙ СОЮЗ",
							"sanction": "0",
							"date": "",
							"url": ""
						},
						{
							"countryCode": "AU",
							"country": "АВСТРАЛІЯ",
							"sanction": "1",
							"date": "2022-05-18",
							"url": "https://www.dfat.gov.au/international-relations/security/sanctions/consolidated-list"
						},
						{
							"countryCode": "CH",
							"country": "ШВЕЙЦАРІЯ",
							"sanction": "0",
							"date": "",
							"url": ""
						},
						{
							"countryCode": "JP",
							"country": "ЯПОНІЯ",
							"sanction": "0",
							"date": "",
							"url": ""
						},
						{
	
"docs
						"countryCode": 
{
"GB",
							"
doc
country":
{
 "СПОЛУЧЕНЕ КОРОЛІВСТВО",
							"
dtype
sanction": "
1
0",
							"
dser
date": "
АМ
",
							"
dnom
url": "
578072
"
						},
						
}
{
							
}
"countryCode": "UA",
							"
contacts
country": 
{
"УКРАЇНА",
							"
cont
sanction": 
{
"1",
							"
cval
date": "
+380962134234
2021-02-02",
							"
ctype
url": "
3
https://www.president.gov.ua/documents/432021-36441"
						},
						
},
{
							"
reqlng
countryCode": "
4
NZ",
						
}
	"country": "НОВА ЗЕЛАНДІЯ",
							"
version
sanction": "1
.0
",
							"
reqtype
date": "
12
2022-05-03",
							"
reqreason
url": "
2
https://www.mfat.govt.nz/en/countries-and-regions/europe/ukraine/russian-invasion-of-ukraine/sanctions"
						},
						
}
{
				
},
			"
sessid
countryCode": "
6D7D781B1E884A6AB384481804A35EA8
PL",
		
} } }

Response JSON

Code Block
{
	"ubkidata": {
					"techcountry": {
			"traceПОЛЬЩА": {,
				"step": {
					"namesanction": "build report0",
							"stm": "2022-11-25 12:15:47.585"date": "",
							"ftmurl": "2022-08-25 12:15:47.807"
						},
				},
		{
							"reqinfocountryCode": {"US",
							"reqidcountry": "req2#000002459637СПОЛУЧЕНІ ШТАТИ АМЕРИКИ",
			}
		},
		"compsanction": ["1",
			{
				"ckidate": {
"2022-01-20",
							"identurl": [ "https://home.treasury.gov/policy-issues/financial-sanctions/recent-actions/20220120"
						},
						{
							"cchildcountryCode": "CA",
							"sstaterefcountry": "КАНАДА",
							"sstatesanction": "1",
							"spdrefdate": "natural person2022-02-24",
							"spdurl": "1",https://gazette.gc.ca/rp-pr/p2/2022/2022-03-16/html/sor-dors30-eng.html"
						}
	"cgragref				],
					"found": "Ukraine1",
							"cgragfoundRef": "804Found information",
							"ceducrefsubName": "ГАРНА ІРІНА ВАСИЛІВНА",
							"ceducbDate": "05.10.1989",
							"familyref": ""position": "Народний депутат Верховної Ради IX скликання («Опозиційна платформа — за життя»)",
							"familyreason": "Дестабілізація ситуації в Україні",
							"csexrefendDate": "woman2032-09-07",
							"csex
                    "sanctionsTerm": "2Десять років",
							"bdate": "1989-10-05",
							"mname": "ВАСИЛІВНА",
							"fname": "ІРІНА",
							"lname": "ГАРНА",
							"inn": "3278508288",
							"lngref": "Ukrainian",
							"lng": "1",
							"vdate": "2022-02-25",
							"donor": "BNK"
						},
						{
							"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"
					},
					"bdate": "1989-10-05",
					"reqlngref": "Ukrainian",
					"reqlng": "1",
					"mname": "ВАСИЛІВНА",
					"fname": "ІРІНА",
					"lname": "ГАРНА",
					"inn": "3278508288"
				},
				"identdocmvds": {
					"identdocmvd": {
						"foundsource": [
							{
								"name": "MVS",
								"found": "1",
								"foundref": "Found",
								"sourcedate": "2022-10-16"
							},
							{
								"name": "DMS",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-16"
							},
							{
								"name": "UBKI",
								"found": "0",
								"foundref": "Not found",
								"sourcedate": "2022-10-16"
							}
						],
						"found": "1",
						"foundref": "Found",
						"foundtitle": "Passport АМ-578072 is found in the list of invalid passports.",
						"pser": "АМ",
						"pnom": "578072",
						"dtype": "1",
						"dtyperef": "Passport"
					}
				},
				"id": "1",
				"descr": "Identification of the Credit History Subject (CHS)"
			},
			{
				"pret": {
					"inn": "3278508288                    "sanctionsNo": "1, 2, 3, 4, 5, 6, 7, 11, 13, 14, 19, 24, 24-1",
                    "sanctions": "1 - блокування активів - тимчасове позбавлення права користуватися та розпоряджатися активами, що належать фізичній або юридичній особі, а також активами, щодо яких така особа може прямо чи опосередковано (через інших фізичних або юридичних осіб) вчиняти дії, тотожні за змістом здійсненню права розпорядження ними; 2 - обмеження торговельних операцій; 3 - обмеження, часткове чи повне припинення транзиту ресурсів, польотів та перевезень територією України; 4 - запобігання виведенню капіталів за межі України; 5 - зупинення виконання економічних та фінансових зобов’язань; 6 - анулювання або зупинення ліцензій та інших дозволів, одержання (наявність) яких є умовою для здійснення певного виду діяльності, зокрема, анулювання чи зупинення дії спеціальних дозволів на користування надрами; 7 - заборона участі у приватизації, оренді державного майна резидентами іноземної держави та особами, які прямо чи опосередковано контролюються резидентами іноземної держави або діють в їх інтересах; 11 - заборона або обмеження заходження іноземних невійськових суден та військових кораблів до територіального моря України, її внутрішніх вод, портів та повітряних суден до повітряного простору України або здійснення посадки на території України; 13 - заборона видачі дозволів, ліцензій Національного банку України на здійснення інвестицій в іноземну державу, розміщення валютних цінностей на рахунках і вкладах на території іноземної держави; 14 - припинення видачі дозволів, ліцензій на ввезення в Україну з іноземної держави чи вивезення з України валютних цінностей та обмеження видачі готівки за платіжними картками, емітованими резидентами іноземної держави; 19 - заборона передання технологій, прав на об’єкти права інтелектуальної власності; 24 - позбавлення державних нагород України, інших форм відзначення; 24-1 - заборона на набуття у власність земельних ділянок",
                    "address": "",
					"nonewdealtypeSearch": "0",
					"nonewdealreftypeSearchText": "No",
					"nonewdealcomment": ""Found by name and date of birth"
				},
				"id": "1840",
				"descr": "Client alertInformation from sanctions lists"
			},
			{
				"sanctions": {
					"sanctionsData": [
						{
		pep": {
					"countryCodefound": "EU0",
							"countryfoundref": "ЄВРОПЕЙСЬКИЙNo information СОЮЗfound",
							"sanctionsubname": "0ГАРНА ІРІНА ВАСИЛІВНА",
							"datebdate": "1989-10-05",
							"urlcategory": ""
						},
						{
							"countryCodelastpost": "AU",
							"countrydateofrelease": "АВСТРАЛІЯ",
							"sanctionisur": "1",
							"datestate": "2022-05-18",
							"url": "https://www.dfat.gov.au/international-relations/security/sanctions/consolidated-list"
						},
						{
							"countryCodetypesearch": "CH-1",
							"countrytypesearchtext": "ШВЕЙЦАРІЯ",
No person was found for any search parameters"
				},
				"sanctionid": "041",
							"datedescr": "Information from the public register of politically exposed persons of Ukraine"
			},
			{
				"urlcontverif": {
					"donortype": {
						},"donor": "BNK"
						{},
							"countryCodephone": "JP+380962134234",
							"countrymathch": "ЯПОНІЯ1",
							"sanctionmatchref": "0Yes",
				},
				"dateid": "44",
			
				"urldescr": "Phone number verification"
						},
			{
			"ludomans":{

							"countryCode": "GB",
							"country": "СПОЛУЧЕНЕ КОРОЛІВСТВО",
							"sanction": "0",
							"date": "",
							"url": ""
						},
						{
							"countryCode": "UA",
							"country": "УКРАЇНА",
							"sanction": "1",
							"date": "2021-02-02",
							"url": "https://www.president.gov.ua/documents/432021-36441"
						},
						{
							"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"
						},
						{
							"countryCode": "PL",
							"country": "ПОЛЬЩА",
							"sanction": "0",
							"date": "",
							"url": ""
						},
						{
							"countryCode": "US",
							"country": "СПОЛУЧЕНІ ШТАТИ АМЕРИКИ",
							"sanction": "1",
							"date": "2022-01-20",
							"url": "https://home.treasury.gov/policy-issues/financial-sanctions/recent-actions/20220120"
						},
						{
							"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"
						}
					],
					"found": "1",
					"foundRef": "Found information",
					"subName": "ГАРНА ІРІНА ВАСИЛІВНА",
					"bDate": "05.10.1989",
					"position": "Народний депутат Верховної Ради IX скликання («Опозиційна платформа — за життя»)",
					"reason": "Дестабілізація ситуації в Україні",
					"typeSearch": "0",
					"typeSearchText": "Found by name and date of birth"
				},
				"id": "40",
				"descr": "Information from sanctions lists"
			},
			{
				"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"
				},
				"id": "41",
				"descr": "Information from the public register of politically exposed persons of Ukraine"
			},
			{
				"contverif": {
					"donortype": {
						"donor": "BNK"
					},
					"phone": "+380962134234",
					"mathch": "1",
					"matchref": "Yes"
				},
				"id": "44",
				"descr": "Phone number verification"
			}
		]
	}
}

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"
                  "found": 0,
		                  "foundref":"Not found in the registry of ludomaniacs",
		                  "information": []
		         },
			"id": "76",
			"descr": "Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)"
		}
	}
}

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="804" 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="Ukrainian citizen 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"/>
        
</
docs>
cki>
        <identdocmvds>
   
<contacts>
         
<cont cval="+380962134234" ctype="3" /> </contacts> </i> </request>
<identdocmvd found="1" foundref="Found" foundtitle="Passport АМ-578072 is found in the list of invalid passports" pser="АМ" pnom="578072" dtype="1" dtyperef="Ukrainian citizen passport">
        
</req_xml>
     
</req_envelope>
   
</ubki> </doc>

Response XML

Code Block
<?xml version<foundsource name="MVS" found="1.0" encodingfoundref="UTF-8Found" standalonesourcedate="yes"?>
<ubkidata>2022-10-16"/>
    <tech>         <trace>             <step <foundsource name="build reportDMS" found="0" stmfoundref="2022-11-25 12:15:47.585Not found" ftmsourcedate="2022-08-25 12:15:47.80710-16"/>
         </trace>       <foundsource name="UBKI"  <reqinfo reqid="req2#000002459637found="0" foundref="Not found" sourcedate="2022-10-16"/>
    </tech>     <comp id="1" descr="Identification of the Credit History Subject (CHS)"> </identdocmvd>
        </identdocmvds>
    <cki bdate="1989-10-05" reqlngref="Ukrainian" reqlng="1" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" inn="3278508288</comp>
    <comp id="18" descr="Alert">
            <ident cchild<pret inn="3278508288" sstaterefnonewdeal="0" sstatenonewdealref="No" spdrefnonewdealcomment="natural person" spdfreezedate="1" cgragref/>
        <fcert inn="Ukraine3278508288" cgragcert="8040" ceducrefcertref="No" ceduccertid="" familyrefcerturl="" family="" csexref="woman" csex="2" bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА"/>
        <maybegone inn="3278508288" lngref="Ukrainian" lng="1" vdate="2022-0212-2501" donordldonor="BNK" />
  
    </comp>
    <ident<comp cchildid="40" sstaterefdescr="Information from sanctions lists" sstate="" spdref="natural person" spd>
      <sanctions found="1" cgragreffoundRef="Знайдена інформація" cgragsubName="802ГАРНА ІРІНА ВАСИЛІВНА" ceducrefbDate="05.10.1989" ceducposition="" 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="Дестабілізація ситуації в УкраїніНародний депутат Верховної Ради IX скликання («Опозиційна платформа — за життя»)" reason="Дестабілізація ситуації в Україні" endDate="2032-09-07" sanctionsTerm="Десять років" sanctionsNo="1, 2, 3, 4, 5, 6, 7, 11, 13, 14, 19, 24, 24-1" sanctions="1 - блокування активів - тимчасове позбавлення права користуватися та розпоряджатися активами, що належать фізичній або юридичній особі, а також активами, щодо яких така особа може прямо чи опосередковано (через інших фізичних або юридичних осіб) вчиняти дії, тотожні за змістом здійсненню права розпорядження ними; 2 - обмеження торговельних операцій; 3 - обмеження, часткове чи повне припинення транзиту ресурсів, польотів та перевезень територією України; 4 - запобігання виведенню капіталів за межі України; 5 - зупинення виконання економічних та фінансових зобов’язань; 6 - анулювання або зупинення ліцензій та інших дозволів, одержання (наявність) яких є умовою для здійснення певного виду діяльності, зокрема, анулювання чи зупинення дії спеціальних дозволів на користування надрами; 7 - заборона участі у приватизації, оренді державного майна резидентами іноземної держави та особами, які прямо чи опосередковано контролюються резидентами іноземної держави або діють в їх інтересах; 11 - заборона або обмеження заходження іноземних невійськових суден та військових кораблів до територіального моря України, її внутрішніх вод, портів та повітряних суден до повітряного простору України або здійснення посадки на території України; 13 - заборона видачі дозволів, ліцензій Національного банку України на здійснення інвестицій в іноземну державу, розміщення валютних цінностей на рахунках і вкладах на території іноземної держави; 14 - припинення видачі дозволів, ліцензій на ввезення в Україну з іноземної держави чи вивезення з України валютних цінностей та обмеження видачі готівки за платіжними картками, емітованими резидентами іноземної держави; 19 - заборона передання технологій, прав на об’єкти права інтелектуальної власності; 24 - позбавлення державних нагород України, інших форм відзначення; 24-1 - заборона на набуття у власність земельних ділянок" address="" 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>>
        </contverif>
    </comp>
    <comp id="76" descr="Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)">
        <ludomans found="0" foundref="Not found in the registry of ludomaniacs"  />
    </comp>
</ubkidata>

Test URL

https://test.ubki.ua/b2_api_xml/ubki/xml

Test datadata

  • 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="19911981-0305-3020" mname="ПЕТРОВИЧПЕТРОВНА" fname="ВАДИММАРИЯ" lname="НИКОЛАЕВИВАНЦОВА" okpo="33326430952972566397" dtype="1" dser="ДОСЕ" dnom="270000311111" cval="+380981220000380506630641" ctype="3"

  • bdate="19741988-0807-2010" mname="БОГДАНОВИЧІВАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ"ПОШТАР" okpo="3233312116" dtype="1" dser="КО" dnom="220394" cval="+380971321122" ctype="3"

  • bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="27260205933333312110"   dtype="171" dser="ДД" dnom="001013900222222" cval="+380935171868380732144444" ctype="3"

  • bdate="19811985-0503-20" mname="ПЕТРОВНАНИКИФОРОВНА" fname="МАРИЯАННА" lname="ИВАНЦОВАЯРЦЕВА" okpo="29725663973112579786" dtype="1" dser="СЕСЮ" dnom="311111170000" cval="+380506630641380981224895" ctype="3"

  • bdate="19881957-0710-1019" mname="ІВАНОВИЧІГОРЕВНА" fname="БОГДАНАННА" lname="ПОШТАРРИБАЧКА" okpo="32333121162111118724" dtype="1" dser="КОВВ" dnom="142228" cval="+380662134234" ctype="2203943" (cval="+38097132112248202011010" ctype="3")

  • bdate="19911989-0410-0605" mname="ВОЛОДИМИРОВИЧВАСИЛІВНА" fname="ВОЛОДИМИРІРІНА" lname="ТКАЧУКГАРНА" okpo="33333121103278508288" dtype="1" dser="ДДАМ" dnom="578072" cval="222222" "+380962134234" ctype="3" (cval="+380732144444421224946000" ctype="3")bdate

<comp id="

1985-03-20" mname

18" descr="

НИКИФОРОВНА

Alert"

fname

>

okpo="

АННА

one of the examples below" lname="Ivanov" fname="

ЯРЦЕВА

Ivan"

okpo

mname="

3112579786

Ivanovitch"

dtype

bdate="

1

1975-01-01" dser="

СЮ

AH" dnom="454241" cval=

"170000" cval="+380981224895" ctype="3"

"380671234567" ctype="3"

  • 2230428048

  • 2269501369

  • 2274214699

  • 2293515103

<comp id="18"descr="Alert">  tag <changedeal> 

  • bdate="19571991-1003-1930" mname="ІГОРЕВНАПЕТРОВИЧ" fname="АННАВАДИМ" lname="РИБАЧКАНИКОЛАЕВ" okpo="21111187243332643095" dtype="1" dser="ВВДО" dnom="142228270000" cval="+380662134234380981220000" ctype="3" (cval

<comp id="

+48202011010

40"

ctype

descr="

3")

Information from sanctions lists">

  • bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" dtype="1" dser="АМ" dnom="578072" cval="+380962134234" ctype="3" (cval="+421224946000" ctype="3")

<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"

  • 2230428028

  • 2269501369

  • 2274214699

  • 2293515103")

<comp id="1841"18 - Client alert descr="Client alertInformation from the Public Register of Politically Exposed Persons of Ukraine">  tag <changedeal> 

  • bdate="19911981-0305-3020" mname="ПЕТРОВИЧПЕТРОВНА" fname="ВАДИММАРИЯ" lname="НИКОЛАЕВИВАНЦОВА" okpo="33326430952972566397" dtype="1" dser="ДОСЕ" dnom="270000311111" cval="+380981220000380506630641" ctype="3"

<comp id="4072" descr="Search by full name + inn if more than 1 person is found">

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА"

<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)">

  • bdate="19891957-10-0519" mname="ВАСИЛІВНАІГОРЕВНА" fname="ІРІНААННА" lname="ГАРНАРИБАЧКА" okpo="32785082882111118724" dtype="1" dser="АМВВ" dnom="578072142228" cval="+380962134234" ctype="3" (cval="+421224946000380662134234" ctype="3")

<comp id="41" descr="Information from the Public Register of Politically Exposed Persons of Ukraine"> 

  • bdate="19811991-0504-2006" mname="ПЕТРОВНАВОЛОДИМИРОВИЧ" fname="МАРИЯВОЛОДИМИР" lname="ИВАНЦОВАТКАЧУК" okpo="29725663973333312110" dtype="1" dser="СЕДД" dnom="311111222222" cval="+380506630641380732144444" ctype="3"

<comp id="72" descr="Search by full name + inn if more than 1 person is found">

  • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА"