Reveal Email Results

POST https://webhook.example.com

When the email verifications are done, the results will be sent to you via a POST request to the url you passed in the Reveal endpoint.

application/json

Body Required

  • emails array[object] Required

    Email data, sent back in the same order as the input ids.

    Hide emails attributes Show emails attributes object
    • address string | null Required
    • status string Required

      Status of the address: verified, catchAll or guessed

      Values are verified, guessed, catchAll, or notFound.

    • personId string Required

      Ocean ID of the person

Responses

  • 200 application/json

    Successful Response

  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
POST reveal_emails
Request examples 
{
  "emails": [
    {
      "status": "verified",
      "address": "email@domain.com",
      "personId": "personId1"
    },
    {
      "status": "guessed",
      "address": "example@domain.com",
      "personId": "personId2"
    },
    {
      "status": "notFound",
      "personId": "personId3"
    }
  ]
}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}