{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}
{
"message": "Client does not have access to validation result val_abcdef123456."
}
{
"message": "Too Many Requests"
}
Widgets
Start Widget
Generate a widget session. Returns a widgetToken and widgetUri to display Axle’s embeddable widget experience to the user. Currently, validation is the only supported widget type.
Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Axle","colors":{"primary":"#3F3F46","light":"#D4D4D8","dark":"#27272A"},"logo":{"light":"https://mintcdn.com/axle/enJXHO5JjjypOw69/logo/light.svg?fit=max\u0026auto=format\u0026n=enJXHO5JjjypOw69\u0026q=85\u0026s=62b3826a6d7c78b1f559063f2c2d3f00","dark":"https://mintcdn.com/axle/enJXHO5JjjypOw69/logo/dark.svg?fit=max\u0026auto=format\u0026n=enJXHO5JjjypOw69\u0026q=85\u0026s=b60a327c63083ec273936a7cb95a2759"},"favicon":"https://mintcdn.com/axle/jvr_RjEwsLPkmitD/favicon-lg.png?fit=max\u0026auto=format\u0026n=jvr_RjEwsLPkmitD\u0026q=85\u0026s=2fcaf929965104a4df7633dd76b9325a","api":{"openapi":"openapi.yaml","mdx":{"server":["https://api.axle.insure","https://sandbox.axle.insure"]}},"appearance":{"default":"light"},"background":{"color":{"dark":"#121212"}},"navbar":{"links":[{"href":"https://status.axle.insure","label":"Status"},{"href":"https://www.ycombinator.com/companies/axle/jobs","label":"We're hiring!"}],"primary":{"type":"button","label":"Get Started","href":"https://www.axle.insure/contact"}},"footer":{"socials":{"x":"https://x.com/axlelabs","linkedin":"https://www.linkedin.com/company/axle-labs","website":"https://www.axle.insure/"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Get Started","icon":"rocket-launch","href":"https://www.axle.insure/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"axle","hasAudioNarration":false,"actualSubdomain":"axle","customDomains":["docs.axle.insure"],"gitSource":{"type":"github","owner":"axle-labs","repo":"axle","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aecc9663d9c2abd053ee03a","collectionId":"d5039d81-14d0-4479-a886-7a006edc9987","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecc9663d9c2abd053ee03a"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aecdaa92ce0e78217a38beb","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Documentation","count":51},{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"Validation","count":6},{"language":"default","tag":"Policies","count":5},{"language":"default","tag":"Sandbox","count":5},{"language":"default","tag":"Axle Ignition","count":5},{"language":"default","tag":"Templates","count":4},{"language":"default","tag":"Webhooks","count":4},{"language":"default","tag":"Platform","count":3}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@axle.insure","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:\"Suisse Intl\";src:url(https://uploads-ssl.webflow.com/62c9a8ebe81984320aaa6d60/63870e3e7d02c82500d5b032_SuisseIntl-Regular.woff2)\n format(\"woff2\"),\n url(https://uploads-ssl.webflow.com/62c9a8ebe81984320aaa6d60/63870e3e7d02c82500d5b032_SuisseIntl-Regular.woff)\n format(\"woff\");font-weight:300;font-style:normal}@font-face{font-family:\"Suisse Intl\";src:url(https://uploads-ssl.webflow.com/62c9a8ebe81984320aaa6d60/63870ec9d6797e86085b84fa_SuisseIntl-SemiBold.woff2)\n format(\"woff2\"),\n url(https://uploads-ssl.webflow.com/62c9a8ebe81984320aaa6d60/63870ec9d6797e86085b84fa_SuisseIntl-SemiBold.woff)\n format(\"woff\");font-weight:600;font-style:normal}body{font-family:\"Suisse Intl\", \"Helvetica\", \"Arial\", sans-serif;font-feature-settings:\"salt\";-o-font-feature-settings:\"salt\";-moz-font-feature-settings:\"salt\";-webkit-font-feature-settings:\"salt\"}.axle-chips{display:inline-flex;flex-wrap:wrap;gap:6px;margin:0 0 4px}.axle-chip{display:inline-flex;align-items:center;padding:2px 8px;border-radius:6px;font-size:0.75rem;font-weight:600;line-height:1.5;letter-spacing:0.01em}.axle-chip.all{background:#eef2f6;color:#475569}.axle-chip.auto{background:#e6eefe;color:#1d4ed8}.axle-chip.home{background:#e7f6ec;color:#15803d}.axle-chip.condo{background:#f1ecfd;color:#6d28d9}.axle-chip.planned,.axle-chip.research{--chip-icon: none}.axle-chip.planned::before,.axle-chip.research::before{content:\"\";flex:none;width:12px;height:12px;margin-right:4px;background-color:currentColor;-webkit-mask:var(--chip-icon) no-repeat center / contain;mask:var(--chip-icon) no-repeat center / contain}.axle-chip.planned{background:#fef3c7;color:#b45309;--chip-icon: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='12' cy='12' r='10'/%3E%3Cpolyline points='12 6 12 12 16 14'/%3E%3C/svg%3E\")}.axle-chip.research{background:#ccfbf1;color:#0f766e;--chip-icon: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M10 2v7.527a2 2 0 0 1-.211.896L4.72 20.55a1 1 0 0 0 .9 1.45h12.76a1 1 0 0 0 .9-1.45l-5.069-10.127A2 2 0 0 1 14 9.527V2'/%3E%3Cpath d='M8.5 2h7'/%3E%3Cpath d='M7 16h10'/%3E%3C/svg%3E\")}.dark .axle-chip.all{background:rgba(148, 163, 184, 0.18);color:#cbd5e1}.dark .axle-chip.auto{background:rgba(59, 130, 246, 0.20);color:#93c5fd}.dark .axle-chip.home{background:rgba(34, 197, 94, 0.18);color:#86efac}.dark .axle-chip.condo{background:rgba(139, 92, 246, 0.20);color:#c4b5fd}.dark .axle-chip.planned{background:rgba(245, 158, 11, 0.18);color:#fcd34d}.dark .axle-chip.research{background:rgba(20, 184, 166, 0.20);color:#5eead4}"}],"page":{"pagePath":"api-reference/widgets/start-widget","slug":"/api-reference/widgets/start-widget","pageMetadata":{"openapi":"POST /widgets","title":"Start Widget","description":"Generate a widget session. Returns a widgetToken and widgetUri to display Axle's embeddable widget experience to the user. Currently, `validation` is the only supported widget type.","href":"/api-reference/widgets/start-widget"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Generate a widget session. Returns a widgetToken and widgetUri to display Axle’s embeddable widget experience to the user. Currently, \", _jsx(_components.code, {\n children: \"validation\"\n }), \" is the only supported widget type.\"]\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":{"config":{},"pageMetadata":{"openapi":"POST /widgets","title":"Start Widget","description":"Generate a widget session. Returns a widgetToken and widgetUri to display Axle's embeddable widget experience to the user. Currently, `validation` is the only supported widget type.","href":"/api-reference/widgets/start-widget"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Start Widget","description":"Generate a widget session. Returns a widgetToken and widgetUri to display Axle's embeddable widget experience to the user. Currently, `validation` is the only supported widget type.","operationId":"StartWidget","parameters":["bb7d8ba6-c0b3-461e-8974-70f566f39937","6980f61e-a0dc-479d-bc54-02ded94dc2c3"],"requestBody":"23aa3ed9-a613-4e71-9a6b-17442cd8d5e4","responses":{"200":"c9c7002b-5498-4268-9df6-25bba7d1089a","400":"94f49398-b3a4-40d7-979d-53840218c6df","403":"0d74c821-bcb6-475b-b3a3-5fffbdfa3606","429":"1fd1c763-5c98-4a6f-864f-2108672a8d1f"},"deprecated":false,"tags":["Widgets"],"method":"post","type":"path","servers":["ee30736d-4962-44ef-be34-53de5093e51d","523ea38f-1b27-450b-b0aa-366b65a0adb1"],"security":["77d7208c-b690-4124-862a-9bf9ea5d77c0"],"path":"/widgets","baseUrlOptions":["https://sandbox.axle.insure","https://api.axle.insure"],"title":"Start Widget","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bb7d8ba6-c0b3-461e-8974-70f566f39937":{"name":"x-client-id","in":"header","required":true,"schema":{"type":"string","isRequired":true,"description":"Your client ID. This will be shared with you during onboarding.","uniqueKey":"","typeLabel":"string"},"description":"Your client ID. This will be shared with you during onboarding."},"6980f61e-a0dc-479d-bc54-02ded94dc2c3":{"name":"x-destination-client-id","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"The client ID of the destination client. This is optional and only used by platform clients. See the [Axle for Platforms](/guides/platform-integration) guide for more information.","uniqueKey":"","typeLabel":"string"},"description":"The client ID of the destination client. This is optional and only used by platform clients. See the [Axle for Platforms](/guides/platform-integration) guide for more information."}},"requestBody":{"description":"","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"validation":{"type":"object","description":"Configuration for a validation widget session.","properties":{"enabled":{"type":"boolean","description":"Set to `true` to start a validation widget session.","isRequired":true,"uniqueKey":"validation.enabled","typeLabel":"boolean"},"data":{"type":"object","properties":{"validationResult":{"type":"string","description":"The unique identifier for a validation result, returned as `validationResult` from [Validate Policy](/api-reference/validation/validate-policy).","isRequired":true,"uniqueKey":"validation.data.validationResult","typeLabel":"string"}},"required":["validationResult"],"isRequired":true,"uniqueKey":"validation.data","typeLabel":"object"}},"required":["enabled","data"],"isRequired":true,"uniqueKey":"validation","typeLabel":"object"}},"required":["validation"],"uniqueKey":"","typeLabel":"object"},"example":{"validation":{"enabled":true,"data":{"validationResult":"val_abcdef123456"}}},"examples":{"Example":{"title":"Example","value":{"validation":{"enabled":true,"data":{"validationResult":"val_abcdef123456"}}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"c9c7002b-5498-4268-9df6-25bba7d1089a":{"headers":{"x-axle-request-id":{"description":"A unique identifier generated per request. Include this value when contacting Axle support to help us locate your exact request.","schema":{"type":"string"},"example":"req_V1StGXR8_Z5jdHi6B-myT"}},"description":"","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"success":{"title":"Success","type":"boolean","description":"Indicates whether the operation was performed successfully.","x-internal":false,"example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","required":["widgetToken","widgetUri"],"properties":{"widgetToken":{"type":"string","description":"The unique ID for the widget session.","isRequired":true,"uniqueKey":"data.widgetToken","typeLabel":"string"},"widgetUri":{"type":"string","description":"The URL that hosts the widget session. Append `origin` (web) or `redirectUri` (mobile) before rendering. See [Widgets](/guides/widgets) for more details.","isRequired":true,"uniqueKey":"data.widgetUri","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","data"],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"widgetToken":"ey...","widgetUri":"https://widget.sandbox.axle.insure/?token=ey..."}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"widgetToken":"ey...","widgetUri":"https://widget.sandbox.axle.insure/?token=ey..."}}}},"exampleType":"examples"}},"exampleType":"examples"},"94f49398-b3a4-40d7-979d-53840218c6df":{"headers":{"x-axle-request-id":{"description":"A unique identifier generated per request. Include this value when contacting Axle support to help us locate your exact request.","schema":{"type":"string"},"example":"req_V1StGXR8_Z5jdHi6B-myT"}},"description":"The request body is invalid. See the error message for details.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Input validation failed due to one or more missing or invalid parameters. Review the request and try again.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Input validation failed due to one or more missing or invalid parameters. Review the request and try again."}}},"exampleType":"generated"}},"exampleType":"generated"},"0d74c821-bcb6-475b-b3a3-5fffbdfa3606":{"headers":{"x-axle-request-id":{"description":"A unique identifier generated per request. Include this value when contacting Axle support to help us locate your exact request.","schema":{"type":"string"},"example":"req_V1StGXR8_Z5jdHi6B-myT"}},"description":"The client does not have access to the requested validation result.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Client does not have access to validation result val_abcdef123456.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Client does not have access to validation result val_abcdef123456."}}},"exampleType":"generated"}},"exampleType":"generated"},"1fd1c763-5c98-4a6f-864f-2108672a8d1f":{"headers":{"x-axle-request-id":{"description":"A unique identifier generated per request. Include this value when contacting Axle support to help us locate your exact request.","schema":{"type":"string"},"example":"req_V1StGXR8_Z5jdHi6B-myT"}},"description":"Rate limit exceeded. This is only to protect Axle systems against errant or abnormal request volume. The limit is sufficiently high for all normal usage.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Too Many Requests","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Too Many Requests"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"77d7208c-b690-4124-862a-9bf9ea5d77c0":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-client-secret","description":"Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"ee30736d-4962-44ef-be34-53de5093e51d":{"description":"Sandbox","url":"https://sandbox.axle.insure"},"523ea38f-1b27-450b-b0aa-366b65a0adb1":{"description":"Production","url":"https://api.axle.insure","variables":{}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-client-secret","description":"Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-client-secret","type":"string","description":"Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-client-secret"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"axle","siteName":"Axle","title":"Start Widget - Axle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-27T21:56:35.124Z","originalFileLocation":"api-reference/widgets/start-widget.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=\"Generate a widget session. Returns a widgetToken and widgetUri to display Axle\u0026#x27;s embeddable widget experience to the user. Currently, validation is the only supported widget type.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Axle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/axle/DXTH79GIjAle_zmy/_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/axle/DXTH79GIjAle_zmy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/axle/DXTH79GIjAle_zmy/_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/axle/DXTH79GIjAle_zmy/_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/axle/DXTH79GIjAle_zmy/_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/axle/DXTH79GIjAle_zmy/_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/axle/DXTH79GIjAle_zmy/_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/axle/DXTH79GIjAle_zmy/_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/axle/DXTH79GIjAle_zmy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start Widget - Axle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate a widget session. Returns a widgetToken and widgetUri to display Axle\u0026#x27;s embeddable widget experience to the user. Currently, validation is the only supported widget type.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Axle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.axle.insure/api-reference/widgets/start-widget\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://axle.mintlify.site/_mintlify/api/og/v2?division=Widgets\u0026amp;title=Start+Widget\u0026amp;description=Generate+a+widget+session.+Returns+a+widgetToken+and+widgetUri+to+display+Axle%27s+embeddable+widget+experience+to+the+user.+Currently%2C+%60validation%60+is+the+only+s\u0026amp;theme=89b4b8c22e9e1c87b956c02e\u0026amp;signature=64c1a10075bcac1c6a90b6369375ced53bbc18f83ed3a939fe53dafe712348a2\">\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 Widget - Axle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate a widget session. Returns a widgetToken and widgetUri to display Axle\u0026#x27;s embeddable widget experience to the user. Currently, validation is the only supported widget type.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://axle.mintlify.site/_mintlify/api/og/v2?division=Widgets\u0026amp;title=Start+Widget\u0026amp;description=Generate+a+widget+session.+Returns+a+widgetToken+and+widgetUri+to+display+Axle%27s+embeddable+widget+experience+to+the+user.+Currently%2C+%60validation%60+is+the+only+s\u0026amp;theme=89b4b8c22e9e1c87b956c02e\u0026amp;signature=64c1a10075bcac1c6a90b6369375ced53bbc18f83ed3a939fe53dafe712348a2\">\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/axle/DXTH79GIjAle_zmy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Axle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3F3F46\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.axle.insure/api-reference/widgets/start-widget\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/widgets/start-widget.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.axle.insure/#organization\",\"name\":\"Axle\",\"url\":\"https://docs.axle.insure\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/axle/enJXHO5JjjypOw69/logo/light.svg?fit=max\u0026auto=format\u0026n=enJXHO5JjjypOw69\u0026q=85\u0026s=62b3826a6d7c78b1f559063f2c2d3f00\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.axle.insure#website\",\"name\":\"Axle\",\"url\":\"https://docs.axle.insure\",\"publisher\":{\"@id\":\"https://docs.axle.insure/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.axle.insure/api-reference/widgets/start-widget#webpage\",\"url\":\"https://docs.axle.insure/api-reference/widgets/start-widget\",\"name\":\"Start Widget\",\"description\":\"Generate a widget session. Returns a widgetToken and widgetUri to display Axle's embeddable widget experience to the user. Currently, validation is the only supported widget type.\",\"dateModified\":\"2026-07-27T21:56:35.124Z\",\"isPartOf\":{\"@id\":\"https://docs.axle.insure#website\"},\"breadcrumb\":{\"@id\":\"https://docs.axle.insure/api-reference/widgets/start-widget#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.axle.insure/api-reference/widgets/start-widget#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.axle.insure/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start Widget\",\"item\":\"https://docs.axle.insure/api-reference/widgets/start-widget\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.axle.insure/api-reference/widgets/start-widget#apireference\",\"headline\":\"Start Widget\",\"name\":\"Start Widget\",\"description\":\"Generate a widget session. Returns a widgetToken and widgetUri to display Axle's embeddable widget experience to the user. Currently, validation is the only supported widget type.\",\"url\":\"https://docs.axle.insure/api-reference/widgets/start-widget\",\"mainEntityOfPage\":{\"@id\":\"https://docs.axle.insure/api-reference/widgets/start-widget#webpage\"},\"dateModified\":\"2026-07-27T21:56:35.124Z\",\"publisher\":{\"@id\":\"https://docs.axle.insure/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.axle.insure#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Axle\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Axle","nav":{"global":{"anchors":[{"anchor":"Get Started","icon":"rocket-launch","href":"https://www.axle.insure/contact"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Home","pages":[{"title":"Welcome","href":"/welcome"},{"title":"Security","href":"/security"},{"title":"Changelog","href":"/changelog"}]},{"group":"Guides","pages":[{"title":"Quickstart","href":"/guides/quickstart"},{"group":"Axle Ignition","pages":[{"title":"Initialize","href":"/guides/initialize-ignition"},{"title":"Proxy","href":"/guides/proxy-ignition"},{"title":"Events","href":"/guides/ignition-events"},{"title":"Results","href":"/guides/completion-types"},{"title":"Optimizing conversion with Axle Ignition","sidebarTitle":"Optimizing conversion","href":"/guides/optimizing-ignition-conversion"}]},{"title":"Axle for Platforms","href":"/guides/platform-integration"},{"group":"Monitoring","pages":[{"title":"Overview","href":"/guides/monitoring"},{"title":"Account events","href":"/guides/account-events"},{"title":"Policy events","href":"/guides/policy-events"}]},{"group":"Axle Validation","pages":[{"title":"Policy Validation","href":"/guides/validate/policy-validation"},{"title":"Policy Validation with Templates","href":"/guides/validate/policy-validation-with-template"}]},{"title":"Widgets","href":"/guides/widgets"},{"title":"Policy Actions","href":"/guides/policy-actions"},{"group":"Sandbox","pages":[{"title":"Testing Ignition","href":"/guides/sandbox/ignition-completion"},{"title":"Monitoring notifications","href":"/guides/sandbox/monitoring-notifications"},{"title":"Validate Policy with Template","href":"/guides/sandbox/validate-policy-with-template"}]}]},{"group":"API Reference","pages":[{"title":"Overview","href":"/api-reference/overview"},{"group":"Ignition","pages":[{"openapi":"POST /ignition","title":"Start Ignition","href":"/api-reference/ignition/start-ignition"},{"openapi":"POST /ignition/{ignitionToken}/proxy","title":"Proxy Ignition","href":"/api-reference/ignition/proxy-ignition"}]},{"group":"Tokens","pages":[{"openapi":"POST /token/exchange","title":"Exchange Token","href":"/api-reference/tokens/exchange-token"},{"openapi":"POST /token/descope","title":"Descope Token","href":"/api-reference/tokens/descope-token"}]},{"group":"Accounts","pages":[{"title":"The Account object","href":"/api-reference/accounts/account"},{"openapi":"GET /accounts/{id}","title":"Get Account","href":"/api-reference/accounts/get-account"}]},{"group":"Policies","pages":[{"title":"The Policy object","href":"/api-reference/policies/policy"},{"title":"Coverages","href":"/api-reference/policies/coverages"},{"openapi":"GET /policies/{policyId}","title":"Get Policy","href":"/api-reference/policies/get-policy"},{"openapi":"GET /policies/{policyId}/report","title":"Get Policy Report","href":"/api-reference/policies/get-policy-report"},{"openapi":"POST /policies/{policyId}/actions","title":"Execute Policy Action","href":"/api-reference/policies/execute-policy-action"}]},{"group":"Carriers","pages":[{"openapi":"GET /carriers/{id}","title":"Get Carrier","href":"/api-reference/carriers/get-carrier"},{"openapi":"GET /carriers","title":"Get Carriers","href":"/api-reference/carriers/get-carriers"}]},{"group":"Platform","pages":[{"openapi":"POST /platform/clients","title":"Create Client","href":"/api-reference/platform/create-client"},{"openapi":"GET /platform/clients","title":"Get Clients","href":"/api-reference/platform/get-clients"},{"openapi":"POST /platform/validation/templates","title":"Create Template","href":"/api-reference/platform/create-templates"}]},{"group":"Sandbox","pages":[{"openapi":"POST /sandbox/accounts/{id}/event","title":"Trigger Account event","href":"/api-reference/sandbox/trigger-account-event"},{"openapi":"POST /sandbox/policies/{policyId}/event","title":"Trigger Policy event","href":"/api-reference/sandbox/trigger-policy-event"}]},{"group":"Validation","pages":[{"openapi":"POST /policies/{policyId}/validate","title":"Validate Policy","href":"/api-reference/validation/validate-policy"},{"openapi":"POST /policies/{policyId}/validate/{templateId}","title":"Validate Policy with Template","href":"/api-reference/validation/validate-policy-template"},{"group":"Templates","pages":[{"openapi":"POST /validation/templates","title":"Create Template","href":"/api-reference/validation/templates/create-template"},{"openapi":"GET /validation/templates/{templateId}","title":"Get Template","href":"/api-reference/validation/templates/get-template"},{"openapi":"POST /validation/templates/{templateId}","title":"Update Template","href":"/api-reference/validation/templates/update-template"},{"openapi":"GET /validation/templates","title":"Get Templates","description":"Get a list of all templates for the provided `clientId` or `destinationId`.\n\nRefer to the [Policy Validation with Templates](/guides/validate/policy-validation#validation-templates) guide for more details.","href":"/api-reference/validation/templates/get-templates"}]}]},{"group":"Widgets","pages":[{"openapi":"POST /widgets","title":"Start Widget","href":"/api-reference/widgets/start-widget"}]},{"group":"Webhooks","pages":[{"openapi":"openapi.yaml webhook ignitionEvents","title":"Ignition Events","description":"Sent to your `webhookUri` (configured on [Start Ignition](/api-reference/ignition/start-ignition)) as the user progresses through an Ignition session. These events also fire for [Proxy Ignition](/api-reference/ignition/proxy-ignition) operations. See [Ignition Events](/guides/ignition-events) for more details.","href":"/api-reference/webhooks/ignition-events"},{"openapi":"openapi.yaml webhook accountEvents","title":"Account Events","href":"/api-reference/webhooks/account-events"},{"openapi":"openapi.yaml webhook policyEvents","title":"Policy Events","href":"/api-reference/webhooks/policy-events"},{"openapi":"openapi.yaml webhook policyActionEvents","title":"Policy Action Events","href":"/api-reference/webhooks/policy-action-events"}]}]},{"group":"Advanced","pages":[{"title":"MCP","href":"/advanced/mcp"}]}]},{"tab":"Authorization","hidden":true,"pages":[{"title":"Authorization","href":"/dashboard/rbac"}]},{"tab":"Carriers","hidden":true,"pages":[{"title":"Carriers","href":"/carriers/overview"}]}]},"basePath":"","title":"Start Widget - Axle","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}