41 - Feature Set
Service for obtaining numerical indicators about a legal entity and an individual.
The report contains the following components:
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "okpo": "INN-RNUKPN (for natural persons)/EGPROU of the legal entity" }, "additionaldata": { "date": "Scoring date. Not filled in if the scoring is currently calculated", "featlist": "List of indicators for calculation. Not to be filled in if all available metrics are calculated" }, "reqlng": "Search criteria language (code from ref.23)" }, "version": "1.0", "reqtype": "Template code (code from ref.49): 'FeatureSet' - 41", "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": { "featureSet": { "features": { "name": "Name of predictor ", "value": "Value of predictor " }, "okpo": "INN-RNUKPN (for natural persons)/EGPROU of the legal entity", "date": "Scoring date. Not filled in if the scoring is currently calculated" }, "id": "60", "descr": "Components name" } } } |
Request XML<?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): 'FeatureSet' - 41" 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="INN-RNUKPN (for natural persons)/EGPROU of the legal entity" /> <additionaldata date="Scoring date. Not filled in if the scoring is currently calculated" featlist="List of indicators for calculation. Not to be filled in if all available metrics are calculated" /> </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> <!-- FeatureSet --> <comp id="60" descr="Components name"> <featureSet okpo="INN-RNUKPN (for natural persons)/EGPROU of the legal entity" date="Scoring date. Not filled in if the scoring is currently calculated"> <features name="Name of predictor " value="Value of predictor " /> <!--This block has to consist of the 1..* elements--> </featureSet> </comp> </ubkidata> |
Example |
---|
Request JSON | {
"doc": {
"ubki": {
"req_envelope": {
"req_xml": {
"request": {
"i": {
"ident": {
"okpo": "2111118724"
},
"additionaldata": {
"featlist": "od1,ch1,ch537,od193,od834,od67,od301",
"date": "2019-02-01"
},
"reqlng": "4"
},
"version": "1.0",
"reqtype": "41",
"reqreason": "2"
}
}
},
"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
}
}
} |
Response JSON | {
"ubkidata": {
"tech": {
"trace": {
"step": {
"name": "build report",
"stm": "2022-08-29 14:01:58.101",
"ftm": "2022-08-29 14:01:59.444"
}
},
"reqinfo": {
"reqid": "req2#000002461665"
}
},
"comp": {
"featureSet": {
"features": [
{
"name": "ch308",
"value": "0.0"
},
{
"name": "ch318",
"value": "5915.82"
},
{
"name": "od1089",
"value": "61.2"
},
{
"name": "od1081",
"value": "52.33"
}
],
"okpo": "2111118724",
"date": "2019-02-01"
},
"id": "60",
"descr": "FeatureSet"
}
}
} |
Request XML | <?xml version="1.0" encoding="UTF-8"?>
<doc>
<ubki sessid="EDF4309796114D6D9B8365370DA2DEE9">
<req_envelope>
<req_xml>
<request version="1.0" reqtype="41" reqreason="2">
<i reqlng="4">
<ident okpo="2111118724">
</ident>
<additionaldata featlist="od1,ch1,ch537,od193,od834,od67,od301" date="2019-02-01" />
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc> |
Response XML |
XSD Schema request | |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response41.xsd |
Test URL | |
---|---|
Test data |
okpo="2111118724" featlist="od1,ch1,ch537,od193,od834,od67,od301" date="2019-02-01"
okpo="12345632" featlist="od1,ch1,ch537,od193,od834,od67,od301" date="2019-01-01" |