v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB

Reveal Email Results

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.

postWebhookreveal_emails

Payload

creditsUsednumber required

Number of credits charged for this request.

Example payload

{
  "emails": [
    {
      "address": "email@domain.com",
      "personId": "personId1",
      "status": "verified"
    },
    {
      "address": "example@domain.com",
      "personId": "personId2",
      "status": "guessed"
    },
    {
      "personId": "personId3",
      "status": "notFound"
    }
  ],
  "creditsUsed": 1
}

Response

Successful Response

{"stackTrail":"webhooks:reveal_emails:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}