Data Quality user documentation | Regional Location Insights

Credit usage

If you have a per-click license, each successful request will deduct one or more credits. Please contact your account manager or contact support for more information. You can also log in to Experian's Self Service Portal to review your product usage.

Use the /enrichment/v2 endpoint to append specific building roof top latitude and longitude information, as well as local government area indicators and mesh blocks, to your validated addresses.

Headers

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.

Body parameters

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 aus_regional_geocodes attributes.

Attributes

Name	Type	Description
latitude	string	The latitude in degrees for the specified address.
longitude	string	The longitude in degrees for the specified address.
sa1	string	The 7 digit SA1 code.
meshblock	string	The Mesh Block ID. This element consists of 11 digit Mesh Block Code.
lga_code	string	The Local Government Area persistent identifier.
lga_name	string	The Local Government Area name.
match_level	string	Specifies the accuracy of the coordinates for the specified address.
street_pid	string	This is a unique street persistent identifier.
locality_pid	string	This is a unique locality persistent identifier.
geocode_level_code	string	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	string	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	string	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	string	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	string	The highest level longitude in degrees.
highest_level_latitude	string	The highest level latitude in degrees.
highest_level_elevation	string	The highest level elevation.
highest_level_planimetric_accuracy	string	The highest level planimetric accuracy.
highest_level_boundary_extent	string	The highest level boundary extent.
highest_level_geocode_reliability_code	string	The highest level geocode reliability code.
highest_level_geocode_reliability_description	string	The highest level geocode reliability description.
confidence_level_code	string	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	string	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	string	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	string	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	string	The code for the level of matching to 2021 Mesh Blocks.
2021_meshblock_match_description	string	The description of the 2021 Mesh Block match level.
2016_meshblock_id	string	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	string	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	string	The code for the level of matching to 2016 Mesh Blocks.
2016_meshblock_match_description	string	The description of the 2016 Mesh Block match level.
2011_meshblock_id	string	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	string	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	string	Deprecated element, always blank, e.g. " ". The code for the level of matching to 2011 Mesh Blocks.
2011_meshblock_match_description	string	Deprecated element, always blank, e.g. " ". The description of the 2011 Mesh Block match level.
address_type_code	string	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	string	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	string	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	string	This is a unique Collector District persistent identifier.
collector_district_code	string	This is the Collector District code.
commonwealth_electoral_boundary_id	string	This is a unique Commonwealth Electoral Boundary persistent identifier.
commonwealth_electoral_boundary_name	string	This is the Commonwealth Electoral Boundary name.
statistical_local_area_id	string	This is a Statistical Local Area persistent identifier.
statistical_local_area_code	string	9-digit SLAcode. For example 150154750.
statistical_local_area_name	string	This is a Statistical Local Area name.
state_electoral_boundary_id	string	This is a State Electoral Boundary persistent identifier.
state_electoral_boundary_name	string	This is a State Electoral Boundary name.
state_electoral_effective_start	string	This is the date that the electorate becomes effective.
state_electoral_effective_end	string	This is the end date when electorate is no longer in effect.
state_electoral_new_pid	string	This is the State Electoral Boundary identifier for new electorate that will be in effect.
state_electoral_new_name	string	This is the State Electoral Boundary name for new electorate that will be in effect.
state_electoral_new_effective_start	string	This is the start date that the new electorate will become effective.
state_electoral_new_effective_end	string	This is the end date when the new electorate will no longer be in effect.
address_level_longitude	string	The address-level longitude in degrees.
address_level_latitude	string	The address-level latitude in degrees.
address_level_elevation	string	The address-level elevation.
address_level_planimetric_accuracy	string	The address-level planimetric accuracy.
address_level_boundary_extent	string	The address-level boundary extent.
address_level_geocode_reliability_code	string	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	string	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	string	The street-level longitude in degrees.
street_level_latitude	string	The street-level latitude in degrees.
street_level_planimetric_accuracy	string	The street-level planimetric accuracy.
street_level_boundary_extent	string	The street-level boundary extent.
street_level_geocode_reliability_code	string	The street-level geocode reliability code. The value of this is either 4 or blank.
street_level_geocode_reliability_description	string	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	string	The locality-level longitude in degrees.
locality_level_latitude	string	The locality-level latitude in degrees.
locality_level_planimetric_accuracy	string	The locality-level planimetric accuracy.
locality_level_geocode_reliability_code	string	The locality-level geocode reliability code.The value of this is either 5, 6, or blank.
locality_level_geocode_reliability_description	string	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	string	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.

Headers

Name	Type	Description
Reference-Id (Optional)	string	Identifier that was supplied by you in the request header to help you track the request.

Body

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.

Result object

Attributes are only returned if

All attributes in this object are optionally returned - only when the requests includes them in the attributes collection.

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.

Metadata object

Object is only returned if

This object is only returned when the Add-Metadata header is set to True on the request.

Name			Type	Description
code			string	Response-level metadata code.
message			string	Response-level metadata message.
detail			string	Response-level metadata detail.
datasets			object
	aus_regional_geocodes		object
		latitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		longitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		sa1	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		meshblock	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		lga_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		lga_name	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		match_level	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		street_pid	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		locality_pid	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		geocode_level_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		geocode_level_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		geocode_type_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		geocode_type_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		highest_level_longitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		highest_level_latitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		highest_level_elevation	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		highest_level_planimetric_accuracy	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		highest_level_boundary_extent	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		highest_level_geocode_reliability_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		highest_level_geocode_reliability_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		confidence_level_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		confidence_level_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2021_meshblock_id	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2021_meshblock_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2021_meshblock_match_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2021_meshblock_match_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2016_meshblock_id	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2016_meshblock_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2016_meshblock_match_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2016_meshblock_match_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2011_meshblock_id	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2011_meshblock_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2011_meshblock_match_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		2011_meshblock_match_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_type_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		primary_address_pid	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_join_type	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		collector_district_id	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		collector_district_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		commonwealth_electoral_boundary_id	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		commonwealth_electoral_boundary_name	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		statistical_local_area_id	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		statistical_local_area_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		statistical_local_area_name	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_boundary_id	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_boundary_name	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_effective_start	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_effective_end	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_new_pid	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_new_name	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_new_effective_start	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		state_electoral_new_effective_end	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_level_longitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_level_latitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_level_elevation	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_level_planimetric_accuracy	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_level_boundary_extent	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_level_geocode_reliability_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		address_level_geocode_reliability_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		street_level_longitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		street_level_latitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		street_level_planimetric_accuracy	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		street_level_boundary_extent	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		street_level_geocode_reliability_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		street_level_geocode_reliability_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		locality_level_longitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		locality_level_latitude	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		locality_level_planimetric_accuracy	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		locality_level_geocode_reliability_code	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		locality_level_geocode_reliability_description	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.
		gnaf_legal_parcel_identifier	object	A MetadataDatasetElement object containing attribute level match information for this aus_regional_geocodes attribute. Only included if the attribute was requested.

MetadataDatasetElement object

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.

Response status codes

Each response you receive from the API will also return a HTTP status code.

Scenarios

The response body will also contain details about the scenarios presented below (with the exception of 404, 406 and 415).

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.
406	Not Acceptable	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.

Metadata status codes

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.

Attribute status code

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.

Request

POST /enrichment/v2 HTTP/1.1
Add-Metadata: true

{
  "country_iso": "AUS",
  "keys": {
    "global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
  },
  "attributes": {
    "aus_regional_geocodes": [
      "latitude",
      "longitude",
      "match_level",
      "sa1",
      "meshblock",
      "lga_code",
      "lga_name",
      "street_pid",
      "locality_pid",
      "geocode_level_code",
      "geocode_level_description",
      "geocode_type_code",
      "geocode_type_description",
      "highest_level_longitude",
      "highest_level_latitude",
      "highest_level_elevation",
      "highest_level_planimetric_accuracy",
      "highest_level_boundary_extent",
      "highest_level_geocode_reliability_code",
      "highest_level_geocode_reliability_description",
      "confidence_level_code",
      "confidence_level_description",
      "2021_meshblock_id",
      "2021_meshblock_code",
      "2021_meshblock_match_code",
      "2021_meshblock_match_description",
      "2016_meshblock_id",
      "2016_meshblock_code",
      "2016_meshblock_match_code",
      "2016_meshblock_match_description",
      "address_type_code",
      "primary_address_pid",
      "address_join_type",
      "collector_district_id",
      "collector_district_code",
      "commonwealth_electoral_boundary_id",
      "commonwealth_electoral_boundary_name",
      "statistical_local_area_id",
      "statistical_local_area_code",
      "statistical_local_area_name",
      "state_electoral_boundary_id",
      "state_electoral_boundary_name",
      "state_electoral_effective_start",
      "state_electoral_effective_end",
      "state_electoral_new_pid",
      "state_electoral_new_name",
      "state_electoral_new_effective_start",
      "state_electoral_new_effective_end",
      "address_level_longitude",
      "address_level_latitude",
      "address_level_elevation",
      "address_level_planimetric_accuracy",
      "address_level_boundary_extent",
      "address_level_geocode_reliability_code",
      "address_level_geocode_reliability_description",
      "street_level_longitude",
      "street_level_latitude",
      "street_level_planimetric_accuracy",
      "street_level_boundary_extent",
      "street_level_geocode_reliability_code",
      "street_level_geocode_reliability_description",
      "locality_level_longitude",
      "locality_level_latitude",
      "locality_level_planimetric_accuracy",
      "locality_level_geocode_reliability_code",
      "locality_level_geocode_reliability_description",
      "gnaf_legal_parcel_identifier",
      "locality_class_code"
    ]
  }
}

Response

{
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "aus_regional_geocodes": {
      "latitude": -31.06740552,
      "longitude": 152.83315122,
      "match_level": "building",
      "sa1": "1115514",
      "meshblock": "10402970000",
      "lga_code": "14350",
      "lga_name": "Kempsey (A)",
      "street_pid": "NSW2838126",
      "locality_pid": "NSW4281",
      "geocode_level_code": "7",
      "geocode_level_description": "Locality, street and parcel level geocodes",
      "geocode_type_code": "PC",
      "geocode_type_description": "Property centroid",
      "highest_level_longitude": 152.833151218104,
      "highest_level_latitude": -31.0674055233909,
      "highest_level_geocode_reliability_code": "2",
      "highest_level_geocode_reliability_description": "Geocode accuracy sufficient to place centroid within address site boundary",
      "confidence_level_code": "2",
      "confidence_level_description": "All three contributors have supplied an identical address",
      "2021_meshblock_id": "MB2110402970000",
      "2021_meshblock_code": "10402970000",
      "2021_meshblock_match_code": "1",
      "2021_meshblock_match_description": "Parcel level match",
      "2016_meshblock_id": "MB1610402970000",
      "2016_meshblock_code": "10402970000",
      "2016_meshblock_match_code": "1",
      "2016_meshblock_match_description": "Parcel level match",
      "collector_district_id": "NSW1081403",
      "collector_district_code": "1081403",
      "commonwealth_electoral_boundary_id": "NSW32",
      "commonwealth_electoral_boundary_name": "COWPER",
      "statistical_local_area_id": "NSW125104350",
      "statistical_local_area_code": "125104350",
      "statistical_local_area_name": "KEMPSEY (A)",
      "state_electoral_boundary_id": "NSW231",
      "state_electoral_boundary_name": "OXLEY",
      "state_electoral_effective_start": "24/03/2007 00:00:00",
      "state_electoral_effective_end": "28/03/2015 00:00:00",
      "state_electoral_new_pid": "NSW242",
      "state_electoral_new_name": "OXLEY",
      "state_electoral_new_effective_start": "28/03/2015 00:00:00",
      "address_level_longitude": 152.833151218104,
      "address_level_latitude": -31.0674055233909,
      "address_level_geocode_reliability_code": "2",
      "address_level_geocode_reliability_description": "Geocode accuracy sufficient to place centroid within address site boundary",
      "street_level_longitude": 152.831107798991,
      "street_level_latitude": -31.0627225231523,
      "street_level_boundary_extent": "651",
      "street_level_geocode_reliability_code": "4",
      "street_level_geocode_reliability_description": "Geocode accuracy sufficient to associate address site with a unique road feature",
      "locality_level_longitude": 152.829982639523,
      "locality_level_latitude": -31.0598233330185,
      "locality_level_geocode_reliability_code": "5",
      "locality_level_geocode_reliability_description": "Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood",
      "gnaf_legal_parcel_identifier": "B/366584",
      "locality_class_code": "G"
    }
  },
  "metadata": {
    "code": "S206",
    "message": "Success",
    "detail": "Some of the requested attribute(s) retrieved.",
    "datasets": {
      "aus_regional_geocodes": {
        "latitude": {
          "code": "S200",
          "message": "Match",
          "value": "-31.06740552"
        },
        "longitude": {
          "code": "S200",
          "message": "Match",
          "value": "152.83315122,"
        },
        "match_level": {
          "code": "S200",
          "message": "Match",
          "value": "building"
        },
        "sa1": {
          "code": "S200",
          "message": "Match",
          "value": "1115514"
        },
        "meshblock": {
          "code": "S200",
          "message": "Match",
          "value": "10402970000"
        },
        "lga_code": {
          "code": "S200",
          "message": "Match",
          "value": "14350"
        },
        "lga_name": {
          "code": "S200",
          "message": "Match",
          "value": "Kempsey (A)"
        },
        "street_pid": {
          "code": "S200",
          "message": "Match",
          "value": "NSW2838126"
        },
        "locality_pid": {
          "code": "S200",
          "message": "Match",
          "value": "NSW4281"
        },
        "geocode_level_code": {
          "code": "S200",
          "message": "Match",
          "value": "7"
        },
        "geocode_level_description": {
          "code": "S200",
          "message": "Match",
          "value": "Locality, street and parcel level geocodes"
        },
        "geocode_type_code": {
          "code": "S200",
          "message": "Match",
          "value": "PC"
        },
        "geocode_type_description": {
          "code": "S200",
          "message": "Match",
          "value": "Property centroid"
        },
        "highest_level_longitude": {
          "code": "S200",
          "message": "Match",
          "value": "152.833151218104"
        },
        "highest_level_latitude": {
          "code": "S200",
          "message": "Match",
          "value": "-31.0674055233909"
        },
        "highest_level_elevation": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "highest_level_planimetric_accuracy": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "highest_level_boundary_extent": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "highest_level_geocode_reliability_code": {
          "code": "S200",
          "message": "Match",
          "value": "2"
        },
        "highest_level_geocode_reliability_description": {
          "code": "S200",
          "message": "Match",
          "value": "Geocode accuracy sufficient to place centroid within address site boundary"
        },
        "confidence_level_code": {
          "code": "S200",
          "message": "Match",
          "value": "2"
        },
        "confidence_level_description": {
          "code": "S200",
          "message": "Match",
          "value": "All three contributors have supplied an identical address"
        },
        "2021_meshblock_id": {
          "code": "S200",
          "message": "Match",
          "value": "MB2110402970000"
        },
        "2021_meshblock_code": {
          "code": "S200",
          "message": "Match",
          "value": "10402970000"
        },
        "2021_meshblock_match_code": {
          "code": "S200",
          "message": "Match",
          "value": "1"
        },
        "2021_meshblock_match_description": {
          "code": "S200",
          "message": "Match",
          "value": "Parcel level match"
        },
        "2016_meshblock_id": {
          "code": "S200",
          "message": "Match",
          "value": "MB1610402970000"
        },
        "2016_meshblock_code": {
          "code": "S200",
          "message": "Match",
          "value": "10402970000"
        },
        "2016_meshblock_match_code": {
          "code": "S200",
          "message": "Match",
          "value": "1"
        },
        "2016_meshblock_match_description": {
          "code": "S200",
          "message": "Match",
          "value": "Parcel level match"
        },
        "address_type_code": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "primary_address_pid": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "address_join_type": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "collector_district_id": {
          "code": "S200",
          "message": "Match",
          "value": "NSW1081403"
        },
        "collector_district_code": {
          "code": "S200",
          "message": "Match",
          "value": "1081403"
        },
        "commonwealth_electoral_boundary_id": {
          "code": "S200",
          "message": "Match",
          "value": "NSW32"
        },
        "commonwealth_electoral_boundary_name": {
          "code": "S200",
          "message": "Match",
          "value": "COWPER"
        },
        "statistical_local_area_id": {
          "code": "S200",
          "message": "Match",
          "value": "NSW125104350"
        },
        "statistical_local_area_code": {
          "code": "S200",
          "message": "Match",
          "value": "125104350"
        },
        "statistical_local_area_name": {
          "code": "S200",
          "message": "Match",
          "value": "KEMPSEY (A)"
        },
        "state_electoral_boundary_id": {
          "code": "S200",
          "message": "Match",
          "value": "NSW231"
        },
        "state_electoral_boundary_name": {
          "code": "S200",
          "message": "Match",
          "value": "OXLEY"
        },
        "state_electoral_effective_start": {
          "code": "S200",
          "message": "Match",
          "value": "24/03/2007 00:00:00"
        },
        "state_electoral_effective_end": {
          "code": "S200",
          "message": "Match",
          "value": "28/03/2015 00:00:00"
        },
        "state_electoral_new_pid": {
          "code": "S200",
          "message": "Match",
          "value": "NSW242"
        },
        "state_electoral_new_name": {
          "code": "S200",
          "message": "Match",
          "value": "OXLEY"
        },
        "state_electoral_new_effective_start": {
          "code": "S200",
          "message": "Match",
          "value": "28/03/2015 00:00:00"
        },
        "state_electoral_new_effective_end": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "address_level_longitude": {
          "code": "S200",
          "message": "Match",
          "value": "152.833151218104"
        },
        "address_level_latitude": {
          "code": "S200",
          "message": "Match",
          "value": "-31.0674055233909"
        },
        "address_level_elevation": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "address_level_planimetric_accuracy": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "address_level_boundary_extent": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "address_level_geocode_reliability_code": {
          "code": "S200",
          "message": "Match",
          "value": "2"
        },
        "address_level_geocode_reliability_description": {
          "code": "S200",
          "message": "Match",
          "value": "Geocode accuracy sufficient to place centroid within address site boundary"
        },
        "street_level_longitude": {
          "code": "S200",
          "message": "Match",
          "value": "152.831107798991"
        },
        "street_level_latitude": {
          "code": "S200",
          "message": "Match",
          "value": "-31.0627225231523"
        },
        "street_level_planimetric_accuracy": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "street_level_boundary_extent": {
          "code": "S200",
          "message": "Match",
          "value": "651"
        },
        "street_level_geocode_reliability_code": {
          "code": "S200",
          "message": "Match",
          "value": "4"
        },
        "street_level_geocode_reliability_description": {
          "code": "S200",
          "message": "Match",
          "value": "Geocode accuracy sufficient to associate address site with a unique road feature"
        },
        "locality_level_longitude": {
          "code": "S200",
          "message": "Match",
          "value": "152.829982639523"
        },
        "locality_level_latitude": {
          "code": "S200",
          "message": "Match",
          "value": "-31.0598233330185"
        },
        "locality_level_planimetric_accuracy": {
          "code": "E404",
          "message": "Not found",
          "value": ""
        },
        "locality_level_geocode_reliability_code": {
          "code": "S200",
          "message": "Match",
          "value": "5"
        },
        "locality_level_geocode_reliability_description": {
          "code": "S200",
          "message": "Match",
          "value": "Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood"
        },
        "gnaf_legal_parcel_identifier": {
          "code": "S200",
          "message": "Match",
          "value": "B/366584"
        },
        "locality_class_code": {
          "code": "S200",
          "message": "Match",
          "value": "G"
        }
      }
    }
  }
}

Use the /enrichment/v2 endpoint to append specific higher accuracy geographical coordinate data. In addition, it provides additional New Zealand data such as property information, territorial authority, regional council, general and Maori Electorate information.

Headers

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.

Body parameters

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_regional_geocodes attributes.

Attributes

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

Headers

Name	Type	Description
Reference-Id (Optional)	string	Identifier that was supplied by you in the request header to help you track the request.

Body

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.

Result object

Attributes are only returned if

All attributes in this object are optionally returned - only when the requests includes them in the attributes collection.

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.

Metadata object

Object is only returned if

This object is only returned when the Add-Metadata header is set to True on the request.

Name			Type	Description
code			string	Response-level metadata code.
message			string	Response-level metadata message.
detail			string	Response-level metadata detail.
datasets			object
	nzl_regional_geocodes		object
		addressable	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		centroid_of_property_latitude	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		centroid_of_property_longitude	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		centroid_of_property_nztm_x_coordinate	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		front_of_property_latitude	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		front_of_property_longitude	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		front_of_property_nztm_x_coordinate	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		front_of_property_nztm_y_coordinate	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		general_electorate_code	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		general_electorate_name	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		linz_parcel_id	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		maori_electorate_code	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		maori_electorate_name	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		match_level	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		mesh_block_code	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		property_purpose_type	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		regional_council_code	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		regional_council_name	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		territorial_authority_code	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.
		territorial_authority_name	object	A MetadataDatasetElement object containing attribute level match information for this nzl_regional_geocodes attribute. Only included if the attribute was requested.

MetadataDatasetElement object

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.

Response status codes

Each response you receive from the API will also return a HTTP status code.

Scenarios

The response body will also contain details about the scenarios presented below (with the exception of 404, 406 and 415).

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.
406	Not Acceptable	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.

Metadata status codes

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.

Attribute status code

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.

Request

POST /enrichment/v2 HTTP/1.1
Add-Metadata: true

{
  "country_iso": "NZL",
  "keys": {
    "global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
  },
  "attributes": {
    "nzl_regional_geocodes": [
      "addressable",
      "centroid_of_property_latitude",
      "centroid_of_property_longitude",
      "centroid_of_property_nztm_x_coordinate",
      "centroid_of_property_nztm_y_coordinate",
      "front_of_property_latitude",
      "front_of_property_longitude",
      "front_of_property_nztm_x_coordinate",
      "front_of_property_nztm_y_coordinate",
      "general_electorate_code",
      "general_electorate_name",
      "linz_parcel_id",
      "maori_electorate_code",
      "maori_electorate_name",
      "match_level",
      "mesh_block_code",
      "property_purpose_type",
      "regional_council_code",
      "regional_council_name",
      "territorial_authority_code",
      "territorial_authority_name"
    ]
  }
}

Response

{
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "nzl_regional_geocodes": {
      "front_of_property_nztm_x_coordinate": 1757352.77679428,
      "front_of_property_nztm_y_coordinate": 5920390.38954181,
      "centroid_of_property_nztm_x_coordinate": 1757328.32545739,
      "centroid_of_property_nztm_y_coordinate": 5920399.80535698,
      "linz_parcel_id": "5047052",
      "property_purpose_type": "Business",
      "addressable": "N",
      "mesh_block_code": "434000",
      "territorial_authority_code": "76",
      "territorial_authority_name": "Auckland",
      "regional_council_code": "2",
      "regional_council_name": "Auckland Region",
      "general_electorate_code": "001",
      "general_electorate_name": "Auckland Central",
      "maori_electorate_code": "3",
      "maori_electorate_name": "Tamaki Makaurau",
      "front_of_property_latitude": -36.84930884682109,
      "front_of_property_longitude": 174.76492824881467,
      "centroid_of_property_latitude": -36.849228077790954,
      "centroid_of_property_longitude": 174.76465216104987,
      "match_level": "building"
    }
  },
  "metadata": {
    "code": "S200",
    "message": "Success",
    "detail": "All requested attribute(s) retrieved.",
    "datasets": {
      "nzl_regional_geocodes": {
        "front_of_property_nztm_x_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "1757352.77679428"
        },
        "front_of_property_nztm_y_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "5920390.38954181"
        },
        "centroid_of_property_nztm_x_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "1757328.32545739"
        },
        "centroid_of_property_nztm_y_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "5920399.80535698"
        },
        "linz_parcel_id": {
          "code": "S200",
          "message": "Match",
          "value": "5047052"
        },
        "property_purpose_type": {
          "code": "S200",
          "message": "Match",
          "value": "Business"
        },
        "addressable": {
          "code": "S200",
          "message": "Match",
          "value": "N"
        },
        "mesh_block_code": {
          "code": "S200",
          "message": "Match",
          "value": "434000"
        },
        "territorial_authority_code": {
          "code": "S200",
          "message": "Match",
          "value": "76"
        },
        "territorial_authority_name": {
          "code": "S200",
          "message": "Match",
          "value": "Auckland"
        },
        "regional_council_code": {
          "code": "S200",
          "message": "Match",
          "value": "2"
        },
        "regional_council_name": {
          "code": "S200",
          "message": "Match",
          "value": "Auckland Region"
        },
        "general_electorate_code": {
          "code": "S200",
          "message": "Match",
          "value": "001"
        },
        "general_electorate_name": {
          "code": "S200",
          "message": "Match",
          "value": "Auckland Central"
        },
        "maori_electorate_code": {
          "code": "S200",
          "message": "Match",
          "value": "3"
        },
        "maori_electorate_name": {
          "code": "S200",
          "message": "Match",
          "value": "Tamaki Makaurau"
        },
        "front_of_property_latitude": {
          "code": "S200",
          "message": "Match",
          "value": "-36.84930884682109"
        },
        "front_of_property_longitude": {
          "code": "S200",
          "message": "Match",
          "value": "174.76492824881467"
        },
        "centroid_of_property_latitude": {
          "code": "S200",
          "message": "Match",
          "value": "-36.849228077790954"
        },
        "centroid_of_property_longitude": {
          "code": "S200",
          "message": "Match",
          "value": "174.76465216104987"
        },
        "match_level": {
          "code": "S200",
          "message": "Match",
          "value": "building"
        }
      }
    }
  }
}

Use the /enrichment/v2 endpoint to append Unique Property Reference Number (UPRN), Unique Delivery Point Reference Number (UDPRN), British National Grid's easting and northing coordinates, and building roof top latitude and longitude information from Ordnance Survey to your validated addresses.

This dataset does not include addresses from Isle of Man, Channel Islands or Northern Ireland.

Headers

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.

Body parameters

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
	uk_location_essential	collection	Specify the required attributes. Potential attributes for this dataset are: 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.

Headers

Name	Type	Description
Reference-Id (Optional)	string	Identifier that was supplied by you in the request header to help you track the request.

Body

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.

Result object

Attributes are only returned if

All attributes in this object are optionally returned - only when the requests includes them in the attributes collection.

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.

Metadata object

Object is only returned if

This object is only returned when the Add-Metadata header is set to True on the request.

Name			Type	Description
code			string	Response-level metadata code.
message			string	Response-level metadata message.
detail			string	Response-level metadata detail.
datasets			object
	uk_location_complete		object
		latitude	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		longitude	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		match_level	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		udprn	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		uprn	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		x_coordinate	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		y_coordinate	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.

MetadataDatasetElement object

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.

Response status codes

Each response you receive from the API will also return a HTTP status code.

Scenarios

The response body will also contain details about the scenarios presented below (with the exception of 404, 406 and 415).

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.
406	Not Acceptable	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.

Metadata status codes

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.

Attribute status code

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.

Request

POST /enrichment/v2 HTTP/1.1
Add-Metadata: true

{
  "country_iso": "GBR",
  "keys": {
    "global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
  },
  "attributes": {
    "uk_location_essential": [
      "latitude",
      "longitude",
      "match_level",
      "udprn",
      "uprn",
      "x_coordinate",
      "y_coordinate"
    ]
  }
}

Response

{
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "uk_location_essential": {
      "latitude": 51.5014256,
      "longitude": -0.104257,
      "match_level": "building",
      "udprn": "55244256",
      "uprn": "10091977422",
      "x_coordinate": 531677.95,
      "y_coordinate": 179757.59
    }
  },
  "metadata": {
    "code": "S200",
    "message": "Success",
    "detail": "All requested attribute(s) retrieved.",
    "datasets": {
      "uk_location_essential": {
        "latitude": {
          "code": "S200",
          "message": "Match",
          "value": "51.5014256"
        },
        "longitude": {
          "code": "S200",
          "message": "Match",
          "value": "-0.104257"
        },
        "match_level": {
          "code": "S200",
          "message": "Match",
          "value": "building"
        },
        "udprn": {
          "code": "S200",
          "message": "Match",
          "value": "55244256"
        },
        "uprn": {
          "code": "S200",
          "message": "Match",
          "value": "10091977422"
        },
        "x_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "531677.95"
        },
        "y_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "179757.59"
        }
      }
    }
  }
}

This dataset includes addresses from Isle of Man, Channel Islands, and Northern Ireland.

Headers

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.

Body parameters

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
	uk_location_complete	collection	Specify the required attributes. Potential attributes for this dataset are: 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.

Headers

Name	Type	Description
Reference-Id (Optional)	string	Identifier that was supplied by you in the request header to help you track the request.

Body

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.

Result object

Attributes are only returned if

All attributes in this object are optionally returned - only when the requests includes them in the attributes collection.

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.

Metadata object

Object is only returned if

This object is only returned when the Add-Metadata header is set to True on the request.

Name			Type	Description
code			string	Response-level metadata code.
message			string	Response-level metadata message.
detail			string	Response-level metadata detail.
datasets			object
	uk_location_complete		object
		latitude	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		longitude	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		match_level	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		udprn	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		uprn	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		x_coordinate	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.
		y_coordinate	object	A MetadataDatasetElement object containing attribute level match information for this uk_location_complete attribute. Only included if the attribute was requested.

MetadataDatasetElement object

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.

Response status codes

Each response you receive from the API will also return a HTTP status code.

Scenarios

The response body will also contain details about the scenarios presented below (with the exception of 404, 406 and 415).

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.
406	Not Acceptable	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.

Metadata status codes

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.

Attribute status code

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.

Request

POST /enrichment/v2 HTTP/1.1
Add-Metadata: true

{
  "country_iso": "GBR",
  "keys": {
    "global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
  },
  "attributes": {
    "uk_location_complete": [
      "latitude",
      "longitude",
      "match_level",
      "udprn",
      "uprn",
      "x_coordinate",
      "y_coordinate"
    ]
  }
}

Response

{
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "uk_location_complete": {
      "latitude": 51.5014256,
      "longitude": -0.104257,
      "match_level": "building",
      "udprn": "55244256",
      "uprn": "10091977422",
      "x_coordinate": 531677.95,
      "y_coordinate": 179757.59
    }
  },
  "metadata": {
    "code": "S200",
    "message": "Success",
    "detail": "All requested attribute(s) retrieved.",
    "datasets": {
      "uk_location_complete": {
        "latitude": {
          "code": "S200",
          "message": "Match",
          "value": "51.5014256"
        },
        "longitude": {
          "code": "S200",
          "message": "Match",
          "value": "-0.104257"
        },
        "match_level": {
          "code": "S200",
          "message": "Match",
          "value": "building"
        },
        "udprn": {
          "code": "S200",
          "message": "Match",
          "value": "55244256"
        },
        "uprn": {
          "code": "S200",
          "message": "Match",
          "value": "10091977422"
        },
        "x_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "531677.95"
        },
        "y_coordinate": {
          "code": "S200",
          "message": "Match",
          "value": "179757.59"
        }
      }
    }
  }
}

Use the /enrichment/v2 endpoint to append specific accurate latitude, longitude and other attributes from the US Census Bureau to your validated addresses.

Headers

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.

Body parameters

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
usa_regional_geocodes		collection	Specify the required attributes. Potential attributes for this dataset are: 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_tract: Smallest geographical unit used by US Census Bureau for the purpose of taking a census; sub-division of a tract. census_block: 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.

Headers

Name	Type	Description
Reference-Id (Optional)	string	Identifier that was supplied by you in the request header to help you track the request.

Body

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.

Result object

Attributes are only returned if

All attributes in this object are optionally returned - only when the requests includes them in the attributes collection.

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_tract	Smallest geographical unit used by US Census Bureau for the purpose of taking a census; sub-division of a tract.
census_block	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.

Metadata object

Object is only returned if

This object is only returned when the Add-Metadata header is set to True on the request.

Name			Type	Description
code			string	Response-level metadata code.
message			string	Response-level metadata message.
detail			string	Response-level metadata detail.
datasets			object
	usa_regional_geocodes		object
		latitude	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.
		longitude	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.
		match_level	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.
		census_tract	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.
		census_block	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.
		core_based_statistical_area	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.
		congressional_district_code	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.
		county_code	object	A MetadataDatasetElement object containing attribute level match information for this usa_regional_geocodes attribute. Only included if the attribute was requested.

MetadataDatasetElement object

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.

Response status codes

Each response you receive from the API will also return a HTTP status code.

Scenarios

The response body will also contain details about the scenarios presented below (with the exception of 404, 406 and 415).

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.
406	Not Acceptable	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.

Metadata status codes

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.

Attribute status code

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.

Request

POST /enrichment/v2 HTTP/1.1
Add-Metadata: true

{
  "country_iso": "USA",
  "keys": {
    "global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
  },
  "attributes": {
    "usa_regional_geocodes": [
      "latitude",
      "longitude",
      "match_level",
      "census_tract",
      "census_block",
      "core_based_statistical_area",
      "congressional_district_code",
      "county_code"
    ]
  }
}

Response

{
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "usa_regional_geocodes": {
      "latitude": 18.215183,
      "longitude": -66.226806,
      "match_level": "building",
      "census_tract": "952000",
      "census_block": "2012",
      "core_based_statistical_area": "41980",
      "congressional_district_code": "7298116",
      "county_code": "045"
    }
  },
  "metadata": {
    "code": "S200",
    "message": "Success",
    "detail": "All requested attribute(s) retrieved.",
    "datasets": {
      "usa_regional_geocodes": {
        "latitude": {
          "code": "S200",
          "message": "Match",
          "value": "18.215183"
        },
        "longitude": {
          "code": "S200",
          "message": "Match",
          "value": "-66.226806"
        },
        "match_level": {
          "code": "S200",
          "message": "Match",
          "value": "building"
        },
        "census_tract": {
          "code": "S200",
          "message": "Match",
          "value": "952000"
        },
        "census_block": {
          "code": "S200",
          "message": "Match",
          "value": "2012"
        },
        "core_based_statistical_area": {
          "code": "S200",
          "message": "Match",
          "value": "41980"
        },
        "congressional_district_code": {
          "code": "S200",
          "message": "Match",
          "value": "7298116"
        },
        "county_code": {
          "code": "S200",
          "message": "Match",
          "value": "045"
        }
      }
    }
  }
}

Was this helpful?

Previous: Global Location Insights

Next: Health

Experian Address Validation

Enrichment API reference

Next topic:
Introduction
Previous topic:
API specification