10 - Credit report of an individual


Information on past and current loans of individuals and the history of their repayment.


Http Method

POST

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

{

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

},

"spd": {

"inn": "Tax/Taxpayer Identification Number (INN-RNUKPN, for legal entities)"

},

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

}

},

"mvd": {

"dtype": "Document type (code from ref.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 the ref.49): 'Credit report of an individual' - 10",

"reqreason": "Purpose of the request (Code from the ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (we receive it from the API authorization)"

}

}

}

Response JSON

{

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

},

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

}

}

},

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

},

{

"donorsData": {

"donorTypeDealCount": {

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

"typeref": "Source/donor of information (value from ref. 54)",

"count": "The number of deals"

},

"totalCount": "Total number of unique creditors",

"activeCount": "Number of unique creditors under current agreements"

},

"crdeal": {

"deallife": {

"dlref": "Transaction identifier",

"dlmonth": "Data period (month)",

"dlyear": "Data period (year)",

"dlds": "Date of the transaction beginning",

"dldpf": "Date of the transaction ending by the agreement",

"dldff": "Actual date of the transaction ending",

"dlflstat": "Transaction Status at the current period (Code from ref.16)",

"dlflstatref": "Transaction status at the current period (Meaning from ref.16)",

"dlamtlim": "Current transaction limit (for revolving transactions, credit cards)",

"dlamtpaym": "The amount of the obligatory payment in the current period",

"dlamtcur": "The sum of the current debt",

"dlamtexp": "The sum of the current outstanding debt",

"dldayexp": "Current number of days in arrears",

"dlflpay": "The sign of payment execution in the current period (the code from ref.13)",

"dlflpayref": "The sign of payment execution in the current period (Meaning from ref.13)",

"dlflbrk": "The sign of the existence of an outstanding payment in the current period (the code from ref.13)",

"dlflbrkref": "The sign of the existence of an outstanding payment in the current period (Meaning from ref.13)",

"dlfluse": "Characteristics of a credit tranche in the current period (code from ref.13)",

"dlfluseref": "Characteristics of a credit tranche in the current period (Meaning from ref.13)",

"dldateclc": "Calculation Date"

},

"dlref": "Transaction identifier",

"lng": "Block representation language (Code from ref.23)",

"lngref": "Block representation language (Meaning from ref.23)",

"inn": "INN SKI / EGRPOU of the legal entity",

"lname": "Surname/Name of the legal entity",

"fname": "Name",

"mname": "Father’s name",

"bdate": "Date of Birth",

"dlcelcred": "Transaction type (Code from ref.17)",

"dlcelcredref": "Transaction type (Meaning from ref.17)",

"dlvidobes": "Type of collateral (Code from ref.15)",

"dlvidobesref": "Type of collateral (Meaning from ref.15)",

"dlporpog": "Repayment procedure (Code from ref.18)",

"dlporpogref": "Repayment procedure (Meaning from ref.18)",

"dlcurr": "Transaction currency (Code from ref.12)",

"dlcurrref": "Transaction currency (Meaning from ref.12)",

"dlamt": "Transaction sum (initial)",

"dldonor": "Information donor (code from ref.54)",

"dlrolesub": "Role of the subject (Code from ref.14)",

"dlrolesubref": "Role of the subject (Meaning from ref.14)",

"dlamtobes": "Cost of collateral in the base currency"

},

"id": "2",

"descr": "Components name"

},

{

"penaltiesCount": {

"totalCount": "The total number of enforcement proceedings for all time",

"activeCount": "Number of active enforcement proceedings"

},

"susd": {

"changes": {

"voteid": "Enforcement Number",

"inn": "TIN of the debtor",

"votedate": "Enforcement start date",

"votesudname": "Executor",

"vdate": "Record Date",

"credname": "Name of creditor",

"credokpo": "Creditor`s code",

"vpstate": "Status of proceedings"

},

"votesudname": "Executor",

"votetype": "Enforcement type",

"votedate": "Enforcement start date",

"inn": "TIN of the debtor",

"voteid": "Enforcement Number",

"votedonor": "Source of information",

"votesudphone": "Executor’s phone",

"votesudemail": "Executor’s email",

"vdate": "Record update date",

"credname": "Creditor name",

"credokpo": "Creditor`s code",

"vpstate": "Status of proceedings"

},

"id": "3",

"descr": "Information on the enforcement proceedings of SKI"

},

{

"credres": {

"redate": "Date of decision",

"retime": "Time of decision",

"inn": "INN",

"reqid": "Request identifier in the Bureau",

"result": "Report result (Code from ref.19)",

"resultref": "Report result (Meaning from ref.19)",

"reqreason": "Reason for the request in to the bureau (Code from ref.24)",

"reqreasonref": "Reason for the request in to the bureau (Meaning from ref.24)",

"org": "Initiating agency (code from ref.54)",

"typereport": "The type of report provided (Code from ref.71)",

"typereportref": "The type of report provided (Meaning from ref.71)"

},

"reestrtime": {

"hr": "Number of requests per hour",

"da": "Number of requests per day",

"wk": "Number of requests per week",

"mn": "Number of requests per month",

"qw": "Number of requests per quarter",

"ye": "Number of requests per year",

"yu": "Number of requests per over a year"

},

"id": "4",

"descr": "Components name"

},

{

"mvd": {

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

},

"id": "5",

"descr": "Components name"

},

{

"moncredres": {

"org": "Initiating organization (code from ref.54)",

"resultref": "Monitoring result (value from ref.19)",

"result": "Monitoring result (Code from ref.19)",

"monid": "Unique Monitoring Identifier",

"inn": "TIN",

"startdate": "Monitoring start date",

"enddate": "Date of last monitoring "

},

"id": "6",

"descr": "Components name"

},

{

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

},

"id": "10",

"descr": "Names of components"

},

{

"utilitiesdebt": {

"utldebt": {

"debtDate": "Date of calculation of arrears for payment of communal services",

"totalDebt": "Current arrears for the payment of utility services, taking into account overdue arrears on bills for the previous period and the last bill issued",

"expDebt": "Overdue arrears for the payment of utility services on bills for the previous period, without the last issued bill"

},

"inn": "TIN code of the utility payer",

"branch": "Center of operational activity or utility service region",

"account": "Personal account",

"accountDate": "The date of opening a personal account",

"utltypetype": "Type of utility service (code)",

"utltypetyperef": "Type of utility service (name)",

"isDebtState": "The fact of open overdue debt for the payment of communal services",

"dbDate": "Data update date in the Bureau",

"debtMonthNumber":"Number of months of debt for utility services (0-36, 99 - more than 3 years or an indefinite term)"

},

"id": "11",

"descr": "Debt for communal services"

},

{

"spd": {

"found": "Status in EGR (Code from ref.27)",

"inn": "INN of a business entity",

"name": "Name of business entity",

"state": "The current status of the subject",

"statetxt": "Additional subject status comment",

"regdate": "Registration Date of SPD",

"kindcode": "Code of the main type of activity on KVED",

"kindname": "Name of the main type of economic activity",

"termnumber": "Number of the record of state registration of the termination of business activities",

"termcause": "The basis for making a record of the state registration of the termination of business activities",

"termdate": "Record date of state registration of termination of business activities",

"tel": "List of phones SPD",

"fax": "SPD fax number",

"email": "SPD email address",

"adress": "Residential address",

"regrecordnumber": "Record number in the Unified State Register",

"vdate": "Date of information update"

},

"registration": {

"name": "Name of registration authority",

"code": "EDRPOU registration authority code",

"type": "Registration Authority Type",

"description": "Description",

"startdate": "Date of registration with the authority",

"startnum": "Registration number with the authority",

"enddate": "Date of the deregistration entry in the authority",

"endnum": "Deregistration record number"

},

"id": "14",

"descr": "Components name"

},

{

"wantedmvs": {

"found": "0-not found, 1-found",

"foundref": "not found/found",

"bdate": "Date of Birth",

"lng": "Block representation language (Code from ref.23)",

"lngref": "Block representation language (Meaning from ref.23)",

"lname": "Surname",

"fname": "Name",

"mname": "Father’s name",

"url": "A reference to the Ministry of Internal Affairs form",

"category": "Category",

"articlecrim": "Article of accusation",

"restraint": "Preventive measure"

},

"id": "17",

"descr": "Components name"

},

{

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

},

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

},

"id": "18",

"descr": "Components name"

},

{

"sanctions": {

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

},

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

},

"id": "40",

"descr": "Information from sanctions lists"

},

{

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

},

"id": "41",

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

},

{

"contact": {

"cval": "Contact value",

"ctype": "Contact type (code from ref.10)",

"ctyperef": "Contact type in text format (ref.10)",

"cstate": "Contact’s status (code from ref.57)",

"cstateref": "Contact’s status (text value from ref.57)",

"vdatestart": "First actualization date",

"vdate": "Last actualization date"

},

"id": "46",

"descr": "Names of components"

},

{

"bankruptcyinfo": {

"bankruptcy": {

"subname": "Subject’s name",

"subcode": "TIN/EDRPOU",

"eventtype": "Event type",

"eventclaimer": "Initiator of the event",

"eventcourtcase": "Case number",

"eventdate": "Date of event"

},

"found": "Availability of information about bankruptcy, numerical designation 0-1",

"foundref": " Availability of information about bankruptcy, textual meaning 0-not found / 1-found"

},

"id": "54",

"descr": "Bankruptcy information"

},

{

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

},

{

"creditSummary": {

"totalDeals": "Total credit agreements",

"totalOpenDeals": "Total open credit agreements",

"totalClosedDeals": "Total closed loan agreements",

"newDealsMonth": "The number of new transactions in the last month",

"dealsExpPay": "The number of credit agreements with a violation of the payment schedule",

"dealsExpNow": "The number of loan agreements with current overdue",

"dealsClosedEarl": "The number of credit agreements closed early",

"dealsExpYear": "The number of credit agreements with an existing default over the past year",

"totalCreditAmount": "The total amount of loans",

"totalOpenLimits": "Total amount of open limits",

"totalOblPay": "The total amount of mandatory payments at the current moment",

"totalExpNow": "The amount of current overdue debt",

"totalCurDebt": "The amount of total current debt"

},

"id": "78",

"descr": "Consolidated credit history analytics"

}

]

}

}

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

<?xml version="1.0" encoding="utf-8"?>

<doc>

<ubki sessid="Session key (we receive it from the API authorization)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request Parameters -->

<request version="1.0" reqtype="Template code (Code from the ref.49): 'Credit report of an individual' - 10" reqreason="Purpose of the request (Code from the ref.24)">

<!-- Parameters, which describe the search criteria-->

<i reqlng="Search criteria language (Code from ref.23)">

<!-- Identification parameters of the subject-->

<ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)"

lname="**Last name"

fname="**First name"

mname="**Middle name"

bdate="**Date of birth">

</ident>

<spd inn="Tax/Taxpayer Identification Number (INN-RNUKPN, for legal entities)" />

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

<!-- Checking according to the databases of the invalid documents -->

<mvd dtype="Document type (code from ref.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

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

<!-- Block of information on credit transactions -->

<comp id="2" descr="Components name">

<donorsData totalCount="Total number of unique creditors"

activeCount="Number of unique creditors under current agreements">

<donorTypeDealCount type="Source/donor of information (code from ref. 54)"

typeref="Source/donor of information (value from ref. 54)"

count="The number of deals"/>

</donorsData>

<crdeal dlref="Transaction identifier"

lng="Block representation language (Code from ref.23)"

lngref="Block representation language (Meaning from ref.23)"

inn="INN SKI / EGRPOU of the legal entity"

lname="Surname/Name of the legal entity"

fname="Name" mname="Father’s name"

bdate="Date of Birth"

dlcelcred="Transaction type (Code from ref.17)"

dlcelcredref="Transaction type (Meaning from ref.17)"

dlvidobes="Type of collateral (Code from ref.15)"

dlvidobesref="Type of collateral (Meaning from ref.15)"

dlporpog="Repayment procedure (Code from ref.18)"

dlporpogref="Repayment procedure (Meaning from ref.18)"

dlcurr="Transaction currency (Code from ref.12)"

dlcurrref="Transaction currency (Meaning from ref.12)"

dlamt="Transaction sum (initial)"

dldonor="Information donor (code from ref.54)"

dlrolesub="Role of the subject (Code from ref.14)"

dlrolesubref="Role of the subject (Meaning from ref.14)"

dlamtobes="Cost of collateral in the base currency">

<!-- Block of variable values of a credit history -->

<deallife dlref="Transaction identifier"

dlmonth="Data period (month)"

dlyear="Data period (year)"

dlds="Date of the transaction beginning"

dldpf="Date of the transaction ending by the agreement"

dldff="Actual date of the transaction ending"

dlflstat="Transaction Status at the current period (Code from ref.16)"

dlflstatref="Transaction status at the current period (Meaning from ref.16)"

dlamtlim="Current transaction limit (for revolving transactions, credit cards)"

dlamtpaym="The amount of the obligatory payment in the current period"

dlamtcur="The sum of the current debt"

dlamtexp="The sum of the current outstanding debt"

dldayexp="Current number of days in arrears"

dlflpay="The sign of payment execution in the current period (the code from ref.13)"

dlflpayref="The sign of payment execution in the current period (Meaning from ref.13)"

dlflbrk="The sign of the existence of an outstanding payment in the current period (the code from ref.13)"

dlflbrkref="The sign of the existence of an outstanding payment in the current period (Meaning from ref.13)"

dlfluse="Characteristics of a credit tranche in the current period (code from ref.13)"

dlfluseref="Characteristics of a credit tranche in the current period (Meaning from ref.13)"

dldateclc="Calculation Date">

<!--This block has to consist of 1 .. * elements-->

</deallife>

</crdeal>

</comp>

<!-- Information block on enforcement proceedings SKI -->

<comp id="3" descr="Information on the enforcement proceedings of SKI">

<penaltiesCount totalCount="The total number of enforcement proceedings for all time"

activeCount="Number of active enforcement proceedings" />

<susd votesudname="Executor"

votetype="Enforcement type"

votedate="Enforcement start date"

inn="TIN of the debtor"

voteid="Enforcement Number"

votedonor="Source of information"

votesudphone="Executor’s phone"

votesudemail="Executor’s email"

vdate="Record update date"

credname="Creditor name"

credokpo="Creditor`s code"

vpstate="Status of proceedings">

<changes voteid="Enforcement Number"

inn="TIN of the debtor"

votedate="Enforcement start date"

votesudname="Executor"

vdate="Record Date"

credname="Name of creditor"

credokpo="Creditor`s code"

vpstate="Status of proceedings" />

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

</susd>

</comp>

<!-- Block – a register of requests -->

<comp id="4" descr="Components name">

<credres redate="Date of decision"

retime="Time of decision"

inn="INN"

reqid="Request identifier in the Bureau"

result="Report result (Code from ref.19)"

resultref="Report result (Meaning from ref.19)"

reqreason="Reason for the request in to the bureau (Code from ref.24)"

reqreasonref="Reason for the request in to the bureau (Meaning from ref.24)"

org="Initiating agency (code from ref.54)"

typereport="The type of report provided (Code from ref.71)"

typereportref="The type of report provided (Meaning from ref.71)">

<!--This block has to consist of 1 .. * elements -->

</credres>

<reestrtime hr="Number of requests per hour"

da="Number of requests per day"

wk="Number of requests per week"

mn="Number of requests per month"

qw="Number of requests per quarter"

ye="Number of requests per year"

yu="Number of requests per over a year">

<!--This block has to consist of the 1st element-->

</reestrtime>

</comp>

<!-- Checking according to the databases of the invalid 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>

<!-- Block – Monitoring -->

<comp id="6" descr="Components name">

<moncredres org="Initiating organization (code from ref.54)"

resultref="Monitoring result (value from ref.19)"

result="Monitoring result (Code from дов.19)"

monid="Unique Monitoring Identifier"

inn="TIN"

startdate="Monitoring start date"

enddate="Date of last monitoring " />

<!-- This part can contain 0..* items -->

</comp>

<!-- Block of the Information History on the contacts -->

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

<!-- Block Debt for communal services-->

<comp id="11" descr="Debt for communal services">

<utilitiesdebt inn="TIN code of the utility payer"

branch="Center of operational activity or utility service region"

account="Personal account"

accountDate="The date of opening a personal account"

utltypetype="Type of utility service (code)"

utltypetyperef="Type of utility service (name)"

isDebtState="The fact of open overdue debt for the payment of communal services"

dbDate="Data update date in the Bureau">

<utldebt debtDate="Date of calculation of arrears for payment of communal services"

totalDebt="Current arrears for the payment of utility services, taking into account overdue arrears on bills for the previous period and the last bill issued"

expDebt="Overdue arrears for the payment of utility services on bills for the previous period, without the last issued bill"

debtMonthNumber="Number of months of debt for utility services (0-36, 99 - more than 3 years or an indefinite term)"/>

</utilitiesdebt>

</comp>

<!-- Block SPD -->

<comp id="14" descr="Components name">

<spd found="Status in EGR (Code from ref.27)"

inn="INN of a business entity"

name="Name of business entity"

state="The current status of the subject"

statetxt="Additional subject status comment"

regdate="Registration Date of SPD"

kindcode="Code of the main type of activity on KVED"

kindname="Name of the main type of economic activity"

termnumber="Number of the record of state registration of the termination of business activities"

termcause="The basis for making a record of the state registration of the termination of business activities"

termdate="Record date of state registration of termination of business activities"

tel="List of phones SPD"

fax="SPD fax number"

email="SPD email address"

adress="Residential address"

regrecordnumber="Record number in the Unified State Register"

vdate="Date of information update" />

<registration name="Name of registration authority"

code="EDRPOU registration authority code"

type="Registration Authority Type"

description="Description"

startdate="Date of registration with the authority"

startnum="Registration number with the authority"

enddate="Date of the deregistration entry in the authority"

endnum="Deregistration record number" />

</comp>

<!-- Block - Search for wanted persons in the Ministry of Internal Affairs database -->

<comp id="17" descr="Components name">

<wantedmvs found="0-not found, 1-found"

foundref="not found/found"

bdate="Date of Birth"

lng="Block representation language (Code from ref.23)"

lngref="Block representation language (Meaning from ref.23)"

lname="Surname"

fname="Name"

mname="Father’s name"

url="A reference to the Ministry of Internal Affairs form"

category="Category"

articlecrim="Article of accusation"

restraint="Preventive measure" />

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

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=&q