Atoka API User Reference

People package "Base"

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
address.fullAddress Private field

full last known address for this person

"string" -
address.geoStats[].id Private field

unique id of this stat. you can use this field to query the geoStats endpoint

By default the geoStats field is not provided in the output because of its size, but can be displayed (when available) using showGeoStats or querying with geoStats

"string" -
address.geoStats[].provenance Private field

source of the data

"string" -
address.geoStats[].updateTime Private field

latest time the data was computed

"string" -
address.geoStats[].value Private field

value of the stat

float geoStats
address.hamlet Private field

hamlet of the last known address for this person

"string" -
address.lat Private field

latitude for this location

float -
address.latlonPrecision Private field

precision of the geolocation data ('lat' and 'lon')

int -
address.lon Private field

longitude for this location

float -
address.macroregion Private field

macro region of the last known address for this person

"string" addressMacroregions
address.municipality Private field

municipality of the last known address for this person

"string" addressMunicipalities
address.postcode Private field

postcode of the last known address for this person

"string" addressPostcodes
address.province Private field

province of the last known address for this person

"string" addressProvinces
address.provinceCode Private field

province code of the last known address for this person

"string" -
address.region Private field

region of the last known address for this person

"string" addressRegions
address.state Private field

state of the last known address for this person

"string" -
address.stateCode Private field

state code of the last known address for this person

"string" addressStates
address.streetName Private field

street name of the last known address for this person

"string" -
address.streetNumber Private field

street number of the last known address for this person

"string" -
address.toponym Private field

toponym of the last known address for this person

"string" -
birthDate

birth date

- ageMin ageMax birthDateFrom birthDateTo
birthPlace.macroregion

macro region of the person birth place

"string" birthPlaceMacroregions
birthPlace.municipality

municipality of the person birth place

"string" birthPlaceMunicipalities
birthPlace.province

province of the person birth place

"string" birthPlaceProvinces
birthPlace.provinceCode

province code of the person birth place

"string" -
birthPlace.region

region of the person birth place

"string" birthPlaceRegions
birthPlace.state

state of the person birth place. This field could change in future due to language depencencies

"string" -
birthPlace.stateCode

state code of the person birth place

"string" birthPlaceStates
familyName

family name

- familyName
gender

gender

- gender
givenName

given name

- givenName
residenceAddress.fullAddress Private field

full address of the person residence

"string" -
residenceAddress.hamlet Private field

hamlet of the person residence

"string" -
residenceAddress.lat Private field

latitude for this location

float -
residenceAddress.latlonPrecision Private field

precision of the geolocation data ('lat' and 'lon')

int -
residenceAddress.lon Private field

longitude for this location

float -
residenceAddress.macroregion Private field

macro region of the person residence

"string" residenceMacroregions
residenceAddress.municipality Private field

municipality of the person residence

"string" residenceMunicipalities
residenceAddress.postcode Private field

postcode of the person residence

"string" residencePostcodes
residenceAddress.province Private field

province of the person residence

"string" residenceProvinces
residenceAddress.provinceCode Private field

province code of the person residence

"string" -
residenceAddress.region Private field

region of the person residence

"string" residenceRegions
residenceAddress.state Private field

state of the person residence

"string" -
residenceAddress.stateCode Private field

state code of the person residence

"string" residenceStates
residenceAddress.streetName Private field

street name of the person residence

"string" -
residenceAddress.streetNumber Private field

street number of the person residence

"string" -
residenceAddress.toponym Private field

toponym of the person residence

"string" -
taxId

the tax ID ("codice fiscale") of the person

- taxIds
Example JSON fragment for package
{
"givenName": "John",
"familyName": "Doe",
"gender": "M",
"taxId": "DOEJHN90A01H501H",
"birthDate": "2015-12-24",
"birthPlace": {
"municipality": "Roma",
"province": "Roma",
"provinceCode": "RM",
"region": "Lazio",
"macroregion": "Centro",
"state": "Italia",
"stateCode": "it"
},
"residenceAddress": {
"fullAddress": "foo",
"toponym": "foo",
"streetName": "foo",
"streetNumber": "foo",
"hamlet": "foo",
"postcode": "foo",
"municipality": "foo",
"province": "foo",
"provinceCode": "foo",
"region": "foo",
"macroregion": "foo",
"state": "Italia",
"stateCode": "it",
"lat": 0.42,
"lon": 0.42,
"latlonPrecision": 42
},
"address": {
"fullAddress": "foo",
"toponym": "foo",
"streetName": "foo",
"streetNumber": "foo",
"hamlet": "foo",
"postcode": "foo",
"municipality": "foo",
"province": "foo",
"provinceCode": "foo",
"region": "foo",
"macroregion": "foo",
"state": "Italia",
"stateCode": "it",
"lat": 0.42,
"lon": 0.42,
"latlonPrecision": 42,
"geoStats": [
{
"id": "foo",
"value": 0.42,
"provenance": "foo",
"updateTime": "2015-12-24T12:00:00.000000"
},
...
]
}
}