Public
Documentation Settings

BriteVerify API Suite Documentation

Authorization

To get started, you must first create your API key:

  • Log in to your account and go to the API Keys tab.
  • Click on 'Generate New Key', and provide a key name. This name is for your convenience and has no bearing on your implementation.
  • Select a key type. If using this API key in a client-side implementation, select Client-side, otherwise select Server-side.
  • If Client-side, you have some additional options available. Learn more ↗
  • Once your key is created, it will appear in your keys list and is activated for use.

API Key Best Practices

API keys are sensitive and give access to the data in your account and access to perform new verifications. Only trusted sources should be given access to your API keys.

If you suspect your key is compromised, it's best to go ahead and replace it—even if you can't yet prove it. You can easily de-activate it and replace it with a new one:

  • Go to the API Keys tab in your BriteVerify account.
  • Locate the key in question and click on the actions gear. Click 'disable'. This action cannot be undone.
  • Generate a new key and replace the old one in your code.

Status Responses

A full list of email, phone, and mailing address statuses is available in the help center.

Performance, Usage, & Rate Limits


TouchpointRate LimitsProcessing SpeedsNotes
Real-time Single Transaction API (all versions)500
Verifications per key, per minute. Applies to both server-side and client-side (public) keys.

25
Verifications per client IP address, per minute. Applies to client-side (public) keys only. This applies in addition to the 500 verifications per key, per minute limit.
500 ms
Average response time


If you believe your transactional traffic will be greater than 500 requests per key, per minute, please reach out to our support team. When being rate limited you will receive a 429 response, which you should develop around if you suspect you could approach these limits.
Bulk API (all versions)100k
Emails per page

1M
Email addresses per job (or 20 pages of 50k)
4,000
Average verifcations per minute
This is an average based upon performance achieved by 95% of customers. Actual speeds can vary depending upon network load, time of day, domain response times, and quality of addresses being verified.