Validation API
- Noam Rotem
Intro
This is a first of a new family of API methods that requires an API key in order to use it.
For now you will need to ask Ongage Support to generate a Secret API Key for you.
The Secret API Key uses JSON Web Token (JWT) authentication for securely transmitting information between web and server applications to Ongage.
The New API Header Authentication
This is the new API Authentication, and replaces the Username Password authentication described in our API Getting Started guide.
API Header
x-api-key: <THE_SECRET_KEY_HERE>The New API URL Endpoint
https://api.ongage.io/Real-Time Email Validation Method
Note: This methods accepts only one email address per call. The response time for this call is typically seconds.
API Request
POST https://api.ongage.io/email-validation/api/v1/realtime-validation
Header:
x-api-key: THE_SECRET_KEY_HERE
Body:
{ “email”@”address.com”}Response
The status can be anyone of the following:
Deliverable
Unknown
Risky
Undeliverable
An explanation of those and the reasons you can find in our Validation online help page.
Best practice is to only add Deliverable email addresses to your Ongage Sending list. All others should not be added (or you can add the non deliverables to an Ongage Suppression List).
Error Response
Following are possible error responses one can get.
Out of Validation Credits
Invalid API Key
Additional Information
Screenshot of the POST API Header
