Data Quality user documentation
home/Data enrichment/Experian Enrichment/API reference/Attributes

Attributes

When you send a request to the API, you need to specify the dataset-specific attributes you want to use.

The available attributes for the supported datasets are listed below.

Dataset code - geocodes

Attribute Description
latitude The latitude in degrees for the specified address.
longitude The longitude in degrees for the specified address.
match_level Specifies the accuracy of the coordinates for the specified address.

Dataset code - aus_regional_geocodes

Attribute Description
latitude The latitude in degrees for the specified address.
longitude The longitude in degrees for the specified address.
sa1 The 7 digit SA1 code.
meshblock The Mesh Block ID. This element consists of 11 digit Mesh Block Code.
lga_code The Local Government Area persistent identifier.
lga_name The Local Government Area name.
match_level Specifies the accuracy of the coordinates for the specified address.
street_pid This is a unique street persistent identifier.
locality_pid This is a unique locality persistent identifier.
geocode_level_code This is the geocode level code.The value is a number between 0 and 7. For example 2. For a list of all possible values, please refer to the Australia G-NAF (AUG) data guide
geocode_level_description This is the geocode level description. For example Street level geocode only. For a list of all possible descriptions, please refer to the Australia G-NAF (AUG) data guide
geocode_type_code This is the geocode type code.The value is 2-4 alphabetic characters in uppercase. For example LB. For a list of all possible values, please refer to the Australia G-NAF (AUG) data guide
geocode_type_description This is the geocode type description. For example Letterbox. For a list of all possible descriptions, please refer to the Australia G-NAF (AUG) data guide
highest_level_longitude The highest level longitude in degrees.
highest_level_latitude The highest level latitude in degrees.
highest_level_elevation The highest level elevation.
highest_level_planimetric_accuracy The highest level planimetric accuracy.
highest_level_boundary_extent The highest level boundary extent.
highest_level_geocode_reliability_code The highest level geocode reliability code.
highest_level_geocode_reliability_description The highest level geocode reliability description.
confidence_level_code This is the confidence level code. The value is numerical. For example 2.For a list of all possible values, please refer to the Australia G-NAF (AUG) data guide
confidence_level_description This is the confidence level descriptor. The value is alphabetic. For example All three contributors have supplied an identical address. For a list of all possible descriptions, please refer to the Australia G-NAF (AUG) data guide
2021_meshblock_id The latest 2021 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.
2021_meshblock_code The 11-digit 2021 version of the Mesh Block Code.For a list of all possible values, please refer to the Australia G-NAF (AUG) data guide
2021_meshblock_match_code The code for the level of matching to 2021 Mesh Blocks.
2021_meshblock_match_description The description of the 2021 Mesh Block match level.
2016_meshblock_id The 2016 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.
2016_meshblock_code The 11-digit 2016 version of the Mesh Block Code.For a list of all possible values, please refer to the Australia G-NAF (AUG) data guide
2016_meshblock_match_code The code for the level of matching to 2016 Mesh Blocks.
2016_meshblock_match_description The description of the 2016 Mesh Block match level.
2011_meshblock_id Deprecated element, always blank, e.g. " ". The 2011 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block code.
2011_meshblock_code Deprecated element, always blank, e.g. " ". The 11-digit 2011 version of the Mesh Block code.For a list of all possible values, please refer to the Australia G-NAF (AUG) data guide
2011_meshblock_match_code Deprecated element, always blank, e.g. " ". The code for the level of matching to 2011 Mesh Blocks.
2011_meshblock_match_description Deprecated element, always blank, e.g. " ". The description of the 2011 Mesh Block match level.
address_type_code Returns the Address Type, indicating if the address is a primary or secondary address. If the primary/secondary relationship does not exist, then this element would be blank, otherwise the possible values are P (PrimaryAddress) and S (SecondaryAddress).
primary_address_pid This element will only be populated if the input address is a secondary address. In that case, this element would contain the PID of the primary address.
address_join_type Returns the JoinType code.The possible values are 1 (Both parent and child have the same root address) or 2 (Parent and child may or may not have the same root address).
collector_district_id This is a unique Collector District persistent identifier.
collector_district_code This is the Collector District code.
commonwealth_electoral_boundary_id This is a unique Commonwealth Electoral Boundary persistent identifier.
commonwealth_electoral_boundary_name This is the Commonwealth Electoral Boundary name.
statistical_local_area_id This is a Statistical Local Area persistent identifier.
statistical_local_area_code 9-digit SLAcode. For example 150154750.
statistical_local_area_name This is a Statistical Local Area name.
state_electoral_boundary_id This is a State Electoral Boundary persistent identifier.
state_electoral_boundary_name This is a State Electoral Boundary name.
state_electoral_effective_start This is the date that the electorate becomes effective.
state_electoral_effective_end This is the end date when electorate is no longer in effect.
state_electoral_new_pid This is the State Electoral Boundary identifier for new electorate that will be in effect.
state_electoral_new_name This is the State Electoral Boundary name for new electorate that will be in effect.
state_electoral_new_effective_start This is the start date that the new electorate will become effective.
state_electoral_new_effective_end This is the end date when the new electorate will no longer be in effect.
address_level_longitude The address-level longitude in degrees.
address_level_latitude The address-level latitude in degrees.
address_level_elevation The address-level elevation.
address_level_planimetric_accuracy The address-level planimetric accuracy.
address_level_boundary_extent The address-level boundary extent.
address_level_geocode_reliability_code The address-level geocode reliability code. For example 2. For a list of all possible values, please refer to the Australia G-NAF (AUG) data guide
address_level_geocode_reliability_description The address-level geocode reliability description. For example Geocode accuracy sufficient to place centroid within address site boundary.For a list of all possible descriptions, please refer to the Australia G-NAF (AUG) data guide
street_level_longitude The street-level longitude in degrees.
street_level_latitude The street-level latitude in degrees.
street_level_planimetric_accuracy The street-level planimetric accuracy.
street_level_boundary_extent The street-level boundary extent.
street_level_geocode_reliability_code The street-level geocode reliability code. The value of this is either 4 or blank.
street_level_geocode_reliability_description The street-level geocode reliability description. If the reliability code is 4, this is Geocode accuracy sufficient to associate address site with a unique road feature.
locality_level_longitude The locality-level longitude in degrees.
locality_level_latitude The locality-level latitude in degrees.
locality_level_planimetric_accuracy The locality-level planimetric accuracy.
locality_level_geocode_reliability_code The locality-level geocode reliability code.The value of this is either 5, 6, or blank.
locality_level_geocode_reliability_description The locality-level geocode reliability description. For example, Geocode accuracy sufficient to associate address site with a unique locality or neighborhood. For a list of all possible descriptions, please refer to the Australia G-NAF (AUG) data guide
gnaf_legal_parcel_identifier The Legal Parcel Id field is populated with the cadastral information using the same concatenations (where applicable) as adopted for the Jurisdiction Id used in the Cadastre theme (CAD table) of the CadLite product.

Dataset code - AUS_CV_Person

Attribute Description
pin A unique Experian person identifier.
gender Consumer's gender.
hin A unique Experian household identifier.
linkage_postcode Linkage postal code.

Dataset code - AUS_CV_Household

Attribute Description
hin A unique Experian household identifier.
address The full address. An additional mail_suppression attribute will be returned if the address is suppressed and should not be contacted.
suburb The suburb of the address.
postcode The postal code of the address.
state The state of the address.
residential_flag Indicates whether the address is residential.
gnaf_pid The persistent identifier of the address. This is a unique 14-character alphanumeric identifier of the address record; for example, GANSW716798454”. An additional mail_suppression attribute will be returned if the address is suppressed and should not be contacted.
gnaf_latitude The address-level latitude in degrees.
gnaf_longitude The address-level longitude in degrees.
meshblock The Mesh Block ID. This element consists of 15 alphanumeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.
sa1 The 7 digit SA1 code.
local_government_area_code The Local Government Area persistent identifier.
local_government_area_name The Local Government Area name.
mosaic_group The Mosaic group, e.g. K
mosaic_group_2018 Deprecated element. The 2018 version of the Mosaic group, e.g. K
mosaic_group_2015 Deprecated element. The 2015 version of the Mosaic group, e.g. K
mosaic_type The Mosaic group and type, e.g. K39
mosaic_type_2018 Deprecated element. The 2018 version of the Mosaic group and type, e.g. K39
mosaic_type_2015 Deprecated element. The 2015 version of the Mosaic type, e.g. K39
mosaic_segment The Mosaic group, type and segment e.g. K39_4
mosaic_segment_2018 Deprecated element. The 2018 version of the Mosaic group, type and segment e.g. K39_4
mosaic_segment_2015 Deprecated element. The 2015 version of the Mosaic segment, e.g. K39_4
affluence_code A rating indicating the household level of wealth based on household demographics, assets and investments.
affluence_description Description of the code returned for the above attribute.
adults_at_address_code Estimate of the number of people aged 18 and over in a household.
adults_at_address_description Description of the code returned for the above attribute.
children_at_address_code_0_10_years A prediction of the presence of children aged 0-10 in a household. Code represents one of 10 likelihood bands.
children_at_address_description_0_10_years Description of the code returned for the above attribute.
children_at_address_code_11_18_years A prediction of the presence of children aged 11-18 in a household.
children_at_address_description_11_18_years Description of the code returned for the above attribute.
credit_demand_code An indicator of demand for credit at the sub meshblock level. For privacy reasons, credit data is aggregated to a geographical region, rather than a single address.
credit_demand_description Description of the code returned for the above attribute.
channel_preference Channel Preferences classifies every Australian household into one of eight unique segments based on their most preferred form of media. This is provided as a code ranging from 1 to 8.
channel_preference_description Channel Preferences classifies every Australian household into one of eight unique segments based on their most preferred form of media. This is provided as a description.
household_income_code Prediction of annual income of the household. Code represents one of 7 income bands.
household_income_description Description of the code returned for the above attribute.
household_composition_code Indication of the type of household in which the people at an address are living in. Code represents one of 6 bands.
household_composition_description Description of the code returned for the above attribute.
head_of_household_age_code A prediction of the age for the person likely to be head of household. Code represents one of 15 age bands.
head_of_household_age_description Description of the code returned for the above attribute.
lifestage_code An indication of the stage of life of the household occupants. Represents one of 10 bands.
lifestage_description Description of the code returned for the above attribute.
length_of_residence_code An estimate of the length of time a person or family has lived at an address. Code represents one of 15 bands.
length_of_residence_description Description of the code returned for the above attribute.
mosaic_factor1_score Mosaic factor score for Family Composition.
mosaic_factor2_score Mosaic factor score for Prosperity.
mosaic_factor3_score Mosaic factor score for Dependants.
mosaic_factor4_score Mosaic factor score for Cultural Diversity.
mosaic_factor5_score Mosaic factor score for Housing Ownership.
mosaic_factor1_score_2018 Deprecated element. The 2018 version of the Mosaic factor score for Family Composition.
mosaic_factor2_score_2018 Deprecated element. The 2018 version of the Mosaic factor score for Prosperity.
mosaic_factor3_score_2018 Deprecated element. The 2018 version of the Mosaic factor score for Dependants.
mosaic_factor4_score_2018 Deprecated element. The 2018 version of the Mosaic factor score for Cultural Diversity.
mosaic_factor5_score_2018 Deprecated element. The 2018 version of the Mosaic factor score for Housing Ownership.
mosaic_factor1_percentile Mosaic factor percentile for Family Composition.
mosaic_factor2_percentile Mosaic factor percentile for Prosperity.
mosaic_factor3_percentile Mosaic factor percentile for Dependants.
mosaic_factor4_percentile Mosaic factor percentile for Cultural Diversity.
mosaic_factor5_percentile Mosaic factor percentile for Housing Ownership.
mosaic_factor1_percentile_2018 Deprecated element. The 2018 version of the Mosaic factor percentile for Family Composition.
mosaic_factor2_percentile_2018 Deprecated element. The 2018 version of the Mosaic factor percentile for Prosperity.
mosaic_factor3_percentile_2018 Deprecated element. The 2018 version of the Mosaic factor percentile for Dependants.
mosaic_factor4_percentile_2018 Deprecated element. The 2018 version of the Mosaic factor percentile for Cultural Diversity.
mosaic_factor5_percentile_2018 Deprecated element. The 2018 version of the Mosaic factor percentile for Housing Ownership.
risk_insight_code Indicator of risk at the sub meshblock level. For privacy reasons, the bureau data is aggregated to a geographical region, rather than a single address. Code represents one of 12 bands.
risk_insight_description Description of the code returned for the above attribute.

Dataset code - AUS_CV_Postcode

Attribute Description
postcode The postal code of the address.
adults_at_address_code Estimate of the number of people aged 18 and over in a household.
adults_at_address_description Description of the code returned for the above attribute.
affluence_code A rating indicating the household level of wealth based on household demographics, assets and investments.
affluence_code_description Description of the code returned for the above attribute.
children_at_address_code_0_10_years A prediction of the presence of children aged 0-10 in a household. Code represents one of 10 likelihood bands.
children_at_address_description_0_10_years Description of the code returned for the above attribute.
children_at_address_code_11_18_years A prediction of the presence of children aged 11-18 in a household.
children_at_address_description_11_18_years Description of the code returned for the above attribute.
credit_demand_code An indicator of demand for credit at the sub meshblock level. For privacy reasons, credit data is aggregated to a geographical region, rather than a single address.
credit_demand_description Description of the code returned for the above attribute.
head_of_household_age_code A prediction of the age for the person likely to be head of household. Code represents one of 15 age bands.
head_of_household_age_description Description of the code returned for the above attribute.
household_income_code Prediction of annual income of the household. Code represents one of 7 income bands.
household_income_description Description of the code returned for the above attribute.
length_of_residence_code An estimate of the length of time a person or family has lived at an address. Code represents one of 15 bands.
length_of_residence_description Description of the code returned for the above attribute.
lifestage_code An indication of the stage of life of the household occupants. Represents one of 10 bands.
lifestage_code_description Description of the code returned for the above attribute.
mosaic_group The Mosaic classification group. One of 13. e.g. K
mosaic_group_2018 Deprecated element. The 2018 version of the Mosaic classification group. One of 13. e.g. K
mosaic_type The Mosaic classification group and type. One of 13 groups and 49 types. e.g. K39.
mosaic_type_2018 Deprecated element. The 2018 version of the Mosaic classification group and type. One of 13 groups and 49 types. e.g. K39.
household_composition_code Indication of the type of household in which the people at an address are living in. Code represents one of 6 bands.
household_composition_description Description of the code returned for the above attribute.
risk_insight_code Indicator of risk at the sub meshblock level. For privacy reasons, the bureau data is aggregated to a geographical region, rather than a single address. Code represents one of 12 bands.
risk_insight_description Description of the code returned for the above attribute.

Dataset code - nzl_cv_household

Attribute Description
head_of_household_age A code which estimates the age category of the person likely to be the head of the household.
children_at_address A code which represents the likelihood of the presence of children in the household.
household_composition A code which indicates the composition of the household.
head_of_household_lifestage A code which indicates the life stage of the head of household.
adults_at_address A code which estimates the number of adults (people aged 18+) living in the household.
mosaic_group A code that appends the mosaic group for the searched address. Mosaic classifies all NZ households into nine groups and 34 types.
mosaic_type_group A code that appends the mosaic type for the searched address. Mosaic classifies all NZ households into nine groups and 34 types.
mosaic_segment A code that appends the mosaic segment code for the searched address. Mosaic segments offer the next level of discrimination from Mosaic types, with 110 segments available.

Dataset code - nzl_regional_geocodes

Attribute Description
addressable This defines whether the address is deliverable or not. The possible values are Y or N.
centroid_of_property_latitude The latitude for the center of the property.
centroid_of_property_longitude The longitude for the center of the property.
centroid_of_property_nztm_x_coordinate The Geocode 'X' coordinate for the center of the property.
centroid_of_property_nztm_y_coordinate The Geocode 'Y' coordinate for the center of the property.
front_of_property_latitude The latitude for the front of the building.
front_of_property_longitude The longitude for the front of the building.
front_of_property_nztm_x_coordinate The Geocode 'X' coordinate for the front of the building.
front_of_property_nztm_y_coordinate The Geocode 'Y' coordinate for the front of the building.
general_electorate_code The unique identifier assigned to the General Electorate.
general_electorate_name The name assigned to the General Electorate.
linz_parcel_id This is a unique identifier of the address record.
maori_electorate_code The unique identifier assigned to the Maori Electorate.
maori_electorate_name The name assigned to the Maori Electorate.
match_level Specifies the accuracy of the coordinates for the specified address.
mesh_block_code The unique identifier assigned to each Mesh Block.
property_purpose_type The type of property, the possible values are: Business, Farm, Holiday Home, Residential or Empty section.
regional_council_code The unique identifier assigned to the Regional Council.
regional_council_name The name assigned to the Regional Council.
territorial_authority_code The unique identifier assigned to the Territorial Authority.
territorial_authority_name The name assigned to the Territorial Authority.

Dataset code - uk_location_complete

Attribute Description
latitude The latitude in degrees for the specified address.
longitude The longitude in degrees for the specified address.
match_level Specifies the accuracy of the coordinates for the specified address.
udprn Specifies the UDPRN for the specified address.
uprn Specifies the UPRN for the specified address.
x_coordinate Specifies the X coordinate for the specified address.
y_coordinate Specifies the Y coordinate for the specified address.

Dataset code - gbr_government

Attribute Description
eer_code Official code given to the European Electoral Region by the Office of National Statistics (ONS) in January 2011.
eer_code_pre_2011 Official code for the European Electoral Region, as used by the ONS before January 2011.
eer_name Official name given to the European Electoral Region.
gor_code Official code given to the Government Office Region by the ONS in January 2011.
gor_code_pre_2011 Official code for the Government Office Region, as used by the ONS before January 2011.
gor_name Official name given to the Government Office Region.
lea_code Official code given to the Local Education Authority.
lea_name Official name given to the Local Education Authority.
la_code Official code given to the Local Authority by the ONS in January 2011.
la_code_pre_2011 Official code for the Local Authority,as used by the ONS before January 2011.
la_name Official name given to the Local Authority.
ward_code Official code given to the Local Authority Ward by the ONS in January 2011.
ward_code_pre_2011 Official code for the Local Authority Ward,as used by the ONS before January 2011.
ward_name Official name given to the Local Authority Ward.
cens_out_area Census Area output code.

Dataset code - gbr_health

Attribute Description
authority_code Official NHS Authority code, as used by the ONS before January 2011.
authority_code_2011 Official code give to the NHS Authority by the ONS in January 2011.
authority_name Official name given to the NHS Authority.
pclh_code Official Primary Care Trust or Local Health Group code, as used by the ONS before January 2011.
pclh_code_2011 Official code given to the Primary Care Trust or Local Health Group by the ONS in January 2011.
pclh_name Official name given to the Primary Care Trust or Local Health Group.
ward_code Official Local Authority Ward code, as used by the ONS before January 2011.
ward_code_2011 Official code given to the Local Authority Ward by the ONS in January 2011.
ward_name Official name given to the Local Authority Ward.
ccg_code The 9 character area code for Clinical Commissioning Group in England (E.g. E38000056), Local Health Board (LHB) in Wales, Community Health Partnership (CHP) in Scotland, Local Commissioning Group(LCG) in Northern Ireland and Primary Healthcare Directorate (PHD) in the Isle of Man.
ccg_name Official name given to the area. E.g. NHS Eastern Cheshire
doh_code Department of Health area code. E.g. 01C

Dataset code - usa_regional_geocodes

Attribute Description
latitude The latitude in degrees for the specified address.
longitude The longitude in degrees for the specified address.
match_level Specifies the accuracy of the coordinates for the specified address.
census_block Smallest geographical unit used by US Census Bureau for the purpose of taking a census; sub-division of a tract.
census_tract Geographical region defined by US Census Bureau for the purpose of taking a census.
core_based_statistical_area Geographical area maintained by US Office of Management and Budget (OMB) which consists of one or more counties anchored by an urban center. These are categorized as Metropolitan (at least one urbanized area of 50,000+ inhabitants) or Micropolitan (at least one urban cluster of between 10,000 and 50,000 inhabitants)
congressional_district_code US Federal Information Processing Standards (FIPS) codes to identify US electoral divisions. The first two digits represent the state, the second two digits represent the congressional district, and the final three digits designate the number of the Congress.
county_code County code within a US state or possession.
Experian Enrichment

API reference

Related Resources