{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}
{
"message": "Unauthorized"
}
{
"message": "Requested entity not found"
}
{
"message": "Too Many Requests"
}
Policies
Get Policy
The Get Policy endpoint returns a Policy object. Please refer to the Policy object for a detailed description of each field.
Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.
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 renewal if you would like to receive the renewal policy information. By default it returns the policy the insurance carrier designates as default (i.e. insurance might return either current or renewal term).
⚠️ Note If endpoint returns 404, it means no renewal or current policy is available. We recommend calling the API again without the term query parameter to receive the policy the insurance carrier designates as default.
A Policy represents a specific policy associated with an Account and includes high-level policy information (e.g. policy number) and any children objects (e.g., coverages) associated with the policy.
Show child attributes
Was this page helpful?
{"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":"6ad28de75acefda23ad06022","collectionId":"d9d95daa-9fd8-444b-8a40-7b3166f22d90","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad28de75acefda23ad06022"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad28de75acefda23ad06022","clientVersion":"0.0.3971","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":"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":[{"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/policies/get-policy","slug":"/api-reference/policies/get-policy","pageMetadata":{"openapi":"GET /policies/{policyId}","title":"Get Policy","description":"The Get Policy endpoint returns a Policy object. Please refer to the [Policy](/api-reference/policies/policy) object for a detailed description of each field.\nPlease note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.","href":"/api-reference/policies/get-policy"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"The Get Policy endpoint returns a Policy object. Please refer to the \", _jsx(_components.a, {\n href: \"/api-reference/policies/policy\",\n children: \"Policy\"\n }), \" object for a detailed description of each field.\\nPlease note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.\"]\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":"GET /policies/{policyId}","title":"Get Policy","description":"The Get Policy endpoint returns a Policy object. Please refer to the [Policy](/api-reference/policies/policy) object for a detailed description of each field.\nPlease note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.","href":"/api-reference/policies/get-policy"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Policy","description":"The Get Policy endpoint returns a Policy object. Please refer to the [Policy](/api-reference/policies/policy) object for a detailed description of each field.\nPlease note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.","operationId":"GetPolicy","parameters":["87e20a5d-ab44-4896-b096-4e211e785870","d2b4efb1-f6d8-41e3-b8e1-36c161649d58","52bb4855-b2b7-4a22-aae1-1f4cb892fa26","92da22d5-ebd5-4ae4-a653-1546cfcb5401","28da5044-6d92-417d-a4f5-cb8a813dab9c"],"responses":{"200":"4b161315-61dd-48e0-9540-e3a03d610043","400":"f46fc33f-a8e1-403f-92f1-8eb5cdda1279","401":"456fc619-94c9-4d15-8f75-55262f76e106","404":"3618e9c4-858a-4e19-ac45-d7964785e808","429":"e5573302-2d33-4d6b-b1b1-8089421001f8"},"deprecated":false,"tags":["Policies"],"method":"get","type":"path","servers":["3d81c19b-4e35-4132-a730-b4bf9c69526c","2686c353-be7f-49a8-ab59-adbc6d1ac376"],"security":["bb75e395-5f65-4165-a443-4e2b58c1a59a"],"path":"/policies/{policyId}","baseUrlOptions":["https://sandbox.axle.insure","https://api.axle.insure"],"title":"Get Policy","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"87e20a5d-ab44-4896-b096-4e211e785870":{"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."},"d2b4efb1-f6d8-41e3-b8e1-36c161649d58":{"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."},"52bb4855-b2b7-4a22-aae1-1f4cb892fa26":{"name":"x-access-token","in":"header","required":true,"schema":{"type":"string","isRequired":true,"description":"The access token required for access to the requested Account. Returned as part of [Exchange Token](/api-reference/tokens/exchange-token).","uniqueKey":"","typeLabel":"string"},"description":"The access token required for access to the requested Account. Returned as part of [Exchange Token](/api-reference/tokens/exchange-token)."},"92da22d5-ebd5-4ae4-a653-1546cfcb5401":{"name":"expand","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"isRequired":false,"description":"Set to `true` if you would like to expand related entities (e.g., account, policy, client). Defaults to `false`.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Set to `true` if you would like to expand related entities (e.g., account, policy, client). Defaults to `false`."},"28da5044-6d92-417d-a4f5-cb8a813dab9c":{"name":"term","in":"query","required":false,"schema":{"type":"string","enum":["current","renewal"],"isRequired":false,"description":"Set to `renewal` if you would like to receive the renewal policy information. By default it returns the policy the insurance carrier designates as default (i.e. insurance might return either `current` or `renewal` term).\n\n ⚠️ **Note** If endpoint returns 404, it means no `renewal` or `current` policy is available. We recommend calling the API again without the `term` query parameter to receive the policy the insurance carrier designates as default. ","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Set to `renewal` if you would like to receive the renewal policy information. By default it returns the policy the insurance carrier designates as default (i.e. insurance might return either `current` or `renewal` term).\n\n ⚠️ **Note** If endpoint returns 404, it means no `renewal` or `current` policy is available. We recommend calling the API again without the `term` query parameter to receive the policy the insurance carrier designates as default. "},"963cb085-1f3d-4836-90c7-886b3ebb2c9f":{"name":"policyId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique ID for the requested policy, in the format `pol_...`. Returned by Get Account for each Policy associated with the Account.","uniqueKey":"","typeLabel":"string"},"description":"The unique ID for the requested policy, in the format `pol_...`. Returned by Get Account for each Policy associated with the Account."}},"responses":{"4b161315-61dd-48e0-9540-e3a03d610043":{"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":{"type":"object","properties":{"success":{"title":"Success","type":"boolean","description":"Indicates whether the operation was performed successfully.","x-internal":false,"example":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"title":"Policy","type":"object","description":"A Policy represents a specific policy associated with an Account and includes high-level policy information (e.g. policy number) and any children objects (e.g., coverages) associated with the policy.","x-tags":["Accounts"],"properties":{"id":{"type":"string","description":"Unique identifier for the Policy object.","example":"pol_CbxGmGWnp9bGAFCC-eod2","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"account":{"oneOf":[{"type":"string","description":"Unique identifier for the Account object associated with the Policy, or if `expand=true`, the Account object.","example":"acc_gM2wn_gaqUv76ZljeVXOv","isRequired":true,"uniqueKey":"data.account.oneOf.0","typeLabel":"string"},{"type":"object","title":"Account","description":"Unique identifier for the Account object associated with the Policy, or if `expand=true`, the Account object.","required":["id","carrier","firstName","lastName","email","phone","policies","connection","createdAt","modifiedAt","refreshedAt"],"x-examples":{"example":{"id":"acc_gM2wn_gaqUv76ZljeVXOv","firstName":"John","lastName":"Smith","email":"john.smith@grr.la","carrier":"state-farm","policies":["pol_CbxGmGWnp9bGAFCC-eod2"],"connection":{"status":"active","updatedAt":"2022-01-01T00:00:00.000Z"},"resultDetail":"user-portal-login","createdAt":"2022-01-01T00:00:00.000Z","modifiedAt":"2022-01-01T00:00:00.000Z","refreshedAt":"2022-01-01T00:00:00.000Z"}},"x-tags":["Accounts"],"example":"acc_gM2wn_gaqUv76ZljeVXOv","properties":{"id":{"type":"string","description":"Unique identifier for the Account object.","isRequired":true,"uniqueKey":"data.account.oneOf.1.id","typeLabel":"string"},"carrier":{"type":"string","description":"Insurance carrier that is the source for the Account data.","isRequired":true,"uniqueKey":"data.account.oneOf.1.carrier","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","description":"First name of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.account.oneOf.1.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.lastName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.account.oneOf.1.lastName","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Primary phone number of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary phone number of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.account.oneOf.1.phone","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Primary email address of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary email address of insurance account owner.","isRequired":true,"uniqueKey":"data.account.oneOf.1.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.account.oneOf.1.email","typeLabel":"string | null"},"policies":{"type":"array","description":"List of unique identifiers of Policy objects associated with the Account, or if `expand=true`, list of Policy objects.","items":{"oneOf":[{"type":"string","uniqueKey":"data.account.oneOf.1.policies.items.[INDEX].oneOf.0","typeLabel":"string"},{}],"uniqueKey":"data.account.oneOf.1.policies.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.account.oneOf.1.policies","typeLabel":"string[]"},"connection":{"title":"Connection","type":"object","x-internal":false,"properties":{"status":{"type":"string","description":"The Account connection status represents if Axle can actively request new Account and Policy data from the insurance carrier.","enum":["active","credentials-expired","mfa-expired","account-disabled","account-inaccessible","lienholder-required","comp-coll-required","policy-summary-only"],"uniqueKey":"data.account.oneOf.1.connection.status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"string","description":"ISO 8601 timestamp at which the Account connection status was updated.","uniqueKey":"data.account.oneOf.1.connection.updatedAt","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.account.oneOf.1.connection","typeLabel":"Connection · object"},"createdAt":{"type":"string","description":"ISO 8601 timestamp at which the Account object was generated via Axle.","isRequired":true,"uniqueKey":"data.account.oneOf.1.createdAt","typeLabel":"string"},"modifiedAt":{"type":"string","description":"ISO 8601 timestamp at which the Account object was modified via Axle. The Account object is modified only when there are differences between the current Account and new Account data requested from the carrier.","isRequired":true,"uniqueKey":"data.account.oneOf.1.modifiedAt","typeLabel":"string"},"refreshedAt":{"type":"string","description":"ISO 8601 timestamp at which the Account object was refreshed via Axle. The Account object is refreshed only when Axle successfully requests new Account data from the insurance carrier.","isRequired":true,"uniqueKey":"data.account.oneOf.1.refreshedAt","typeLabel":"string"},"resultDetail":{"type":"string","description":"Identifies the process that describes how each Ignition was completed in detail. See \u003ca href=\"/guides/completion-types#resultdetail\" className=\"no-underline\">resultDetail\u003c/a> for more details.","enum":["basic","credit-card-form","document-ai-declarations-page","document-ai-id-card","document-ai-push-through","manual-form","policy-lookup","policy-lookup-no-comp-coll","policy-lookup-no-lienholder","policy-lookup-summary","user-portal-login"],"example":"user-portal-login","uniqueKey":"data.account.oneOf.1.resultDetail","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.account.oneOf.1","typeLabel":"Account · object"}],"isRequired":true,"uniqueKey":"data.account","typeLabel":"string | Account · object"},"type":{"oneOf":[{"type":"string","description":"Type of insurance policy that the Policy object represents.","enum":["auto","motorcycle","home","condo","flood","renters"],"example":"auto","isRequired":true,"uniqueKey":"data.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Type of insurance policy that the Policy object represents.","enum":["auto","motorcycle","home","condo","flood","renters"],"example":"auto","isRequired":true,"uniqueKey":"data.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring> | null"},"carrier":{"type":"string","description":"Insurance carrier that is the source for the Policy data.","example":"state-farm","isRequired":true,"uniqueKey":"data.carrier","typeLabel":"string"},"policyNumber":{"oneOf":[{"type":"string","description":"Identifier of the policy, as specified by the insurance carrier.","example":"123456789","isRequired":true,"uniqueKey":"data.policyNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier of the policy, as specified by the insurance carrier.","example":"123456789","isRequired":true,"uniqueKey":"data.policyNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.policyNumber","typeLabel":"string | null"},"effectiveDate":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp of current term effective date of the policy, as specified by the insurance carrier.","example":"2022-10-22T04:00:00.000Z","isRequired":true,"uniqueKey":"data.effectiveDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp of current term effective date of the policy, as specified by the insurance carrier.","example":"2022-10-22T04:00:00.000Z","isRequired":true,"uniqueKey":"data.effectiveDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.effectiveDate","typeLabel":"string | null"},"expirationDate":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp of current term expiration date of the policy, as specified by the insurance carrier.","example":"2023-10-22T04:00:00.000Z","isRequired":true,"uniqueKey":"data.expirationDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp of current term expiration date of the policy, as specified by the insurance carrier.","example":"2023-10-22T04:00:00.000Z","isRequired":true,"uniqueKey":"data.expirationDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.expirationDate","typeLabel":"string | null"},"policyStatus":{"title":"PolicyStatus","type":"object","description":"Additional status details about the policy, as specified by the insurance carrier. Always present, and empty when the carrier doesn't provide any status details.","example":{"cancellationDate":"2023-03-15T04:00:00.000Z","cancellationReason":"non-payment"},"x-internal":false,"properties":{"cancellationDate":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp of the date the policy was or will be cancelled, as specified by the insurance carrier. Defaults to `null` if the policy isn't cancelled or the carrier doesn't specify.","example":"2023-03-15T04:00:00.000Z","isRequired":true,"uniqueKey":"data.policyStatus.cancellationDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp of the date the policy was or will be cancelled, as specified by the insurance carrier. Defaults to `null` if the policy isn't cancelled or the carrier doesn't specify.","example":"2023-03-15T04:00:00.000Z","isRequired":true,"uniqueKey":"data.policyStatus.cancellationDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.policyStatus.cancellationDate","typeLabel":"string | null"},"cancellationReason":{"oneOf":[{"type":"string","description":"The reason the policy was or will be cancelled, as specified by the insurance carrier. Defaults to `null` if the policy isn't cancelled or the carrier doesn't specify.\n\n- `non-payment` - The carrier cancelled because premium wasn't paid. This includes a pending cancellation for a missed payment.\n- `rewritten` - The policy was cancelled and replaced by a new one, for example a re-issue, a new term or product, or a change of carrier entity. The customer keeps coverage under the new policy.\n- `insured-request` - The policyholder asked to cancel, for example a customer-requested or future-dated cancellation.\n- `underwriting` - The carrier chose to end the policy for risk reasons, such as a claims history, a failed inspection, or a material misrepresentation. It is different from `non-payment`.\n- `sold` - The insured item was sold or transferred, such as a vehicle or a home.\n- `not-taken` - The policy was cancelled back to its effective date because the customer never took it, for example a quote that was bound but not paid for.\n","enum":["non-payment","rewritten","insured-request","underwriting","sold","not-taken",null],"example":"non-payment","isRequired":true,"uniqueKey":"data.policyStatus.cancellationReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The reason the policy was or will be cancelled, as specified by the insurance carrier. Defaults to `null` if the policy isn't cancelled or the carrier doesn't specify.\n\n- `non-payment` - The carrier cancelled because premium wasn't paid. This includes a pending cancellation for a missed payment.\n- `rewritten` - The policy was cancelled and replaced by a new one, for example a re-issue, a new term or product, or a change of carrier entity. The customer keeps coverage under the new policy.\n- `insured-request` - The policyholder asked to cancel, for example a customer-requested or future-dated cancellation.\n- `underwriting` - The carrier chose to end the policy for risk reasons, such as a claims history, a failed inspection, or a material misrepresentation. It is different from `non-payment`.\n- `sold` - The insured item was sold or transferred, such as a vehicle or a home.\n- `not-taken` - The policy was cancelled back to its effective date because the customer never took it, for example a quote that was bound but not paid for.\n","enum":["non-payment","rewritten","insured-request","underwriting","sold","not-taken",null],"example":"non-payment","isRequired":true,"uniqueKey":"data.policyStatus.cancellationReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.policyStatus.cancellationReason","typeLabel":"enum\u003cstring> | null"}},"required":["cancellationDate","cancellationReason"],"isRequired":true,"uniqueKey":"data.policyStatus","typeLabel":"PolicyStatus · object"},"premium":{"oneOf":[{"type":"number","description":"Total policy premium, as specified by the insurance carrier. *Note: only available for `type=home,condo` policies*","example":999.99,"isRequired":true,"uniqueKey":"data.premium.oneOf.0","typeLabel":"number"},{"type":"null","description":"Total policy premium, as specified by the insurance carrier. *Note: only available for `type=home,condo` policies*","example":999.99,"isRequired":true,"uniqueKey":"data.premium.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.premium","typeLabel":"number | null"},"amountDue":{"oneOf":[{"type":"number","description":"The balance that must be paid by the stated due date to keep the policy current, as specified by the insurance carrier. This may reflect an amount due from the insured, a third party (e.g., mortgagee or escrow), or both. If an amount due is present from multiple parties, the returned amount is the sum of all amounts due.","example":125.5,"isRequired":true,"uniqueKey":"data.amountDue.oneOf.0","typeLabel":"number"},{"type":"null","description":"The balance that must be paid by the stated due date to keep the policy current, as specified by the insurance carrier. This may reflect an amount due from the insured, a third party (e.g., mortgagee or escrow), or both. If an amount due is present from multiple parties, the returned amount is the sum of all amounts due.","example":125.5,"isRequired":true,"uniqueKey":"data.amountDue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.amountDue","typeLabel":"number | null"},"underwriter":{"title":"Underwriter","type":"object","example":{"name":"John Doe","naicCode":"12345"},"x-internal":false,"properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"data.underwriter.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.underwriter.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.underwriter.name","typeLabel":"string | null"},"naicCode":{"oneOf":[{"type":"string","uniqueKey":"data.underwriter.naicCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.underwriter.naicCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.underwriter.naicCode","typeLabel":"string | null"}},"description":"Underwriter associated with the policy.","isRequired":true,"uniqueKey":"data.underwriter","typeLabel":"Underwriter · object"},"address":{"title":"Address","type":"object","example":{"addressLine1":"123 Fake St.","addressLine2":"Unit 456","city":"Atlanta","state":"Georgia","postalCode":"30315","country":"USA"},"x-internal":false,"properties":{"addressLine1":{"oneOf":[{"type":"string","uniqueKey":"data.address.addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.address.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","uniqueKey":"data.address.addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.address.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address.addressLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"data.address.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address.state","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"data.address.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.address.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address.city","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","uniqueKey":"data.address.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.address.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address.postalCode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","uniqueKey":"data.address.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.address.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.address.country","typeLabel":"string | null"}},"description":"Primary address associated with the policy.","isRequired":true,"uniqueKey":"data.address","typeLabel":"Address · object"},"coverages":{"type":"array","description":"List of coverage types and levels offered by the policy.","items":{"title":"Coverage","type":"object","example":{"code":"BI","label":"Bodily Injury","limitPerPerson":250000,"limitPerAccident":500000},"x-internal":false,"properties":{"code":{"oneOf":[{"type":"string","title":"Auto Coverages","enum":["BI","PD","UMBI","UMPD","UIMBI","UIMPD","UUIMBI","UUIMPD","COLL","COMP"],"isRequired":true,"uniqueKey":"data.coverages.items.[INDEX].code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Home Coverages","enum":["DW","OS","PP","LOU","PL","MED","WIND","STORM"],"isRequired":true,"uniqueKey":"data.coverages.items.[INDEX].code.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.coverages.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.coverages.items.[INDEX].label","typeLabel":"string"},"limitPerPerson":{"oneOf":[{"type":"number","uniqueKey":"data.coverages.items.[INDEX].limitPerPerson.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.coverages.items.[INDEX].limitPerPerson.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.coverages.items.[INDEX].limitPerPerson","typeLabel":"number | null"},"limitPerAccident":{"oneOf":[{"type":"number","uniqueKey":"data.coverages.items.[INDEX].limitPerAccident.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.coverages.items.[INDEX].limitPerAccident.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.coverages.items.[INDEX].limitPerAccident","typeLabel":"number | null"},"deductible":{"oneOf":[{"type":"number","uniqueKey":"data.coverages.items.[INDEX].deductible.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.coverages.items.[INDEX].deductible.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.coverages.items.[INDEX].deductible","typeLabel":"number | null"},"property":{"oneOf":[{"type":"string","description":"Unique identifier of Property afforded coverage. If specified coverage is afforded to all properties on the policy, property will be undefined.","uniqueKey":"data.coverages.items.[INDEX].property.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of Property afforded coverage. If specified coverage is afforded to all properties on the policy, property will be undefined.","uniqueKey":"data.coverages.items.[INDEX].property.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.coverages.items.[INDEX].property","typeLabel":"string | null"},"settlementBasis":{"oneOf":[{"type":"string","enum":["replacement-cost","actual-cash-value","functional-replacement-cost"],"description":"Beta. Always present when `code` is `DW`. `replacement-cost` pays to repair or replace the dwelling with new materials of like kind and quality, with no deduction for depreciation. `actual-cash-value` pays replacement cost minus depreciation for age, wear, and obsolescence. `functional-replacement-cost` pays to rebuild with modern, functionally equivalent materials rather than exact like-kind replacement. `null` when the carrier did not supply a basis.","uniqueKey":"data.coverages.items.[INDEX].settlementBasis.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["replacement-cost","actual-cash-value","functional-replacement-cost"],"description":"Beta. Always present when `code` is `DW`. `replacement-cost` pays to repair or replace the dwelling with new materials of like kind and quality, with no deduction for depreciation. `actual-cash-value` pays replacement cost minus depreciation for age, wear, and obsolescence. `functional-replacement-cost` pays to rebuild with modern, functionally equivalent materials rather than exact like-kind replacement. `null` when the carrier did not supply a basis.","uniqueKey":"data.coverages.items.[INDEX].settlementBasis.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.coverages.items.[INDEX].settlementBasis","typeLabel":"enum\u003cstring> | null"}},"required":["code","label"],"uniqueKey":"data.coverages.items.[INDEX]","typeLabel":"Coverage · object"},"example":[{"code":"BI","label":"Bodily Injury","limitPerPerson":250000,"limitPerAccident":500000},{"code":"PD","label":"Property Damage","limitPerAccident":100000},{"code":"COMP","label":"Comprehensive","deductible":375,"property":"prp_uSdzLVpi8c76H7kl6AQ-F"},{"code":"COLL","label":"Collision","deductible":375,"property":"prp_uSdzLVpi8c76H7kl6AQ-F"},{"code":"UMBI","label":"Uninsured Bodily Injury","limitPerPerson":100000,"limitPerAccident":300000,"property":"prp_uSdzLVpi8c76H7kl6AQ-F"}],"isRequired":true,"uniqueKey":"data.coverages","typeLabel":"Coverage · object[]"},"exclusions":{"type":"array","description":"List of policy exclusions (i.e., explicit removal of coverage afforded by the policy).","items":{"title":"Exclusion","type":"object","example":{"code":"WIND","label":"Wind Exclusion"},"x-internal":false,"properties":{"code":{"type":"string","title":"Home Exclusions","enum":["WIND"],"isRequired":true,"uniqueKey":"data.exclusions.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.exclusions.items.[INDEX].label","typeLabel":"string"}},"required":["code","label"],"uniqueKey":"data.exclusions.items.[INDEX]","typeLabel":"Exclusion · object"},"example":[{"code":"WIND","label":"Wind Exclusion"}],"isRequired":true,"uniqueKey":"data.exclusions","typeLabel":"Exclusion · object[]"},"properties":{"type":"array","description":"List of properties (such as a vehicle or dwelling) afforded coverage by the policy.","items":{"title":"Property","type":"object","example":{"id":"prp_uSdzLVpi8c76H7kl6AQ-F","type":"vehicle","data":{"vin":"SMTD44GN3HT812287","model":"CR-V","year":"2017","make":"HONDA","use":"pleasure"}},"x-internal":false,"properties":{"id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].id","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","enum":["vehicle","dwelling"],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["vehicle","dwelling"],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].type","typeLabel":"enum\u003cstring> | null"},"data":{"oneOf":[{"type":"object","title":"Dwelling","required":["addressLine1","addressLine2","city","state","postalCode","country","ratedFloodZone","replacementCost"],"x-internal":false,"example":{"addressLine1":"123 Fake St.","addressLine2":"Unit 456","city":"Atlanta","state":"Georgia","postalCode":"30315","country":"USA"},"properties":{"addressLine1":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.addressLine1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.addressLine2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.addressLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.state","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.city","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.postalCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.postalCode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.country","typeLabel":"string | null"},"ratedFloodZone":{"oneOf":[{"type":"string","enum":["A","AE","A1-A30","AH","AO","AR","AR/AE","AR/AO","AR/A","AR/A1-A30","A99","V","VE","V1-V30","B","C","X","D"],"description":"The FEMA designated flood zone that the dwelling resides in. This field is currently only available for flood policies.","example":"X","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.ratedFloodZone.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["A","AE","A1-A30","AH","AO","AR","AR/AE","AR/AO","AR/A","AR/A1-A30","A99","V","VE","V1-V30","B","C","X","D"],"description":"The FEMA designated flood zone that the dwelling resides in. This field is currently only available for flood policies.","example":"X","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.ratedFloodZone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.ratedFloodZone","typeLabel":"enum\u003cstring> | null"},"replacementCost":{"oneOf":[{"type":"number","description":"Beta. The estimated cost of replacing or repairing the dwelling, as specified by the insurance carrier. For flood policies, this is the RCV as specified by FEMA. If the FEMA RCV is not available, this field will return the RCV as specified by the carrier.","example":250000,"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.replacementCost.oneOf.0","typeLabel":"number"},{"type":"null","description":"Beta. The estimated cost of replacing or repairing the dwelling, as specified by the insurance carrier. For flood policies, this is the RCV as specified by FEMA. If the FEMA RCV is not available, this field will return the RCV as specified by the carrier.","example":250000,"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.replacementCost.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0.replacementCost","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.0","typeLabel":"Dwelling · object"},{"type":"object","title":"Vehicle","required":["vin","model","year","make"],"x-internal":false,"example":{"bodyStyle":null,"vin":"SMTD44GN3HT812287","model":"CR-V","year":"2017","make":"HONDA","use":"pleasure"},"properties":{"vin":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.vin.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.vin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.vin","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.model.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.model","typeLabel":"string | null"},"year":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.year.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.year.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.year","typeLabel":"string | null"},"make":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.make.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.make.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.make","typeLabel":"string | null"},"bodyStyle":{"oneOf":[{"type":"string","uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.bodyStyle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.bodyStyle.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.bodyStyle","typeLabel":"string | null"},"use":{"oneOf":[{"type":"string","enum":["pleasure","commute","business","farm"],"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.use.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pleasure","commute","business","farm"],"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.use.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1.use","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data.oneOf.1","typeLabel":"Vehicle · object"}],"isRequired":true,"uniqueKey":"data.properties.items.[INDEX].data","typeLabel":"Dwelling · object | Vehicle · object"}},"required":["id","type","data"],"uniqueKey":"data.properties.items.[INDEX]","typeLabel":"Property · object"},"isRequired":true,"uniqueKey":"data.properties","typeLabel":"Property · object[]"},"insureds":{"type":"array","description":"List of entities (such as an individuals or businesses) afforded direct coverage by the policy.","items":{"title":"Insured","type":"object","example":{"firstName":"Armaan","lastName":"Sikand","dateOfBirthYear":"1993","licenseNo":"•••••7259","licenseState":"GA","dateOfBirth":null,"type":"primary"},"x-internal":false,"properties":{"type":{"oneOf":[{"type":"string","description":"Should be used for display purposes only. All listed insureds are afforded coverage by the policy.","enum":["primary","secondary"],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Should be used for display purposes only. All listed insureds are afforded coverage by the policy.","enum":["primary","secondary"],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].type","typeLabel":"enum\u003cstring> | null"},"firstName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].firstName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].lastName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].lastName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].lastName","typeLabel":"string | null"},"dateOfBirthYear":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].dateOfBirthYear.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].dateOfBirthYear.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].dateOfBirthYear","typeLabel":"string | null"},"licenseNo":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].licenseNo.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].licenseNo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].licenseNo","typeLabel":"string | null"},"licenseState":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].licenseState.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].licenseState.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].licenseState","typeLabel":"string | null"},"dateOfBirth":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].dateOfBirth.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].dateOfBirth.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.insureds.items.[INDEX].dateOfBirth","typeLabel":"string | null"},"property":{"oneOf":[{"type":"string","description":"Unique identifier of Property afforded coverage for specified Insured. If Insured is afforded coverage across all properties on the policy, property will be undefined.","uniqueKey":"data.insureds.items.[INDEX].property.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of Property afforded coverage for specified Insured. If Insured is afforded coverage across all properties on the policy, property will be undefined.","uniqueKey":"data.insureds.items.[INDEX].property.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.insureds.items.[INDEX].property","typeLabel":"string | null"}},"required":["firstName","lastName","type","dateOfBirth","dateOfBirthYear","licenseNo","licenseState"],"uniqueKey":"data.insureds.items.[INDEX]","typeLabel":"Insured · object"},"isRequired":true,"uniqueKey":"data.insureds","typeLabel":"Insured · object[]"},"thirdParties":{"type":"array","description":"List of external parties with interest in the policy.","items":{"title":"Third Party","type":"object","example":{"name":"Super Leasing Trust","type":"lessor","address":{"addressLine1":"Po Box 105205","state":"GA","city":"Atlanta","postalCode":"30348"}},"x-internal":false,"properties":{"type":{"oneOf":[{"type":"string","enum":["lienholder","lessor","interest"],"description":"Should be used for display purposes only. All listed thirdParties have established financial interest in the associated property.","isRequired":true,"uniqueKey":"data.thirdParties.items.[INDEX].type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["lienholder","lessor","interest"],"description":"Should be used for display purposes only. All listed thirdParties have established financial interest in the associated property.","isRequired":true,"uniqueKey":"data.thirdParties.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.thirdParties.items.[INDEX].type","typeLabel":"enum\u003cstring> | null"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.thirdParties.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.thirdParties.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.thirdParties.items.[INDEX].name","typeLabel":"string | null"},"address":{"title":"Address","type":"object","example":{"addressLine1":"123 Fake St.","addressLine2":"Unit 456","city":"Atlanta","state":"Georgia","postalCode":"30315","country":"USA"},"x-internal":false,"properties":{"addressLine1":{"oneOf":[{"type":"string","uniqueKey":"data.thirdParties.items.[INDEX].address.addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.thirdParties.items.[INDEX].address.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.thirdParties.items.[INDEX].address.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","uniqueKey":"data.thirdParties.items.[INDEX].address.addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.thirdParties.items.[INDEX].address.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.thirdParties.items.[INDEX].address.addressLine2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"data.thirdParties.items.[INDEX].address.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.thirdParties.items.[INDEX].address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.thirdParties.items.[INDEX].address.state","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"data.thirdParties.items.[INDEX].address.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.thirdParties.items.[INDEX].address.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.thirdParties.items.[INDEX].address.city","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","uniqueKey":"data.thirdParties.items.[INDEX].address.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.thirdParties.items.[INDEX].address.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.thirdParties.items.[INDEX].address.postalCode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","uniqueKey":"data.thirdParties.items.[INDEX].address.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.thirdParties.items.[INDEX].address.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.thirdParties.items.[INDEX].address.country","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.thirdParties.items.[INDEX].address","typeLabel":"Address · object"},"property":{"oneOf":[{"type":"string","default":"Unique identifier of Property afforded coverage for specified Third Party.","uniqueKey":"data.thirdParties.items.[INDEX].property.oneOf.0","typeLabel":"string"},{"type":"null","default":"Unique identifier of Property afforded coverage for specified Third Party.","uniqueKey":"data.thirdParties.items.[INDEX].property.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.thirdParties.items.[INDEX].property","typeLabel":"string | null"}},"required":["type","name","address"],"uniqueKey":"data.thirdParties.items.[INDEX]","typeLabel":"Third Party · object"},"isRequired":true,"uniqueKey":"data.thirdParties","typeLabel":"Third Party · object[]"},"documents":{"type":"array","description":"List of documents (such as declaration pages and policy agreements) associated with the policy.","items":{"title":"Document","type":"object","example":{"source":"carrier","name":"Declaration Page","type":["declaration-page"],"url":"\u003csigned-url>","id":"doc_jd73dw6fn02sj28.pdf","issuedDate":"2022-01-01T00:00:00.000Z","effectiveDate":"2022-01-02T00:00:00.000Z","createdAt":"2022-01-01T00:00:00.000Z"},"properties":{"source":{"type":"string","description":"The source of the document. Note, user documents are unverified by Axle.","enum":["carrier","user"],"isRequired":true,"uniqueKey":"data.documents.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Name of the document, as specified by carrier or user.","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].name","typeLabel":"string"},"url":{"type":"string","description":"URL for document access. Note, the URL is signed and has an expiry of 60 minutes.","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].url","typeLabel":"string"},"createdAt":{"type":"string","description":"ISO 8601 timestamp at which the document was fetched or shared via Axle.","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].createdAt","typeLabel":"string"},"type":{"type":"array","description":"The type of information contained in the document, as specified by carrier or user. A document may have multiple types.","items":{"type":"string","enum":["declaration-page","id-card","policy-agreement"],"uniqueKey":"data.documents.items.[INDEX].type.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"data.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>[]"},"issuedDate":{"type":"string","description":"If available, ISO 8601 timestamp at which the document was generated or issued by the carrier.","uniqueKey":"data.documents.items.[INDEX].issuedDate","typeLabel":"string"},"effectiveDate":{"type":"string","description":"If available, ISO 8601 timestamp at which the document becomes active or goes into effect.","uniqueKey":"data.documents.items.[INDEX].effectiveDate","typeLabel":"string"},"id":{"type":"string","description":"Unique identifier (formatted as filename) for the document.","uniqueKey":"data.documents.items.[INDEX].id","typeLabel":"string"}},"required":["source","name","url","createdAt"],"uniqueKey":"data.documents.items.[INDEX]","typeLabel":"Document · object"},"isRequired":true,"uniqueKey":"data.documents","typeLabel":"Document · object[]"},"createdAt":{"type":"string","description":"ISO 8601 timestamp at which the Policy object was generated via Axle.","example":"2022-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string"},"modifiedAt":{"type":"string","description":"ISO 8601 timestamp at which the Policy object was modified via Axle. The Policy object is modified only when there are differences between the current Policy and new Policy data requested from the carrier.","example":"2022-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.modifiedAt","typeLabel":"string"},"refreshedAt":{"type":"string","description":"ISO 8601 timestamp at which the Policy object was refreshed via Axle. The Policy object is refreshed only when Axle successfully requests new Policy data from the carrier.","example":"2022-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.refreshedAt","typeLabel":"string"},"isActive":{"oneOf":[{"type":"boolean","description":"Active status of the policy, as specified by the insurance carrier. If an Ignition session is completed with result `manual`, this field will be undefined.","example":true,"uniqueKey":"data.isActive.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Active status of the policy, as specified by the insurance carrier. If an Ignition session is completed with result `manual`, this field will be undefined.","example":true,"uniqueKey":"data.isActive.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.isActive","typeLabel":"boolean | null"},"result":{"type":"string","description":"Appears on Policy only and is an Ignition completion type that describes the high-level Policy outcome. See \u003ca href=\"/guides/completion-types#result\" className=\"no-underline\">result\u003c/a> for more details.","enum":["basic","link","manual","proxy"],"example":"link","uniqueKey":"data.result","typeLabel":"enum\u003cstring>"},"resultDetail":{"type":"string","description":"Identifies the process that describes how each Ignition was completed in detail. See \u003ca href=\"/guides/completion-types#resultdetail\" className=\"no-underline\">resultDetail\u003c/a> for more details.","enum":["basic","credit-card-form","document-ai-declarations-page","document-ai-id-card","document-ai-push-through","manual-form","policy-lookup","policy-lookup-no-comp-coll","policy-lookup-no-lienholder","policy-lookup-summary","user-portal-login"],"example":"user-portal-login","uniqueKey":"data.resultDetail","typeLabel":"enum\u003cstring>"}},"required":["id","account","type","carrier","policyNumber","effectiveDate","expirationDate","policyStatus","premium","amountDue","underwriter","address","coverages","exclusions","properties","insureds","thirdParties","documents","createdAt","modifiedAt","refreshedAt"],"uniqueKey":"data","typeLabel":"Policy · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":"pol_CbxGmGWnp9bGAFCC-eod2","account":"acc_gM2wn_gaqUv76ZljeVXOv","type":"auto","carrier":"state-farm","policyNumber":"123456789","effectiveDate":"2022-10-22T04:00:00.000Z","expirationDate":"2023-10-22T04:00:00.000Z","policyStatus":{"cancellationDate":"2023-03-15T04:00:00.000Z","cancellationReason":"non-payment"},"premium":999.99,"amountDue":125.5,"underwriter":{"name":"John Doe","naicCode":"12345"},"address":{"addressLine1":"123 Fake St.","addressLine2":"Unit 456","city":"Atlanta","state":"Georgia","postalCode":"30315","country":"USA"},"coverages":[{"code":"BI","label":"Bodily Injury","limitPerPerson":250000,"limitPerAccident":500000},{"code":"PD","label":"Property Damage","limitPerAccident":100000},{"code":"COMP","label":"Comprehensive","deductible":375,"property":"prp_uSdzLVpi8c76H7kl6AQ-F"},{"code":"COLL","label":"Collision","deductible":375,"property":"prp_uSdzLVpi8c76H7kl6AQ-F"},{"code":"UMBI","label":"Uninsured Bodily Injury","limitPerPerson":100000,"limitPerAccident":300000,"property":"prp_uSdzLVpi8c76H7kl6AQ-F"}],"exclusions":[{"code":"WIND","label":"Wind Exclusion"}],"properties":[{"id":"prp_uSdzLVpi8c76H7kl6AQ-F","type":"vehicle","data":{"vin":"SMTD44GN3HT812287","model":"CR-V","year":"2017","make":"HONDA","use":"pleasure"}}],"insureds":[{"firstName":"Armaan","lastName":"Sikand","dateOfBirthYear":"1993","licenseNo":"•••••7259","licenseState":"GA","dateOfBirth":null,"type":"primary"}],"thirdParties":[{"name":"Super Leasing Trust","type":"lessor","address":{"addressLine1":"Po Box 105205","state":"GA","city":"Atlanta","postalCode":"30348"}}],"documents":[{"source":"carrier","name":"Declaration Page","type":["declaration-page"],"url":"\u003csigned-url>","id":"doc_jd73dw6fn02sj28.pdf","issuedDate":"2022-01-01T00:00:00.000Z","effectiveDate":"2022-01-02T00:00:00.000Z","createdAt":"2022-01-01T00:00:00.000Z"}],"createdAt":"2022-01-01T00:00:00.000Z","modifiedAt":"2022-01-01T00:00:00.000Z","refreshedAt":"2022-01-01T00:00:00.000Z","isActive":true,"result":"link","resultDetail":"user-portal-login"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f46fc33f-a8e1-403f-92f1-8eb5cdda1279":{"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"},"456fc619-94c9-4d15-8f75-55262f76e106":{"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 provided `x-access-token` is invalid, expired, or not authorized for the requested resource.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"3618e9c4-858a-4e19-ac45-d7964785e808":{"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":"Requested entity or resource not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Requested entity not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Requested entity not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"e5573302-2d33-4d6b-b1b1-8089421001f8":{"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":{"bb75e395-5f65-4165-a443-4e2b58c1a59a":{"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":{"3d81c19b-4e35-4132-a730-b4bf9c69526c":{"description":"Sandbox","url":"https://sandbox.axle.insure"},"2686c353-be7f-49a8-ab59-adbc6d1ac376":{"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":"Get Policy - Axle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T15:26:01.162Z","originalFileLocation":"api-reference/policies/get-policy.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=\"The Get Policy endpoint returns a Policy object. Please refer to the Policy object for a detailed description of each field. Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.\">\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=\"Get Policy - Axle\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Get Policy endpoint returns a Policy object. Please refer to the Policy object for a detailed description of each field. Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Axle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.axle.insure/api-reference/policies/get-policy\">\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=Policies\u0026amp;title=Get+Policy\u0026amp;description=The+Get+Policy+endpoint+returns+a+Policy+object.+Please+refer+to+the+%5BPolicy%5D%28%2Fapi-reference%2Fpolicies%2Fpolicy%29+object+for+a+detailed+description+of+each+field.%0AP\u0026amp;theme=89b4b8c22e9e1c87b956c02e\u0026amp;signature=575b98016bb6b110ece0609c3280c06ce6fb01678541675e1ea07a858d6c53c0\">\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=\"Get Policy - Axle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Get Policy endpoint returns a Policy object. Please refer to the Policy object for a detailed description of each field. Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://axle.mintlify.app/_mintlify/api/og/v2?division=Policies\u0026amp;title=Get+Policy\u0026amp;description=The+Get+Policy+endpoint+returns+a+Policy+object.+Please+refer+to+the+%5BPolicy%5D%28%2Fapi-reference%2Fpolicies%2Fpolicy%29+object+for+a+detailed+description+of+each+field.%0AP\u0026amp;theme=89b4b8c22e9e1c87b956c02e\u0026amp;signature=575b98016bb6b110ece0609c3280c06ce6fb01678541675e1ea07a858d6c53c0\">\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/policies/get-policy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/policies/get-policy.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/policies/get-policy#webpage\",\"url\":\"https://docs.axle.insure/api-reference/policies/get-policy\",\"name\":\"Get Policy\",\"description\":\"The Get Policy endpoint returns a Policy object. Please refer to the Policy object for a detailed description of each field. Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.\",\"dateModified\":\"2025-08-07T15:26:01.162Z\",\"isPartOf\":{\"@id\":\"https://docs.axle.insure#website\"},\"breadcrumb\":{\"@id\":\"https://docs.axle.insure/api-reference/policies/get-policy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.axle.insure/api-reference/policies/get-policy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.axle.insure/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Policies\",\"item\":\"https://docs.axle.insure/api-reference/policies/policy\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Policy\",\"item\":\"https://docs.axle.insure/api-reference/policies/get-policy\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.axle.insure/api-reference/policies/get-policy#apireference\",\"headline\":\"Get Policy\",\"name\":\"Get Policy\",\"description\":\"The Get Policy endpoint returns a Policy object. Please refer to the Policy object for a detailed description of each field. Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.\",\"url\":\"https://docs.axle.insure/api-reference/policies/get-policy\",\"mainEntityOfPage\":{\"@id\":\"https://docs.axle.insure/api-reference/policies/get-policy#webpage\"},\"dateModified\":\"2025-08-07T15:26:01.162Z\",\"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","description":"This page provides additional detail about the Axle Schema's insurance coverage types and highlights key rules and checks used to ensure accurate data. Coverages are provided through the `coverages` array in Policy objects.\n","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","description":"The Get Policy Report endpoint returns a PDF or image report of the requested Policy object. Please refer to the [Policy](/api-reference/policies/policy) object for a detailed description of each field.","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":"Get Policy - Axle","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}