{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}
{
"message": "Too Many Requests"
}
Ignition
Start Ignition
Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.
{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}
{
"message": "Too Many Requests"
}
The Axle Team can set up Ignition templates to overwrite the default configuration that is set per client.To apply one, pass the template in the Start Ignition request body. The template scopes to that single Ignition session. Contact the Axle team to set up a template.
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.
Set to true if you would like to send an encrypted base64 string as the request body, instead of a JSON string. The body must be encrypted using an Axle-provided public key with RSA_PKCS1_OAEP_PADDING and SHA256 hashing. Defaults to false.
Note - If your client is configured to use the Ignition landing page to collect additional user information, the provided Ignition user and metadata can be accessed by the user that is sent a generated Ignition session.
User to attach to the Ignition session. This object is used to identify the user that is associated with the Ignition session, enabling consolidated metrics, easy matching for webhook events, and upcoming features.
Optional object to store ephemeral information about the session, such as reservationTime. Will be returned in webhook events.
ℹ️ metadata can be used in policy validation templates as dynamic rule inputs (keys matching template source values). See Policy Validation with Templates.
{"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":"6ae36eb5b3f002741c1a9b3c","collectionId":"e7ca1e81-cddb-4eb0-89da-cdf50c0ad9ff","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae36eb5b3f002741c1a9b3c"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae36eb5b3f002741c1a9b3c","clientVersion":"0.0.4021","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":[{"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":"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":"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":"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}],"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) format(\"woff2\"),url(https://uploads-ssl.webflow.com/62c9a8ebe81984320aaa6d60/63870e3e7d02c82500d5b032_SuisseIntl-Regular.woff) 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) format(\"woff2\"),url(https://uploads-ssl.webflow.com/62c9a8ebe81984320aaa6d60/63870ec9d6797e86085b84fa_SuisseIntl-SemiBold.woff) 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:.75rem;font-weight:600;line-height:1.5;letter-spacing:.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,.18);color:#cbd5e1}.dark .axle-chip.auto{background:rgba(59,130,246,.2);color:#93c5fd}.dark .axle-chip.home{background:rgba(34,197,94,.18);color:#86efac}.dark .axle-chip.condo{background:rgba(139,92,246,.2);color:#c4b5fd}.dark .axle-chip.planned{background:rgba(245,158,11,.18);color:#fcd34d}.dark .axle-chip.research{background:rgba(20,184,166,.2);color:#5eead4}"}],"page":{"pagePath":"api-reference/ignition/start-ignition","slug":"/api-reference/ignition/start-ignition","pageMetadata":{"openapi":"POST /ignition","title":"Start Ignition","description":"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.","href":"/api-reference/ignition/start-ignition"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(Info,{children:[_jsx(_components.p,{children:`The Axle Team can set up Ignition templates to overwrite the default configuration that is set per client.`}),_jsxs(_components.p,{children:[`To apply one, pass the template in the `,_jsx(_components.a,{href:`/api-reference/ignition/start-ignition`,children:`Start Ignition`}),` request body. The template scopes to that single Ignition session. Contact the Axle team to set up a template.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"POST /ignition","title":"Start Ignition","description":"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.","href":"/api-reference/ignition/start-ignition"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Start Ignition","description":"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.","operationId":"StartIgnition","parameters":["37855579-0bdc-4894-86eb-26cb3aaab00b","381c92a2-ef7c-4eb2-b05c-5bd16ec149b4","ebb80746-ccd5-4b91-a744-4add2776482a"],"requestBody":"dfe6fb2a-5c7e-4666-8a7f-74a7913a8a2b","responses":{"200":"226d1f34-5ea4-455a-ba47-6ccdb749d8bc","400":"d5cc7f7b-aff6-4e04-94bf-ff520846f712","429":"0b9bc747-9d1b-4a5b-bdd7-397ead13b6d2"},"deprecated":false,"tags":["Ignition"],"method":"post","type":"path","servers":["ca3700b0-553c-46da-b132-7bc9fd2e1915","d0f63b60-8fd1-44b5-b8ca-5b3e86116fc6"],"security":["af7a6590-981f-4d06-8dfc-1b6a6d6057cd"],"path":"/ignition","baseUrlOptions":["https://sandbox.axle.insure","https://api.axle.insure"],"title":"Start Ignition","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"37855579-0bdc-4894-86eb-26cb3aaab00b":{"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."},"381c92a2-ef7c-4eb2-b05c-5bd16ec149b4":{"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."},"ebb80746-ccd5-4b91-a744-4add2776482a":{"name":"x-encrypted-data","in":"header","required":false,"schema":{"type":"boolean","isRequired":false,"description":"Set to *true* if you would like to send an encrypted base64 string as the request body, instead of a JSON string. The body must be encrypted using an Axle-provided public key with RSA_PKCS1_OAEP_PADDING and SHA256 hashing. Defaults to *false*.\n\n**Note** - If your client is configured to use the Ignition landing page to collect additional user information, the provided Ignition user and metadata can be accessed by the user that is sent a generated Ignition session.\n","uniqueKey":"","typeLabel":"boolean"},"description":"Set to *true* if you would like to send an encrypted base64 string as the request body, instead of a JSON string. The body must be encrypted using an Axle-provided public key with RSA_PKCS1_OAEP_PADDING and SHA256 hashing. Defaults to *false*.\n\n**Note** - If your client is configured to use the Ignition landing page to collect additional user information, the provided Ignition user and metadata can be accessed by the user that is sent a generated Ignition session.\n"}},"requestBody":{"description":"","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"user":{"title":"User","type":"object","x-examples":{"example":{"id":"usr_foqnkvhwerq7h81","firstName":"John","lastName":"Smith","email":"john@smith.com"}},"description":"User to attach to the Ignition session. This object is used to identify the user that is associated with the Ignition session, enabling consolidated metrics, easy matching for webhook events, and upcoming features.","properties":{"id":{"type":"string","description":"A public, unique identifier for the user or entity associated with the Ignition session.\n> **Note** \n> `user.id` is typically a public identifier for a user in your application. However, it can also represent the entity you are tracking insurance for, such as a trip ID or loan number. Consider the following when choosing a value:\n> - **Metric aggregation behavior** – Metrics are aggregated based on the `user.id` provided. Passing a **user ID** rolls metrics up at the user level. Passing an **entity ID** (e.g. loan number) rolls metrics up at the entity level.\n> - **Historical lookback** – If you use a user ID and want a historical timeline of all accounts a user has linked across entities, you should store the mapping of user, entity, and access token in your system.\n> - **Interaction with Descope Token** – The [Descope Token](../descope-token) endpoint stops monitoring on the account tied to the given access token.\n> - If using a **user ID**, stopping monitoring applies to the user's insurance account across all entities.\n> - If using an **entity ID**, stopping monitoring applies only to the account originally linked for that entity.","isRequired":true,"uniqueKey":"user.id","typeLabel":"string"},"firstName":{"type":"string","description":"User's first name.","uniqueKey":"user.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"User's last name.","uniqueKey":"user.lastName","typeLabel":"string"},"email":{"type":"string","description":"User's email address.","uniqueKey":"user.email","typeLabel":"string"},"phone":{"type":"string","description":"User's phone number in E.164 format.","uniqueKey":"user.phone","typeLabel":"string"}},"required":["id"],"isRequired":true,"uniqueKey":"user","typeLabel":"User · object"},"redirectUri":{"type":"string","description":"The URI Ignition should direct the user to after authenticating successfully or exiting the Ignition session.","uniqueKey":"redirectUri","typeLabel":"string"},"webhookUri":{"type":"string","description":"The URI Axle should send updates about this session or the resulting Account or Policy objects.","uniqueKey":"webhookUri","typeLabel":"string"},"metadata":{"type":"object","title":"FlatMetadata","description":"Optional object to store ephemeral information about the session, such as `reservationTime`. Will be returned in webhook events.\n\nℹ️ `metadata` can be used in policy validation templates as dynamic rule inputs (keys matching template `source` values). See [Policy Validation with Templates](/guides/validate/policy-validation-with-template).","uniqueKey":"metadata","typeLabel":"FlatMetadata · object"}},"required":["user"],"uniqueKey":"","typeLabel":"object"},"example":{"redirectUri":"https://example.com/redirect","webhookUri":"https://example.com/webhook","user":{"id":"usr_123456789"}},"examples":{"Example":{"title":"Example","value":{"redirectUri":"https://example.com/redirect","webhookUri":"https://example.com/webhook","user":{"id":"usr_123456789"}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"226d1f34-5ea4-455a-ba47-6ccdb749d8bc":{"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","x-examples":{"example-1":{"success":true,"data":{"ignitionToken":"ign_d83jd7n2hd75jDh6E575x","ignitionUri":"https://ignition.axle.insure/?token=ign_d83jd7n2hd75jDh6E575x"}}},"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":["ignitionUri","ignitionToken"],"properties":{"ignitionUri":{"type":"string","description":"The URL that hosts the Ignition session. This URL can be navigated to in an iframe, webview, or a separate page. See [Initialize Ignition](/guides/initialize-ignition) for more details.","isRequired":true,"uniqueKey":"data.ignitionUri","typeLabel":"string"},"ignitionToken":{"type":"string","description":"The unique ID for the Ignition session.","isRequired":true,"uniqueKey":"data.ignitionToken","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","data"],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"ignitionToken":"ign_d83jd7n2hd75jDh6E575x","ignitionUri":"https://ignition.axle.insure/?token=ign_d83jd7n2hd75jDh6E575x"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"ignitionToken":"ign_d83jd7n2hd75jDh6E575x","ignitionUri":"https://ignition.axle.insure/?token=ign_d83jd7n2hd75jDh6E575x"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d5cc7f7b-aff6-4e04-94bf-ff520846f712":{"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"},"0b9bc747-9d1b-4a5b-bdd7-397ead13b6d2":{"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":{"af7a6590-981f-4d06-8dfc-1b6a6d6057cd":{"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":{"ca3700b0-553c-46da-b132-7bc9fd2e1915":{"description":"Sandbox","url":"https://sandbox.axle.insure"},"d0f63b60-8fd1-44b5-b8ca-5b3e86116fc6":{"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 Ignition - Axle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-22T19:47:58.046Z","originalFileLocation":"api-reference/ignition/start-ignition.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 an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.\">\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 Ignition - Axle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Axle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.axle.insure/api-reference/ignition/start-ignition\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://axle.mintlify.app/_mintlify/api/og/v2?division=Ignition\u0026amp;title=Start+Ignition\u0026amp;description=Generate+an+Ignition+session.+Returns+an+ignitionToken+and+ignitionUri+to+direct+the+user+to+share+their+insurance+information.+The+ignition+session+will+never+\u0026amp;theme=89b4b8c22e9e1c87b956c02e\u0026amp;signature=ffc88e0b7cd132c22f1d0b4829ad8ecb1a0e10b7bcca60efffbfc5b043c350f5\">\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 Ignition - Axle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://axle.mintlify.app/_mintlify/api/og/v2?division=Ignition\u0026amp;title=Start+Ignition\u0026amp;description=Generate+an+Ignition+session.+Returns+an+ignitionToken+and+ignitionUri+to+direct+the+user+to+share+their+insurance+information.+The+ignition+session+will+never+\u0026amp;theme=89b4b8c22e9e1c87b956c02e\u0026amp;signature=ffc88e0b7cd132c22f1d0b4829ad8ecb1a0e10b7bcca60efffbfc5b043c350f5\">\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/ignition/start-ignition\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/ignition/start-ignition.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/ignition/start-ignition#webpage\",\"url\":\"https://docs.axle.insure/api-reference/ignition/start-ignition\",\"name\":\"Start Ignition\",\"description\":\"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.\",\"dateModified\":\"2026-07-22T19:47:58.046Z\",\"isPartOf\":{\"@id\":\"https://docs.axle.insure#website\"},\"breadcrumb\":{\"@id\":\"https://docs.axle.insure/api-reference/ignition/start-ignition#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.axle.insure/api-reference/ignition/start-ignition#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.axle.insure/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start Ignition\",\"item\":\"https://docs.axle.insure/api-reference/ignition/start-ignition\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.axle.insure/api-reference/ignition/start-ignition#apireference\",\"headline\":\"Start Ignition\",\"name\":\"Start Ignition\",\"description\":\"Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.\",\"url\":\"https://docs.axle.insure/api-reference/ignition/start-ignition\",\"mainEntityOfPage\":{\"@id\":\"https://docs.axle.insure/api-reference/ignition/start-ignition#webpage\"},\"dateModified\":\"2026-07-22T19:47:58.046Z\",\"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","description":"Learn about the Axle API","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","description":"Proxy insurance information on behalf of your user to Axle for processing and/or verification. This endpoint should ONLY be used when insurance information is gathered when the user is not present (such as a document received from an insurance carrier via mail).\n\nFor more details on permitted usage and supported operations, see the [Proxy Ignition](/guides/proxy-ignition) guide.","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","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","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"}]}]},"title":"Start Ignition - Axle","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}