Getting started with BriteVerify APIs

The BriteVerify suite of APIs allow you to build the powerful validation services of BriteVerify right into your workflow, automating data quality for your organization. 

Available APIs

Our APIs are designed to address two common use cases:

• Transactional Verification
  Point-of-capture data verification into your own applications. As data is captured (either by customers or data entry staff), it can be verified in real time on a one-by-one basis, preventing misspelling and bad data from entering your system. This is what the Real-time Single Transaction API is designed to do.
  
  
• Bulk Verification
  Periodic data verification for large sets of stored data, either in a database or a spreadsheet, to combat stagnation and help you understand how much of your customer base you can reach. For this, use the Bulk Validation API.

How it works with your BriteVerify account

How credits work with the API 

One credit is good for a single email address, phone number, or mailing address verification when using an API.

Usage reporting 

Each API request is reported by type in the Usage tab of your BriteVerify account. All reporting is available in customizable date range based on UTC.

API Key

All API requests must be authenticated using an API Key generated from your account.  To create an API Key, go to the API Keys tab in your BriteVerify account. You can create as many keys as you like, though only two keys may be active at any given time.

Getting Started

1. Read through the documentation for the API that you want to use.
2. Review the best practice guidelines: 
   • Best practices for the Real-time Single Transaction API
   • Best practices for the Bulk Validation API
3. Create a BriteVerify account.
4. Create an API key in the API Keys tab, and make sure that it is active.
5. Get verifying!