---
title: "Reveal phones"
method: POST
path: "/v2/reveal/phones"
tags: ["Reveal"]
---

# Reveal phones

`POST /v2/reveal/phones`

Get phones and phone statuses for people.

**Webhook result:**
[Documentation](/docs/webhooks/reveal_phones)

## Query parameters

- `apiToken` string, nullable

## Headers

- `x-api-token` string, nullable

## Request body

- PublicRevealPhoneBody
  - `personIds` string[], required — List of Ocean person ids to fetch the phone data for. One phone credit will be charged for every verified phone found.
  - `webhookUrl` string, required — Url of the webhook the phone data should be sent to, when completed.

## Response `200`

Successful Response

- PublicRevealPhoneResult
  - `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.

## Other responses

- `400` — Bad Request
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.dev/ocean/apis/ocean-io-api-documentation.md) · [All operations](https://skmtc.dev/ocean/apis/ocean-io-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ocean/ocean-io-api-documentation/revisions/5a550a018473/schema)
