Use the /enrichment/v2 endpoint to append specific over 50 attributes, such as number of adults and children at the household, income levels, and various Mosaic factors.
Name | Type | Description |
---|---|---|
Auth-Token | string | Input your unique token here. This is required to submit an API request. |
Add-Metadata (Optional) |
boolean | Specify whether the response should return all fields and values, in addition to the main core information. The default value of this setting is false. |
Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
Match-Rule (Optional) |
string | Currently only Strict is supported. |
Linkage-Rule (Optional) |
string | Currently only None is supported. |
Layout (Optional) |
string | This element is not editable at this time. |
Timeout-Seconds (Optional) |
integer | Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned. The default value of this setting is 15. |
In the request body you can specify:
Name | Type | Description | |
---|---|---|---|
country_iso | string | The 3-letter ISO country code. | |
keys | |||
global_address_key | string | The unique Experian identifier identifing the address to append the Enrichment data to. You can find the global_address_key in the responses of the /search and /lookup endpoints, e.g. aWQ9fDEgQXVkcmV5IFphcHAgRHJpdm. |
|
dpid | string | Unique 8-digit identifier allocated to each address maintained in Australia Post's National Address File, i.e.31176490 | |
gnaf_pid | string | Unique 14-character alphanumeric persistent identifier of the address record. An additional "mail_suppresion" attribute will be returned if the address is suppressed and should not be contacted, i.e. GAVIC420630433 | |
hin | string | Unique Experian-assigned household identifier, i.e.987654326 | |
attributes | collection | Specify the required aus_cv_household attributes. |
Name | Type | Description |
---|---|---|
hin | string | A unique Experian household identifier. |
address | string | The full address. An additional mail_suppression attribute will be returned if the address is suppressed and should not be contacted. |
suburb | string | The suburb of the address. |
postcode | string | The postal code of the address. |
state | string | The state of the address. |
residential_flag | string | Indicates whether the address is residential. |
gnaf_pid | string | 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 | string | The address-level latitude in degrees. |
gnaf_longitude | string | The address-level longitude in degrees. |
meshblock | string | The Mesh Block ID. This element consists of 15 alphanumeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code. |
sa1 | string | The 7 digit SA1 code. |
local_government_area_code | string | The Local Government Area persistent identifier. |
local_government_area_name | string | The Local Government Area name. |
mosaic_group | string | The Mosaic group, e.g. K |
mosaic_group_2018 | string | Deprecated element. The 2018 version of the Mosaic group, e.g. K |
mosaic_group_2015 | string | Deprecated element. The 2015 version of the Mosaic group, e.g. K |
mosaic_type | string | The Mosaic group and type, e.g. K39 |
mosaic_type_2018 | string | Deprecated element. The 2018 version of the Mosaic group and type, e.g. K39 |
mosaic_type_2015 | string | Deprecated element. The 2015 version of the Mosaic type, e.g. K39 |
mosaic_segment | string | The Mosaic group, type and segment e.g. K39_4 |
mosaic_segment_2018 | string | Deprecated element. The 2018 version of the Mosaic group, type and segment e.g. K39_4 |
mosaic_segment_2015 | string | Deprecated element. The 2015 version of the Mosaic segment, e.g. K39_4 |
affluence_code | string | A rating indicating the household level of wealth based on household demographics, assets and investments. |
affluence_description | string | Description of the code returned for the above attribute. |
adults_at_address_code | string | Estimate of the number of people aged 18 and over in a household. |
adults_at_address_description | string | Description of the code returned for the above attribute. |
children_at_address_code_0_10_years | string | 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 | string | Description of the code returned for the above attribute. |
children_at_address_code_11_18_years | string | A prediction of the presence of children aged 11-18 in a household. |
children_at_address_description_11_18_years | string | Description of the code returned for the above attribute. |
credit_demand_code | string | 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 | string | Description of the code returned for the above attribute. |
channel_preference | string | 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 | string | 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 | string | Prediction of annual income of the household. Code represents one of 7 income bands. |
household_income_description | string | Description of the code returned for the above attribute. |
household_composition_code | string | 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 | string | Description of the code returned for the above attribute. |
head_of_household_age_code | string | 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 | string | Description of the code returned for the above attribute. |
lifestage_code | string | An indication of the stage of life of the household occupants. Represents one of 10 bands. |
lifestage_description | string | Description of the code returned for the above attribute. |
length_of_residence_code | string | 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 | string | Description of the code returned for the above attribute. |
mosaic_factor1_score | string | Mosaic factor score for Family Composition. |
mosaic_factor2_score | string | Mosaic factor score for Prosperity. |
mosaic_factor3_score | string | Mosaic factor score for Dependants. |
mosaic_factor4_score | string | Mosaic factor score for Cultural Diversity. |
mosaic_factor5_score | string | Mosaic factor score for Housing Ownership. |
mosaic_factor1_score_2018 | string | Deprecated element. The 2018 version of the Mosaic factor score for Family Composition. |
mosaic_factor2_score_2018 | string | Deprecated element. The 2018 version of the Mosaic factor score for Prosperity. |
mosaic_factor3_score_2018 | string | Deprecated element. The 2018 version of the Mosaic factor score for Dependants. |
mosaic_factor4_score_2018 | string | Deprecated element. The 2018 version of the Mosaic factor score for Cultural Diversity. |
mosaic_factor5_score_2018 | string | Deprecated element. The 2018 version of the Mosaic factor score for Housing Ownership. |
mosaic_factor1_percentile | string | Mosaic factor percentile for Family Composition. |
mosaic_factor2_percentile | string | Mosaic factor percentile for Prosperity. |
mosaic_factor3_percentile | string | Mosaic factor percentile for Dependants. |
mosaic_factor4_percentile | string | Mosaic factor percentile for Cultural Diversity. |
mosaic_factor5_percentile | string | Mosaic factor percentile for Housing Ownership. |
mosaic_factor1_percentile_2018 | string | Deprecated element. The 2018 version of the Mosaic factor percentile for Family Composition. |
mosaic_factor2_percentile_2018 | string | Deprecated element. The 2018 version of the Mosaic factor percentile for Prosperity. |
mosaic_factor3_percentile_2018 | string | Deprecated element. The 2018 version of the Mosaic factor percentile for Dependants. |
mosaic_factor4_percentile_2018 | string | Deprecated element. The 2018 version of the Mosaic factor percentile for Cultural Diversity. |
mosaic_factor5_percentile_2018 | string | Deprecated element. The 2018 version of the Mosaic factor percentile for Housing Ownership. |
risk_insight_code | string | 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 | string | Description of the code returned for the above attribute. |
Name | Type | Description |
---|---|---|
Reference-Id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
The response from the API returns the below attributes. Should an error occur, an error
object is returned instead.
Name | Type | Description |
---|---|---|
reference_id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
transaction_id | string | Unique Experian-assigned transaction identifier. |
result | object | A result object containing the requested attributes. |
metadata (Optional) |
object | A metadata object containing detailed element level match information.This object is only returned when the Add-Metadata header is set to True on the request. |
Attributes are only returned if
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. |
Object is only returned if
Name | Type | Description | ||
---|---|---|---|---|
code | string | Response-level metadata code. | ||
message | string | Response-level metadata message. | ||
detail | string | Response-level metadata detail. | ||
datasets | object | |||
AUS_CV_Household | object | |||
hin | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
address | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
suburb | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
postcode | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
state | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
residential_flag | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
gnaf_pid | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
gnaf_latitude | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
gnaf_longitude | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
meshblock | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
sa1 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
local_government_area_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
local_government_area_name | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_group | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_group_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_group_2015 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_type | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_type_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_type_2015 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_segment | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_segment_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_segment_2015 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
affluence_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
affluence_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
adults_at_address_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
adults_at_address_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
children_at_address_code_0_10_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
children_at_address_description_0_10_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
children_at_address_code_11_18_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
children_at_address_description_11_18_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
credit_demand_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
credit_demand_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
channel_preference | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
channel_preference_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
household_income_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
household_income_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
household_composition_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
head_of_household_age_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
head_of_household_age_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
lifestage_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
lifestage_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
length_of_residence_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
length_of_residence_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor1_score | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor2_score | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor3_score | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor4_score | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor5_score | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor1_score_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor2_score_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor3_score_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor4_score_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor5_score_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor1_percentile | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor2_percentile | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor3_percentile | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor4_percentile | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor5_percentile | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor1_percentile_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor2_percentile_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor3_percentile_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor4_percentile_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
mosaic_factor5_percentile_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
risk_insight_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. | ||
risk_insight_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Household attribute. Only included if the attribute was requested. |
Name | Type | Description |
---|---|---|
code | string | Attribute-level metadata code. |
message | string | Attribute-level metadata message. |
value | string | The attribute's value that was returned by the API. |
Each response you receive from the API will also return a HTTP status code.
Scenarios
The table below will help you identify the reason why you are getting a certain response.
Status Code | Reason phrase | Description |
---|---|---|
200 | Success | Request processed successfully. |
400 | Bad Request | Request failed due to malformed syntax. |
You didn't specify the keys field. Try submitting another call and make sure the request body contains the keys field. Check out Search keys for details. | ||
You've specified one or more invalid search keys. Try submitting another request and make sure you specify a valid search key for each dataset you use. Check out Search keys for details. | ||
You didn't specify any search keys. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
You didn't specify any search key for a dataset. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
You've specified multiple search keys for a dataset. Try submitting another request and make sure you only specify one search key per dataset. Check out Search keys for details. | ||
You didn't specify the attributes field. Try submitting another cal and make sure the request body contains the attributes field. Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified one or more invalid attributes. Try submitting another request and make sure you specify valid attributes. Check out the attributes listed in the enrichment dataset you are using. | ||
You didn't specify any attributes. Try submitting another request and make sure you specify at least one attribute for each dataset you use. Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified one or more empty attributes (e.g. " "). Try submitting another request and make sure you specify attribute names (e.g. "pin"). Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified an invalid country value. Try submitting another request and make sure you specify a valid country value. | ||
You didn't provide an authentication token. Try submitting another request and make sure you specify your token, which you can find by signing in to the Self Service Portal. | ||
You've submitted a malformed request body. Try sending another call and make sure the request body contains all required fields and that they are formatted correctly. | ||
You've submitted an empty request body. Try sending another call and make sure the request body contains all required fields. | ||
You've submitted an invalid Reference-ID header. Try submitting another request and make sure this header is formatted correctly. | ||
You've submitted an invalid Add-Metadata header. Try submitting another request and make sure this header is formatted correctly. | ||
401 | Unauthorized | Auth-Token provided is incorrect. Sign in to the Self Service Portal to find the right token. |
403 | Forbidden | Request is not authorized to use this service. |
The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. | ||
The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. | ||
The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain. | ||
The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address. | ||
404 | Not Found | The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact us. |
406 | Not Acceptable | Request is not in an acceptable format. |
You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. | ||
408 | Request Timeout | Your request has timed out (the web server failed to respond in the specified time frame). Try submitting another request. If the issue persists, contact us. |
415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. |
429 | Too many requests | Too many requests were sent. To protect all customers, your account has been temporarily throttled. Check our rate limiting for more details. |
500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact us. |
503 | Service Unavailable | Service unavailable. Check service status for up-to-date information. |
If you send a request to the API with the Add-Metadata
header set to True, and the HTTP status code of the response is 200, the API will return a metadata-level status code
, a message
and a detail
field.
Code | Message | Detail |
---|---|---|
S200 | Success | All requested attributes retrieved. |
S206 | Success | Some of the requested attributes retrieved. |
S204 | No match | No records matching the specified keys. |
S201 | Not authorized | Attributes not authorized. |
If you send a request to the API with the Add-Metadata
header set to True, and the HTTP status code of the response is 200, the API will return a code
and message
for each attribute.
Code | Message | Description |
---|---|---|
S200 | Match | Attribute retrieved successfully. |
E404 | Not found | The requested attribute could not be found because there are no records matching the specified keys. |
E401 | Not authorized | You are not authorized to use the requested attribute based on the token you have provided. |
POST /enrichment/v2 HTTP/1.1
Add-Metadata: true
{
"country_iso": "AUS",
"keys": {
"global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
},
"attributes": {
"AUS_CV_Household": [
"address",
"adults_at_address_code",
"adults_at_address_description",
"affluence_code",
"affluence_description",
"channel_preference",
"channel_preference_description",
"children_at_address_code_0_10_years",
"children_at_address_code_11_18_years",
"children_at_address_description_0_10_years",
"children_at_address_description_11_18_years",
"credit_demand_code",
"credit_demand_description",
"gnaf_latitude",
"gnaf_longitude",
"gnaf_pid",
"head_of_household_age_code",
"head_of_household_age_description",
"hin",
"household_composition_code",
"household_composition_description",
"household_income_code",
"household_income_description",
"length_of_residence_code",
"length_of_residence_description",
"lifestage_code",
"lifestage_description",
"local_government_area_code",
"local_government_area_name",
"meshblock",
"mosaic_group",
"mosaic_segment",
"mosaic_type",
"postcode",
"residential_flag",
"risk_insight_code",
"risk_insight_description",
"sa1",
"state",
"suburb",
"mosaic_factor1_percentile",
"mosaic_factor1_score",
"mosaic_factor2_percentile",
"mosaic_factor2_score",
"mosaic_factor3_percentile",
"mosaic_factor3_score",
"mosaic_factor4_percentile",
"mosaic_factor4_score",
"mosaic_factor5_percentile",
"mosaic_factor5_score"
]
}
}
{
"transaction_id": "00000000-0000-0000-0000-000000000000",
"result": {
"aus_cv_household": {
"hin": "201479983",
"address": "22 TOURMALINE DR",
"suburb": "WEST WODONGA",
"postcode": "3690",
"state": "VIC",
"residential_flag": "R",
"gnaf_pid": "GAVIC420630433",
"gnaf_latitude": -36.12433166,
"gnaf_longitude": 146.86341447,
"meshblock": "20620060000",
"sa1": "2107330",
"local_government_area_code": "27170",
"local_government_area_name": "Wodonga (RC)",
"affluence_code": "4",
"affluence_description": "Average income Average assets",
"adults_at_address_code": "2",
"adults_at_address_description": "Two adults",
"children_at_address_code_0_10_years": "5",
"children_at_address_description_0_10_years": "Average likelihood",
"children_at_address_code_11_18_years": "7",
"children_at_address_description_11_18_years": "Moderately high likelihood",
"credit_demand_code": "6",
"credit_demand_description": "Moderate Likelihood of Credit Demand (60-70%)",
"household_income_code": "2",
"household_income_description": "$20,800 - $41,599",
"household_composition_code": "3",
"household_composition_description": "Couples",
"head_of_household_age_code": "15",
"head_of_household_age_description": "Age 85 and over",
"lifestage_code": "9",
"lifestage_description": "Elderly Couples",
"length_of_residence_code": "15",
"length_of_residence_description": "14+ yrs",
"risk_insight_code": "1",
"risk_insight_description": "Highest Likelihood of Credit Risk (top 5%)",
"channel_preference": "8",
"channel_preference_description": "Keeping it Local",
"mosaic_group": "L",
"mosaic_type": "L46",
"mosaic_segment": "L46_5",
"mosaic_factor1_score": "1012",
"mosaic_factor2_score": "-13182",
"mosaic_factor3_score": "869",
"mosaic_factor4_score": "10913",
"mosaic_factor5_score": "850",
"mosaic_factor1_percentile": "51",
"mosaic_factor2_percentile": "2",
"mosaic_factor3_percentile": "50",
"mosaic_factor4_percentile": "86",
"mosaic_factor5_percentile": "39"
}
},
"metadata": {
"code": "S200",
"message": "Success",
"detail": "All requested attribute(s) retrieved.",
"datasets": {
"aus_cv_household": {
"hin": {
"code": "S200",
"message": "Match",
"value": "201479983"
},
"address": {
"code": "S200",
"message": "Match",
"value": "22 TOURMALINE DR"
},
"suburb": {
"code": "S200",
"message": "Match",
"value": "WEST WODONGA"
},
"postcode": {
"code": "S200",
"message": "Match",
"value": "3690"
},
"state": {
"code": "S200",
"message": "Match",
"value": "VIC"
},
"residential_flag": {
"code": "S200",
"message": "Match",
"value": "R"
},
"gnaf_pid": {
"code": "S200",
"message": "Match",
"value": "GAVIC420630433"
},
"gnaf_latitude": {
"code": "S200",
"message": "Match",
"value": "-36.12433166"
},
"gnaf_longitude": {
"code": "S200",
"message": "Match",
"value": "146.86341447"
},
"meshblock": {
"code": "S200",
"message": "Match",
"value": "20620060000"
},
"sa1": {
"code": "S200",
"message": "Match",
"value": "2107330"
},
"local_government_area_code": {
"code": "S200",
"message": "Match",
"value": "27170"
},
"local_government_area_name": {
"code": "S200",
"message": "Match",
"value": "Wodonga (RC)"
},
"affluence_code": {
"code": "S200",
"message": "Match",
"value": "4"
},
"affluence_description": {
"code": "S200",
"message": "Match",
"value": "Average income Average assets"
},
"adults_at_address_code": {
"code": "S200",
"message": "Match",
"value": "2"
},
"adults_at_address_description": {
"code": "S200",
"message": "Match",
"value": "Two adults"
},
"children_at_address_code_0_10_years": {
"code": "S200",
"message": "Match",
"value": "5"
},
"children_at_address_description_0_10_years": {
"code": "S200",
"message": "Match",
"value": "Average likelihood"
},
"children_at_address_code_11_18_years": {
"code": "S200",
"message": "Match",
"value": "7"
},
"children_at_address_description_11_18_years": {
"code": "S200",
"message": "Match",
"value": "Moderately high likelihood"
},
"credit_demand_code": {
"code": "S200",
"message": "Match",
"value": "6"
},
"credit_demand_description": {
"code": "S200",
"message": "Match",
"value": "Moderate Likelihood of Credit Demand (60-70%)"
},
"household_income_code": {
"code": "S200",
"message": "Match",
"value": "2"
},
"household_income_description": {
"code": "S200",
"message": "Match",
"value": "$20,800 - $41,599"
},
"household_composition_code": {
"code": "S200",
"message": "Match",
"value": "3"
},
"household_composition_description": {
"code": "S200",
"message": "Match",
"value": "Couples"
},
"head_of_household_age_code": {
"code": "S200",
"message": "Match",
"value": "15"
},
"head_of_household_age_description": {
"code": "S200",
"message": "Match",
"value": "Age 85 and over"
},
"lifestage_code": {
"code": "S200",
"message": "Match",
"value": "9"
},
"lifestage_description": {
"code": "S200",
"message": "Match",
"value": "Elderly Couples"
},
"length_of_residence_code": {
"code": "S200",
"message": "Match",
"value": "15"
},
"length_of_residence_description": {
"code": "S200",
"message": "Match",
"value": "14+ yrs"
},
"risk_insight_code": {
"code": "S200",
"message": "Match",
"value": "1"
},
"risk_insight_description": {
"code": "S200",
"message": "Match",
"value": "Highest Likelihood of Credit Risk (top 5%)"
},
"channel_preference": {
"code": "S200",
"message": "Match",
"value": "8"
},
"channel_preference_description": {
"code": "S200",
"message": "Match",
"value": "Keeping it Local"
},
"mosaic_group": {
"code": "S200",
"message": "Match",
"value": "L"
},
"mosaic_type": {
"code": "S200",
"message": "Match",
"value": "L46"
},
"mosaic_segment": {
"code": "S200",
"message": "Match",
"value": "L46_5"
},
"mosaic_factor1_score": {
"code": "S200",
"message": "Match",
"value": "1012"
},
"mosaic_factor2_score": {
"code": "S200",
"message": "Match",
"value": "-13182"
},
"mosaic_factor3_score": {
"code": "S200",
"message": "Match",
"value": "869"
},
"mosaic_factor4_score": {
"code": "S200",
"message": "Match",
"value": "10913"
},
"mosaic_factor5_score": {
"code": "S200",
"message": "Match",
"value": "850"
},
"mosaic_factor1_percentile": {
"code": "S200",
"message": "Match",
"value": "51"
},
"mosaic_factor2_percentile": {
"code": "S200",
"message": "Match",
"value": "2"
},
"mosaic_factor3_percentile": {
"code": "S200",
"message": "Match",
"value": "50"
},
"mosaic_factor4_percentile": {
"code": "S200",
"message": "Match",
"value": "86"
},
"mosaic_factor5_percentile": {
"code": "S200",
"message": "Match",
"value": "39"
}
}
}
}
}
Use the /enrichment/v2 endpoint to append specific close to 30 attributes, such as number of adults and children at the location, length of residence, and several Mosaic elements.
Name | Type | Description |
---|---|---|
Auth-Token | string | Input your unique token here. This is required to submit an API request. |
Add-Metadata (Optional) |
boolean | Specify whether the response should return all fields and values, in addition to the main core information. The default value of this setting is false. |
Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
Match-Rule (Optional) |
string | Currently only Strict is supported. |
Linkage-Rule (Optional) |
string | Currently only None is supported. |
Layout (Optional) |
string | This element is not editable at this time. |
Timeout-Seconds (Optional) |
integer | Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned. The default value of this setting is 15. |
In the request body you can specify:
Name | Type | Description | |
---|---|---|---|
country_iso | string | The 3-letter ISO country code. | |
keys | |||
postcode | string | The postal code or zip code of the address. | |
attributes | |||
attributes | collection | Specify the required aus_cv_postcode attributes. |
Name | Type | Description |
---|---|---|
postcode | string | The postal code of the address. |
adults_at_address_code | string | Estimate of the number of people aged 18 and over in a household. |
adults_at_address_description | string | Description of the code returned for the above attribute. |
affluence_code | string | A rating indicating the household level of wealth based on household demographics, assets and investments. |
affluence_code_description | string | Description of the code returned for the above attribute. |
children_at_address_code_0_10_years | string | 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 | string | Description of the code returned for the above attribute. |
children_at_address_code_11_18_years | string | A prediction of the presence of children aged 11-18 in a household. |
children_at_address_description_11_18_years | string | Description of the code returned for the above attribute. |
credit_demand_code | string | 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 | string | Description of the code returned for the above attribute. |
head_of_household_age_code | string | 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 | string | Description of the code returned for the above attribute. |
household_income_code | string | Prediction of annual income of the household. Code represents one of 7 income bands. |
household_income_description | string | Description of the code returned for the above attribute. |
length_of_residence_code | string | 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 | string | Description of the code returned for the above attribute. |
lifestage_code | string | An indication of the stage of life of the household occupants. Represents one of 10 bands. |
lifestage_code_description | string | Description of the code returned for the above attribute. |
mosaic_group | string | The Mosaic classification group. One of 13. e.g. K |
mosaic_group_2018 | string | Deprecated element. The 2018 version of the Mosaic classification group. One of 13. e.g. K |
mosaic_type | string | The Mosaic classification group and type. One of 13 groups and 49 types. e.g. K39. |
mosaic_type_2018 | string | 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 | string | 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 | string | Description of the code returned for the above attribute. |
risk_insight_code | string | 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 | string | Description of the code returned for the above attribute. |
Name | Type | Description |
---|---|---|
Reference-Id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
The response from the API returns the below attributes. Should an error occur, an error
object is returned instead.
Name | Type | Description |
---|---|---|
reference_id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
transaction_id | string | Unique Experian-assigned transaction identifier. |
result | object | A result object containing the requested attributes. |
metadata (Optional) |
object | A metadata object containing detailed element level match information.This object is only returned when the Add-Metadata header is set to True on the request. |
Attributes are only returned if
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. |
Object is only returned if
Name | Type | Description | ||
---|---|---|---|---|
code | string | Response-level metadata code. | ||
message | string | Response-level metadata message. | ||
detail | string | Response-level metadata detail. | ||
datasets | object | |||
AUS_CV_Postcode | object | |||
postcode | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
adults_at_address_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
adults_at_address_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
affluence_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
affluence_code_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
children_at_address_code_0_10_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
children_at_address_description_0_10_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
children_at_address_code_11_18_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
children_at_address_description_11_18_years | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
credit_demand_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
head_of_household_age_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
head_of_household_age_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
household_income_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
household_income_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
length_of_residence_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
length_of_residence_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
lifestage_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
lifestage_code_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
mosaic_group | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
mosaic_group_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
mosaic_type | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
mosaic_type_2018 | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
household_composition_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
household_composition_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
risk_insight_code | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. | ||
risk_insight_description | object | A MetadataDatasetElement object containing attribute level match information for this AUS_CV_Postcode attribute. Only included if the attribute was requested. |
Name | Type | Description |
---|---|---|
code | string | Attribute-level metadata code. |
message | string | Attribute-level metadata message. |
value | string | The attribute's value that was returned by the API. |
Each response you receive from the API will also return a HTTP status code.
Scenarios
The table below will help you identify the reason why you are getting a certain response.
Status Code | Reason phrase | Description |
---|---|---|
200 | Success | Request processed successfully. |
400 | Bad Request | Request failed due to malformed syntax. |
You didn't specify the keys field. Try submitting another call and make sure the request body contains the keys field. Check out Search keys for details. | ||
You've specified one or more invalid search keys. Try submitting another request and make sure you specify a valid search key for each dataset you use. Check out Search keys for details. | ||
You didn't specify any search keys. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
You didn't specify any search key for a dataset. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
You've specified multiple search keys for a dataset. Try submitting another request and make sure you only specify one search key per dataset. Check out Search keys for details. | ||
You didn't specify the attributes field. Try submitting another cal and make sure the request body contains the attributes field. Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified one or more invalid attributes. Try submitting another request and make sure you specify valid attributes. Check out the attributes listed in the enrichment dataset you are using. | ||
You didn't specify any attributes. Try submitting another request and make sure you specify at least one attribute for each dataset you use. Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified one or more empty attributes (e.g. " "). Try submitting another request and make sure you specify attribute names (e.g. "pin"). Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified an invalid country value. Try submitting another request and make sure you specify a valid country value. | ||
You didn't provide an authentication token. Try submitting another request and make sure you specify your token, which you can find by signing in to the Self Service Portal. | ||
You've submitted a malformed request body. Try sending another call and make sure the request body contains all required fields and that they are formatted correctly. | ||
You've submitted an empty request body. Try sending another call and make sure the request body contains all required fields. | ||
You've submitted an invalid Reference-ID header. Try submitting another request and make sure this header is formatted correctly. | ||
You've submitted an invalid Add-Metadata header. Try submitting another request and make sure this header is formatted correctly. | ||
401 | Unauthorized | Auth-Token provided is incorrect. Sign in to the Self Service Portal to find the right token. |
403 | Forbidden | Request is not authorized to use this service. |
The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. | ||
The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. | ||
The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain. | ||
The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address. | ||
404 | Not Found | The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact us. |
406 | Not Acceptable | Request is not in an acceptable format. |
You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. | ||
408 | Request Timeout | Your request has timed out (the web server failed to respond in the specified time frame). Try submitting another request. If the issue persists, contact us. |
415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. |
429 | Too many requests | Too many requests were sent. To protect all customers, your account has been temporarily throttled. Check our rate limiting for more details. |
500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact us. |
503 | Service Unavailable | Service unavailable. Check service status for up-to-date information. |
If you send a request to the API with the Add-Metadata
header set to True, and the HTTP status code of the response is 200, the API will return a metadata-level status code
, a message
and a detail
field.
Code | Message | Detail |
---|---|---|
S200 | Success | All requested attributes retrieved. |
S206 | Success | Some of the requested attributes retrieved. |
S204 | No match | No records matching the specified keys. |
S201 | Not authorized | Attributes not authorized. |
If you send a request to the API with the Add-Metadata
header set to True, and the HTTP status code of the response is 200, the API will return a code
and message
for each attribute.
Code | Message | Description |
---|---|---|
S200 | Match | Attribute retrieved successfully. |
E404 | Not found | The requested attribute could not be found because there are no records matching the specified keys. |
E401 | Not authorized | You are not authorized to use the requested attribute based on the token you have provided. |
POST /enrichment/v2 HTTP/1.1
Add-Metadata: true
{
"country_iso": "AUS",
"keys": {
"dpid": "31176490",
"postcode": "7140"
},
"attributes": {
"AUS_CV_Household": [
"address",
"adults_at_address_code",
"adults_at_address_description",
"affluence_code",
"affluence_description",
"channel_preference",
"channel_preference_description",
"children_at_address_code_0_10_years",
"children_at_address_code_11_18_years",
"children_at_address_description_0_10_years",
"children_at_address_description_11_18_years",
"credit_demand_code",
"credit_demand_description",
"gnaf_latitude",
"gnaf_longitude",
"gnaf_pid",
"head_of_household_age_code",
"head_of_household_age_description",
"hin",
"household_composition_code",
"household_composition_description",
"household_income_code",
"household_income_description",
"length_of_residence_code",
"length_of_residence_description",
"lifestage_code",
"lifestage_description",
"local_government_area_code",
"local_government_area_name",
"meshblock",
"mosaic_group",
"mosaic_segment",
"mosaic_type",
"postcode",
"residential_flag",
"risk_insight_code",
"risk_insight_description",
"sa1",
"state",
"suburb",
"mosaic_factor1_percentile",
"mosaic_factor1_score",
"mosaic_factor2_percentile",
"mosaic_factor2_score",
"mosaic_factor3_percentile",
"mosaic_factor3_score",
"mosaic_factor4_percentile",
"mosaic_factor4_score",
"mosaic_factor5_percentile",
"mosaic_factor5_score"
],
"AUS_CV_Postcode": [
"postcode",
"adults_at_address_code",
"adults_at_address_description",
"affluence_code",
"affluence_code_description",
"children_at_address_code_0_10_years",
"children_at_address_description_0_10_years",
"children_at_address_code_11_18_years",
"children_at_address_description_11_18_years",
"credit_demand_code",
"credit_demand_description",
"head_of_household_age_code",
"head_of_household_age_description",
"household_income_code",
"household_income_description",
"length_of_residence_code",
"length_of_residence_description",
"lifestage_code",
"lifestage_code_description",
"household_composition_code",
"household_composition_description",
"risk_insight_code",
"risk_insight_description",
"mosaic_group",
"mosaic_type"
]
}
}
{
"transaction_id": "00000000-0000-0000-0000-000000000000",
"result": {
"aus_cv_household": {
"hin": "201479983",
"address": "22 TOURMALINE DR",
"suburb": "WEST WODONGA",
"postcode": "3690",
"state": "VIC",
"residential_flag": "R",
"gnaf_pid": "GAVIC420630433",
"gnaf_latitude": -36.12433166,
"gnaf_longitude": 146.86341447,
"meshblock": "20620060000",
"sa1": "2107330",
"local_government_area_code": "27170",
"local_government_area_name": "Wodonga (RC)",
"affluence_code": "4",
"affluence_description": "Average income Average assets",
"adults_at_address_code": "2",
"adults_at_address_description": "Two adults",
"children_at_address_code_0_10_years": "5",
"children_at_address_description_0_10_years": "Average likelihood",
"children_at_address_code_11_18_years": "7",
"children_at_address_description_11_18_years": "Moderately high likelihood",
"credit_demand_code": "6",
"credit_demand_description": "Moderate Likelihood of Credit Demand (60-70%)",
"household_income_code": "2",
"household_income_description": "$20,800 - $41,599",
"household_composition_code": "3",
"household_composition_description": "Couples",
"head_of_household_age_code": "15",
"head_of_household_age_description": "Age 85 and over",
"lifestage_code": "9",
"lifestage_description": "Elderly Couples",
"length_of_residence_code": "15",
"length_of_residence_description": "14+ yrs",
"risk_insight_code": "1",
"risk_insight_description": "Highest Likelihood of Credit Risk (top 5%)",
"channel_preference": "8",
"channel_preference_description": "Keeping it Local",
"mosaic_group": "L",
"mosaic_type": "L46",
"mosaic_segment": "L46_5",
"mosaic_factor1_score": "1012",
"mosaic_factor2_score": "-13182",
"mosaic_factor3_score": "869",
"mosaic_factor4_score": "10913",
"mosaic_factor5_score": "850",
"mosaic_factor1_percentile": "51",
"mosaic_factor2_percentile": "2",
"mosaic_factor3_percentile": "50",
"mosaic_factor4_percentile": "86",
"mosaic_factor5_percentile": "39"
},
"aus_cv_postcode": {
"postcode": "7140",
"adults_at_address_code": "2",
"adults_at_address_description": "Two adults",
"affluence_code": "1",
"affluence_code_description": "Low income Low assets",
"children_at_address_code_0_10_years": "10",
"children_at_address_description_0_10_years": "High Likelihood",
"children_at_address_code_11_18_years": "8",
"children_at_address_description_11_18_years": "High Likelihood",
"credit_demand_code": "10",
"credit_demand_description": "Low Likelihood of Credit Demand (bottom 20-30%)",
"head_of_household_age_code": "6",
"head_of_household_age_description": "Age 40 to 44",
"household_income_code": "2",
"household_income_description": "$20,800 - $41,599",
"length_of_residence_code": "15",
"length_of_residence_description": "14+ yrs",
"lifestage_code": "6",
"lifestage_code_description": "Older Couples & Families",
"household_composition_code": "1",
"household_composition_description": "Families",
"risk_insight_code": "5",
"risk_insight_description": "High Likelihood of Credit Risk (top 20-30%)",
"mosaic_group": "L",
"mosaic_type": "L46"
}
},
"metadata": {
"code": "S200",
"message": "Success",
"detail": "All requested attribute(s) retrieved.",
"datasets": {
"aus_cv_household": {
"hin": {
"code": "S200",
"message": "Match",
"value": "201479983"
},
"address": {
"code": "S200",
"message": "Match",
"value": "22 TOURMALINE DR"
},
"suburb": {
"code": "S200",
"message": "Match",
"value": "WEST WODONGA"
},
"postcode": {
"code": "S200",
"message": "Match",
"value": "3690"
},
"state": {
"code": "S200",
"message": "Match",
"value": "VIC"
},
"residential_flag": {
"code": "S200",
"message": "Match",
"value": "R"
},
"gnaf_pid": {
"code": "S200",
"message": "Match",
"value": "GAVIC420630433"
},
"gnaf_latitude": {
"code": "S200",
"message": "Match",
"value": "-36.12433166"
},
"gnaf_longitude": {
"code": "S200",
"message": "Match",
"value": "146.86341447"
},
"meshblock": {
"code": "S200",
"message": "Match",
"value": "20620060000"
},
"sa1": {
"code": "S200",
"message": "Match",
"value": "2107330"
},
"local_government_area_code": {
"code": "S200",
"message": "Match",
"value": "27170"
},
"local_government_area_name": {
"code": "S200",
"message": "Match",
"value": "Wodonga (RC)"
},
"affluence_code": {
"code": "S200",
"message": "Match",
"value": "4"
},
"affluence_description": {
"code": "S200",
"message": "Match",
"value": "Average income Average assets"
},
"adults_at_address_code": {
"code": "S200",
"message": "Match",
"value": "2"
},
"adults_at_address_description": {
"code": "S200",
"message": "Match",
"value": "Two adults"
},
"children_at_address_code_0_10_years": {
"code": "S200",
"message": "Match",
"value": "5"
},
"children_at_address_description_0_10_years": {
"code": "S200",
"message": "Match",
"value": "Average likelihood"
},
"children_at_address_code_11_18_years": {
"code": "S200",
"message": "Match",
"value": "7"
},
"children_at_address_description_11_18_years": {
"code": "S200",
"message": "Match",
"value": "Moderately high likelihood"
},
"credit_demand_code": {
"code": "S200",
"message": "Match",
"value": "6"
},
"credit_demand_description": {
"code": "S200",
"message": "Match",
"value": "Moderate Likelihood of Credit Demand (60-70%)"
},
"household_income_code": {
"code": "S200",
"message": "Match",
"value": "2"
},
"household_income_description": {
"code": "S200",
"message": "Match",
"value": "$20,800 - $41,599"
},
"household_composition_code": {
"code": "S200",
"message": "Match",
"value": "3"
},
"household_composition_description": {
"code": "S200",
"message": "Match",
"value": "Couples"
},
"head_of_household_age_code": {
"code": "S200",
"message": "Match",
"value": "15"
},
"head_of_household_age_description": {
"code": "S200",
"message": "Match",
"value": "Age 85 and over"
},
"lifestage_code": {
"code": "S200",
"message": "Match",
"value": "9"
},
"lifestage_description": {
"code": "S200",
"message": "Match",
"value": "Elderly Couples"
},
"length_of_residence_code": {
"code": "S200",
"message": "Match",
"value": "15"
},
"length_of_residence_description": {
"code": "S200",
"message": "Match",
"value": "14+ yrs"
},
"risk_insight_code": {
"code": "S200",
"message": "Match",
"value": "1"
},
"risk_insight_description": {
"code": "S200",
"message": "Match",
"value": "Highest Likelihood of Credit Risk (top 5%)"
},
"channel_preference": {
"code": "S200",
"message": "Match",
"value": "8"
},
"channel_preference_description": {
"code": "S200",
"message": "Match",
"value": "Keeping it Local"
},
"mosaic_group": {
"code": "S200",
"message": "Match",
"value": "L"
},
"mosaic_type": {
"code": "S200",
"message": "Match",
"value": "L46"
},
"mosaic_segment": {
"code": "S200",
"message": "Match",
"value": "L46_5"
},
"mosaic_factor1_score": {
"code": "S200",
"message": "Match",
"value": "1012"
},
"mosaic_factor2_score": {
"code": "S200",
"message": "Match",
"value": "-13182"
},
"mosaic_factor3_score": {
"code": "S200",
"message": "Match",
"value": "869"
},
"mosaic_factor4_score": {
"code": "S200",
"message": "Match",
"value": "10913"
},
"mosaic_factor5_score": {
"code": "S200",
"message": "Match",
"value": "850"
},
"mosaic_factor1_percentile": {
"code": "S200",
"message": "Match",
"value": "51"
},
"mosaic_factor2_percentile": {
"code": "S200",
"message": "Match",
"value": "2"
},
"mosaic_factor3_percentile": {
"code": "S200",
"message": "Match",
"value": "50"
},
"mosaic_factor4_percentile": {
"code": "S200",
"message": "Match",
"value": "86"
},
"mosaic_factor5_percentile": {
"code": "S200",
"message": "Match",
"value": "39"
}
},
"aus_cv_postcode": {
"postcode": {
"code": "S200",
"message": "Match",
"value": "7140"
},
"adults_at_address_code": {
"code": "S200",
"message": "Match",
"value": "2"
},
"adults_at_address_description": {
"code": "S200",
"message": "Match",
"value": "Two adults"
},
"affluence_code": {
"code": "S200",
"message": "Match",
"value": "1"
},
"affluence_code_description": {
"code": "S200",
"message": "Match",
"value": "Low income Low assets"
},
"children_at_address_code_0_10_years": {
"code": "S200",
"message": "Match",
"value": "10"
},
"children_at_address_description_0_10_years": {
"code": "S200",
"message": "Match",
"value": "High Likelihood"
},
"children_at_address_code_11_18_years": {
"code": "S200",
"message": "Match",
"value": "8"
},
"children_at_address_description_11_18_years": {
"code": "S200",
"message": "Match",
"value": "High Likelihood"
},
"credit_demand_code": {
"code": "S200",
"message": "Match",
"value": "10"
},
"credit_demand_description": {
"code": "S200",
"message": "Match",
"value": "Low Likelihood of Credit Demand (bottom 20-30%)"
},
"head_of_household_age_code": {
"code": "S200",
"message": "Match",
"value": "6"
},
"head_of_household_age_description": {
"code": "S200",
"message": "Match",
"value": "Age 40 to 44"
},
"household_income_code": {
"code": "S200",
"message": "Match",
"value": "2"
},
"household_income_description": {
"code": "S200",
"message": "Match",
"value": "$20,800 - $41,599"
},
"length_of_residence_code": {
"code": "S200",
"message": "Match",
"value": "15"
},
"length_of_residence_description": {
"code": "S200",
"message": "Match",
"value": "14+ yrs"
},
"lifestage_code": {
"code": "S200",
"message": "Match",
"value": "6"
},
"lifestage_code_description": {
"code": "S200",
"message": "Match",
"value": "Older Couples & Families"
},
"household_composition_code": {
"code": "S200",
"message": "Match",
"value": "1"
},
"household_composition_description": {
"code": "S200",
"message": "Match",
"value": "Families"
},
"risk_insight_code": {
"code": "S200",
"message": "Match",
"value": "5"
},
"risk_insight_description": {
"code": "S200",
"message": "Match",
"value": "High Likelihood of Credit Risk (top 20-30%)"
},
"mosaic_group": {
"code": "S200",
"message": "Match",
"value": "L"
},
"mosaic_type": {
"code": "S200",
"message": "Match",
"value": "L46"
}
}
}
}
}
Use the /enrichment/v2 endpoint to append specific over 50 attributes, such as number of adults and children at the household, income levels, and various Mosaic factors.
Name | Type | Description |
---|---|---|
Auth-Token | string | Input your unique token here. This is required to submit an API request. |
Add-Metadata (Optional) |
boolean | Specify whether the response should return all fields and values, in addition to the main core information. The default value of this setting is false. |
Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
Match-Rule (Optional) |
string | Currently only Strict is supported. |
Linkage-Rule (Optional) |
string | Currently only None is supported. |
Layout (Optional) |
string | This element is not editable at this time. |
Timeout-Seconds (Optional) |
integer | Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned. The default value of this setting is 15. |
In the request body you can specify:
Name | Type | Description | |
---|---|---|---|
country_iso | string | The 3-letter ISO country code. | |
keys | |||
global_address_key | string | The unique Experian identifier identifing the address to append the Enrichment data to. You can find the global_address_key in the responses of the /search and /lookup endpoints, e.g. aWQ9fDEgQXVkcmV5IFphcHAgRHJpdm. |
|
attributes | collection | Specify the required nzl_cv_household attributes. |
Name | Type | Description |
---|---|---|
head_of_household_age | string | A code which estimates the age category of the person likely to be the head of the household. |
children_at_address | string | A code which represents the likelihood of the presence of children in the household. |
household_composition | string | A code which indicates the composition of the household. |
head_of_household_lifestage | string | A code which indicates the life stage of the head of household. |
adults_at_address | string | A code which estimates the number of adults (people aged 18+) living in the household. |
mosaic_group | string | 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 | string | A code that appends the mosaic type for the searched address. Mosaic classifies all NZ households into nine groups and 34 types. |
mosaic_segment | string | 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. |
Name | Type | Description |
---|---|---|
Reference-Id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
The response from the API returns the below attributes. Should an error occur, an error
object is returned instead.
Name | Type | Description |
---|---|---|
reference_id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
transaction_id | string | Unique Experian-assigned transaction identifier. |
result | object | A result object containing the requested attributes. |
metadata (Optional) |
object | A metadata object containing detailed element level match information.This object is only returned when the Add-Metadata header is set to True on the request. |
Attributes are only returned if
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. |
Object is only returned if
Name | Type | Description | ||
---|---|---|---|---|
code | string | Response-level metadata code. | ||
message | string | Response-level metadata message. | ||
detail | string | Response-level metadata detail. | ||
datasets | object | |||
nzl_cv_household | object | |||
head_of_household_age | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. | ||
children_at_address | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. | ||
household_composition | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. | ||
head_of_household_lifestage | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. | ||
adults_at_address | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. | ||
mosaic_group | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. | ||
mosaic_type_group | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. | ||
mosaic_segment | object | A MetadataDatasetElement object containing attribute level match information for this nzl_cv_household attribute. Only included if the attribute was requested. |
Name | Type | Description |
---|---|---|
code | string | Attribute-level metadata code. |
message | string | Attribute-level metadata message. |
value | string | The attribute's value that was returned by the API. |
Each response you receive from the API will also return a HTTP status code.
Scenarios
The table below will help you identify the reason why you are getting a certain response.
Status Code | Reason phrase | Description |
---|---|---|
200 | Success | Request processed successfully. |
400 | Bad Request | Request failed due to malformed syntax. |
You didn't specify the keys field. Try submitting another call and make sure the request body contains the keys field. Check out Search keys for details. | ||
You've specified one or more invalid search keys. Try submitting another request and make sure you specify a valid search key for each dataset you use. Check out Search keys for details. | ||
You didn't specify any search keys. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
You didn't specify any search key for a dataset. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
You've specified multiple search keys for a dataset. Try submitting another request and make sure you only specify one search key per dataset. Check out Search keys for details. | ||
You didn't specify the attributes field. Try submitting another cal and make sure the request body contains the attributes field. Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified one or more invalid attributes. Try submitting another request and make sure you specify valid attributes. Check out the attributes listed in the enrichment dataset you are using. | ||
You didn't specify any attributes. Try submitting another request and make sure you specify at least one attribute for each dataset you use. Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified one or more empty attributes (e.g. " "). Try submitting another request and make sure you specify attribute names (e.g. "pin"). Check out the attributes listed in the enrichment dataset you are using. | ||
You've specified an invalid country value. Try submitting another request and make sure you specify a valid country value. | ||
You didn't provide an authentication token. Try submitting another request and make sure you specify your token, which you can find by signing in to the Self Service Portal. | ||
You've submitted a malformed request body. Try sending another call and make sure the request body contains all required fields and that they are formatted correctly. | ||
You've submitted an empty request body. Try sending another call and make sure the request body contains all required fields. | ||
You've submitted an invalid Reference-ID header. Try submitting another request and make sure this header is formatted correctly. | ||
You've submitted an invalid Add-Metadata header. Try submitting another request and make sure this header is formatted correctly. | ||
401 | Unauthorized | Auth-Token provided is incorrect. Sign in to the Self Service Portal to find the right token. |
403 | Forbidden | Request is not authorized to use this service. |
The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. | ||
The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. | ||
The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain. | ||
The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address. | ||
404 | Not Found | The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact us. |
406 | Not Acceptable | Request is not in an acceptable format. |
You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. | ||
408 | Request Timeout | Your request has timed out (the web server failed to respond in the specified time frame). Try submitting another request. If the issue persists, contact us. |
415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. |
429 | Too many requests | Too many requests were sent. To protect all customers, your account has been temporarily throttled. Check our rate limiting for more details. |
500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact us. |
503 | Service Unavailable | Service unavailable. Check service status for up-to-date information. |
If you send a request to the API with the Add-Metadata
header set to True, and the HTTP status code of the response is 200, the API will return a metadata-level status code
, a message
and a detail
field.
Code | Message | Detail |
---|---|---|
S200 | Success | All requested attributes retrieved. |
S206 | Success | Some of the requested attributes retrieved. |
S204 | No match | No records matching the specified keys. |
S201 | Not authorized | Attributes not authorized. |
If you send a request to the API with the Add-Metadata
header set to True, and the HTTP status code of the response is 200, the API will return a code
and message
for each attribute.
Code | Message | Description |
---|---|---|
S200 | Match | Attribute retrieved successfully. |
E404 | Not found | The requested attribute could not be found because there are no records matching the specified keys. |
E401 | Not authorized | You are not authorized to use the requested attribute based on the token you have provided. |
POST /enrichment/v2 HTTP/1.1
Add-Metadata: true
{
"country_iso": "NZL",
"keys": {
"global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
},
"attributes": {
"nzl_cv_household": [
"adults_at_address",
"children_at_address",
"head_of_household_age",
"head_of_household_lifestage",
"household_composition",
"mosaic_group",
"mosaic_segment",
"mosaic_type_group"
]
}
}
{
"transaction_id": "00000000-0000-0000-0000-000000000000",
"result": {
"nzl_cv_household": {
"head_of_household_age": "10",
"children_at_address": "4",
"household_composition": "3",
"head_of_household_lifestage": "9",
"adults_at_address": "2",
"mosaic_group": "G",
"mosaic_type_group": "G25",
"mosaic_segment": "25_2"
}
},
"metadata": {
"code": "S200",
"message": "Success",
"detail": "All requested attribute(s) retrieved.",
"datasets": {
"nzl_cv_household": {
"head_of_household_age": {
"code": "S200",
"message": "Match",
"value": "10"
},
"children_at_address": {
"code": "S200",
"message": "Match",
"value": "4"
},
"household_composition": {
"code": "S200",
"message": "Match",
"value": "3"
},
"head_of_household_lifestage": {
"code": "S200",
"message": "Match",
"value": "9"
},
"adults_at_address": {
"code": "S200",
"message": "Match",
"value": "2"
},
"mosaic_group": {
"code": "S200",
"message": "Match",
"value": "G"
},
"mosaic_type_group": {
"code": "S200",
"message": "Match",
"value": "G25"
},
"mosaic_segment": {
"code": "S200",
"message": "Match",
"value": "25_2"
}
}
}
}
}