Waterfall API introduction

The Waterfall API is available at https://api.waterfall.io. Send your API key in the x-api-key header. See Authentication.

​

Endpoints

Choose an API based on what you already know and what you want to find. The guidance below separates search, enrichment, verification, and employment checks.

​

Find people and contact details

Search Contact or Prospector? Use Search Contact when you need profile search and structured filters. Use Prospector when you have a target account and want to find people and contact details by title. To enrich someone found through Search Contact, pass their LinkedIn identifier to Contact Enrichment. See account prospecting for the workflow.

​

Find and enrich companies

For existing CRM records, use CRM enrichment. For website traffic, start with website company identification.

​

Check a contact’s employment

Job Change checks a contact’s company information and returns a status with an available profile snapshot. Start with a supported company-and-contact identifier combination or a professional email. If you need recurring checks, your workflow schedules the requests and compares the results. See job changes.

​

When do results arrive?

For async APIs, the launcher returns a job_id. Retrieve the result with the matching Finder or receive it through webhook_url. For sync data APIs, read the result in the POST response. Where a Finder exists, use it to retrieve the saved result later. Email Verification has no Finder. The job’s status describes processing. Inspect the returned data to decide whether it is useful for your task. A SUCCEEDED job does not promise that every requested field was found.

​

Manage your integration

• API Keys Management: create and manage keys for your workflows.
• Usage Tracking: inspect a job’s returned cost and balance snapshot.
• Account Reporting: read usage across a date range.
• Webhook Verification: verify the origin and integrity of signed deliveries.

Ready to try a contact lookup? Follow the quickstart. If you are comparing providers, use the evaluation guide. Working with an agent? Start with Use Waterfall with an agent to run a lookup or build an integration.