API Reference

Definitions of the phone number results payloads you will receive on your webhook endpoint

1. "single_phone_search_finished" payload

{
  "event": "single_phone_search_finished",
  "id": "910f3e13-b2bf-442d-ab0b-4cf44dfrij84fjrt",
  "credits": {
    "cost": 50
  },
  "result": {
    "event": "single_phone_search_finished",
    "id": "070c5374-a837-4193-ba14-ad8721b8c606",
    "result": {
      "number": "+3399999999",
      "params": {
        "linkedin_url": "https://www.linkedin.com/in/antoine-dupont-xyz"
      },
      "qualification": "found"
    }
  }
}

ℹ️ For a single search, since you receive the full result directly in the webhook notification, you don't need to perform a GET request to fetch it afterwards.


2. "bulk_phone_search_finished" payload

{
  "event": "bulk_phone_search_finished",
  "id": "910f3e13-b2bf-442d-ab0b-4cf44dfrij84fjrt"
}

Once you receive a "bulk_phone_search_finished" payload, request the /phone/bulk endpoint with the corresponding id to get the verification results.
This allows for live-retrieval of your results.