48 - Custom credit report
The report is formed on the basis of a complete credit report and contains calculation fields that the user needs.
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": { "crdealshort": { "inn": "TIN of the credit history subject", "dlds": "Transaction commencement date", "dldpf": "Transaction closing date under the contract", "dlamt": "Transaction amount (initial)", "dlcurr": "Transaction currency (code from ref.12)", "typedeal": "Transaction type, one of two: CC - credit card, PL - not credit card", "statedeal": "Transaction status in the current period, one of two: OPEN, CLOSE", "dldateclc": "Calculation date", "dlamtexpuah": "Current debt overdue amount, UAH", "dldayexp": "Current number of days overdue", "dlflstat": "Transaction status in the current period (code from ref.16)", "ex60y3uah": "Maximum overdue amount 60+ days in the last 36 months, UAH", "ex90y3uah": "Maximum overdue amount 90+ days in the last 36 months, UAH", "paymuah": "Planned compulsory payment amount in the current period (as scheduled). Сalculated as an annuity if 0", "dlamtcuruah": "Current debt amount, UAH", "reqyear": "Number of requests per year" }, "id": "71", "descr": "The name of the component" }, { "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> <!-- Custom credit report --> <comp id="71" descr="The name of the component"> <crdealshort inn="TIN of the credit history subject" dlds="Transaction commencement date" dldpf="Transaction closing date under the contract" dlamt="Transaction amount (initial)" dlcurr="Transaction currency (code from ref.12)" typedeal="Transaction type, one of two: CC - credit card, PL - not credit card" statedeal="Transaction status in the current period, one of two: OPEN, CLOSE" dldateclc="Calculation date" dlamtexpuah="Current debt overdue amount, UAH" dldayexp="Current number of days overdue" dlflstat="Transaction status in the current period (code from ref.16)" ex60y3uah="Maximum overdue amount 60+ days in the last 36 months, UAH" ex90y3uah="Maximum overdue amount 90+ days in the last 36 months, UAH" paymuah="Planned compulsory payment amount in the current period (as scheduled). Calculated as an annuity if 0" dlamtcuruah="Current debt amount, UAH" reqyear="Number of requests per year"> <!--This block must consist of 0 .. * elements--> </crdealshort> </comp> <!-- Search by full name + inn if more than 1 person is found (The presence of the component is determined by searching for more than 1 person in the case of searching by full name + inn)--> <comp id="72" descr="Search by full name + inn if more than 1 person is found"> <person bdate="Date of birth" lngref="Search/transfer language (ref. 23)" lng="Part presentation language, value (ref. 23)" mname="Middle name" fname="First name" lname="Last name" inn="TIN of the credit history subject" /> </comp> </ubkidata> |
Example |
---|
Request JSON | {
"doc": {
"ubki": {
"req_envelope": {
"req_xml": {
"request": {
"i": {
"ident": {
"bdate": "1989-10-05",
"mname": "ВАСИЛІВНА",
"fname": "ІРІНА",
"lname": "ГАРНА",
"okpo": "3278508288"
},
"docs": {
"doc": {
"dtype": "1",
"dser": "АМ",
"dnom": "578072"
}
},
"contacts": {
"cont": {
"cval": "+380962134234",
"ctype": "3"
}
},
"reqlng": "1"
},
"version": "1.0",
"reqtype": "48",
"reqreason": "2"
},
"descr": "Request object"
},
"descr": "Request envelope"
},
"sessid": "7BD7E136E3BF470EAA2CFE2E8700000D"
}
}
} |
Response JSON | {
"ubkidata": {
"tech": {
"trace": {
"step": {
"name": "build report",
"stm": "2022-11-09 19:08:22.647",
"ftm": "2022-01-09 19:08:22.734"
}
},
"reqinfo": {
"reqid": "req2#000002007797"
}
},
"comp": {
"crdealshort": [
{
"inn": "3278508288",
"dlds": "2018-02-23",
"dldpf": "2019-06-23",
"dlamt": "0.00",
"dlcurr": "980",
"typedeal": "CC",
"statedeal": "CLOSE",
"dldateclc": "2018-08-03",
"dlamtexpuah": "0.00",
"dldayexp": "0",
"dlflstat": "2",
"ex60y3uah": "0.00",
"ex90y3uah": "0.00",
"paymuah": "0.00",
"dlamtcuruah": "0.00",
"reqyear": "0"
},
{
"inn": "3278508288",
"dlds": "2014-11-25",
"dldpf": "2113-11-25",
"dlamt": "0.00",
"dlcurr": "980",
"typedeal": "CC",
"statedeal": "CLOSE",
"dldateclc": "2017-11-30",
"dlamtexpuah": "0.00",
"dldayexp": "0",
"dlflstat": "2",
"ex60y3uah": "0.00",
"ex90y3uah": "0.00",
"paymuah": "0.00",
"dlamtcuruah": "0.00",
"reqyear": "0"
}
],
"id": "71",
"descr": "Custom credit report"
}
}
} |
Request XML | <?xml version="1.0" encoding="UTF-8"?>
<doc>
<ubki sessid="7BD7E136E3BF470EAA2CFE2E8700000D">
<req_envelope descr="Request envelope">
<req_xml descr="Request object">
<request version="1.0" reqtype="48" reqreason="2">
<i reqlng="1">
<ident bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" />
<docs>
<doc dtype="1" dser="АМ" dnom="578072" />
</docs>
<contacts>
<cont cval="+380962134234" ctype="3" />
</contacts>
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc> |
Response XML |
XSD Schema request |
---|
Test URL | |
---|---|
Test data |
<comp id="72" descr="Search by full name + inn if more than 1 person is found">
|