Reveal phones

Get phones and phone statuses for people.

Webhook result: Documentation

Query Parameters

apiToken?|

Header Parameters

x-api-token?|

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

personIds*array<>

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

Items1 <= items <= 500

Example["personId1","personId2"]

webhookUrl*string

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

Example"https://some-url.com"

Response Body

`application/json`

curl -X POST "https://api.ocean.io/v2/reveal/phones" \  -H "Content-Type: application/json" \  -d '{    "personIds": [      "personId1",      "personId2"    ],    "webhookUrl": "https://some-url.com"  }'

{
  "status": "in progress"
}

{
  "detail": "Conflicting API tokens provided in query parameters and headers"
}

{
  "detail": "Insufficient phone credits"
}

{
  "detail": "API token should be provided in headers or query parameters"
}

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Reveal phones

Query Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

402application/json

403application/json

404

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`