Use the /enrichment/v2 endpoint to append specific United Kingdom government related information such as the Local Authority Electoral Ward, Local Authority District Code, Local Education Authority Code, Government Office Region, and the European Electoral Region to your validated addresses.
| Name | Type | Description |
|---|---|---|
| Auth-Token | string | Input your unique token here. This is required to submit an API request. |
| Add-Metadata (Optional) |
boolean | Specify whether the response should return all fields and values, in addition to the main core information. The default value of this setting is false. |
| Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
| Match-Rule (Optional) |
string | Currently only Strict is supported. |
| Linkage-Rule (Optional) |
string | Currently only None is supported. |
| Layout (Optional) |
string | This element is not editable at this time. |
| Timeout-Seconds (Optional) |
integer | Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned. The default value of this setting is 15. |
In the request body you can specify:
| Name | Type | Description | |
|---|---|---|---|
| country_iso | string | The 3-letter ISO country code. | |
| keys | |||
| global_address_key | string | The unique Experian identifier identifing the address to append the Enrichment data to. You can find the global_address_key in the responses of the /search, /validate, and /lookup endpoints, e.g. aWQ9fDEgQXVkcmV5IFphcHAgRHJpdm. |
|
| attributes | |||
| attributes | |||
| gbr_government | collection | Specify the required attributes. Potential attributes for this dataset are:
|
|
| Name | Type | Description |
|---|---|---|
| Reference-Id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
The response from the API returns the below attributes. Should an error occur, an error object is returned instead.
| Name | Type | Description |
|---|---|---|
| reference_id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
| transaction_id | string | Unique Experian-assigned transaction identifier. |
| result | object | A result object containing the requested attributes. |
| metadata (Optional) |
object | A metadata object containing detailed element level match information.This object is only returned when the Add-Metadata header is set to True on the request. |
Attributes are only returned if
| Attribute | Description |
|---|---|
| eer_code | Official code given to the European Electoral Region by the Office of National Statistics (ONS) in January 2011. |
| eer_code_pre_2011 | Official code for the European Electoral Region, as used by the ONS before January 2011. |
| eer_name | Official name given to the European Electoral Region. |
| gor_code | Official code given to the Government Office Region by the ONS in January 2011. |
| gor_code_pre_2011 | Official code for the Government Office Region, as used by the ONS before January 2011. |
| gor_name | Official name given to the Government Office Region. |
| lea_code | Official code given to the Local Education Authority. |
| lea_name | Official name given to the Local Education Authority. |
| la_code | Official code given to the Local Authority by the ONS in January 2011. |
| la_code_pre_2011 | Official code for the Local Authority,as used by the ONS before January 2011. |
| la_name | Official name given to the Local Authority. |
| ward_code | Official code given to the Local Authority Ward by the ONS in January 2011. |
| ward_code_pre_2011 | Official code for the Local Authority Ward,as used by the ONS before January 2011. |
| ward_name | Official name given to the Local Authority Ward. |
| cens_out_area | Census Area output code. |
Object is only returned if
| Name | Type | Description | ||
|---|---|---|---|---|
| code | string | Response-level metadata code. | ||
| message | string | Response-level metadata message. | ||
| detail | string | Response-level metadata detail. | ||
| datasets | object | |||
| gbr_government | object | |||
| eer_code | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| eer_code_pre_2011 | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| eer_name | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| gor_code | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| gor_code_pre_2011 | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| gor_name | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| lea_code | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| lea_name | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| la_code | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| la_code_pre_2011 | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| la_name | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| ward_code | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| ward_code_pre_2011 | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| ward_name | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| cens_out_area | object | A MetadataDatasetElement object containing attribute level match information for this gbr_government attribute. Only included if the attribute was requested. | ||
| Name | Type | Description |
|---|---|---|
| code | string | Attribute-level metadata code. |
| message | string | Attribute-level metadata message. |
| value | string | The attribute's value that was returned by the API. |
Each response you receive from the API will also return a HTTP status code.
Scenarios
The table below will help you identify the reason why you are getting a certain response.
| Status Code | Reason phrase | Description |
|---|---|---|
| 200 | Success | Request processed successfully. |
| 400 | Bad Request | Request failed due to malformed syntax. |
| You didn't specify the keys field. Try submitting another call and make sure the request body contains the keys field. Check out Search keys for details. | ||
| You've specified one or more invalid search keys. Try submitting another request and make sure you specify a valid search key for each dataset you use. Check out Search keys for details. | ||
| You didn't specify any search keys. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
| You didn't specify any search key for a dataset. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
| You've specified multiple search keys for a dataset. Try submitting another request and make sure you only specify one search key per dataset. Check out Search keys for details. | ||
| You didn't specify the attributes field. Try submitting another cal and make sure the request body contains the attributes field. Check out the attributes listed in the enrichment dataset you are using. | ||
| You've specified one or more invalid attributes. Try submitting another request and make sure you specify valid attributes. Check out the attributes listed in the enrichment dataset you are using. | ||
| You didn't specify any attributes. Try submitting another request and make sure you specify at least one attribute for each dataset you use. Check out the attributes listed in the enrichment dataset you are using. | ||
| You've specified one or more empty attributes (e.g. " "). Try submitting another request and make sure you specify attribute names (e.g. "pin"). Check out the attributes listed in the enrichment dataset you are using. | ||
| You've specified an invalid country value. Try submitting another request and make sure you specify a valid country value. | ||
| You didn't provide an authentication token. Try submitting another request and make sure you specify your token, which you can find by signing in to the Self Service Portal. | ||
| You've submitted a malformed request body. Try sending another call and make sure the request body contains all required fields and that they are formatted correctly. | ||
| You've submitted an empty request body. Try sending another call and make sure the request body contains all required fields. | ||
| You've submitted an invalid Reference-ID header. Try submitting another request and make sure this header is formatted correctly. | ||
| You've submitted an invalid Add-Metadata header. Try submitting another request and make sure this header is formatted correctly. | ||
| 401 | Unauthorized | Auth-Token provided is incorrect. Sign in to the Self Service Portal to find the right token. |
| 403 | Forbidden | Request is not authorized to use this service. |
| The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. | ||
| The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. | ||
| The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain. | ||
| The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address. | ||
| 404 | Not Found | The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact us. |
| 406 | Not Acceptable | Request is not in an acceptable format. |
| You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. | ||
| 408 | Request Timeout | Your request has timed out (the web server failed to respond in the specified time frame). Try submitting another request. If the issue persists, contact us. |
| 415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. |
| 429 | Too many requests | Too many requests were sent. To protect all customers, your account has been temporarily throttled. Check our rate limiting for more details. |
| 500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact us. |
| 503 | Service Unavailable | Service unavailable. Check service status for up-to-date information. |
If you send a request to the API with the Add-Metadata header set to True, and the HTTP status code of the response is 200, the API will return a metadata-level status code, a message and a detail field.
| Code | Message | Detail |
|---|---|---|
| S200 | Success | All requested attributes retrieved. |
| S206 | Success | Some of the requested attributes retrieved. |
| S204 | No match | No records matching the specified keys. |
| S201 | Not authorized | Attributes not authorized. |
If you send a request to the API with the Add-Metadata header set to True, and the HTTP status code of the response is 200, the API will return a code and message for each attribute.
| Code | Message | Description |
|---|---|---|
| S200 | Match | Attribute retrieved successfully. |
| E404 | Not found | The requested attribute could not be found because there are no records matching the specified keys. |
| E401 | Not authorized | You are not authorized to use the requested attribute based on the token you have provided. |
POST /enrichment/v2 HTTP/1.1
Add-Metadata: false
{
"country_iso": "GBR",
"keys": {
"global_address_key": "aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgV"
},
"attributes": {
"gbr_government": [
"eer_name",
"gor_name",
"la_name",
"lea_name",
"ward_name",
"cens_out_area"
]
}
}
{
"transaction_id": "00000000-0000-0000-0000-000000000000",
"result": {
"gbr_government": {
"eer_name": "Scotland",
"gor_name": "Scotland (pseudo)",
"lea_name": "Fife",
"la_name": "Fife",
"ward_name": "Cowdenbeath",
"cens_out_area": "S00110266"
}
}
}