Use the POST /format/v1 endpoint to enrich UK business records with key data such as Business Registration Number, SIC codes, telephone number, and employee count, among others.
Credit usage
| Name | Type | Description |
|---|---|---|
| Auth-Token | string | Input your unique token here. This is required to submit an API request. |
| x-app-key (Optional) |
string | Alternative authentication header. Auth-Token takes precedence. |
| Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
| 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. |
| Add-Components (Optional) |
boolean | Specifies if the response should contain the address broken down into its components. The default value of this setting is false. |
| 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. |
| Add-Enrichment (Optional) |
boolean | Specifies if the response should contain additional enrichment attributes. The default value of this setting is false. |
In the request body you can specify:
| Name | Type | Description | |
|---|---|---|---|
| layouts (Optional) |
collection | Collection of layout names. The default value of this setting is default which will return a predefined 7 line layout. |
|
| layout_format (Optional) |
string | The format of the customized address layout. The available values are:
|
|
| attributes (Optional) |
collection | Specifies which datasets to include. | |
| gbr_business | 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 | |||
|---|---|---|---|---|---|
| result | object | See the result object for a detailed breakdown of available elements. |
|||
| enrichment (Optional) |
object | A enrichment object containing detailed element level match information.This object is only returned when the Add-Enrichment header is set to True on the request. |
|||
| gbr_business | object | An object containing all requested attributes for this dataset. | |||
| urn | string | A reference number that uniquely identifies each business record within Experian's National Business Database. | |||
| commercial_mosaic | object | Commercial MOSAIC data enables companies to select future business prospects that share similar characteristics to existing customers. | |||
| group_type_code | string | A identifier combining the group letter and a number, representing a detailed consumer type. | |||
| group_type_description | string | A more granular profile of household characteristics within the group, including behaviours, financial status, and preferences. | |||
| group_code | string | A single-letter identifier representing one of the consumer lifestyle groups in the UK. | |||
| group_description | string | A high-level summary of the group's shared characteristics, such as demographics, income, lifestyle, and housing. | |||
| registration | string | A unique identifier assigned by Companies House to every registered company in the UK. | |||
| non_limited_company_key | string | A unique identifier used in Companies House datasets to denote non-limited entities. | |||
| phone | string | The telephone number for the business. | |||
| number_of_employees | string | The number of employees working for a given business. | |||
| standard_industry_classification | object | Standard Industry Classification (SIC) codes enable businesses to be classified in a uniform way, where each establishment is classified according to its primary activity. An establishment is defined as a single physical location at which economic activity occurs. These codes enable businesses to accurately target future prospects. | |||
| sic_2007_code | string | A identifier assigned to classify the business's primary industry based on its economic activity. | |||
| sic_2007_description | string | A brief textual explanation of the industry category represented by the SIC code. | |||
| thomson_code | string | A proprietary classification code used by Thomson Reuters to categorize companies based on their business activities. | |||
| thomson_description | string | A descriptive label that outlines the specific sector or industry the company operates in, according to Thomson Reuters' taxonomy. | |||
| location | object | Information of what the particular location is to the business; for example, "Headquarters". This includes a description of the location, a code for the type of location and an indicator as to whether the site is a small office or a home office. | |||
| code | string | A code for the type of location of the business. | |||
| description | string | A description for the type of location of the business. | |||
| small_or_home_office | boolean | Indicates whether the address is a small or home office. The value of this item is always true or false. |
|||
The following response codes can be returned by the API:
| Status Code | Reason phrase | Description |
|---|---|---|
| 200 | Success | Request processed successfully. |
| 204 | No Content | Request processed successfully, but there is no content to be returned. |
| 400 | Bad Request | Request failed due to malformed syntax. |
| 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. |
| 404 | Not Found | Request is not found. |
| 406 | Not Acceptable | Request is not in an acceptable format. |
| 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. |
POST /address/format/v1/aWQ9RXhwZXJpYW4gRWNvbm9taWNzLC HTTP/1.1
{
"layouts": [
"default"
],
"layout_format": "default",
"attributes": {
"gbr_business": [
"urn",
"commercial_mosaic",
"registration",
"phone",
"number_of_employees",
"location",
"standard_industry_classification",
"non_limited_company_key"
]
}
}
{
"result": {
"global_address_key": "aWQ9RXhwZXJpYW4gRWNvbm9taWNzLC",
"confidence": "Verified match",
"address": {
"address_line_1": "Experian Identity & Fraud",
"address_line_2": "Swift Park Park",
"address_line_3": "Old Leicester Road",
"locality": "RUGBY",
"region": "",
"postal_code": "CV21 1DZ",
"country": "UNITED KINGDOM"
}
},
"metadata": {},
"enrichment": {
"result": {
"gbr_business": {
"urn": "Tlt10913482894",
"commercial_mosaic": {
"group_type_code": "B02",
"group_type_description": "Consolidating Combines",
"group_code": "B",
"group_description": "Industrial Blue Chips"
},
"registration": "00653331",
"non_limited_company_key": "00653331",
"phone": "01788 554800",
"standard_industry_classification": {
"sic_2007_code": "82.99",
"sic_2007_description": "Other Business Support Service Activities N.E.C.",
"thomson_code": "87555",
"thomson_description": "Detective Agencies And Private Investigators"
},
"location": {
"code": "B",
"description": "Branch",
"small_or_home_office": false
}
}
}
}
}