11 - Credit Score
- Оксана Нечепоренко
- Zlata
Assessment of default probability based on the borrower’s credit history.
The report contains the following components:
Http Method | POST |
|---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON |
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 |
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> <!-- Che |