OCocean
Reveal

Reveal emails

Changed on

Get emails and email statuses for people.

Webhook result: Documentation

post/v2/reveal/emails

Request

  • Base URL
    https://api.ocean.io
  • URL
    https://api.ocean.io/v2/reveal/emails
  • Auth
    none declared

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

personIdsstring[] required

List of Ocean person ids to fetch the email data for. One email credit will be charged for every verified email found.

webhookUrlstring required

Url of the webhook the email data should be sent to, when completed.

Example request

{
  "personIds": [
    "personId1",
    "personId2"
  ],
  "webhookUrl": "https://some-url.com"
}

Response

Successful Response

status'in progress' | 'webhook sent' required

Status of the request. "in progress" if any email has to be verified in the background. All the email results are sent to the webhook once they are all done.

Example response

{
  "status": "in progress"
}

Changes