Data Quality user documentation | Global 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 Global Location Insight related information such as accurate latitude and longitude information 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
	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.

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.

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
	geocodes		object
		latitude	object	A MetadataDatasetElement object containing attribute level match information for this geocodes attribute. Only included if the attribute was requested.
		longitude	object	A MetadataDatasetElement object containing attribute level match information for this geocodes attribute. Only included if the attribute was requested.
		match_level	object	A MetadataDatasetElement object containing attribute level match information for this 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": "USA",
  "keys": {
    "global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW"
  },
  "attributes": {
    "geocodes": [
      "latitude",
      "longitude",
      "match_level"
    ]
  }
}

Response

{
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "geocodes": {
      "latitude": 33.68945,
      "longitude": -117.87401,
      "match_level": "building"
    }
  },
  "metadata": {
    "code": "S200",
    "message": "Success",
    "detail": "All requested attribute(s) retrieved.",
    "datasets": {
      "geocodes": {
        "latitude": {
          "code": "S200",
          "message": "Match",
          "value": "33.68945"
        },
        "longitude": {
          "code": "S200",
          "message": "Match",
          "value": "-117.87401"
        },
        "match_level": {
          "code": "S200",
          "message": "Match",
          "value": "building"
        }
      }
    }
  }
}

Use the /enrichment/v2 endpoint to append greater precision geocoding data and richer location insights, such as access (door) level geocodes and time zone information 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
	premium_location_insight	collection	Specify the required attributes. Potential attributes for this dataset are: geocodes: 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. geocodes_building_xy: x_coordinate Specifies the X coordinate for the specified address. y_coordinate Specifies the Y coordinate for the specified address. geocodes_access: latitude The latitude in degrees for the entry point of the specified address. logitude The longitude in degrees for the entry point of the specified address. time: time_zone_id The time zone id returned based on the specified address. genericThe Generic time zone name returned based on a specified address. standardThe Standard time zone name returned based on a specified address. daylightThe Daylight time zone name returned based on a specified address. reference_timeThe timezone tag, std offset, daylight savings sunrise , sunset based on current timestamp. time_transitionThe timezone tag, std offset, daylight savings sunrise , sunset based on UTC start and endtime

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
geocodes	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. Example: building, street, locality, postal_code, city, district, county, state, country, etc.

geocodes_building_xy	x_coordinate Specifies the X coordinate for the specified address. y_coordinate Specifies the Y coordinate for the specified address.
geocodes_access	latitude The latitude in degrees for the entry point of the specified address. logitude The longitude in degrees for the entry point of the specified address.
time	time_zone_id The time zone id returned based on the specified address. generic The Generic time zone name returned based on a specified address. standard The Standard time zone name returned based on a specified address. daylight The Daylight time zone name returned based on a specified address. reference_time The timezone tag, std offset, daylight savings sunrise , sunset based on current timestamp. time_transition The timezone tag, std offset, daylight savings sunrise , sunset based on UTC start and endtime

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
	premium_location_insight		object
		geocodes	object	A MetadataDatasetElement object containing attribute level match information for this premium_location_insight attribute. Only included if the attribute was requested.
		geocodes_building_xy	object	A MetadataDatasetElement object containing attribute level match information for this premium_location_insight attribute. Only included if the attribute was requested.
		geocodes_access	object	A MetadataDatasetElement object containing attribute level match information for this premium_location_insight attribute. Only included if the attribute was requested.
		time	object	A MetadataDatasetElement object containing attribute level match information for this premium_location_insight 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": {
    "premium_location_insight": [
      "geocodes",
      "geocodes_building_xy",
      "geocodes_access",
      "time"
    ]
  }
}

Response

{
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "premium_location_insight": {
      "geocodes": {
        "latitude": 54.6020056,
        "longitude": -5.8302126,
        "match_level": "building"
      },
      "geocodes_building_xy": {
        "x_coordinate": 152718.84,
        "y_coordinate": 529726.57
      },
      "geocodes_access": [
        {
          "latitude": 54.6020056,
          "longitude": -5.8302126
        }
      ],
      "time": [
        {
          "time_zone_id": "Europe/London",
          "generic": "United Kingdom Time",
          "standard": "Greenwich Mean Time",
          "daylight": "British Summer Time",
          "reference_time": {
            "tag": "BST",
            "standard_offset": "00:00:00",
            "daylight_savings": "01:00:00",
            "sunrise": "2023-04-11T06:32:15.2599306+01:00",
            "sunset": "2023-04-11T20:16:52.0569033+01:00"
          },
          "time_transition": [
            {
              "tag": "BST",
              "standard_offset": "00:00:00",
              "daylight_savings": "01:00:00",
              "utc_start": "2023-03-26T01:00:00Z",
              "utc_end": "2023-10-29T01:00:00Z"
            },
            {
              "tag": "GMT",
              "standard_offset": "00:00:00",
              "daylight_savings": "00:00:00",
              "utc_start": "2023-10-29T01:00:00Z",
              "utc_end": "2024-03-31T01:00:00Z"
            },
            {
              "tag": "BST",
              "standard_offset": "00:00:00",
              "daylight_savings": "01:00:00",
              "utc_start": "2024-03-31T01:00:00Z",
              "utc_end": "2024-10-27T01:00:00Z"
            }
          ]
        }
      ]
    }
  },
  "metadata": {
    "code": "S200",
    "message": "Success",
    "detail": "All requested attribute(s) retrieved.",
    "datasets": {
      "premium_location_insight": {
        "geocodes": {
          "code": "S200",
          "message": "Match",
          "value": "[complex type]"
        },
        "geocodes_building_xy": {
          "code": "S200",
          "message": "Match",
          "value": "[complex type]"
        },
        "geocodes_access": {
          "code": "S200",
          "message": "Match",
          "value": "[complex type]"
        },
        "time": {
          "code": "S200",
          "message": "Match",
          "value": "[complex type]"
        }
      }
    }
  }
}

Use the /enrichment/v2 endpoint to append latitude and longitude information to a postal address from a what3words address - accurate to a 3 meter square. Enable your end users to pinpoint the exact location of their front door, driveway or safe place for a delivery.

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. For this dataset you will only be able to use the `global_address_key` to retrieve the below attributes if your end user's journey started with supplying a valid what3words address.
attributes
	what3words	collection	Specify the required attributes. Potential attributes for this dataset are: latitude: The latitude for the what3words address. longitude: The longitude for the what3words address. name: The what3words address. description: Describes the nearest place to the what3words address.

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.

Name		Type	Description
what3words		object	Object containing the returned attributes. Available attributes depend on the dataset used.
	latitude	number	The latitude for the what3words address.
	longitude	number	The longitude for the what3words address.
	name	string	The what3words address, e.g. pretty.needed.chill.
	description	string	Describes the nearest place to the what3words address, e.g. near Oxford, Oxfordshire.

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
	what3words		object
		latitude	object	A MetadataDatasetElement object containing attribute level match information for this what3words attribute. Only included if the attribute was requested.
		longitude	object	A MetadataDatasetElement object containing attribute level match information for this what3words attribute. Only included if the attribute was requested.
		name	object	A MetadataDatasetElement object containing attribute level match information for this what3words attribute. Only included if the attribute was requested.
		description	object	A MetadataDatasetElement object containing attribute level match information for this what3words 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
Reference-Id: "99999999-9999-9999-9999-999999999999"

{
  "country_iso": "GBR",
  "keys": {
    "global_address_key": "aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2Fy"
  },
  "attributes": {
    "what3words": [
      "latitude",
      "longitude",
      "name",
      "description"
    ]
  }
}

Response

{
  "reference_id": "99999999-9999-9999-9999-999999999999",
  "transaction_id": "00000000-0000-0000-0000-000000000000",
  "result": {
    "what3words": {
      "latitude": 51.751172,
      "longitude": -1.24623,
      "name": "pretty.needed.chill",
      "description": "near Oxford, Oxfordshire"
    }
  }
}

Was this helpful?

Previous: API specification

Next: Regional Location Insights

Experian Address Validation

Enrichment API reference

Next topic:
Introduction
Previous topic:
API specification