Canopy Connect

Canopy Connect Whitelabel API

Allows you to create a fully whitelabeled experience

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /tos Get the current terms of service · GET /tos #
Ask an LLM
“Which terms version should my white-label consent screen show?”
“Where do I get the terms of service HTML for my own branded flow?”
Tell an agent
Fetch the current terms of service version and HTML.
Get the terms text to display before asking for consent.
POST /widget/pull/consentAndConnect Record consent, create a pull and log in to a carrier · POST /consentAndConnect #
Ask an LLM
“How do I start a pull with my own UI by submitting consent and the user's carrier login?”
“Can I save my own metadata on a pull when it's created?”
Tell an agent
Create a pull on widget {alias} for carrier {carrier} with username token {username}, consent from {device} on terms {version} with wording {language}.
Connect to carrier {carrier} with username token {username} and password token {password}.
POST /widget/pull/consentAndDocuments Record consent, create a pull and upload documents · POST /consentAndDocuments #
Ask an LLM
“Can a consumer upload their insurance documents instead of logging in to their carrier?”
“What are the file size limits when uploading policy documents to a new pull?”
Tell an agent
Create a pull on widget {alias} with documents {documents}, consent from {device} on terms {version} with wording {language}.
Upload {documents} as carrier {carrier} policy documents.
POST /widget/pull/{pullId}/connect Reauthenticate a pull with new credentials · POST /connect #
Ask an LLM
“What do I do when a pull says it's not authenticated?”
“How do I resubmit a consumer's carrier login for an existing pull?”
Tell an agent
Reconnect pull {pull} using JWT {jwt} with carrier {carrier} and username token {username}.
Retry login on pull {pull} with password token {password}.
GET /carriers List supported insurance carriers · GET /carriers #
Ask an LLM
“Which insurance carriers can consumers connect to?”
“Can I list only carriers that support particular products like auto or home?”
Tell an agent
List supported carriers.
List carriers that offer {products}.
GET /carriers/{carrierId} Get one supported carrier · GET /carriers/:carrierId #
Ask an LLM
“How do I look up the details of a single insurance carrier?”
“What UI attributes are returned for a specific carrier?”
Tell an agent
Get carrier {carrier}.
Show carrier {carrier} as configured on widget {alias}.
POST /widget/pull/{pullId}/idv Submit an MFA code for a pull · POST /idv #
Ask an LLM
“How do I pass along the verification code a carrier texted the consumer?”
“What happens when a pull is waiting on identity verification?”
Tell an agent
Submit MFA code {code} for pull {pull} with JWT {jwt}.
Send verification code {code} to finish logging in pull {pull}.
POST /widget/pull/{pullId}/idvoptions Choose how to receive an MFA code · POST /idvoptions #
Ask an LLM
“Can the consumer pick whether the carrier sends the code by text or email?”
“What do I send when a pull asks for identity verification options?”
Tell an agent
Select MFA option {option} for pull {pull} with JWT {jwt}.
Choose delivery method {option} for the verification code on pull {pull}.
POST /widget/pull/reconnectToken Reconnect a monitored pull with a token · POST /reconnectToken #
Ask an LLM
“How does a consumer resume a monitored connection that needs their input?”
“What do I do with a reconnect token in my own flow?”
Tell an agent
Reconnect the monitored pull using token {token}.
Redeem reconnect token {token} so the user can fix their connection.
POST /widget/pull/{pullId}/servicingAction Confirm or reject a servicing action · POST /servicingAction #
Ask an LLM
“How does a consumer approve a requested change on their policy?”
“Can the user decline a servicing action instead of confirming it?”
Tell an agent
Confirm servicing action {action} on pull {pull} with JWT {jwt}.
Set servicing action {action} on pull {pull} to confirmed {confirmed}.

Documentation

📖
Documentation
https://docs.usecanopy.com/reference/getting-started
📖
APIReference
https://docs.usecanopy.com/reference
📖
GettingStarted
https://docs.usecanopy.com/reference/getting-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/authentication/canopy-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/rate-limits/canopy-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/openapi/canopy-whitelabel-api-api-openapi.yml

Other Resources

🔗
Website
https://www.usecanopy.com/
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/scopes/canopy-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/errors/canopy-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/conventions/canopy-conventions.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/conformance/canopy-conformance.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/data-model/canopy-data-model.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/examples/canopy-examples.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/lifecycle/canopy-lifecycle.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/asyncapi/canopy-webhooks.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/mcp/canopy-tool-crosswalk.yml
🔗
Security
https://www.usecanopy.com/security

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canopy:canopy-whitelabel-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canopy-whitelabel-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Whitelabel API
  version: 1.0.0
  description: Canopy Connect Public API Documentation
  contact:
    name: Canopy Connect
    email: support@usecanopy.com
    url: https://usecanopy.com/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://app.usecanopy.com/api/v1.0.0
security:
- BasicAuth: []
tags:


# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/openapi/canopy-whitelabel-api-api-openapi.yml