v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB

Reveal Phone Results

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.

postWebhookreveal_phones

Payload

creditsUsednumber required

Number of credits charged for this request.

Example payload

{
  "phones": [
    {
      "numbers": [
        "+4512345678"
      ],
      "personId": "personId1",
      "status": "verified"
    },
    {
      "numbers": [
        "+33600000000",
        "+4512121212"
      ],
      "personId": "personId2",
      "status": "verified"
    },
    {
      "personId": "personId3",
      "status": "notFound"
    }
  ],
  "creditsUsed": 10
}

Response

Successful Response

{"stackTrail":"webhooks:reveal_phones:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}