We recommend you start by making a test call to see how the API works. There are many different ways to make API requests, we provide two ways of doing that with the API by either using our sample Swagger integration or Postman collection.
To make a test call you will need:
An address or search key you would like more information on.
A license to use the product. Talk to your account manager or contact us to get a license if you don't have one.
Your token, which confirms you are licensed to use Enrichment and authenticates each request you send to the API. This article explains tokens and includes instructions on where to find yours.
A tool that allows you to make API calls. Check out Sending my first API request for more information.
Follow the instructions below to send requests to the API from this page. The instructions detail how to make requests to our Search method, but can easily be adapted by you to make requests against any of our other available methods.
Go to our API specification page and click the POST /search block and then the Try it out button in the upper-right corner.
Enter your token in the Auth-Token field.
In the Request body section you can select an example request from the dropdown. These give you a number of combinations between region and search type.You can then either use it as is or update the request body with your desired address values.
Click the Execute button to send the request to the API.
View the response returned by the API under Responses > Server response.
The information under Responses > Responses are examples only. Your request was successful if the API returned 200 - Success. Check out the possible response status codes to find out more.
Postman is a free, easy-to-use third-party application that you can use to send API calls.
Follow these instructions to send requests to the API via Postman:
Open the Postman app and click Import in the upper-left corner.
Import the file you've downloaded.
Go to the Collections tab on the left-hand side panel and click the API request you want to test.
Go to the Headers tab.
Replace the {{Auth-Token}} value with your token.
Go to the Body tab.
(Optional) Replace the address value with an address of your choice. Note that the address value must be enclosed in quotation marks, e.g. "125 summer St". Alternatively, you can skip this step and use the preset values.
Click Send to submit the API request.
View the response returned by the API. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out Response status codes to find out more about scenarios where the API returns errors.
To use the API from this page:
Go to API specification and click the POST block, so that it expands.
Click the Try it out button in the upper-right corner.
Enter your token in the Auth-Token field.
(Optional) Select true from the Add-Metadata dropdown, so the response also returns metadata information.
(Optional) Enter an identifier in the Reference-Id field.
Enter a 3-letter ISO country code in the **country **field. Currently, only support GBR, AUS and USA.
(Optional) Under enrichmentRequest, you can replace the keys, the dataset, and related attributes. Note that all of them must be enclosed in quotation marks, e.g. "pin". Alternatively, you can skip this step and use the preset keys, dataset and attributes.
(Optional) Select an option from the Parameter content type and Response content type dropdowns. Check out Supported data formats for more information.
Click the Execute button to send the request to the API.
View the response returned by the API under Responses > Server response. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out Response status codes to find out more about scenarios where the API returns errors.
This API comes supplied with a Postman collection. Postman is a free, easy-to-use third-party application you can use to send API calls.
Follow these steps to send requests to the API via Postman:
Open the Postman app and click the Import button in the upper-left corner.
Import the file you've downloaded and unzipped.
Go to the Collections tab on the left-hand side panel and click the API request you want to test.
Go to the Headers tab.
Replace the {{Auth-Token}} value with your token.
Go to the Body tab.
(Optional) You can replace the keys, the dataset and related attributes. Note that all of them must be enclosed in quotation marks, e.g. "pin". Alternatively, you can skip this step and use the preset keys, dataset and attributes.
Click the Send button to submit the API request.
View the response returned by the API. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out Response status codes to find out more about scenarios where the API returns errors.
