You can use BriteVerify to verify data right at the point of collection or to verify databases and lists at speed and scale using an API key.
What is an API key?
An API key is just that: a key. When you integrate your web form or application with BriteVerify, an API key is the way your code authenticates itself so that it can perform verifications and retrieve results using your BriteVerify account. API keys are account-specific, and they are required to integrate your web form or application with BriteVerify.
Using Multiple API keys
BriteVerify supports up to three active API keys for your account. Multiple key management is useful for:
- Deploying Briteverify APIs to multiple locations securely, each with its own key
- Containing the threat of a compromised key
- Easy key replacement with activation and deactivation on a per-key basis
You can generate a new key, disable a key, or edit the name you use for a key at any time from the API Keys tab. Edit and Disable functions are available under the Actions column.
Tips for keeping your API keys safe from compromise can be found in the best practice guidelines at the end of this document.
Prerequisites
For Pay As You Go accounts, use of API keys requires Auto-replenish to be turned on. This allows for uninterrupted use of BriteVerify APIs by automatically making sure that your credit balance never hits zero. If, at any time, a billing problem occurs (your payment method cannot be charged, for example), Auto-replenish will turn off and your API keys will be paused until the billing problem is resolved. Once your billing issue is corrected and Auto-replenish is turned back on, those same keys can be used again.
Getting Started with an API key
- Read through the documentation for the API that you want to use.
- Review the best practice guidelines:
- Create a BriteVerify account.
- Turn on Auto-replenish.
- Create an API key in the API Keys tab, and make sure that it is active.
- Get verifying!
