Reveal phones

POST /v2/reveal/phones

Get phones and phone statuses for people.

application/json

Body Required

  • personIds array[string] Required

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

    At least 1 but not more than 500 elements.

  • webhookUrl string Required

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

Responses

  • 200 application/json

    Successful Response

    Hide response attribute Show response attribute object
    • status string 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.

      Values are in progress or webhook sent.
  • 403 application/json

    Forbidden

    Hide response attribute Show response attribute object
    • detail string Required

      Value is Current API token is not registered in our database.
  • 402 application/json

    Payment Required

    Hide response attribute Show response attribute object
    • detail string Required

      Values are Credits might be insufficient because of pending phone verifications. Please try again later. or Insufficient phone credits.
  • 404

    Not found

  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
POST /v2/reveal/phones 
curl \
 -X POST https://api.ocean.io/v2/reveal/phones?apiToken=string \
 -H "Content-Type: application/json" \
 -d '{"personIds":["personId1","personId2"],"webhookUrl":"https://some-url.com"}'
Request examples 
{
  "personIds": [
    "personId1",
    "personId2"
  ],
  "webhookUrl": "https://some-url.com"
}
Response examples (200) 
{
  "status": "in progress"
}
Response examples (403) 
{
  "detail": "Current API token is not registered in our database"
}
Response examples (402) 
{
  "detail": "Credits might be insufficient because of pending phone verifications. Please try again later."
}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}