Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any
environment today — this endpoint returns simulated results. No credit
bureau is contacted, despite plaid, experian, equifax and
transunion appearing in the request and in providers[].provider. The
per-provider request_id values are generated locally, and the decision is
derived from the request body alone.
Check the response’s mode field: simulated means no provider was
called. Do not present a simulated result to an end user as a verification
outcome.
Nothing is persisted — this endpoint writes no record and returns no id you can
look up later.
Preview endpoint. Read this before integrating.Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any
environment today — this endpoint returns simulated results. No credit
bureau is contacted, despite plaid, experian, equifax and
transunion appearing in the request and in providers[].provider. The
per-provider request_id values are generated locally, and the decision is
derived from the request body alone.Check the response’s mode field: simulated means no provider was
called. Do not present a simulated result to an end user as a verification
outcome.Nothing is persisted — this endpoint writes no record and returns no id you can
look up later.Requires the write scope.
Whether the provider results in this response came from real provider calls (live) or from the built-in simulator (simulated). The provider names are actual credit bureaus, so a completed result is otherwise indistinguishable from one. Branch on this rather than trusting providers[].status.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aura API","description":"REST and GraphQL APIs for partner integrations","colors":{"primary":"#7C3AED","light":"#A78BFA","dark":"#6D28D9"},"favicon":"https://mintcdn.com/aura-84f04a78/ysSUChuBcy4CPcDn/favicon.png?fit=max\u0026auto=format\u0026n=ysSUChuBcy4CPcDn\u0026q=85\u0026s=8ccf8e6924b6cad812298ed2ea32fc94","navbar":{"links":[{"href":"https://app.aura-app.ai","label":"Aura"}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aura-84f04a78","hasAudioNarration":false,"actualSubdomain":"aura-84f04a78","customDomains":["docs.api.aura-app.ai"],"gitSource":{"type":"github","owner":"aura-app-ai","repo":"aura","deployBranch":"main","contentDirectory":"apps/api-docs/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adc184e0a0572dc1e6a8a62","collectionId":"088fa338-5010-438a-996a-01f21e70c0d1","liveDeploymentHistoryId":"6adc184e0a0572dc1e6a8a62","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adc197a3dbc661bca0dff4d","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"GraphQL API","count":114},{"language":"default","tag":"Types","count":86},{"language":"default","tag":"REST API","count":55},{"language":"default","tag":"API reference","count":49},{"language":"default","tag":"Queries","count":19},{"language":"default","tag":"Calls","count":10},{"language":"default","tag":"Mutations","count":9},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Leads","count":7},{"language":"default","tag":"Analytics","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"openapi/v1/lead-qualifications/post","slug":"/openapi/v1/lead-qualifications/post","pageMetadata":{"title":"Qualify a lead (preview)","description":"**Preview endpoint. Read this before integrating.**\n\nUnless `LEAD_QUALIFY_MODE=real` is configured server-side — it is not, in any\nenvironment today — this endpoint returns **simulated** results. No credit\nbureau is contacted, despite `plaid`, `experian`, `equifax` and\n`transunion` appearing in the request and in `providers[].provider`. The\nper-provider `request_id` values are generated locally, and the decision is\nderived from the request body alone.\n\nCheck the response's `mode` field: `simulated` means no provider was\ncalled. Do not present a `simulated` result to an end user as a verification\noutcome.\n\nNothing is persisted — this endpoint writes no record and returns no id you can\nlook up later.\n\nRequires the `write` scope.","openapi":"openapi.json POST /v1/lead-qualifications","href":"/openapi/v1/lead-qualifications/post"},"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 code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Preview endpoint. Read this before integrating.\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Unless \", _jsx(_components.code, {\n children: \"LEAD_QUALIFY_MODE=real\"\n }), \" is configured server-side — it is not, in any\\nenvironment today — this endpoint returns \", _jsx(_components.strong, {\n children: \"simulated\"\n }), \" results. No credit\\nbureau is contacted, despite \", _jsx(_components.code, {\n children: \"plaid\"\n }), \", \", _jsx(_components.code, {\n children: \"experian\"\n }), \", \", _jsx(_components.code, {\n children: \"equifax\"\n }), \" and\\n\", _jsx(_components.code, {\n children: \"transunion\"\n }), \" appearing in the request and in \", _jsx(_components.code, {\n children: \"providers[].provider\"\n }), \". The\\nper-provider \", _jsx(_components.code, {\n children: \"request_id\"\n }), \" values are generated locally, and the decision is\\nderived from the request body alone.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Check the response’s \", _jsx(_components.code, {\n children: \"mode\"\n }), \" field: \", _jsx(_components.code, {\n children: \"simulated\"\n }), \" means no provider was\\ncalled. Do not present a \", _jsx(_components.code, {\n children: \"simulated\"\n }), \" result to an end user as a verification\\noutcome.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Nothing is persisted — this endpoint writes no record and returns no id you can\\nlook up later.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"write\"\n }), \" scope.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Preview endpoint. Read this before integrating.`})}),`\n`,_jsxs(_components.p,{children:[`Unless `,_jsx(_components.code,{children:`LEAD_QUALIFY_MODE=real`}),` is configured server-side — it is not, in any\nenvironment today — this endpoint returns `,_jsx(_components.strong,{children:`simulated`}),` results. No credit\nbureau is contacted, despite `,_jsx(_components.code,{children:`plaid`}),`, `,_jsx(_components.code,{children:`experian`}),`, `,_jsx(_components.code,{children:`equifax`}),` and\n`,_jsx(_components.code,{children:`transunion`}),` appearing in the request and in `,_jsx(_components.code,{children:`providers[].provider`}),`. The\nper-provider `,_jsx(_components.code,{children:`request_id`}),` values are generated locally, and the decision is\nderived from the request body alone.`]}),`\n`,_jsxs(_components.p,{children:[`Check the response’s `,_jsx(_components.code,{children:`mode`}),` field: `,_jsx(_components.code,{children:`simulated`}),` means no provider was\ncalled. Do not present a `,_jsx(_components.code,{children:`simulated`}),` result to an end user as a verification\noutcome.`]}),`\n`,_jsx(_components.p,{children:`Nothing is persisted — this endpoint writes no record and returns no id you can\nlook up later.`}),`\n`,_jsxs(_components.p,{children:[`Requires the `,_jsx(_components.code,{children:`write`}),` scope.`]})]})}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":{"config":{},"pageMetadata":{"title":"Qualify a lead (preview)","description":"**Preview endpoint. Read this before integrating.**\n\nUnless `LEAD_QUALIFY_MODE=real` is configured server-side — it is not, in any\nenvironment today — this endpoint returns **simulated** results. No credit\nbureau is contacted, despite `plaid`, `experian`, `equifax` and\n`transunion` appearing in the request and in `providers[].provider`. The\nper-provider `request_id` values are generated locally, and the decision is\nderived from the request body alone.\n\nCheck the response's `mode` field: `simulated` means no provider was\ncalled. Do not present a `simulated` result to an end user as a verification\noutcome.\n\nNothing is persisted — this endpoint writes no record and returns no id you can\nlook up later.\n\nRequires the `write` scope.","openapi":"openapi.json POST /v1/lead-qualifications","href":"/openapi/v1/lead-qualifications/post"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/aura-84f04a78/a23b3099adac29d9/search-focus.js"],"openApiReferenceData":{"operation":{"description":"**Preview endpoint. Read this before integrating.**\n\nUnless `LEAD_QUALIFY_MODE=real` is configured server-side — it is not, in any\nenvironment today — this endpoint returns **simulated** results. No credit\nbureau is contacted, despite `plaid`, `experian`, `equifax` and\n`transunion` appearing in the request and in `providers[].provider`. The\nper-provider `request_id` values are generated locally, and the decision is\nderived from the request body alone.\n\nCheck the response's `mode` field: `simulated` means no provider was\ncalled. Do not present a `simulated` result to an end user as a verification\noutcome.\n\nNothing is persisted — this endpoint writes no record and returns no id you can\nlook up later.\n\nRequires the `write` scope.","requestBody":"bbc8bd3d-2b4c-4511-b04f-63874caf5d00","responses":{"200":"22ddeb4a-2fd0-4cf5-a240-428c909e0ec1","400":"8aacdb78-e6ec-44b4-9bdc-5b3627e34302","401":"53163a9c-6193-4776-b4c4-76827154aa79","402":"f637c46c-2a19-4f58-8b9e-3c49fb1941c9","403":"fa5907ed-e297-4e89-b4d1-838ec8bd5c2c","408":"db378681-6e15-4ca1-8a74-7ab8f2ec0bad","413":"fd6d0626-cf6a-4b32-83ca-5bf378731902","429":"b2503633-6c74-4a26-a9f0-b219f36e8a36","500":"2309db73-5027-43ee-94b9-5c695ace42cf"},"security":["fd77b58c-dbef-4f7d-b8eb-93cec6b65033"],"summary":"Qualify a lead (preview)","tags":["Lead Qualification"],"method":"post","type":"path","servers":["5221a7e1-3d3d-4c69-849e-b4d57dd9af35","171a8e50-7771-4b7a-972e-29a2e587af64","5e31f02a-c4b3-4824-b16e-80268ce26955"],"path":"/v1/lead-qualifications","baseUrlOptions":["https://api.aura-app.ai","https://staging-api.aura-app.ai","http://localhost:3001"],"title":"Qualify a lead (preview)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"consent_reference":{"maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"consent_reference","typeLabel":"string"},"email":{"format":"email","type":"string","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"full_name":{"maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"full_name","typeLabel":"string"},"answers":{"additionalProperties":{"maxLength":500,"type":"string","uniqueKey":"answers.additionalProperties","typeLabel":"string"},"default":{},"type":"object","uniqueKey":"answers","typeLabel":"object"},"lead_id":{"type":"string","uniqueKey":"lead_id","typeLabel":"string"},"phone":{"maxLength":40,"minLength":7,"type":"string","uniqueKey":"phone","typeLabel":"string"},"providers":{"default":["plaid","experian","equifax","transunion"],"items":{"enum":["plaid","experian","equifax","transunion"],"type":"string","uniqueKey":"providers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"maxItems":4,"minItems":1,"type":"array","uniqueKey":"providers","typeLabel":"enum\u003cstring>[]"}},"required":["full_name","email","consent_reference"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"consent_reference":"\u003cstring>","email":"jsmith@example.com","full_name":"\u003cstring>","answers":{},"lead_id":"\u003cstring>","phone":"\u003cstring>","providers":["plaid","experian","equifax","transunion"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"22ddeb4a-2fd0-4cf5-a240-428c909e0ec1":{"content":{"application/json":{"schema":{"properties":{"consent_reference":{"type":"string","isRequired":true,"uniqueKey":"consent_reference","typeLabel":"string"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"full_name":{"type":"string","isRequired":true,"uniqueKey":"full_name","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"latency_ms":{"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"latency_ms","typeLabel":"integer"},"lead_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"lead_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"lead_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lead_id","typeLabel":"string | null"},"mode":{"description":"Whether the provider results in this response came from real provider calls (`live`) or from the built-in simulator (`simulated`). The provider names are actual credit bureaus, so a `completed` result is otherwise indistinguishable from one. Branch on this rather than trusting `providers[].status`.","enum":["live","simulated"],"example":"simulated","type":"string","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"providers":{"items":{"properties":{"error_category":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"providers.items.[INDEX].error_category.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"providers.items.[INDEX].error_category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"providers.items.[INDEX].error_category","typeLabel":"string | null"},"latency_ms":{"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"providers.items.[INDEX].latency_ms","typeLabel":"integer"},"provider":{"type":"string","isRequired":true,"uniqueKey":"providers.items.[INDEX].provider","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"providers.items.[INDEX].request_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"providers.items.[INDEX].request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"providers.items.[INDEX].request_id","typeLabel":"string | null"},"signals":{"items":{"type":"string","uniqueKey":"providers.items.[INDEX].signals.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"providers.items.[INDEX].signals","typeLabel":"string[]"},"status":{"enum":["completed","pending","unavailable","not_configured","failed"],"type":"string","isRequired":true,"uniqueKey":"providers.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["provider","status","latency_ms","request_id","signals","error_category"],"type":"object","uniqueKey":"providers.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"providers","typeLabel":"object[]"},"qualification":{"enum":["qualified","review","unqualified","unverifiable"],"type":"string","isRequired":true,"uniqueKey":"qualification","typeLabel":"enum\u003cstring>"},"reasons":{"items":{"type":"string","uniqueKey":"reasons.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"reasons","typeLabel":"string[]"},"route":{"enum":["book_call","nurture","manual_review","unverifiable"],"type":"string","isRequired":true,"uniqueKey":"route","typeLabel":"enum\u003cstring>"},"score":{"maximum":100,"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"score","typeLabel":"integer"},"status":{"enum":["completed","partial","failed"],"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"tier":{"enum":["A","B","C","review"],"type":"string","isRequired":true,"uniqueKey":"tier","typeLabel":"enum\u003cstring>"}},"required":["mode","id","lead_id","full_name","email","qualification","score","tier","reasons","route","status","providers","latency_ms","consent_reference","created_at"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"consent_reference":"\u003cstring>","created_at":"\u003cstring>","email":"\u003cstring>","full_name":"\u003cstring>","id":"\u003cstring>","latency_ms":1,"lead_id":"\u003cstring>","mode":"simulated","providers":[{"error_category":"\u003cstring>","latency_ms":1,"provider":"\u003cstring>","request_id":"\u003cstring>","signals":["\u003cstring>"],"status":"completed"}],"qualification":"qualified","reasons":["\u003cstring>"],"route":"book_call","score":50,"status":"completed","tier":"A"}}},"exampleType":"generated"}},"description":"Qualification result","exampleType":"generated"},"8aacdb78-e6ec-44b4-9bdc-5b3627e34302":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","success":false,"code":"\u003cstring>","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Validation error","exampleType":"generated"},"53163a9c-6193-4776-b4c4-76827154aa79":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Missing or invalid API key","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"f637c46c-2a19-4f58-8b9e-3c49fb1941c9":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The organization's subscription is not active","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"fa5907ed-e297-4e89-b4d1-838ec8bd5c2c":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","success":false,"code":"\u003cstring>","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Missing qualify scope","exampleType":"generated"},"db378681-6e15-4ca1-8a74-7ab8f2ec0bad":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The request exceeded its processing time limit. Check the outcome before retrying a write","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"fd6d0626-cf6a-4b32-83ca-5bf378731902":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The request body exceeds 256KB","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"b2503633-6c74-4a26-a9f0-b219f36e8a36":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Rate limit exceeded. Wait before retrying","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed in the current window","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Window reset as a Unix timestamp","schema":{"type":"string"}},"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"2309db73-5027-43ee-94b9-5c695ace42cf":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Unexpected server failure. Include the request identifier when contacting support","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"}},"security":{"fd77b58c-dbef-4f7d-b8eb-93cec6b65033":{"bearerAuth":{"$ref":"cebf0d74-e31b-446c-85cc-4688098a9e49","scopes":[]}}},"servers":{"5221a7e1-3d3d-4c69-849e-b4d57dd9af35":{"description":"Production","url":"https://api.aura-app.ai"},"171a8e50-7771-4b7a-972e-29a2e587af64":{"description":"Staging","url":"https://staging-api.aura-app.ai"},"5e31f02a-c4b3-4824-b16e-80268ce26955":{"description":"Local Development","url":"http://localhost:3001"}}},"originalFileLocation":"openapi.json"},"subdomain":"aura-84f04a78","siteName":"Aura API","title":"Qualify a lead (preview) - Aura API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T04:36:14.301Z","originalFileLocation":"openapi/v1/lead-qualifications/post.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=\"system\"}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=\"Preview endpoint. Read this before integrating. Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any environment today — this endpoint returns simulated results. No credit bureau is contacted, despite plaid, experian, equifax and transunion appearing in the request and in providers[].provider. The per-provider request_id values are generated locally, and the decision is derived from the request body alone. Check the response\u0026#x27;s mode field: simulated means no provider was called. Do not present a simulated result to an end user as a verification outcome. Nothing is persisted — this endpoint writes no record and returns no id you can look up later. Requires the write scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aura API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Qualify a lead (preview) - Aura API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Preview endpoint. Read this before integrating. Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any environment today — this endpoint returns simulated results. No credit bureau is contacted, despite plaid, experian, equifax and transunion appearing in the request and in providers[].provider. The per-provider request_id values are generated locally, and the decision is derived from the request body alone. Check the response\u0026#x27;s mode field: simulated means no provider was called. Do not present a simulated result to an end user as a verification outcome. Nothing is persisted — this endpoint writes no record and returns no id you can look up later. Requires the write scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aura API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aura-84f04a78.mintlify.app/_mintlify/api/og/v2?division=Lead+qualifications\u0026amp;title=Qualify+a+lead+%28preview%29\u0026amp;description=**Preview+endpoint.+Read+this+before+integrating.**%0A%0AUnless+%60LEAD_QUALIFY_MODE%3Dreal%60+is+configured+server-side+%E2%80%94+it+is+not%2C+in+any%0Aenvironment+today+%E2%80%94+this+endp\u0026amp;theme=913ff3c47c90e1d37f4e1ee0\u0026amp;signature=5c1554ab9e000445764bb00a32a8d2d4755d58e5fc080324590a1a60c9f199f0\">\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=\"Qualify a lead (preview) - Aura API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Preview endpoint. Read this before integrating. Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any environment today — this endpoint returns simulated results. No credit bureau is contacted, despite plaid, experian, equifax and transunion appearing in the request and in providers[].provider. The per-provider request_id values are generated locally, and the decision is derived from the request body alone. Check the response\u0026#x27;s mode field: simulated means no provider was called. Do not present a simulated result to an end user as a verification outcome. Nothing is persisted — this endpoint writes no record and returns no id you can look up later. Requires the write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aura-84f04a78.mintlify.app/_mintlify/api/og/v2?division=Lead+qualifications\u0026amp;title=Qualify+a+lead+%28preview%29\u0026amp;description=**Preview+endpoint.+Read+this+before+integrating.**%0A%0AUnless+%60LEAD_QUALIFY_MODE%3Dreal%60+is+configured+server-side+%E2%80%94+it+is+not%2C+in+any%0Aenvironment+today+%E2%80%94+this+endp\u0026amp;theme=913ff3c47c90e1d37f4e1ee0\u0026amp;signature=5c1554ab9e000445764bb00a32a8d2d4755d58e5fc080324590a1a60c9f199f0\">\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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aura API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C3AED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/openapi/v1/lead-qualifications/post.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.api.aura-app.ai/#organization\",\"name\":\"Aura API\",\"url\":\"https://docs.api.aura-app.ai\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.api.aura-app.ai#website\",\"name\":\"Aura API\",\"url\":\"https://docs.api.aura-app.ai\",\"publisher\":{\"@id\":\"https://docs.api.aura-app.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post#webpage\",\"url\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post\",\"name\":\"Qualify a lead (preview)\",\"description\":\"Preview endpoint. Read this before integrating. Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any environment today — this endpoint returns simulated results. No credit bureau is contacted, despite plaid, experian, equifax and transunion appearing in the request and in providers[].provider. The per-provider request_id values are generated locally, and the decision is derived from the request body alone. Check the response's mode field: simulated means no provider was called. Do not present a simulated result to an end user as a verification outcome. Nothing is persisted — this endpoint writes no record and returns no id you can look up later. Requires the write scope.\",\"dateModified\":\"2026-09-28T04:36:14.301Z\",\"isPartOf\":{\"@id\":\"https://docs.api.aura-app.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.api.aura-app.ai/openapi/v1/leads/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Qualify a lead (preview)\",\"item\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post#apireference\",\"headline\":\"Qualify a lead (preview)\",\"name\":\"Qualify a lead (preview)\",\"description\":\"Preview endpoint. Read this before integrating. Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any environment today — this endpoint returns simulated results. No credit bureau is contacted, despite plaid, experian, equifax and transunion appearing in the request and in providers[].provider. The per-provider request_id values are generated locally, and the decision is derived from the request body alone. Check the response's mode field: simulated means no provider was called. Do not present a simulated result to an end user as a verification outcome. Nothing is persisted — this endpoint writes no record and returns no id you can look up later. Requires the write scope.\",\"url\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post\",\"mainEntityOfPage\":{\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/lead-qualifications/post#webpage\"},\"dateModified\":\"2026-09-28T04:36:14.301Z\",\"publisher\":{\"@id\":\"https://docs.api.aura-app.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.api.aura-app.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aura API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aura API","nav":{"global":null,"tabs":[{"tab":"REST API","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":""}]},{"group":"Guides","pages":[{"title":"Making requests","href":"/requests"},{"title":"GraphQL","href":"/graphql"},{"title":"TypeScript client","href":"/sdk"},{"title":"MCP","href":"/mcp-connector"},{"title":"Webhooks","href":"/webhooks"}]},{"group":"API reference","pages":[{"group":"Leads","pages":[{"title":"List leads","openapi":"openapi.json GET /v1/leads","href":"/openapi/v1/leads/get"},{"title":"Archive lead","openapi":"openapi.json DELETE /v1/leads/{id}","href":"/openapi/v1/leads/id/delete"},{"title":"Get lead by ID","openapi":"openapi.json GET /v1/leads/{id}","href":"/openapi/v1/leads/id/get"},{"title":"List lead notes","openapi":"openapi.json GET /v1/leads/{id}/notes","href":"/openapi/v1/leads/id/notes/get"},{"title":"Add lead note","openapi":"openapi.json POST /v1/leads/{id}/notes","href":"/openapi/v1/leads/id/notes/post"},{"title":"Update lead","openapi":"openapi.json PATCH /v1/leads/{id}","href":"/openapi/v1/leads/id/patch"},{"title":"Create lead","openapi":"openapi.json POST /v1/leads","href":"/openapi/v1/leads/post"}]},{"group":"Calls","pages":[{"title":"List calls","openapi":"openapi.json GET /v1/calls","href":"/openapi/v1/calls/get"},{"title":"Get call analysis","openapi":"openapi.json GET /v1/calls/{id}/analysis","href":"/openapi/v1/calls/id/analysis/get"},{"title":"Get call form answers","openapi":"openapi.json GET /v1/calls/{id}/answers","href":"/openapi/v1/calls/id/answers/get"},{"title":"Cancel a booked call","openapi":"openapi.json POST /v1/calls/{id}/cancel","href":"/openapi/v1/calls/id/cancel/post"},{"title":"Get call by ID","openapi":"openapi.json GET /v1/calls/{id}","href":"/openapi/v1/calls/id/get"},{"title":"Set call outcome","openapi":"openapi.json POST /v1/calls/{id}/outcome","href":"/openapi/v1/calls/id/outcome/post"},{"title":"Update call","openapi":"openapi.json PATCH /v1/calls/{id}","href":"/openapi/v1/calls/id/patch"},{"title":"Reassign a booked call to a different closer","openapi":"openapi.json POST /v1/calls/{id}/reassign-closer","href":"/openapi/v1/calls/id/reassign-closer/post"},{"title":"Reschedule a booked call","openapi":"openapi.json POST /v1/calls/{id}/reschedule","href":"/openapi/v1/calls/id/reschedule/post"},{"title":"Create a booking","openapi":"openapi.json POST /v1/calls","href":"/openapi/v1/calls/post"}]},{"group":"Opportunities","pages":[{"title":"List opportunities","openapi":"openapi.json GET /v1/opportunities","href":"/openapi/v1/opportunities/get"},{"title":"Get opportunity by ID","description":"\nRetrieve a single opportunity by ID (the underlying booking call's ID).\n\n**Response includes:**\n- Derived pipeline stage and raw call outcome status\n- Embedded lead summary (id, name, email)\n- Expected deal value and actual won value from the linked sale\n- Scheduling and close timestamps\n ","openapi":"openapi.json GET /v1/opportunities/{id}","href":"/openapi/v1/opportunities/id/get"}]},{"group":"Lead qualifications","pages":[{"title":"Qualify a lead (preview)","openapi":"openapi.json POST /v1/lead-qualifications","href":"/openapi/v1/lead-qualifications/post"}]},{"group":"Schedulers","pages":[{"title":"List schedulers","description":"\nRetrieve a paginated list of schedulers for your organization.\n\n**Use Cases:**\n- Display available schedulers in partner dashboards\n- Build custom booking widgets\n- Track scheduler performance\n ","openapi":"openapi.json GET /v1/booking-links","href":"/openapi/v1/booking-links/get"},{"title":"Get bookable time slots for a scheduler","openapi":"openapi.json GET /v1/booking-links/{id}/availability","href":"/openapi/v1/booking-links/id/availability/get"},{"title":"Get scheduler field schema","openapi":"openapi.json GET /v1/booking-links/{id}/fields","href":"/openapi/v1/booking-links/id/fields/get"},{"title":"Get scheduler by ID","openapi":"openapi.json GET /v1/booking-links/{id}","href":"/openapi/v1/booking-links/id/get"}]},{"group":"Team","pages":[{"title":"List team members","openapi":"openapi.json GET /v1/team","href":"/openapi/v1/team/get"},{"title":"Get team member by ID","openapi":"openapi.json GET /v1/team/{id}","href":"/openapi/v1/team/id/get"},{"title":"Get team performance summary","openapi":"openapi.json GET /v1/team/performance","href":"/openapi/v1/team/performance/get"}]},{"group":"Products","pages":[{"title":"List products","openapi":"openapi.json GET /v1/products","href":"/openapi/v1/products/get"},{"title":"Get product by ID","openapi":"openapi.json GET /v1/products/{id}","href":"/openapi/v1/products/id/get"}]},{"group":"Payments","pages":[{"title":"List payments","openapi":"openapi.json GET /v1/payments","href":"/openapi/v1/payments/get"},{"title":"Get payment by ID","openapi":"openapi.json GET /v1/payments/{id}","href":"/openapi/v1/payments/id/get"},{"title":"Update payment","openapi":"openapi.json PATCH /v1/payments/{id}","href":"/openapi/v1/payments/id/patch"},{"title":"Verify payment","openapi":"openapi.json POST /v1/payments/{id}/verify","href":"/openapi/v1/payments/id/verify/post"},{"title":"Record payment","openapi":"openapi.json POST /v1/payments","href":"/openapi/v1/payments/post"}]},{"group":"Analytics","pages":[{"title":"Get per-ad funnel performance","openapi":"openapi.json GET /v1/analytics/ad-performance","href":"/openapi/v1/analytics/ad-performance/get"},{"title":"Get campaign analytics","openapi":"openapi.json GET /v1/analytics/campaigns","href":"/openapi/v1/analytics/campaigns/get"},{"title":"Get dashboard analytics","openapi":"openapi.json GET /v1/analytics/dashboard","href":"/openapi/v1/analytics/dashboard/get"},{"title":"Get lead source analytics","openapi":"openapi.json GET /v1/analytics/lead-sources","href":"/openapi/v1/analytics/lead-sources/get"},{"title":"Get objection analytics","openapi":"openapi.json GET /v1/analytics/objections","href":"/openapi/v1/analytics/objections/get"},{"title":"Get revenue grouped by recorded currency","openapi":"openapi.json GET /v1/analytics/revenue","href":"/openapi/v1/analytics/revenue/get"}]},{"group":"Funnel","pages":[{"title":"Ingest an external funnel event","openapi":"openapi.json POST /v1/funnel/events","href":"/openapi/v1/funnel/events/post"}]},{"group":"Webhooks","pages":[{"title":"List webhook delivery logs","openapi":"openapi.json GET /v1/webhooks/deliveries","href":"/openapi/v1/webhooks/deliveries/get"},{"title":"List webhook subscriptions","openapi":"openapi.json GET /v1/webhooks","href":"/openapi/v1/webhooks/get"},{"title":"Delete webhook subscription","openapi":"openapi.json DELETE /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/delete"},{"title":"Get webhook subscription by ID","openapi":"openapi.json GET /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/get"},{"title":"Update webhook subscription","openapi":"openapi.json PATCH /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/patch"},{"title":"Rotate webhook secret","openapi":"openapi.json POST /v1/webhooks/{id}/rotate-secret","href":"/openapi/v1/webhooks/id/rotate-secret/post"},{"title":"Create webhook subscription","openapi":"openapi.json POST /v1/webhooks","href":"/openapi/v1/webhooks/post"},{"title":"Test webhook subscription","openapi":"openapi.json POST /v1/webhooks/test","href":"/openapi/v1/webhooks/test/post"}]}]}]},{"tab":"GraphQL API","pages":[{"title":"GraphQL API","href":"/graphql-reference/queries/adPerformance"}]}]},"title":"Qualify a lead (preview) - Aura API","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}