{
"status": {
"code": 200,
"message": "🧙 Wiza is working on it!"
},
"type": "individual_reveal",
"data": {
"id": 32,
"status": "queued",
"is_complete": false
}
}
{
"status": {
"code": 400,
"message": "Please add a valid payment method to start this scan."
}
}
{
"status": {
"code": 429,
"message": "Queue is full. Try again later."
}
}
Individual Reveals
Start Individual Reveal
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 . 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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Wiza Docs","colors":{"primary":"#7E43FF","light":"#E0D3FD","dark":"#7C3AED"},"logo":{"light":"https://mintcdn.com/wiza-036374f4/1UdIu3jtcY0uyviL/logo-light.png?fit=max\u0026auto=format\u0026n=1UdIu3jtcY0uyviL\u0026q=85\u0026s=6ffc6e5951c92c16b94d7b9a9cf743fa","dark":"https://mintcdn.com/wiza-036374f4/1UdIu3jtcY0uyviL/logo-dark.png?fit=max\u0026auto=format\u0026n=1UdIu3jtcY0uyviL\u0026q=85\u0026s=82efc0b4606cefe3c924ee1e1ad7e7d3","href":"https://wiza.co/"},"favicon":"https://mintcdn.com/wiza-036374f4/vb1SsyUO9AcltFMG/favicon.png?fit=max\u0026auto=format\u0026n=vb1SsyUO9AcltFMG\u0026q=85\u0026s=7ddbe5973f5fa7e0cd647c12b7a3e658","appearance":{"default":"light"},"navbar":{"links":[{"href":"https://wiza.co/","label":"Home"},{"href":"https://wiza.co/book-demo","label":"Book a demo"},{"href":"https://status.wiza.co/","label":"Status"}]},"footer":{"socials":{"website":"https://wiza.co/","linkedin":"https://www.linkedin.com/company/wizainc"}},"seo":{"indexing":"all"},"styling":{"codeblocks":"dark","latex":false},"integrations":{"ga4":{"measurementId":"G-8NZJGC14HV"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wiza-036374f4","hasAudioNarration":false,"actualSubdomain":"wiza-036374f4","customDomains":["docs.wiza.co"],"gitSource":{"type":"github","owner":"wizaco","repo":"wiza-backend","deployBranch":"main","contentDirectory":"wiza-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aea2840be4973f62cf440f1","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":13},{"language":"default","tag":"Using the API","count":10},{"language":"default","tag":"Legacy Endpoints","count":5},{"language":"default","tag":"Account Access","count":4},{"language":"default","tag":"Overview","count":4},{"language":"default","tag":"Integrations","count":3},{"language":"default","tag":"Lists","count":3},{"language":"default","tag":"Individual Reveals","count":2},{"language":"default","tag":"Prospect Lists","count":2},{"language":"default","tag":"Prospect","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/individual-reveals/start-individual-reveal","slug":"/api-reference/individual-reveals/start-individual-reveal","pageMetadata":{"title":"Start Individual Reveal","description":">\nStart 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.\n\n> Either `company` (company name) or `domain` is required when using contact details.\n\nOnce 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.\n\nYou can get the status of the individual reveal by calling the `GET /api/individual_reveals/:id` endpoint.\n","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/individual_reveals","href":"/api-reference/individual-reveals/start-individual-reveal","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n blockquote: \"blockquote\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.blockquote, {\n children: \"\\n\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"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.\"\n }), \"\\n\", _jsxs(_components.blockquote, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"Either \", _jsx(_components.code, {\n children: \"company\"\n }), \" (company name) or \", _jsx(_components.code, {\n children: \"domain\"\n }), \" is required when using contact details.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Once the reveal is completed, an update will be posted to the webhook URL as configured in your \", _jsx(_components.a, {\n href: \"http://wiza.co/app/settings/api\",\n children: \" account settings \"\n }), \". 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 \", _jsx(_components.code, {\n children: \"x-auth-key\"\n }), \" which will be a SHA256 hash of your api key.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"You can get the status of the individual reveal by calling the \", _jsx(_components.code, {\n children: \"GET /api/individual_reveals/:id\"\n }), \" endpoint.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Start Individual Reveal","description":">\nStart 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.\n\n> Either `company` (company name) or `domain` is required when using contact details.\n\nOnce 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.\n\nYou can get the status of the individual reveal by calling the `GET /api/individual_reveals/:id` endpoint.\n","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/individual_reveals","href":"/api-reference/individual-reveals/start-individual-reveal","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/wiza-036374f4/093b722fbe93573c/scripts/open-expandables.js"],"openApiReferenceData":{"operation":{"summary":"Start Individual Reveal","tags":["Individual Reveals"],"description":">\nStart 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.\n\n> Either `company` (company name) or `domain` is required when using contact details.\n\nOnce 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.\n\nYou can get the status of the individual reveal by calling the `GET /api/individual_reveals/:id` endpoint.\n","security":["fddc47bc-477b-45de-9a84-39782696e8a6"],"parameters":[],"responses":{"200":"a45000b3-1a2b-4b6e-888d-a06046a83fb0","400":"9d22a66d-8161-402f-b080-00d3d0ef3e69","401":"b0672394-f2cd-45d2-9832-207f8af2ddb3","429":"9fb6dd27-594d-4c8f-950f-a8ddf3fdde62"},"requestBody":"b57a26f4-d8be-46c7-9bf9-84b1a3a4225b","method":"post","type":"path","servers":["96af77b7-f6df-4793-80a0-2281e8423854"],"path":"/api/individual_reveals","baseUrlOptions":["https://wiza.co"],"title":"Start Individual Reveal","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"individual_reveal":{"oneOf":[{"type":"object","required":["profile_url"],"properties":{"profile_url":{"type":"string","description":"URL of the Linkedin profile. e.g. \"https://www.linkedin.com/in/stephen-hakami-5babb21b0/\".","example":"https://www.linkedin.com/in/stephen-hakami-5babb21b0/","isRequired":true,"uniqueKey":"individual_reveal.oneOf.0.profile_url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"individual_reveal.oneOf.0","typeLabel":"object"},{"type":"object","required":["full_name","company"],"properties":{"full_name":{"type":"string","description":"Full name of the contact. e.g. \"Stephen Hakami\".","example":"Stephen Hakami","isRequired":true,"uniqueKey":"individual_reveal.oneOf.1.full_name","typeLabel":"string"},"company":{"type":"string","description":"Name of the company. e.g. \"Wiza\". Either company (company name) or domain is required.","example":"Wiza","isRequired":true,"uniqueKey":"individual_reveal.oneOf.1.company","typeLabel":"string"},"domain":{"type":"string","description":"Domain of the company. e.g. \"wiza.co\". Either company (company name) or domain is required.","example":"wiza.co","uniqueKey":"individual_reveal.oneOf.1.domain","typeLabel":"string"},"profile_url":{"type":"string","description":"URL of the Linkedin profile. e.g. \"https://www.linkedin.com/in/stephen-hakami-5babb21b0/\".","example":"https://www.linkedin.com/in/stephen-hakami-5babb21b0/","uniqueKey":"individual_reveal.oneOf.1.profile_url","typeLabel":"string"},"email":{"type":"string","description":"Email address of the contact.","example":"stephen@wiza.co","uniqueKey":"individual_reveal.oneOf.1.email","typeLabel":"string"}},"isRequired":true,"uniqueKey":"individual_reveal.oneOf.1","typeLabel":"object"},{"type":"object","required":["full_name","domain"],"properties":{"full_name":{"type":"string","description":"Full name of the contact. e.g. \"Stephen Hakami\".","example":"Stephen Hakami","isRequired":true,"uniqueKey":"individual_reveal.oneOf.2.full_name","typeLabel":"string"},"domain":{"type":"string","description":"Domain of the company. e.g. \"wiza.co\". Either company (company name) or domain is required.","example":"wiza.co","isRequired":true,"uniqueKey":"individual_reveal.oneOf.2.domain","typeLabel":"string"},"company":{"type":"string","description":"Name of the company. e.g. \"Wiza\". Either company (company name) or domain is required.","example":"Wiza","uniqueKey":"individual_reveal.oneOf.2.company","typeLabel":"string"},"profile_url":{"type":"string","description":"URL of the Linkedin profile. e.g. \"https://www.linkedin.com/in/stephen-hakami-5babb21b0/\".","example":"https://www.linkedin.com/in/stephen-hakami-5babb21b0/","uniqueKey":"individual_reveal.oneOf.2.profile_url","typeLabel":"string"},"email":{"type":"string","description":"Email address of the contact.","example":"stephen@wiza.co","uniqueKey":"individual_reveal.oneOf.2.email","typeLabel":"string"}},"isRequired":true,"uniqueKey":"individual_reveal.oneOf.2","typeLabel":"object"},{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email address of the contact.","example":"stephen@wiza.co","isRequired":true,"uniqueKey":"individual_reveal.oneOf.3.email","typeLabel":"string"}},"isRequired":true,"uniqueKey":"individual_reveal.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"individual_reveal","typeLabel":"object"},"enrichment_level":{"type":"string","enum":["none","partial","phone","full"],"description":">\nEnrichment level of the list.\n| Enrichment Level | Description |\n|--------|--------------------------------------|\n| none | Will enrich with contact's data when you provide a Linkedin profile url or email. But will not find emails or phone numbers |\n| partial| Will find email. |\n| phone | Will find phone numbers. |\n| full | Will find email and phone numbers. |","isRequired":true,"uniqueKey":"enrichment_level","typeLabel":"enum\u003cstring>"},"email_options":{"description":"Types of emails to return. If not provided, all emails will be returned.","type":"object","properties":{"accept_work":{"type":"boolean","description":"Professional email address, i.e. tim.cooke@apple.com","uniqueKey":"email_options.accept_work","typeLabel":"boolean"},"accept_personal":{"type":"boolean","description":"A personal email address, i.e. tcooke1960@gmail.com","uniqueKey":"email_options.accept_personal","typeLabel":"boolean"}},"uniqueKey":"email_options","typeLabel":"object"},"callback_url":{"type":"string","description":"URL to send the individual reveal update to. If not provided, the default webhook URL configured in your account settings will be used.","uniqueKey":"callback_url","typeLabel":"string"},"reveal_options":{"description":"Optional advanced reveal options.","type":"object","properties":{"fair_key":{"type":"string","description":">\nAn 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.","uniqueKey":"reveal_options.fair_key","typeLabel":"string"}},"uniqueKey":"reveal_options","typeLabel":"object"}},"required":["individual_reveal","enrichment_level"],"uniqueKey":"","typeLabel":"object"},"examples":{"With Contact Details":{"title":"With Contact Details","value":{"individual_reveal":{"full_name":"Stephen Hakami","company":"Wiza","domain":"wiza.co"},"enrichment_level":"partial","email_options":{"accept_work":true,"accept_personal":false}}},"With Linkedin URL":{"title":"With Linkedin URL","value":{"individual_reveal":{"profile_url":"https://www.linkedin.com/in/stephen-hakami-5babb21b0/"},"enrichment_level":"partial"}},"With Email":{"title":"With Email","value":{"individual_reveal":{"email":"stephen@wiza.co"},"enrichment_level":"phone"}},"With Fair Distribution Key":{"title":"With Fair Distribution Key","value":{"individual_reveal":{"profile_url":"https://www.linkedin.com/in/stephen-hakami-5babb21b0/"},"enrichment_level":"partial","reveal_options":{"fair_key":"end-user-12345"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"a45000b3-1a2b-4b6e-888d-a06046a83fb0":{"description":"successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":200,"uniqueKey":"status.code","typeLabel":"integer"},"message":{"type":"string","example":"🧙 Wiza is working on it!","uniqueKey":"status.message","typeLabel":"string"}},"uniqueKey":"status","typeLabel":"object"},"type":{"type":"string","enum":["individual_reveal"],"example":"individual_reveal","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"data":{"type":"object","properties":{"id":{"type":"integer","example":32,"uniqueKey":"data.id","typeLabel":"integer"},"status":{"type":"string","description":">\nCurrent status of the individual reveal.\n\n| Status | Meaning |\n| --- | --- |\n| queued | Accepted and waiting to start. |\n| resolving | Enrichment in progress. |\n| finished | Enrichment completed successfully. |\n| failed | Enrichment completed with errors. |\n","enum":["queued","resolving","finished","failed"],"example":"queued","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"is_complete":{"type":"boolean","example":false,"uniqueKey":"data.is_complete","typeLabel":"boolean"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":{"code":200,"message":"🧙 Wiza is working on it!"},"type":"individual_reveal","data":{"id":32,"status":"queued","is_complete":false}}}},"exampleType":"generated"}},"exampleType":"generated"},"9d22a66d-8161-402f-b080-00d3d0ef3e69":{"description":"Error starting individual reveal","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":400,"uniqueKey":"status.code","typeLabel":"integer"},"message":{"type":"string","example":"Please add a valid payment method to start this scan.","description":">\n Potential error messages:\n\n - Your seat is currently paused. Contact your account owner.\n - Please make sure you have an active subscription.\n - Please add a valid payment method to start this scan.\n ","uniqueKey":"status.message","typeLabel":"string"}},"uniqueKey":"status","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":{"code":400,"message":"Please add a valid payment method to start this scan."}}}},"exampleType":"generated"}},"exampleType":"generated"},"b0672394-f2cd-45d2-9832-207f8af2ddb3":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9fb6dd27-594d-4c8f-950f-a8ddf3fdde62":{"description":"Queue full","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":429,"uniqueKey":"status.code","typeLabel":"integer"},"message":{"type":"string","example":"Queue is full. Try again later.","uniqueKey":"status.message","typeLabel":"string"}},"uniqueKey":"status","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":{"code":429,"message":"Queue is full. Try again later."}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fddc47bc-477b-45de-9a84-39782696e8a6":{"bearer_auth":{"type":"http","scheme":"bearer","description":"Enter your bearer token (your API key) in the **Authorization** header in the format `Bearer {token}`","scopes":[],"schemeName":"bearer_auth"}}},"servers":{"96af77b7-f6df-4793-80a0-2281e8423854":{"url":"https://wiza.co","variables":{"defaultHost":{"default":"wiza.co"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Enter your bearer token (your API key) in the **Authorization** header in the format `Bearer {token}`","scopes":[],"schemeName":"bearer_auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter your bearer token (your API key) in the **Authorization** header in the format `Bearer {token}`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"}]},"originalFileLocation":"swagger/v1/openapi.yaml"},"subdomain":"wiza-036374f4","siteName":"Wiza Docs","title":"Start Individual Reveal - Wiza Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T19:51:00.274Z","originalFileLocation":"api-reference/individual-reveals/start-individual-reveal.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"\u0026gt; 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. \u0026gt; 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 . 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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wiza Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start Individual Reveal - Wiza Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"\u0026gt; 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. \u0026gt; 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 . 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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wiza Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wiza-036374f4.mintlify.site/_mintlify/api/og/v2?division=Individual+Reveals\u0026amp;title=Start+Individual+Reveal\u0026amp;description=%3E%0AStart+an+individual+reveal.+An+individual+reveal+is+a+single+contact+enrichment.+You+can+provide+a+name%2C+company%2C+and+domain%2C+or+an+email%2C+or+a+LinkedIn+profi\u0026amp;theme=50afba618558cf3122199f6e\u0026amp;signature=50cfe719cbf06fbd246142b4303c5cf2deb57bac06489c3063d5cbc2dbcb1a0b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Start Individual Reveal - Wiza Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"\u0026gt; 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. \u0026gt; 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 . 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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wiza-036374f4.mintlify.site/_mintlify/api/og/v2?division=Individual+Reveals\u0026amp;title=Start+Individual+Reveal\u0026amp;description=%3E%0AStart+an+individual+reveal.+An+individual+reveal+is+a+single+contact+enrichment.+You+can+provide+a+name%2C+company%2C+and+domain%2C+or+an+email%2C+or+a+LinkedIn+profi\u0026amp;theme=50afba618558cf3122199f6e\u0026amp;signature=50cfe719cbf06fbd246142b4303c5cf2deb57bac06489c3063d5cbc2dbcb1a0b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/wiza-036374f4/fVk-zEW7crGwAL69/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wiza Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7E43FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/individual-reveals/start-individual-reveal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wiza.co/#organization\",\"name\":\"Wiza Docs\",\"url\":\"https://docs.wiza.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wiza-036374f4/1UdIu3jtcY0uyviL/logo-light.png?fit=max\u0026auto=format\u0026n=1UdIu3jtcY0uyviL\u0026q=85\u0026s=6ffc6e5951c92c16b94d7b9a9cf743fa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wiza.co#website\",\"name\":\"Wiza Docs\",\"url\":\"https://docs.wiza.co\",\"publisher\":{\"@id\":\"https://docs.wiza.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal#webpage\",\"url\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal\",\"name\":\"Start Individual Reveal\",\"description\":\"> 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 . 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.\",\"dateModified\":\"2026-10-29T19:51:00.274Z\",\"isPartOf\":{\"@id\":\"https://docs.wiza.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Wiza Docs\",\"item\":\"https://docs.wiza.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start Individual Reveal\",\"item\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal#apireference\",\"headline\":\"Start Individual Reveal\",\"name\":\"Start Individual Reveal\",\"description\":\"> 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 . 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.\",\"url\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wiza.co/api-reference/individual-reveals/start-individual-reveal#webpage\"},\"dateModified\":\"2026-10-29T19:51:00.274Z\",\"publisher\":{\"@id\":\"https://docs.wiza.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wiza.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wiza Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Wiza Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/individual-reveals/start-individual-reveal.md","siteName":"Wiza Docs","nav":{"global":null,"groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/overview/introduction"},{"title":"Key Functionality","href":"/overview/key-functionality"},{"title":"Data Dictionary","href":"/overview/data-dictionary"},{"title":"Usage Limits","href":"/overview/usage-limits"}]},{"group":"Account Access","pages":[{"title":"Account Setup","href":"/account-access/account-setup"},{"title":"Purchasing API Credits","href":"/account-access/purchasing-api-credits"},{"title":"Generate an API Key","href":"/account-access/generate-api-key"},{"title":"API Key Management","href":"/account-access/api-key-management"}]},{"group":"Using the API","pages":[{"title":"Authorization","href":"/using-the-api/authorization"},{"title":"Recommended Inputs","href":"/using-the-api/recommended-inputs"},{"title":"Autocomplete Filters","href":"/using-the-api/autocomplete"},{"title":"Find Mobile Phone Number","href":"/using-the-api/find-mobile-phone-number"},{"title":"Find Email Addresses","href":"/using-the-api/find-email-addresses"},{"title":"Find Profile Details","href":"/using-the-api/find-linkedin-profile-information"},{"title":"Bulk Enrichment","href":"/using-the-api/bulk-enrichment"},{"title":"Webhooks","href":"/using-the-api/webhooks"},{"title":"Credit Deduction Behavior","href":"/using-the-api/credit-deduction-behavior"},{"title":"Status Codes \u0026 Errors","description":"Handle API responses and errors","href":"/using-the-api/status-codes-and-errors"}]},{"group":"API Reference","pages":[{"group":"Individual Reveals","pages":[{"title":"Start Individual Reveal","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/individual_reveals","href":"/api-reference/individual-reveals/start-individual-reveal"},{"title":"Get Individual Reveal","description":"Get the individual reveal by id.","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml get /api/individual_reveals/{id}","href":"/api-reference/individual-reveals/get-individual-reveal"}]},{"group":"Credits","pages":[{"title":"Get Credits","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml get /api/meta/credits","href":"/api-reference/credits/get-credits"}]},{"group":"Autocomplete","pages":[{"title":"Search Locations","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml get /api/meta/location_autocomplete","href":"/api-reference/prospects/search-locations"},{"title":"Search Technologies","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml get /api/meta/technology_autocomplete","href":"/api-reference/prospects/search-technologies"}]},{"group":"Company Enrichment","pages":[{"title":"Company Enrichment","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/company_enrichments","href":"/api-reference/company-enrichment/company-enrichment"}]},{"group":"Prospect","pages":[{"title":"Prospect search","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/prospects/search","href":"/api-reference/prospect/prospect-search"},{"title":"Company search","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/accounts/search","href":"/api-reference/prospect/company-search"}]},{"group":"Legacy Endpoints","pages":[{"group":"Lists","pages":[{"title":"Create List","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/lists","href":"/api-reference/lists/create-list"},{"title":"Get List","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml get /api/lists/{id}","href":"/api-reference/lists/get-list"},{"title":"Get List Contacts","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml get /api/lists/{id}/contacts","href":"/api-reference/lists/get-list-contacts"}]},{"group":"Prospect Lists","pages":[{"title":"Create prospect list","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/prospects/create_prospect_list","href":"/api-reference/prospect-lists/create-prospect-list"},{"title":"Continue prospect search","deprecated":null,"version":null,"openapi":"/swagger/v1/openapi.yaml post /api/prospects/continue_search","href":"/api-reference/prospect-lists/continue-prospect-search"}]}]}]},{"group":"Integrations","pages":[{"title":"Clay","href":"/integrations/clay"},{"title":"n8n","href":"/integrations/n8n"},{"title":"Apollo.io","href":"/integrations/apollo"}]}]},"basePath":"","title":"Start Individual Reveal - Wiza Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}