---
title: "Start Individual Reveal"
method: POST
path: "/api/individual_reveals"
tags: ["Individual Reveals"]
---

# Start Individual Reveal

`POST /api/individual_reveals`

>
Start an individual reveal. An individual reveal is a single contact enrichment. You can provide a name, company, and domain, or an email, or a LinkedIn profile URL.

> Either `company` (company name) or `domain` is required when using contact details.

Once the reveal is completed, an update will be posted to the webhook URL as configured in your [ account settings ]( http://wiza.co/app/settings/api ). The payload will be the same as the response of the Get Individual Reveal endpoint. If you wish to do added authentication, the headers in the webhook request will include `x-auth-key` which will be a SHA256 hash of your api key.

You can get the status of the individual reveal by calling the `GET /api/individual_reveals/:id` endpoint.

## Request body

- object
  - `individual_reveal` union, required
    - LinkedinProfileInput
      - `profile_url` string, required — URL of the Linkedin profile. e.g. "https://www.linkedin.com/in/stephen-hakami-5babb21b0/".
    - union
      - object
        - `full_name` string, required — Full name of the contact. e.g. "Stephen Hakami".
        - `company` string, required — Name of the company. e.g. "Wiza". Either company (company name) or domain is required.
        - `domain` string — Domain of the company. e.g. "wiza.co". Either company (company name) or domain is required.
        - `profile_url` string — URL of the Linkedin profile. e.g. "https://www.linkedin.com/in/stephen-hakami-5babb21b0/".
        - `email` string — Email address of the contact.
      - object
        - `full_name` string, required — Full name of the contact. e.g. "Stephen Hakami".
        - `company` string — Name of the company. e.g. "Wiza". Either company (company name) or domain is required.
        - `domain` string, required — Domain of the company. e.g. "wiza.co". Either company (company name) or domain is required.
        - `profile_url` string — URL of the Linkedin profile. e.g. "https://www.linkedin.com/in/stephen-hakami-5babb21b0/".
        - `email` string — Email address of the contact.
    - EmailInput
      - `email` string, required — Email address of the contact.
  - `enrichment_level` 'none' | 'partial' | 'phone' | 'full', required — > Enrichment level of the list. | Enrichment Level | Description | |--------|--------------------------------------| | none | Will enrich with contact's data when you provide a Linkedin profile url or email. But will not find emails or phone numbers | | partial| Will find email. | | phone | Will find phone numbers. | | full | Will find email and phone numbers. |
  - `email_options` object — Types of emails to return. If not provided, all emails will be returned.
    - `accept_work` boolean — Professional email address, i.e. tim.cooke@apple.com
    - `accept_personal` boolean — A personal email address, i.e. tcooke1960@gmail.com
  - `callback_url` string — URL to send the individual reveal update to. If not provided, the default webhook URL configured in your account settings will be used.
  - `reveal_options` object — Optional advanced reveal options.
    - `fair_key` string — > An optional key used to fairly distribute throughput across your own sub-groups (for example your end-users or lists). Reveals are dispatched round-robin across distinct `fair_key` values within your account's concurrency limit, so a burst from one sub-group can't starve the others. Use a stable identifier such as your internal user id or list id. If omitted, reveals from your account are dispatched in submission order.

## Response `200`

successful

- object
  - `status` object
    - `code` integer
    - `message` string
  - `type` 'individual_reveal'
  - `data` object
    - `id` integer
    - `status` 'queued' | 'resolving' | 'finished' | 'failed' — > Current status of the individual reveal. | Status | Meaning | | --- | --- | | queued | Accepted and waiting to start. | | resolving | Enrichment in progress. | | finished | Enrichment completed successfully. | | failed | Enrichment completed with errors. |
    - `is_complete` boolean

## Other responses

- `400` — Error starting individual reveal
- `401` — Unauthorized
- `429` — Queue full

---

[API](https://skmtc.dev/wiza/apis/wiza-api-documentation.md) · [All operations](https://skmtc.dev/wiza/apis/wiza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wiza/wiza-api-documentation/revisions/9773e985f208/schema)