48 - Custom credit report


The report is formed on the basis of a complete credit report and contains calculation fields that the user needs.


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"

}

},

"reqlng": "Search criteria language (Code from ref.23)"

},

"version": "1.0",

"reqtype": "Template code (Code from the ref.49): 'Custom credit report' - 48",

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

"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
( ** 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): 'Custom credit report' - 48" 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>

<contacts>

<cont ctype="**Contact type (code from ref.10)"

cval="**Contact value" />

</contacts>

<docs>

<doc dtype="**Document type (code from ref.7)"

dser="**Document series"

dnom="**Document number" />

</docs>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

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

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

Test URL

Test data

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

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

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

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

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

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

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

  • 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="ЯРЦЕВА"