Phone Enrichment Finder

Enrichment Phone Finder

curl --request GET \
  --url https://api.waterfall.io/v1/enrichment/phone \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.waterfall.io/v1/enrichment/phone"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.waterfall.io/v1/enrichment/phone', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.waterfall.io/v1/enrichment/phone",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.waterfall.io/v1/enrichment/phone"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v1/enrichment/phone")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.waterfall.io/v1/enrichment/phone")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "SUCCEEDED",
  "start_date": "2024-01-15T12:00:00.000000+00:00",
  "stop_date": "2024-01-15T12:00:14.000000+00:00",
  "input": {
    "task": {
      "linkedin": "https://www.linkedin.com/in/jane-doe-abc123/",
      "custom_fields": {},
      "job_id": "4fa6b97b-55d0-49fb-924b-16f4c1b6b03e",
      "context_id": "4fa6b97b-55d0-49fb-924b-16f4c1b6b03e"
    }
  },
  "output": {
    "person": {
      "id": "e70fc5a3-55d9-43e5-93ea-b9e8210435da",
      "first_name": "Jane",
      "last_name": "Doe",
      "linkedin_id": "jane-doe-abc123",
      "linkedin_url": "https://www.linkedin.com/in/jane-doe-abc123/",
      "location": "San Francisco, California, United States",
      "country": "United States",
      "company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "company_linkedin_id": "acme-corp",
      "company_name": "Acme Corp",
      "company_domain": "acme.com",
      "professional_email": "jane.doe@acme.com",
      "mobile_phone": "+14155550123",
      "phone_numbers": [
        "+14155550123"
      ],
      "title": "Head of Sales",
      "seniority": "Director",
      "department": "Sales",
      "experiences": [
        {
          "title": "Head of Sales",
          "company_name": "Acme Corp",
          "company_linkedin_id": "acme-corp",
          "company_linkedin_url": "https://www.linkedin.com/company/acme-corp/",
          "company_domain": "acme.com",
          "start_year": 2021,
          "start_month": 3,
          "is_current": true
        }
      ],
      "email_verified": true,
      "email_confidence": "high",
      "email_verified_status": "safe"
    },
    "usage": {
      "total_usd": 0.12,
      "balance_remaining_usd": 99.88,
      "persons_count": 0,
      "persons_usd": 0,
      "phones_count": 1,
      "phones_usd": 0.12,
      "companies_count": 0,
      "companies_usd": 0
    }
  }
}

GET

enrichment

phone

Enrichment Phone Finder

curl --request GET \
  --url https://api.waterfall.io/v1/enrichment/phone \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.waterfall.io/v1/enrichment/phone"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.waterfall.io/v1/enrichment/phone', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.waterfall.io/v1/enrichment/phone",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.waterfall.io/v1/enrichment/phone"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v1/enrichment/phone")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.waterfall.io/v1/enrichment/phone")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "SUCCEEDED",
  "start_date": "2024-01-15T12:00:00.000000+00:00",
  "stop_date": "2024-01-15T12:00:14.000000+00:00",
  "input": {
    "task": {
      "linkedin": "https://www.linkedin.com/in/jane-doe-abc123/",
      "custom_fields": {},
      "job_id": "4fa6b97b-55d0-49fb-924b-16f4c1b6b03e",
      "context_id": "4fa6b97b-55d0-49fb-924b-16f4c1b6b03e"
    }
  },
  "output": {
    "person": {
      "id": "e70fc5a3-55d9-43e5-93ea-b9e8210435da",
      "first_name": "Jane",
      "last_name": "Doe",
      "linkedin_id": "jane-doe-abc123",
      "linkedin_url": "https://www.linkedin.com/in/jane-doe-abc123/",
      "location": "San Francisco, California, United States",
      "country": "United States",
      "company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "company_linkedin_id": "acme-corp",
      "company_name": "Acme Corp",
      "company_domain": "acme.com",
      "professional_email": "jane.doe@acme.com",
      "mobile_phone": "+14155550123",
      "phone_numbers": [
        "+14155550123"
      ],
      "title": "Head of Sales",
      "seniority": "Director",
      "department": "Sales",
      "experiences": [
        {
          "title": "Head of Sales",
          "company_name": "Acme Corp",
          "company_linkedin_id": "acme-corp",
          "company_linkedin_url": "https://www.linkedin.com/company/acme-corp/",
          "company_domain": "acme.com",
          "start_year": 2021,
          "start_month": 3,
          "is_current": true
        }
      ],
      "email_verified": true,
      "email_confidence": "high",
      "email_verified_status": "safe"
    },
    "usage": {
      "total_usd": 0.12,
      "balance_remaining_usd": 99.88,
      "persons_count": 0,
      "persons_usd": 0,
      "phones_count": 1,
      "phones_usd": 0.12,
      "companies_count": 0,
      "companies_usd": 0
    }
  }
}

Use the job_id returned by Phone Enrichment Launcher to fetch state and results.

Polling vs webhook

If you passed webhook_url when launching the job, you don’t need to call this endpoint at all — Waterfall will automatically deliver the result to your URL as soon as the job is ready. If you didn’t use a webhook, poll this endpoint until status is SUCCEEDED:

GET /v1/enrichment/phone?job_id={job_id}

Use short exponential backoff — most jobs complete in under 15 seconds. Start with a 2s delay, then 4s, then 8s.

Job states

Status	Meaning
`RUNNING`	Job is still processing. Continue polling.
`SUCCEEDED`	Job is complete. Phone data is in `output.person`.

Phone number fields

Field	Description
`mobile_phone`	Primary phone number in E.164 format, or `null` if not found.
`phone_numbers`	Full list of numbers found. Empty array `[]` if none returned.

A SUCCEEDED status does not guarantee a phone number was found — it means the job completed. Always check whether mobile_phone is non-null or phone_numbers is non-empty before billing logic.

Response shape

The input.task object always echoes back all fields from the original launch request. Fields not provided will be null.

Authorizations

x-api-key

string

header

required

To access the API, provide your API key in x-api-key.

Query Parameters

job_id

string<uuid>

required

The unique job_id you want to query. This value is returned by the corresponding launcher endpoint.

A UUID.

Example:

"7d44db58-5de3-4e92-a2fb-8325d12c2e8b"

Response

Phone enrichment job state, input, and any available output person.

Finder response with phone enrichment job status, input, and optional output.

status

enum<string>

required

The status of the job.

Available options:

RUNNING,

SUCCEEDED,

FAILED,

TIMED_OUT,

ABORTED

Example:

"RUNNING"

start_date

string<date-time>

required

A date time in ISO 8601 format.

Example:

"2025-02-05T15:46:35.771751+00:00"

input

object | null

required

Show child attributes

stop_date

string<date-time>

A date time in ISO 8601 format.

Example:

"2025-02-05T15:46:35.771751+00:00"

output

object

Show child attributes

Phone Enrichment Launcher

Company Enrichment Launcher

General guidance

Prospector

Search Contact

Search Company

Contact Enrichment