Reveal Phone Results

POST https://webhook.example.com

When the phone verifications are done, the results will be sent to you via a POST request to the url you passed in the Reveal endpoint.

application/json

Body Required

  • phones array[object] Required

    Phone data, sent back in the same order as the input ids.

    Hide phones attributes Show phones attributes object
    • numbers array[string] | null Required
    • status string Required

      Status of the phone numbers: verified or not found

      Values are verified, notFound, or inProgress.

    • personId string Required

      Ocean ID of the person

Responses

  • 200 application/json

    Successful Response

  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
POST reveal_phones
Request examples 
{
  "phones": [
    {
      "status": "verified",
      "numbers": [
        "+4512345678"
      ],
      "personId": "personId1"
    },
    {
      "status": "verified",
      "numbers": [
        "+33600000000",
        "+4512121212"
      ],
      "personId": "personId2"
    },
    {
      "status": "notFound",
      "personId": "personId3"
    }
  ]
}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}