Atoka API User Reference

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
cgrP15 Private field

CGR for people: subcomponent P15; it is based on real estates (it is indeed called "SOTTOSCORE IMMOBILIARE").

- -
cgrP15.linked Private field

CGRP scores are computed in two ways: for people that own a Ditta Individuale, they are directly linked to the CGR of companies, otherwise they are computed with a different logic; when linked=true this score is linked to the CGR of the company (aka: CGR P15 == CGR C15).

true | false -
cgrP15.updated Private field

Cerved Group P15 score. When the score was last updated by Cerved.

date -
cgrP15.value Private field

Value of the P15 score. It's a string in the form of <main-class>.<sub-class> where main-class is a number from 1 to 6, where 1 means "high real estate solidity" and 6 means "irrelevant real estate solidity"; currently sub-class is always 0.

At the moment the labels associated to the value are:

    • 1.0: ELEVATA CONSISTENZA IMMOBILIARE;
    • 2.0: AMPIA CONSISTENZA IMMOBILIARE;
    • 3.0: BUONA CONSISTENZA IMMOBILIARE;
    • 4.0: DISCRETA CONSISTENZA IMMOBILIARE;
    • 5.0: MODESTA CONSISTENZA IMMOBILIARE;
    • 6.0: IRRILEVANTE CONSISTENZA IMMOBILIARE.
"string" cgrP15
cgrP4 Private field

CGR for people: subcomponent P4; it is based on negative events (it is indeed called "SOTTOSCORE EVENTI NEGATIVI").

- -
cgrP4.linked Private field

CGRP scores are computed in two ways: for people that own a Ditta Individuale, they are directly linked to the CGR of companies, otherwise they are computed with a different logic; when linked=true this score is linked to the CGR of the company (aka: CGR P4 == CGR C4).

true | false -
cgrP4.updated Private field

Cerved Group P4 score. When the score was last updated by Cerved.

date -
cgrP4.value Private field

Value of the P4 score. It's a string in the form of <main-class>.<sub-class> where main-class is a number from 0 to 6, where 0 means "no negative events" and 6 means "very serious negative events". Currently sub-class is always 0.

At the moment the labels associated to the value are:

    • 0.0: ASSENZA DI EVENTI;
    • 1.0: EVENTI TRASCURABILI;
    • 2.0: EVENTI MINIMI;
    • 3.0: EVENTI LIMITATI;
    • 4.0: EVENTI SIGNIFICATIVI;
    • 5.0: EVENTI GRAVI;
    • 6.0: EVENTI GRAVISSIMI.
"string" cgrP4
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. When the score was last updated by Cerved.

date -
cgs.value Private field

Value of the Cerved Group Score, can be one of 10 classes (where "1.0" is the lowest risk, "10.0" the highest)

"string" -
negativities

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

- negativities
rca.light

RCA score light

This field will not appear in output unless you specify also allowExpensive=cervedIndicators.rca

"green", "yellow", "red" -
rca.score

RCA score of the person, computed by Cerved Group.

This field will not appear in output unless you specify also allowExpensive=cervedIndicators.rca

float -
Example JSON fragment for package
{
"negativities": false,
"cgrP4": {
"value": "foo",
"updated": "2015-12-24",
"linked": false
},
"cgrP15": {
"value": "foo",
"updated": "2015-12-24",
"linked": false
},
"cgs": {
"value": "foo",
"updated": "2015-12-24",
"realTime": false
},
"rca": {
"score": 0.42,
"light": "green"
}
}