Skip to main content
POST
Company Reveal Launcher
A company may explore your API documentation before anyone signs up. Send a visitor IPv4 address to look for a company match, then use the returned domain in your account workflow.
Company Reveal is currently in beta. It helps identify the company behind a visit, rather than the individual visitor.
The IP above is reserved for documentation; replace it with the visitor IP from your own trusted request or analytics pipeline. The endpoint does not install a tracker or collect visits for you. page_path is metadata, not an input to company matching.

Read the result

Results are returned synchronously. Inspect output.company, output.type, and output.confidence_score. Available confidence values are very_high, high, medium, low, or null. A missing company, an ISP classification, or a low-confidence result should not be treated as a confirmed account visit. Decide which matches are useful for your workflow.

Evaluate your paid traffic

Keep UTM source, medium, campaign, and page path in custom_fields. Your integration can join company matches to campaign spend and conversions, so you can compare which channels bring identifiable accounts that fit your market. This can help you investigate wasted spend and refine targeting. Compare company-match rates too: unknown visitors are not automatically low-quality traffic, and matching coverage may differ by channel or region. Build the traffic-quality workflow →

Explore the account

When a company domain is available: Those people are contacts at the matched company. They are not identified as the people who visited your site.

Authorizations

x-api-key
string
header
required

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

Body

application/json

Company Reveal request payload.

Request payload for Company Reveal.

ip
string<ipv4>
required
Example:

"8.8.8.8"

webhook_url
string<uri> | null

Optional webhook callback URL. If supplied, Waterfall POSTs the same payload returned by the Finder endpoint when processing completes. If your webhook responds with 429, 500, 502, or 504, Waterfall retries delivery up to 5 times with exponential backoff. Waterfall includes X-Webhook-Signature containing a compact JWT when webhook signing configuration is available. The JWT protected header contains alg: "EdDSA", kid, and typ: "JWT". Its claims contain iat, exp, jti, job_id, body_hash, and body_hash_alg: "sha-256". body_hash is the unpadded base64url-encoded SHA-256 digest of the exact raw request body bytes. The JSON body is unchanged by signing. Signatures expire exactly 15 minutes after iat; receivers should reject expired signatures. If signing configuration is unavailable or invalid, Waterfall preserves backward compatibility by sending the callback unsigned without X-Webhook-Signature.

Maximum string length: 2083
Example:

"https://example.com/webhook"

custom_fields
object | null

Optional custom key-value metadata echoed on job input and output (useful for correlating internal source metadata). On create requests, omit the field or send JSON null when no custom fields are needed; both are stored as {}. When present, the value must be a JSON object with keys matching ^[A-Za-z0-9_-]+$ and values that are a string (max 1000 characters), number, or boolean. Empty string, arrays, and other non-object types return HTTP 400. On job GET responses, input.task.custom_fields is always an object ({} or populated).

Example:

Response

Company Reveal result returned successfully.

Company Reveal response with synchronous job envelope and 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
required
stop_date
string<date-time>

A date time in ISO 8601 format.

Example:

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

output
object

Company Reveal output payload.