Validation API

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.

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>

https://api.ongage.io/

Note: This methods accepts only one email address per call. The response time for this call is typically seconds.

POST https://api.ongage.io/email-validation/api/v1/realtime-validation
Header: 
x-api-key: THE_SECRET_KEY_HERE
Body: 
{ “email”@”address.com”}

{
    "status": "Deliverable",
    "reason": "accepted_email"
}

The status can be anyone of the following:

An explanation of those and the reasons you can find in our Validation online help page.

Following are possible error responses one can get.

{
  "metadata": {
    "error": true
  },
  "payload": {
    "code": 402,
    "errors": [],
    "message": "Not enough credits in your account"
  }
}

{
  "metadata": {
    "error": true
  },
  "payload": {
    "code": 400,
    "errors": [],
    "message": "Invalid API key"
  }
}