Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

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

API Request

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

Response

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

...

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

Info

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.

...

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

Additional Information

Screenshot of the POST API Header

...