Get signup results

Enrichment Contact Finder

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

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

fetch('https://api.waterfall.io/v1/enrichment/contact', 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/contact",
  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/contact"

	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))

}

require 'uri'
require 'net/http'

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

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": "2023-09-20T20:23:36.086988+00:00",
  "stop_date": "2023-09-20T20:23:51.892893+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",
      "phone_numbers": [],
      "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",
      "smtp_provider": "Google",
      "mx_record": "aspmx.l.google.com"
    },
    "usage": {
      "total_usd": 0.1,
      "balance_remaining_usd": 99.9,
      "persons_count": 1,
      "persons_usd": 0.1,
      "phones_count": 0,
      "phones_usd": 0,
      "companies_count": 0,
      "companies_usd": 0
    }
  }
}

GET

enrichment

contact

Enrichment Contact Finder

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

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

fetch('https://api.waterfall.io/v1/enrichment/contact', 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/contact",
  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/contact"

	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))

}

require 'uri'
require 'net/http'

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

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": "2023-09-20T20:23:36.086988+00:00",
  "stop_date": "2023-09-20T20:23:51.892893+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",
      "phone_numbers": [],
      "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",
      "smtp_provider": "Google",
      "mx_record": "aspmx.l.google.com"
    },
    "usage": {
      "total_usd": 0.1,
      "balance_remaining_usd": 99.9,
      "persons_count": 1,
      "persons_usd": 0.1,
      "phones_count": 0,
      "phones_usd": 0,
      "companies_count": 0,
      "companies_usd": 0
    }
  }
}

Pass the job_id returned by Enrich signups.

curl --get 'https://api.waterfall.io/v1/enrichment/contact' \
  --header "x-api-key: $WATERFALL_API_KEY" \
  --data-urlencode 'job_id=YOUR_JOB_ID'

While status is RUNNING, retry with backoff. Stop on SUCCEEDED, FAILED, TIMED_OUT, or ABORTED. See results and delivery.

Result	Use
`output.person.title`	Tailor onboarding or apply your role rules.
`output.person.company_domain`	Start account enrichment.
`output.person.company_name`	Add company context to your user record.
`output.person.location`	Apply your regional routing rules.
`output.person.experiences`	Review available work history.
`input.task.custom_fields`	Connect the result to your user and workspace.

Treat missing fields as unknown. A completed job is not proof of a correct or complete match. If you use webhooks, this endpoint is also useful for retrieving a job by its ID.

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

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

Finder response with contact 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

Start here

Use cases

Signups & accounts

Find your buying team

Visitors & existing users

Monitoring

Integration essentials

Authorizations

Query Parameters

Response

​Fields to use in your signup workflow

Authorizations

Query Parameters

Response

Fields to use in your signup workflow