11 - Credit Score


Assessment of default probability based on the borrower’s credit history.


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"

},

"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 ref.49): 'Credit Score' Report – 11",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

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"

},

{

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

},

{

"urating": {

"dinfo": {

"all": "Number, total credit transactions",

"open": "Number, open credit transactions",

"opentext": "Text, banks with open credit transactions",

"close": "Number, closed credit transactions",

"expyear": "Text, arrears present in the last year",

"maxnowexp": "Maximum current arrears",

"datelastupdate": "Credit transactions data update date",

"expall": "The number of credit agreements with payment delays",

"expnow": "The number of credit agreements with current overdue",

"reqs12m": "The number of requests for credit over the past 12 months",

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

"smalldebt": "The amount of total current debt",

"vpall": "Number of executive proceedings",

"vpopen": "The number of open executive proceedings"

},

"comments": {

"comment": {

"id": "Comment entry ID",

"text": "Text, textual description of score"

},

"count": "Number, qty of comments within this tag"

},

"pfactors": {

"comment": {

"text": "Textual description of n factor"

},

"count": "Number, qty of positive facts within this tag",

"text": "Positive factors"

},

"nfactors": {

"comment": {

"text": "Textual description of n factor"

},

"count": "Number, qty of negative facts within this tag",

"text": "Negative factors"

},

"inn": "Subject’s TIN",

"lname": "Subject’s last name",

"fname": "Subject’s name",

"mname": "Subject’s middle name",

"bdate": "Date of birth",

"score": "Credit score (0-700, NA)",

"scorelast": "Previous credit score (0-700, NA)",

"scoredate": "Score calculation date",

"scoredatelast": "Previous score calculation date",

"scorelevel": "Credit score level (0-5)",

"score3": "Credit rating of the previous version. Used at the time of issuing a new rating model until partners switch to using the new one (0-700, NA)"

},

"id": "8",

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

},

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

},

{

"scoremfo": {

"inn": "Subject’s TIN",

"lname": "Subject’s last name",

"fname": "Subject’s first name",

"mname": "Subject’s middle name",

"bdate": "Date of birth",

"scoremfo": "Scoring value (0-300, NA)",

"scoremfodate": "Score calculation date"

},

"attributes": {

"closemfo": "Number of close PDL deals",

"closenoexp": "The fact of closing the last deal without delay",

"cntreqsweek": "The number of credit history requests for new loan for the last week",

"maxnowdaymfo": "Maximum PDL delay at the moment",

"openmfo": "Number of open PDL deals",

"soldmfo": "Number of sold PDL deals",

"dlamtcurmfo": "The current amount of DPL debt",

"sumnowexpmfo": "Amount of PDL delay at the moment"

},

"id": "23",

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

}

]

}

}

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 (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): 'Credit Score' Report – 11" 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>

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

<!-- Register of Requests part -->

<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 ref.19)"

monid="Unique Monitoring Identifier"

inn="TIN"

startdate="Monitoring start date"

enddate="Date of last monitoring " />

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

</comp>

<!-- UBKI Credit Score Calculation part -->

<comp id="8" descr="Names of components">

<urating inn="Subject’s TIN"

lname="Subject’s last name"

fname="Subject’s name"

mname="Subject’s middle name"

bdate="Date of birth"

score="Credit score (0-700, NA)"

scorelast="Previous credit score (0-700, NA)"

scoredate="Score calculation date"

scoredatelast="Previous score calculation date"

scorelevel="Credit score level (0-5)"

score3="Credit rating of the previous version. Used at the time of issuing a new rating model until partners switch to using the new one (0-700, NA)">

<dinfo all="Number, total credit transactions"

open="Number, open credit transactions"

opentext="Text, banks with open credit transactions"

close="Number, closed credit transactions"

expyear="Text, arrears present in the last year"

maxnowexp="Maximum current arrears"

datelastupdate="Credit transactions data update date"

expall="The number of credit agreements with payment delays"

expnow="The number of credit agreements with current overdue"

reqs12m="The number of requests for credit over the past 12 months"

smexpnow="The amount of current overdue debt"

smalldebt="The amount of total current debt"

vpall="Number of executive proceedings"

vpopen="The number of open executive proceedings" />

<comments count="Number, qty of comments within this tag">

<comment id="Comment entry ID"

text="Text, textual description of score" />

</comments>

<pfactors count="Number, qty of positive facts within this tag"

text="Positive factors">

<comment text="Textual description of n factor" />

</pfactors>

<nfactors count="Number, qty of negative facts within this tag"

text="Negative factors">

<comment text="Textual description of n factor" />

</nfactors>

</urating>

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

<!-- Scoring for microfinance institutions -->

<comp id="23" descr="Names of components">

<scoremfo inn="Subject’s TIN"

lname="Subject’s last name"

fname="Subject’s first name"

mname="Subject’s middle name"

bdate="Date of birth"

scoremfo="Scoring value (0-300, NA)"

scoremfodate="Score calculation date" />

<attributes closemfo="Number of close PDL deals"

closenoexp="The fact of closing the last deal without delay"

cntreqsweek="The number of credit history requests for new loan for the last week"

maxnowdaymfo="Maximum PDL delay at the moment"

openmfo="Number of open PDL deals"

soldmfo="Number of sold PDL deals"

dlamtcurmfo="The current amount of DPL debt"

sumnowexpmfo="Amount of PDL delay at the moment" />

</comp>

<!-- Bankruptcy information-->

<comp id="54" descr="Bankruptcy information">

<bankruptcyinfo found="Availability of information about bankruptcy, numerical designation 0-1"

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

<bankruptcy subname="Subject’s name"

subcode="TIN/EDRPOU"

eventtype="Event type"

eventclaimer="Initiator of the event"

eventcourtcase="Case number"

eventdate="Date of event" />

</bankruptcyinfo>

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

Example

Request JSON

{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "bdate": "1957-10-19", "mname": "Igorevna", "fname": "ANNA", "lname": "RYBACHKA", "okpo": "2111118724" }, "docs": { "doc": { "dtype": "1", "dser": "ВВ", "dnom": "142228" } }, "contacts": { "cont": { "cval": "+380662134234", "ctype": "3" } }, "reqlng": "4" }, "version": "1.0", "reqtype": "11", "reqreason": "2" } } }, "sessid": "6D7D781B1E884A6AB384481804A35EA8" } } }

Response JSON

{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report", "stm": "2022-08-25 11:50:06.455", "ftm": "2022-08-25 11:50:06.685" } }, "reqinfo": { "reqid": "req2#000002459578" } }, "comp": [ { "cki": { "ident": { "cchild": "", "sstateref": "", "sstate": "", "spdref": "natural person", "spd": "1", "cgragref": "", "cgrag": "804", "ceducref": "", "ceduc": "", "familyref": "", "family": "", "csexref": "woman", "csex": "2", "bdate": "1957-10-19", "mname": "ІГОРЕВНА", "fname": "АННА", "lname": "РИБАЧКА", "inn": "2111118724", "lngref": "Russian", "lng": "2", "vdate": "2022-02-06", "donor": "BNK" }, "work": { "wdohod": "", "wstag": "", "wname": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ 'УКРАЇНСЬКА КОМПАНІЯ 'О'", "wokpo": "34745377", "cdolgnref": "Worker/specialist/performer", "cdolgn": "3", "lngref": "Ukrainian", "lng": "1", "vdate": "2021-11-07", "wdonor": "BNK" }, "doc": { "dwdt": "2004-03-10", "dwho": "ХЕРСОНСКИМ ГО УМВД", "dterm": "", "dnom": "142228", "dser": "ВВ", "dtyperef": "Ukrainian citizen passport", "dtype": "1", "lngref": "Ukrainian", "lng": "1", "vdate": "2021-08-01", "eddr_number": "19571019-00027", "ddonor": "BNK" }, "addr": { "adflat": "81", "adcorp": "", "adhome": "11", "adstreet": "ВУЛ.ЕЖЕЛЕ", "adcitytyperef": "", "adcitytype": "", "adcity": "М.ХЕРСОН", "adarea": "", "adstate": "ХЕРСОНСЬКА", "adindex": "10000", "adcountry": "UA", "adtyperef": "Address of registration", "adtype": "2", "lngref": "Ukrainian", "lng": "1", "vdate": "1900-01-01", "addonor": "BNK" }, "bdate": "1957-10-19", "reqlngref": "Russian", "reqlng": "2", "mname": "ІГОРЕВНА", "fname": "АННА", "lname": "РИБАЧКА", "inn": "2111118724" }, "identdocmvds": { "identdocmvd": { "foundsource": [ { "name": "MVS", "found": "0", "foundref": "Not 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": "0", "foundref": "Not found", "foundtitle": "Passport ВВ-142228 is not found in the list of invalid passports", "pser": "ВВ", "pnom": "142228", "dtype": "1", "dtyperef": "Ukrainian citizen passport" } }, "id": "1", "descr": "Identification of the Credit History Subject (CHS)" }, { "credres": [ { "org": "OWN", "reqreasonref": "Credit request", "reqreason": "2", "resultref": "Report provided successfully", "result": "1", "reqid": "req2#000002459450", "inn": "2111118724", "redate": "2022-08-25", "retime": "10:29:31", "typereport": "2", "typereportref": "Credit history" }, { "org": "BNK", "reqreasonref": "Credit request", "reqreason": "2", "resultref": "Report provided successfully", "result": "1", "reqid": "req2#000002459275", "inn": "2111118724", "redate": "2022-08-25", "retime": "01:14:03", "typereport": "2", "typereportref": "Credit history" }, { "org": "BNK", "reqreasonref": "Credit request", "reqreason": "2", "resultref": "Report provided successfully", "result": "1", "reqid": "req2#000002458722", "inn": "2111118724", "redate": "2022-08-24", "retime": "01:14:04", "typereport": "2", "typereportref": "Credit history" }, { "org": "OWN", "reqreasonref": "Credit request", "reqreason": "2", "resultref": "Report provided successfully", "result": "1", "reqid": "req2#000002458406", "inn": "2111118724", "redate": "2022-08-23", "retime": "14:07:31", "typereport": "2", "typereportref": "Credit history" }, { "org": "FIN", "reqreasonref": "Monitoring (does not affect the credit rating)", "reqreason": "1", "resultref": "Report provided successfully", "result": "1", "reqid": "req2#000001512839", "inn": "2111118724", "redate": "2021-04-19", "retime": "13:46:50", "typereport": "2", "typereportref": "Credit history" }, { "org": "BNK", "reqreasonref": "Monitoring (does not affect the credit rating)", "reqreason": "1", "resultref": "Report provided successfully", "result": "1", "reqid": "req2#000001469755", "inn": "2111118724", "redate": "2021-01-29", "retime": "18:09:47", "typereport": "2", "typereportref": "Credit history" } ], "reestrtime": { "hr": "0", "da": "2", "wk": "10", "mn": "31", "qw": "77", "ye": "379", "yu": "32" }, "id": "4", "descr": "Inquiries registry" }, { "id": "5", "descr": "Checking according to the databases of the invalid documents" }, { "moncredres": [ { "org": "BNK", "resultref": "Report provided successfully", "result": "1", "monid": "MFB50ED6A7683C1E8", "inn": "2111118724", "startdate": "2022-02-10", "enddate": "2022-04-25" }, { "org": "FIN", "resultref": "Report provided successfully", "result": "1", "monid": "ME926E3B7CAD27B78", "inn": "2111118724", "startdate": "2021-04-02", "enddate": "2021-04-19" } ], "id": "6", "descr": "Monitoring (does not affect credit rating)" }, { "urating": { "dinfo": { "all": "104", "open": "25", "opentext": "", "close": "79", "expyear": "Так", "maxnowexp": "40071.0 UAH", "datelastupdate": "2021-08-18 00:00:00", "expall": "0", "expnow": "0", "reqs12m": "10", "smexpnow": "Немає", "smalldebt": "8999.00", "vpall": "2", "vpopen": "1" }, "comments": { "comment": { "id": "1", "text": "A very low rate may indicate that the borrower is uncharitable." }, "count": "1" }, "pfactors": { "count": "0", "text": "Positive factors" }, "nfactors": { "comment": { "text": "You have significant overdue debt that automatically assigns a score of 0 (default)." }, "count": "1", "text": "Negative factors" }, "inn": "2111118724", "lname": "Рибачка", "fname": "Анна", "mname": "Игоревна", "bdate": "1957-10-19", "score": "0", "scorelast": "0", "scoredate": "2021-08-18", "scoredatelast": "2021-08-18", "scorelevel": "0", "score3": "NA" }, "id": "8", "descr": "Credit rating of UBKI" }, { "pret": { "inn": "2111118724", "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" }, { "scoremfo": { "attributes": { "closemfo": "0", "closenoexp": "0", "cntreqsweek": "10", "maxnowdaymfo": "0", "openmfo": "0", "soldmfo": "0", "dlamtcurmfo": "0.00", "sumnowexpmfo": "0.00" }, "inn": "2111118724", "lname": "РИБАЧКА", "fname": "АННА", "mname": "ІГОРЕВНА", "bdate": "1957-10-19", "scoremfo": "95", "scoremfodate": "2022-08-25" }, "id": "23", "descr": "Scoring for microfinance companies" }, { "id": "54", "descr": "Bankruptcy information", "bankruptcyinfo": { "found": "1", "foundref": "Знайдена інформація про банкрутство", "bankruptcy": [ { "subname": "ГАРНА ІРІНА ВАСИЛІВНА", "subcode": "3278508288", "eventtype": "Інформація про поновлення справи про банкрутство", "eventclaimer": "Вищий господарський суд України (vgsu.arbitr.gov.ua)", "eventcourtcase": "910/3551/21", "eventdate": "2021-04-14" }, { "subname": "ГАРНА ІРІНА ВАСИЛІВНА", "subcode": "3278508288", "eventtype": "Інформація про порушення справи про банкрутство", "eventclaimer": "Вищий господарський суд України (vgsu.arbitr.gov.ua)", "eventcourtcase": "910/3551/21", "eventdate": "2021-10-06" } ] } } ] } }

Request XML

<?xml version="1.0" encoding="UTF-8"?> <doc> <ubki sessid="6D7D781B1E884A6AB384481804A35EA8"> <req_envelope> <req_xml> <request version="1.0" reqtype="11" reqreason="2"> <i reqlng="4"> <ident bdate="1957-10-19" mname="Igorevna" fname="ANNA" lname="RYBACHKA" okpo="2111118724" /> <docs> <doc dtype="1" dser="ВВ" dnom="142228" /> </docs> <contacts> <cont cval="+380662134234" ctype="3" /> </contacts> </i> </request> </req_xml> </req_envelope> </ubki> </doc>

Response XML

Test URL

Test data

  • Credit Score 0 - bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" dtype="1" dser="ВВ" dnom="142228" cval="+380662134234" ctype="3"

  • Credit Score 244 - bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116" dtype="1" dser="КО" dnom="220394" cval="+380971321122" ctype="3"

  • Credit Score 349 - bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" okpo="3112579786" dtype="1" dser="СЮ" dnom="170000" cval="+380981224895" ctype="3"

  • Credit Score 381 - bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397" dtype="1" dser="СЕ" dnom="311111" cval="+380506630641" ctype="3"

  • Credit Score 434 - bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095" dtype="1" dser="ДО" dnom="270000" cval="+380981220000" ctype="3"

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

  • Credit Score 495 - bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593" dtype="17" dser="" dnom="001013900" cval="+380935171868" ctype="3"

  • Credit Score 552 - bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="3333312110" dtype="1" dser="ДД" dnom="222222" cval="+380732144444" ctype="3"

 

<comp id="18" descr="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"

  • 2230428048

  • 2269501369

  • 2274214699

  • 2293515103

 

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

  • bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095" dtype="1" dser="ДО" dnom="270000" cval="+380981220000" ctype="3"

 

<comp id="54" descr="Information bankruptcy"> 

  • bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" dtype="1" dser="АМ" dnom="578072" cval="+380962134234" 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="ЯРЦЕВА"