Sign in

v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB
Reveal

Reveal phones

Get phones and phone statuses for people.

Webhook result: Documentation

post/v2/reveal/phones

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

personIdsstring[] required

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

webhookUrlstring required

Url of the webhook the phone 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 phone has to be verified in the background. All the phone results are sent to the webhook once they are all done.

Example response

{
  "status": "in progress"
}