Webhook reveal_emails

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.

This payload is POSTed to the webhook_url you provided when triggering the endpoint. Return a 2xx response so the API knows delivery succeeded.

Payload application/json

Email data, sent back in the same order as the input ids.
Array of Email
address string Required
Email address
status enum Required
Status of the address: verified, catchAll or guessed
"verified""guessed""catchAll""notFound"
personId string Required
Ocean ID of the person
creditsUsed number Required
Number of credits charged for this request.