Think of a token as your username and password. When you sign in to a website you need to use your credentials; similarly, when you want to access any of our APIs, you need to provide your token(s).
A token is a unique alphanumeric code that looks like: ab123ab1-abc1-1234-abcd-ab1a123a1a12.
We recommend you treat your tokens like your passwords: keep them secure and change them often.
The purpose of a token is to authenticate the requests you send to our APIs.
Now you can perform the following actions:
We suggest you create and use multiple tokens. Check out How many tokens should I use? to find out why.
To create a new token:
Activate tokens so they can be used to send requests to our APIs.
To activate a token:
Disable tokens to prevent them from being used in requests to our APIs.
To disable a token:
You might want to edit a token to:
To edit a token:
If you don't secure your tokens, there's the risk of unauthorized parties using your licensed products, which you may be charged for.
One of the easiest and most effective ways to secure your tokens is to periodically change them, just like you do with your passwords.
You can take additional steps to secure your tokens:
Follow How do I edit a token? to implement the steps listed above.
You need to find out the values of tokens so you can use them to send requests to our APIs.
To find out the value of a token:
By default, a license comes with a token, which applies to all the products you are entitled to use through the respective license.
However, we recommend you create and use at least one token per environment (development, testing, staging, production).
Consider using multiple tokens for your production environment. This way, it’s easy to monitor and create reports on product usage and different integrations you might have.
Note: You cannot use a token across multiple licenses.
To check if a token is working correctly, you need to test it, by making an API call.
You will know if your token is working correctly based on the status code of the response you get from the API:
|Status code||Is my token working correctly?|
|200||The request was successful and your token is working correctly.|
|400||The request was not successful. You might have forgotten to add the token in the request header.|
|401||The request was not successful. You might have used an incorrect token. Check the Self Service Portal to make sure you’ve used the right token.|
|403||The request was not successful. The token is valid, but it might be disabled. You can activate it in the Self Service Portal.|
There are several reasons why a token might not be working:
This section provides answers to FAQs about product usage alerts and reporting.
For per-click products, you can set up alerts to notify you when your credit balance is low. Email notifications will be sent to you based on the limit you specify:
You can create usage reports for all of your accounts, licenses, and products (currently excludes Clean Application & Clean API).
Usage information includes credits used, the number of searches submitted and results returned.
DPV is used by the United States Postal Service to validate whether an address is deliverable. It also provides information on the exact delivery point, for example, an apartment or suite number.
You have encountered a seed address. A seed address is a non-existent address that will deactivate DPV functionality if it is searched upon. Seed addresses are used to prevent the illegal creation of verified address lists.