Canopy Connect Components is a set of prebuilt UI components for building your authentication flow. It tokenizes the credentials within a Component without having them touch your server.
Installation
Include Canopy Connect Components in your application, you can do so through the following methods:
Note: this is a UMD module, if RequireJS/AMD are defined, they will be used. Otherwise CanopyConnectComponents will be set on the window.
🚧
Subresource Integrity (SRI) verification
Do not use Subresource Integrity (SRI) verification in the script tag. Canopy Connect may deploy updates and improvements to Components. Using a Subresource Integrity check will fail when we deploy updates to Components.
Form fields are fully customizable. Learn more here.
Then, use your form to mount the available input fields:
const { username, password, thirdfield } = form.components;
form.on('ready', () => {
// components are mounted and ready for input
});
if (username) {
username.mount("#username"); // Use any selector or element object
}
if (password) {
password.mount("#password"); // Use any selector or element object
}
if (thirdfield) {
thirdfield.mount("#thirdfield"); // Use any selector or element object
}
Then, let your user enter their credentials and provide them with a button to submit those credentials.
document.getElementById("your-submit-button").on("click", async () => {
const { errors, tokens } = await form.submit();
if (errors) {
// display form errors
return;
}
const { username, password, thirdfield } = tokens;
// submit the tokens to POST /consentAndConnect or POST /connect
});
Example
\n```\n\nNote: this is a UMD module, if RequireJS/AMD are defined, they will be used. Otherwise `CanopyConnectComponents` will be set on the `window`.\n\n> 🚧 Subresource Integrity (SRI) verification\n> \n> Do not use Subresource Integrity (SRI) verification in the script tag. Canopy Connect may deploy updates and improvements to Components. Using a Subresource Integrity check will fail when we deploy updates to Components.\n\n\n\n\n\nDynamic\n\n```javascript\nconst script = document.createElement('script');\nscript.src = \"https://components.usecanopy.com/v1/cc-components.js\";\ndocument.head.append(script);\nscript.onerror = () => {\n // handle failure attempt\n};\n```\n\n\n\n## Usage\n\nInitialize a Components Form:\n\n```javascript\nconst form = CanopyConnectComponents.form(options)\n```\n\nFor available Form options, refer to the [Reference Documentation](https://docs.usecanopy.com/reference/components-reference-documentation#formoptions)\n\n> 📘 Form fields are fully customizable. Learn more [here](https://docs.usecanopy.com/reference/components-customization).\n\nThen, use your `form` to mount the available input fields:\n\n```javascript\nconst { username, password, thirdfield } = form.components;\n\nform.on('ready', () => {\n // components are mounted and ready for input\n});\n\nif (username) {\n username.mount(\"#username\"); // Use any selector or element object\n}\n\nif (password) {\n password.mount(\"#password\"); // Use any selector or element object\n}\n\nif (thirdfield) {\n thirdfield.mount(\"#thirdfield\"); // Use any selector or element object\n}\n```\n\nFor more FieldComponent methods and events, refer to the [Reference Documentation](https://docs.usecanopy.com/reference/components-reference-documentation#fieldcomponent)\n\nThen, let your user enter their credentials and provide them with a button to submit those credentials.\n\n```javascript\ndocument.getElementById(\"your-submit-button\").on(\"click\", async () => {\n const { errors, tokens } = await form.submit();\n if (errors) {\n // display form errors\n return;\n }\n const { username, password, thirdfield } = tokens;\n // submit the tokens to POST /consentAndConnect or POST /connect\n});\n```\n\n## Example\n\n\n\n\n[block:embed]\n{\n \"html\": false,\n \"url\": \"https://codepen.io/MarcL01/embed/VwEGXzW?default-tab=js%2Cresult&editable=true&theme-id=dark\",\n \"href\": \"https://codepen.io/MarcL01/embed/VwEGXzW?default-tab=js%2Cresult&editable=true&theme-id=dark\",\n \"typeOfEmbed\": \"iframe\",\n \"height\": \"700px\",\n \"width\": \"100%\",\n \"iframe\": true,\n \"provider\": \"embed\"\n}\n[/block]","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"using-components","slugUpdatedAt":"2023-04-05T21:51:51.936Z","revision":47,"user":"623a63c9c71e640047e413a5","project":"623a6404d574c300a2422b00","category":{"_id":"642ded3fcec4620042a0598f","title":"COMPONENTS","slug":"components","order":7,"reference":true,"project":"623a6404d574c300a2422b00","version":"623a6406d574c300a2422b05","createdAt":"2023-04-05T21:50:55.259Z","__v":0,"type":"reference","id":"642ded3fcec4620042a0598f"},"createdAt":"2023-04-05T21:51:23.900Z","updatedAt":"2023-05-31T20:42:52.395Z","version":{"pdfStatus":"","source":"readme","_id":"623a6406d574c300a2422b05","version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["623a6406d574c300a2422b07","623a6406d574c300a2422b07","623a6406d574c300a2422b0d","623a65628ac59d016eabdc45","623a658ea60539008d9d1812","623a65a1faffe300430b0b26","623a66b9ffeae1011afb4af4","623a67c144a2db00a23d7a5d","623a683a5b3015002e3a6876","623a68aa1bc46901226e183d","623a69f6c5b849003a79fb0e","623a6a96ffeae1011afb4c27","623a76b5ec36a9001acaf878","623b3d08befa3e064ba2f953","623b4fc0936803002aede6cc","623b4fc74af8e302886cae8d","623bdb37734dd9002aa9dd66","623cdff774905100137222f2","623d210882d4b2003ee3748e","623d266ee5791d0020cdb9c1","623e039228681b002df114d4","623e085cdfa05f00226547e8","623e097ca90b8500a2dde7a9","623e1b363b841b003372efda","628d3b49adbfa30ea3852ef3","628fd6c9df10a10014bd21ad","62be22d4a1bed900a773fea7","62e07715a75911001320381e","6376bf5e127d99000317414d","6426118b53f469007abb1fc8","642ded3fcec4620042a0598f","642f255f59896d004184f334","647b30ff4924200037f6b7af","647b489e1f674f000c782871"],"project":"623a6404d574c300a2422b00","releaseDate":"2022-03-23T00:04:22.444Z","createdAt":"2022-03-23T00:04:22.444Z","__v":2,"apiRegistries":[]},"__v":2,"parentDoc":null,"isApi":false,"tutorials":[],"id":"642ded5b38f0cf063a763399"},"glossaryTerms":[{"_id":"623a6404d574c300a2422b01","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"hideTOC":false,"loginUrl":"https://dash.readme.com/to/canopy-connect","meta":{"_id":"642ded5b38f0cf063a763399","description":"Canopy Connect Components is a set of prebuilt UI components for building your authentication flow. It tokenizes the credentials within a Component without having them touch your server. Installation Include Canopy Connect Components in your application, you can do so through the following methods: ...","hidden":false,"image":[],"keywords":"","metaTitle":"Getting Started","parent":null,"robots":"index","slug":"components-getting-started","title":"Getting Started","type":"reference"},"oasDefinition":null,"oasPublicUrl":null,"oauth":false,"rdmd":{"baseUrl":"/","body":"Canopy Connect Components is a set of prebuilt UI components for building your authentication flow. It tokenizes the credentials within a Component without having them touch your server.\n\n## Installation\n\nInclude Canopy Connect Components in your application, you can do so through the following methods:\n\n\n\nStatic\n\n```html\n\n```\n\nNote: this is a UMD module, if RequireJS/AMD are defined, they will be used. Otherwise `CanopyConnectComponents` will be set on the `window`.\n\n> 🚧 Subresource Integrity (SRI) verification\n> \n> Do not use Subresource Integrity (SRI) verification in the script tag. Canopy Connect may deploy updates and improvements to Components. Using a Subresource Integrity check will fail when we deploy updates to Components.\n\n\n\n\n\nDynamic\n\n```javascript\nconst script = document.createElement('script');\nscript.src = \"https://components.usecanopy.com/v1/cc-components.js\";\ndocument.head.append(script);\nscript.onerror = () => {\n // handle failure attempt\n};\n```\n\n\n\n## Usage\n\nInitialize a Components Form:\n\n```javascript\nconst form = CanopyConnectComponents.form(options)\n```\n\nFor available Form options, refer to the [Reference Documentation](https://docs.usecanopy.com/reference/components-reference-documentation#formoptions)\n\n> 📘 Form fields are fully customizable. Learn more [here](https://docs.usecanopy.com/reference/components-customization).\n\nThen, use your `form` to mount the available input fields:\n\n```javascript\nconst { username, password, thirdfield } = form.components;\n\nform.on('ready', () => {\n // components are mounted and ready for input\n});\n\nif (username) {\n username.mount(\"#username\"); // Use any selector or element object\n}\n\nif (password) {\n password.mount(\"#password\"); // Use any selector or element object\n}\n\nif (thirdfield) {\n thirdfield.mount(\"#thirdfield\"); // Use any selector or element object\n}\n```\n\nFor more FieldComponent methods and events, refer to the [Reference Documentation](https://docs.usecanopy.com/reference/components-reference-documentation#fieldcomponent)\n\nThen, let your user enter their credentials and provide them with a button to submit those credentials.\n\n```javascript\ndocument.getElementById(\"your-submit-button\").on(\"click\", async () => {\n const { errors, tokens } = await form.submit();\n if (errors) {\n // display form errors\n return;\n }\n const { username, password, thirdfield } = tokens;\n // submit the tokens to POST /consentAndConnect or POST /connect\n});\n```\n\n## Example\n\n\n\n\n[block:embed]\n{\n \"html\": false,\n \"url\": \"https://codepen.io/MarcL01/embed/VwEGXzW?default-tab=js%2Cresult&editable=true&theme-id=dark\",\n \"href\": \"https://codepen.io/MarcL01/embed/VwEGXzW?default-tab=js%2Cresult&editable=true&theme-id=dark\",\n \"typeOfEmbed\": \"iframe\",\n \"height\": \"700px\",\n \"width\": \"100%\",\n \"iframe\": true,\n \"provider\": \"embed\"\n}\n[/block]","dehydrated":{"body":"","toc":""},"mdx":false,"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{}},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"baseUrl":"/","terms":[{"_id":"623a6404d574c300a2422b01","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-id","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f6"},{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-secret","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f7"}]}},"terms":[{"_id":"623a6404d574c300a2422b01","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-id","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f6"},{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-secret","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f7"}]}},"slugUrl":"/reference/components-getting-started","suggestedEdits":true,"variables":{"defaults":[{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-id","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f6"},{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-secret","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f7"}],"user":{}},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"liveblocks":{"copilotId":"co_11Q0l0JJlkcBhhAYUFh8s"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.420.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"623a6404d574c300a2422b01","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-id","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f6"},{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-secret","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f7"}]},"project":{"_id":"623a6404d574c300a2422b00","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#1B1CD6","main_alt":"","header_text":"","body_highlight":"#1B1CD6","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"gradient","img":[],"img_size":"auto","img_pos":"tl","linkStyle":"buttons"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":false,"referenceLayout":"row","link_logo_to_url":false,"theme":"line","overlay":"triangles","landing":true,"sticky":false,"hide_logo":true,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/7a05ff2-small-canopy-connect-logo23-blue.png","7a05ff2-small-canopy-connect-logo23-blue.png",276,80,"#000000","https://files.readme.io/1d43a5b-canopy-connect-logo23-blue.png","65057021020aed005947700c"],"loginLogo":[],"logo_white":["https://files.readme.io/2ca8777-small-canopy-connect-logo23-white.png","2ca8777-small-canopy-connect-logo23-white.png",276,80,"#ffffff","https://files.readme.io/971b0f5-canopy-connect-logo23-white.png","65056edd006e9a002636553b"],"logo_white_use":false,"favicon":["https://files.readme.io/b2b17f7-small-maskable_icon_x640.png","b2b17f7-small-maskable_icon_x640.png",32,32,"#000000","https://files.readme.io/7db0e30-maskable_icon_x640.png"],"stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"docs","buttonSecondary":"reference"},"title":"The Canopy Connect Developer Hub","text":"Access fully structured and verified personal and commercial P&C insurance data via API. \n\nGo live fast with our SDKs.\n\nTo gain access to the Canopy Connect API, create a [Canopy Connect account](https://usecanopy.com/).","_id":"623a6404d574c300a2422b02"}],"colorScheme":"system","logo_large":true,"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false,"ai_dropdown":"disabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","perplexity":"enabled","view_as_markdown":"enabled"},"showPageIcons":true,"layout":{"full_width":false,"style":"classic"}},"custom_domain":"docs.usecanopy.com","childrenProjects":[],"derivedPlan":"startup2018","description":"Canopy Connect's API is the fastest way to collect and verify insurance information.","isExternalSnippetActive":false,"error404":"","experiments":[],"first_page":"reference","flags":{"allow_hub2":false,"enterprise":false,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":false,"newEditor":true,"newEditorDash":true,"oldMarkdown":false,"newMarkdownBetaProgram":true,"useReactApp":true,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"graphql":false,"allowApiExplorerJsonEditor":false,"singleProjectEnterprise":false,"dashReact":false,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"dashQuickstart":false,"git":{"read":false,"write":false},"superHubBeta":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false,"superHubPreview":false,"maskErrorMessages":true},"fullBaseUrl":"https://docs.usecanopy.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[{"_id":"623a6404d574c300a2422b01","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"links"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"planLimit":1000000,"thumbsEnabled":true,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":false,"examples":true,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"name":"Canopy Connect","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":false,"domain":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"startup2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":false,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":114},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"623a6406d574c300a2422b05","version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["623a6406d574c300a2422b07","623a6406d574c300a2422b07","623a6406d574c300a2422b0d","623a65628ac59d016eabdc45","623a658ea60539008d9d1812","623a65a1faffe300430b0b26","623a66b9ffeae1011afb4af4","623a67c144a2db00a23d7a5d","623a683a5b3015002e3a6876","623a68aa1bc46901226e183d","623a69f6c5b849003a79fb0e","623a6a96ffeae1011afb4c27","623a76b5ec36a9001acaf878","623b3d08befa3e064ba2f953","623b4fc0936803002aede6cc","623b4fc74af8e302886cae8d","623bdb37734dd9002aa9dd66","623cdff774905100137222f2","623d210882d4b2003ee3748e","623d266ee5791d0020cdb9c1","623e039228681b002df114d4","623e085cdfa05f00226547e8","623e097ca90b8500a2dde7a9","623e1b363b841b003372efda","628d3b49adbfa30ea3852ef3","628fd6c9df10a10014bd21ad","62be22d4a1bed900a773fea7","62e07715a75911001320381e","6376bf5e127d99000317414d","6426118b53f469007abb1fc8","642ded3fcec4620042a0598f","642f255f59896d004184f334","647b30ff4924200037f6b7af","647b489e1f674f000c782871"],"project":"623a6404d574c300a2422b00","releaseDate":"2022-03-23T00:04:22.444Z","createdAt":"2022-03-23T00:04:22.444Z","__v":2},"subdomain":"canopy-connect","subpath":"","superHubWaitlist":false,"topnav":{"left":[],"right":[{"type":"url","text":"Canopy Connect Home","url":"https://usecanopy.com"},{"type":"url","text":"Developer Plans","url":"https://www.usecanopy.com/api/api-pricing"},{"type":"url","text":"Request Access","url":"https://www.usecanopy.com/api/developer-account"},{"type":"url","text":"Agent Help","url":"https://help.usecanopy.com/"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2022-04-06T00:04:20.876Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://usecanopy.com","versions":[{"_id":"623a6406d574c300a2422b05","version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["623a6406d574c300a2422b07","623a6406d574c300a2422b07","623a6406d574c300a2422b0d","623a65628ac59d016eabdc45","623a658ea60539008d9d1812","623a65a1faffe300430b0b26","623a66b9ffeae1011afb4af4","623a67c144a2db00a23d7a5d","623a683a5b3015002e3a6876","623a68aa1bc46901226e183d","623a69f6c5b849003a79fb0e","623a6a96ffeae1011afb4c27","623a76b5ec36a9001acaf878","623b3d08befa3e064ba2f953","623b4fc0936803002aede6cc","623b4fc74af8e302886cae8d","623bdb37734dd9002aa9dd66","623cdff774905100137222f2","623d210882d4b2003ee3748e","623d266ee5791d0020cdb9c1","623e039228681b002df114d4","623e085cdfa05f00226547e8","623e097ca90b8500a2dde7a9","623e1b363b841b003372efda","628d3b49adbfa30ea3852ef3","628fd6c9df10a10014bd21ad","62be22d4a1bed900a773fea7","62e07715a75911001320381e","6376bf5e127d99000317414d","6426118b53f469007abb1fc8","642ded3fcec4620042a0598f","642f255f59896d004184f334","647b30ff4924200037f6b7af","647b489e1f674f000c782871"],"project":"623a6404d574c300a2422b00","releaseDate":"2022-03-23T00:04:22.444Z","createdAt":"2022-03-23T00:04:22.444Z","__v":2}],"variableDefaults":[{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-id","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f6"},{"apiSetting":"623e1b363b841b003372efd9","name":"x-canopy-client-secret","source":"security","type":"apiKey","_id":"6871a21e34db2b874d8560f7"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"1.0.0"},"description":"Canopy Connect's API is the fastest way to collect and verify insurance information.","glossary":[{"_id":"623a6404d574c300a2422b01","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"homepage_url":"https://usecanopy.com","id":"623a6404d574c300a2422b00","name":"Canopy Connect","parent":null,"redirects":[],"sitemap":"disabled","llms_txt":"disabled","subdomain":"canopy-connect","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"x-canopy-client-id","source":"security","type":"apiKey","id":"6871a21e34db2b874d8560f6"},{"name":"x-canopy-client-secret","source":"security","type":"apiKey","id":"6871a21e34db2b874d8560f7"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"disabled"},"mcp":{},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"openapi":"admin","password":null,"view":"public"},"refactored":{"status":"disabled","migrated":"unknown"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"startup2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2022-04-06T00:04:20.876Z"}},"reference":{"api_sdk_snippets":"disabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed","sdk_snippets":{"external":"disabled"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"postman":{"key":null,"client_id":null,"client_secret":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"speakeasy":{"key":null,"spec_url":null},"stainless":{"key":null,"name":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}},"branches":{"merge":{"admin":true}}},"appearance":{"brand":{"primary_color":"#1B1CD6","link_color":"#1B1CD6","theme":"system"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"layout":{"full_width":"disabled","style":"classic"},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"hide"},"logo":{"size":"large","dark_mode":{"uri":"/images/65056edd006e9a002636553b","url":"https://files.readme.io/2ca8777-small-canopy-connect-logo23-white.png","name":"2ca8777-small-canopy-connect-logo23-white.png","width":276,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/971b0f5-canopy-connect-logo23-white.png"}},"main":{"uri":"/images/65057021020aed005947700c","url":"https://files.readme.io/7a05ff2-small-canopy-connect-logo23-blue.png","name":"7a05ff2-small-canopy-connect-logo23-blue.png","width":276,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/1d43a5b-canopy-connect-logo23-blue.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/b2b17f7-small-maskable_icon_x640.png","name":"b2b17f7-small-maskable_icon_x640.png","width":32,"height":32,"color":"#000000","links":{"original_url":"https://files.readme.io/7db0e30-maskable_icon_x640.png"}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":null,"link_style":"buttons","overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"ai":{"dropdown":"disabled","options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","view_as_markdown":"enabled"}},"navigation":{"first_page":"reference","left":[],"logo_link":"landing_page","page_icons":"enabled","right":[{"type":"link_url","title":"Canopy Connect Home","url":"https://usecanopy.com","custom_page":null},{"type":"link_url","title":"Developer Plans","url":"https://www.usecanopy.com/api/api-pricing","custom_page":null},{"type":"link_url","title":"Request Access","url":"https://www.usecanopy.com/api/developer-account","custom_page":null},{"type":"link_url","title":"Agent Help","url":"https://help.usecanopy.com/","custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"disabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}},"git":{"connection":{"repository":{},"organization":null,"status":"inactive"}}}},"version":{"_id":"623a6406d574c300a2422b05","version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["623a6406d574c300a2422b07","623a6406d574c300a2422b07","623a6406d574c300a2422b0d","623a65628ac59d016eabdc45","623a658ea60539008d9d1812","623a65a1faffe300430b0b26","623a66b9ffeae1011afb4af4","623a67c144a2db00a23d7a5d","623a683a5b3015002e3a6876","623a68aa1bc46901226e183d","623a69f6c5b849003a79fb0e","623a6a96ffeae1011afb4c27","623a76b5ec36a9001acaf878","623b3d08befa3e064ba2f953","623b4fc0936803002aede6cc","623b4fc74af8e302886cae8d","623bdb37734dd9002aa9dd66","623cdff774905100137222f2","623d210882d4b2003ee3748e","623d266ee5791d0020cdb9c1","623e039228681b002df114d4","623e085cdfa05f00226547e8","623e097ca90b8500a2dde7a9","623e1b363b841b003372efda","628d3b49adbfa30ea3852ef3","628fd6c9df10a10014bd21ad","62be22d4a1bed900a773fea7","62e07715a75911001320381e","6376bf5e127d99000317414d","6426118b53f469007abb1fc8","642ded3fcec4620042a0598f","642f255f59896d004184f334","647b30ff4924200037f6b7af","647b489e1f674f000c782871"],"project":"623a6404d574c300a2422b00","releaseDate":"2022-03-23T00:04:22.444Z","createdAt":"2022-03-23T00:04:22.444Z","__v":2}},"is404":false,"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/reference/components-getting-started","version":{"_id":"623a6406d574c300a2422b05","version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["623a6406d574c300a2422b07","623a6406d574c300a2422b07","623a6406d574c300a2422b0d","623a65628ac59d016eabdc45","623a658ea60539008d9d1812","623a65a1faffe300430b0b26","623a66b9ffeae1011afb4af4","623a67c144a2db00a23d7a5d","623a683a5b3015002e3a6876","623a68aa1bc46901226e183d","623a69f6c5b849003a79fb0e","623a6a96ffeae1011afb4c27","623a76b5ec36a9001acaf878","623b3d08befa3e064ba2f953","623b4fc0936803002aede6cc","623b4fc74af8e302886cae8d","623bdb37734dd9002aa9dd66","623cdff774905100137222f2","623d210882d4b2003ee3748e","623d266ee5791d0020cdb9c1","623e039228681b002df114d4","623e085cdfa05f00226547e8","623e097ca90b8500a2dde7a9","623e1b363b841b003372efda","628d3b49adbfa30ea3852ef3","628fd6c9df10a10014bd21ad","62be22d4a1bed900a773fea7","62e07715a75911001320381e","6376bf5e127d99000317414d","6426118b53f469007abb1fc8","642ded3fcec4620042a0598f","642f255f59896d004184f334","647b30ff4924200037f6b7af","647b489e1f674f000c782871"],"project":"623a6404d574c300a2422b00","releaseDate":"2022-03-23T00:04:22.444Z","createdAt":"2022-03-23T00:04:22.444Z","__v":2}}">
