Skip to main content
Enrichments

Waterfall Phone Finder

post/v1/enrichments/tasks

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Get an access token ↗

Send a public LinkedIn profile URL to find a phone number. Sales Navigator URLs are not supported.

Public ID: waterfall-phone-finder. Get the current definition. You can read it without authentication. Check availability in the catalog.

Settings​

Use cacheAge to select the allowed cache age; the default is 30 days. To use your own provider keys, enable useCustomAPIKeys and supply a customSequence with a supported provider and its apiKey. Keep credentials private. The finderProvider output is described with an enableOnSetting condition for custom sequences.

cacheAgestring

Maximum age of a cached result you will accept. Defaults to 30 days.

Allowed values: "30", "61", "183", "0"
useCustomAPIKeysboolean

Use a custom lookup sequence with your own API keys.

customSequenceobject[]

Lookup services to try, with your API key for each one.

Enabled when: useCustomAPIKeys==true.

minItems: 1
Show child attributes
providerstringrequired
Allowed values: "enrow", "prospeo", "findymail", "wiza", "full_enrich"
apiKeystringrequired

API key for this lookup service.

Additional properties are supported.

Additional properties are supported.

Inputs​

Give each input an inputId you can use to match the result to your record. Put profileUrl in its data object.

profileUrlstringrequired

Public LinkedIn profile URL, such as https://www.linkedin.com/in/example/. Sales Navigator URLs are not supported.

Additional properties are supported.

Outputs​

Each result contains your inputId, a status, the data in outputs, and creditsUsed. If the input failed, error explains why; otherwise it is null.

The fields below depend on your settings and the data found. Results can include fields not yet listed in the catalog.

phoneNumberstringrequired

Phone Number found in international format (with country prefix).

phoneNumberCountrystring

Alpha-2 country code for the phone Number. See Wikipedia page for more information on ISO 3166-1 alpha-2.

finderProviderstring

Which Phone Finder provider returned the result.

Enabled when: useCustomAPIKeys==true.

Additional properties are supported.

Credits and limits​

Cost: 500 credits per phone number found

The standard price is 500 credits per phone number found. Searches without a result and accepted cached results are not charged. Custom provider sequences can change Datablist usage. creditsPerInput: null describes variable usage, not a free task.

Send 1–10,000 inputs per task, within 16 KiB per input and 10 MiB per request. Tasks can run for up to 24 hours; completed, failed, or stopped tasks are kept for 90 days.

You can set maxCredits to stop starting new work after a credit threshold. Work already underway can still exceed it. Enrichment and source tasks share your account balance and task limits. See limits and errors.

Accepted task and results​

The API returns 202 Accepted with a task ID. Save it, then check links.self every few seconds. Once status is completed, failed, or stopped, read links.results. Failed and stopped tasks can still have useful results. See the task reference.

Example results (sample data and credit amounts):

json
{
  "taskId": "00000000000040008000000000000001",
  "results": [
    {
      "inputId": "row-1",
      "status": "success",
      "outputs": {
        "phoneNumber": "+12025550123",
        "phoneNumberCountry": "US"
      },
      "creditsUsed": "500",
      "error": null
    }
  ],
  "nextCursor": null
}

If nextCursor is not null, pass it unchanged in the next request to get more results. Pages default to 50 results; limit accepts 1–100. A page is at most 128 KiB, so it may contain fewer results than requested.