Atoka API User Reference

Companies package "Cerved Indicators"

API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!

Available fields
Description
Data
Used by filters
Facet
Match
Stats
ateco[].code Private field

ATECO 2007 code (the most specific one)

"string" -
ateco[].description Private field

short description of ATECO 2007 code

"string" -
ateco[].diff Private field

DIFF indicator

float -
ateco[].dir.businessRisk Private field

DIR indicator: business risk

float -
ateco[].dir.creditRisk Private field

DIR indicator: credit risk

float -
ateco[].rootCode Private field

the class of the ATECO 2007 code

"string" -
cgr.subscores.C13_MBD.classValue Private field

class of the score. The classes can be 0.0, ... 10.0.

"string" -
cgr.subscores.C13_MBD.description Private field

description of this score

"string" -
cgr.subscores.C13_MBD.realTime Private field

True if the score was retrieved from Cerved in real time.

true | false -
cgr.subscores.C13_MBD.updateTime Private field

Date when the score was last computed.

date -
cgr.subscores.C1_CEBI.description Private field

description of this score

"string" -
cgr.subscores.C1_CEBI.realTime Private field

True if the score was retrieved from Cerved in real time.

true | false -
cgr.subscores.C1_CEBI.updateTime Private field

Date when the score was last computed.

date -
cgr.subscores.C1_CEBI.value Private field

value of the score

int -
cgr.subscores.C3_PYLN.description Private field

description of this score

"string" -
cgr.subscores.C3_PYLN.realTime Private field

True if the score was retrieved from Cerved in real time.

true | false -
cgr.subscores.C3_PYLN.updateTime Private field

Date when the score was last computed.

date -
cgr.subscores.C3_PYLN.value Private field

value of the score

int -
cgr.subscores.C4_EVNT.classValue Private field

class of the score. The classes can be 0.0, 1.0, 2.0, 3.0, 4.0 and 5.0.

"string" cgrC4
cgr.subscores.C4_EVNT.description Private field

description of this score

"string" -
cgr.subscores.C4_EVNT.realTime Private field

True if the score was retrieved from Cerved in real time.

true | false -
cgr.subscores.C4_EVNT.updateTime Private field

Date when the score was last computed.

date -
cgr.subscores.C4_EVNT.value Private field

value of the score

int -
cgr.subscores.C5_CNSL.description Private field

description of this score

"string" -
cgr.subscores.C5_CNSL.realTime Private field

True if the score was retrieved from Cerved in real time.

true | false -
cgr.subscores.C5_CNSL.updateTime Private field

Date when the score was last computed.

date -
cgr.subscores.C5_CNSL.value Private field

value of the score

int -
cgr.subscores.C6_GVRN.description Private field

description of this score

"string" -
cgr.subscores.C6_GVRN.realTime Private field

True if the score was retrieved from Cerved in real time.

true | false -
cgr.subscores.C6_GVRN.updateTime Private field

Date when the score was last computed.

date -
cgr.subscores.C6_GVRN.value Private field

value of the score

int -
cgr.subscores.C7_INTG.description Private field

description of this score

"string" -
cgr.subscores.C7_INTG.realTime Private field

True if the score was retrieved from Cerved in real time.

true | false -
cgr.subscores.C7_INTG.updateTime Private field

Date when the score was last computed.

date -
cgr.subscores.C7_INTG.value Private field

value of the score

int -
cgs.id Private field

Cerved Group Score for the company. ID.

int -
cgs.label Private field

Cerved Group Score for the company. Label of the score

"Massima", "Elevata", "Buona", "Media", "Moderata", "Contenuta", "Bassa", "Non affidabile" -
cgs.manual Private field

Cerved Group Score for the company. Type of the score.

true | false -
cgs.realTime Private field

Cerved Group Score of the company. True if the CGS was retrieved from Cerved in real time.

true | false -
cgs.updated Private field

Cerved Group Score for the company. Date when the score was last computed.

date -
cgs.value Private field

Cerved Group Score for the company. Value of the score.

int cgsValueMin cgsValueMax cgsValueUnknown
negativities Private field

whether the subject has associated negative events; see the documentation of the parameter for a full description

true | false negativities
Example JSON fragment for package
{
"ateco": [
{
"code": "foo",
"description": "foo",
"rootCode": "foo",
"diff": 0.42,
"dir": {
"businessRisk": 0.42,
"creditRisk": 0.42
}
},
...
],
"negativities": false,
"cgs": {
"value": 42,
"label": "Massima",
"updated": "2015-12-24",
"id": 42,
"manual": false,
"realTime": false
},
"cgr": {
"subscores": {
"C4_EVNT": {
"description": "foo",
"value": 42,
"classValue": "foo",
"updateTime": "2015-12-24",
"realTime": false
},
"C3_PYLN": {
"description": "foo",
"value": 42,
"updateTime": "2015-12-24",
"realTime": false
},
"C1_CEBI": {
"description": "foo",
"value": 42,
"updateTime": "2015-12-24",
"realTime": false
},
"C5_CNSL": {
"description": "foo",
"value": 42,
"updateTime": "2015-12-24",
"realTime": false
},
"C6_GVRN": {
"description": "foo",
"value": 42,
"updateTime": "2015-12-24",
"realTime": false
},
"C7_INTG": {
"description": "foo",
"value": 42,
"updateTime": "2015-12-24",
"realTime": false
},
"C13_MBD": {
"description": "foo",
"classValue": "foo",
"updateTime": "2015-12-24",
"realTime": false
}
}
},
}