Reveal
Reveal phones
Get phones and phone statuses for people.
Cost: 1 phone credit for each returned phone.
Webhook result: Documentation
Query Parameters
apiToken?string | null
Header Parameters
x-api-token?string | null
personIdsarray<string>
List of Ocean person ids to fetch the phone data for. One phone credit will be charged for every verified phone found.
Example
["personId1","personId2"]webhookUrlstring
Url of the webhook the phone data should be sent to, when completed.
Example
"https://some-url.com"Response Body
curl -X POST "https://api.ocean.io/v2/reveal/phones?apiToken=string" \
-H "x-api-token: string" \
-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": "Credits might be insufficient because of pending phone verifications. Please try again later."
}{
"detail": "API token should be provided in headers or query parameters"
}Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}