How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canopy Connect API

The Canopy Connect API returns structured property and casualty insurance data directly from 400+ carriers in real time. Applications can verify coverage, retrieve policy documents, pull driver and vehicle details, and surface claims history in under a minute instead of the typical 30-minute manual verification process.

Canopy Connect API is published by Canopy Connect on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Auto Insurance, Casualty, Insurance, Insurance Verification, and Property. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 54 operations across 42 paths, organized into 13 resource areas, and defines 48 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://app.usecanopy.com/api/v1.0.0.

54 operations 42 paths 48 schemas 4 DELETE27 GET4 PATCH17 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://app.usecanopy.com/api/v1.0.0
Authentication
HTTP Basic
License
Resource Areas
13

Authentication & Security 1

Canopy Connect API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication. Use your Canopy Connect Client ID as the username and your Client Secret as the password. The Authorization header value is Basic .…

Paths & Operations 54

Across 42 paths, the API surfaces 54 operations — 4 DELETE, 27 GET, 4 PATCH, 17 POST, 2 PUT. They span 13 resource areas, including Pulls API, Consent API, Webhooks API, Monitorings API, Policy Forms API, Whitelabel API, Servicings API, Misc API, and 5 more. Each is listed below with its method, path, parameters, and response codes.

Pulls API 8

Get Pull data and download documents

GET
/teams/{teamId}/pulls/{pullId}
GET /pulls/:pullId
get-pull-by-id 3 params → 200400401403
PATCH
/teams/{teamId}/pulls/{pullId}
PATCH /pulls/:pullId
patch-pull-by-id 2 params body → 200400401403404
GET
/teams/{teamId}/pulls
GET /pulls
get-pulls 5 params → 200400401403
GET
/teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdfdeprecated
GET /:documentId/pdf
get-document-by-id 3 params → 200400401404
GET
/teams/{teamId}/pulls/{pullId}/documents/{documentId}
GET /:documentId
download-document-by-id 3 params → 302400401404
GET
/teams/{teamId}/pulls/{pullId}/answers/{answerId}/files/{fileId}
GET /:fileId
download-file-by-id 4 params → 302400401404
POST
/teams/{teamId}/pulls/{pullId}/policyCheck
POST /policyCheck
post-pull-policy-check 2 params body → 200400401403404
GET
/teams/{teamId}/pulls/{pullId}/policyCheck/pdf
GET /policyCheck/pdf
get-pull-policy-check-pdf 2 params → 200400401403404
Consent API 1

Collect consent to skip the consent page in the SDK

POST
/consent
POST /consent
post-consent body → 200400401404
Webhooks API 4

Get, create, update and delete Webhooks

GET
/teams/{teamId}/webhooks
GET /webhooks
get-webhooks 1 param → 200401403
POST
/teams/{teamId}/webhooks
POST /webhooks
post-webhooks 1 param body → 200400401403
PATCH
/teams/{teamId}/webhooks/{webhookId}
PATCH /webhooks/:webhookId
patch-webhook 2 params body → 200400401403
DELETE
/teams/{teamId}/webhooks/{webhookId}
DELETE /webhooks/:webhookId
delete-webhook 2 params → 200400401403
Monitorings API 8

Manage synced accounts

GET
/teams/{teamId}/monitorings
GET /monitorings
get-monitorings 6 params → 200401403
POST
/teams/{teamId}/monitorings
POST /monitorings
post-monitoring 1 param body → 200400401403404
PATCH
/teams/{teamId}/monitorings/{monitoringId}
PATCH /monitorings/:monitoringId
patch-monitoring 2 params body → 200400401403404
DELETE
/teams/{teamId}/monitorings/{monitoringId}
DELETE /monitorings/:monitoringId
delete-monitoring 2 params → 200400401403404
GET
/teams/{teamId}/monitorings/{monitoringId}
GET /monitorings/:monitoringId
get-monitoring 5 params → 200400401403404
GET
/teams/{teamId}/monitorings/{monitoringId}/reconnectToken
GET /monitorings/:monitoringId/reconnectToken
get-monitoring-reconnect-token 2 params → 200
POST
/teams/{teamId}/monitorings/{monitoringId}/refresh
POST /monitorings/:monitoringId/refresh
post-monitoring-refresh 2 params → 200400404
GET
/teams/{teamId}/monitorings/{monitoringId}/events
GET /monitorings/:monitoringId/events
get-monitoring-events 2 params → 200
Policy Forms API 2

Used to get policy form data

GET
/policyforms/{policyFormId}/pdfdeprecated
GET /policyforms/:policyFormId/pdf
get-policy-form-by-id 1 param → 200400404
GET
/teams/{teamId}/policyForms/{policyFormId}
GET /:policyFormId
download-policy-form-by-id 2 params → 302400401404
Whitelabel API 10

Allows you to create a fully whitelabeled experience

GET
/tos
GET /tos
get-tos → 200
POST
/widget/pull/consentAndConnect
POST /consentAndConnect
post-consent-and-connect body → 200400401404
POST
/widget/pull/consentAndDocuments
POST /consentAndDocuments
post-consent-and-documents body → 200400401404
POST
/widget/pull/{pullId}/connect
POST /connect
post-connect 2 params body → 200400403404
GET
/carriers
GET /carriers
get-carriers 2 params → 200401
GET
/carriers/{carrierId}
GET /carriers/:carrierId
get-carrier 3 params → 200400404
POST
/widget/pull/{pullId}/idv
POST /idv
post-idv 2 params body → 200400403404
POST
/widget/pull/{pullId}/idvoptions
POST /idvoptions
post-idvoptions 2 params body → 200400403404
POST
/widget/pull/reconnectToken
POST /reconnectToken
post-reconnect-token body → 200400403404
POST
/widget/pull/{pullId}/servicingAction
POST /servicingAction
post-servicing-action 2 params body → 200400403404
Servicings API 3

Manage servicing actions

GET
/teams/{teamId}/servicings
GET /servicings
get-servicings 4 params → 200400401403
POST
/teams/{teamId}/servicings
POST /servicings
post-servicings 1 param body → 200400401403404
GET
/teams/{teamId}/servicings/{servicingActionId}
GET /servicings/:servicingActionId
get-servicing 2 params → 200400401403404
Misc API 1

Collection of miscellaneous API routes

GET
/health
GET /health
get-health → 200500
Enrichment API 4

Allows you to look up driver/household data

GET
/teams/{teamId}/enrich/propertyData
GET /propertyData
get-property-data 2 params → 200400404
GET
/teams/{teamId}/enrich/driverLicense
GET /driverLicense
get-enrichment-driverlicense 9 params → 200
GET
/teams/{teamId}/enrich/drivingRecordIq
GET /drivingRecordIq
get-enrichment-drivingrecordiq 11 params → 200
GET
/teams/{teamId}/enrich/household
GET /household
get-enrichment-household 12 params → 200
Policy Search API 1

Search verified Auto ID Cards, Auto insurance policies and Home insurance policies from major insurance carriers without the need for login credentials.

POST
/teams/{teamId}/policySearch
POST /policySearch
post-policy-search 1 param body → 200400403500
Policy Check Team Setting API 2

Manage Policy Check team setting

GET
/teams/{teamId}/policyChecks/settings
GET /policyChecks/settings
get-policy-check-team-settings 1 param → 200401403
POST
/teams/{teamId}/policyChecks/settings
POST /policyChecks/settings
post-policy-check-team-settings 1 param body → 200400401403
Widgets API 7

Get, create, update, and delete Widgets

GET
/teams/{teamId}/widgets
GET /widgets
get-widgets 3 params → 200400401403
POST
/teams/{teamId}/widgets
POST /widgets
post-widgets 1 param body → 200400401403
GET
/teams/{teamId}/widgets/{widgetId}
GET /:widgetId
get-widgetId 2 params → 200400401403404
PATCH
/teams/{teamId}/widgets/{widgetId}
PATCH /:widgetId
patch-widgetId 2 params body → 200400401403404
DELETE
/teams/{teamId}/widgets/{widgetId}
DELETE /:widgetId
delete-widgetId 2 params → 200400401403404
PUT
/teams/{teamId}/widgets/{widgetId}/logo
PUT /:widgetId/logo
put-widgetId-logo 2 params body → 200400401403404
PUT
/teams/{teamId}/widgets/{widgetId}/icon
PUT /:widgetId/icon
put-widgetId-icon 2 params body → 200400401403404
Teams API 3

Get, create, delete Teams

GET
/teams/{teamId}
GET /:teamId
get-team 1 param → 200
DELETE
/teams/{teamId}
DELETE /:teamId
delete-team 1 param → 200403404
POST
/teams
POST /teams
create-team body → 200403

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are Pull (42 properties), Policy (37 properties), LifePolicyDetails (26 properties), Vehicle (22 properties). Each schema is shown below with its type and property counts.

Pull
object
42 properties
PullFunnel
objectnull
Information about the Pull’s deal stage
3 properties
PullAssignee
objectnull
Agent to whom the Pull is assigned
4 properties
Policy
object
37 properties
Address
object
AnswerField
object
5 properties
AnswerSection
object
2 properties
FileUpload
object
5 properties
Agent
object
5 properties
AgentInfo
object
7 properties
Driver
object
15 properties
Document
object
7 properties
EnrichmentDriverLicense
object
2 properties
EnrichmentDrivingRecordIq
object
2 properties
EnrichmentHousehold
object
3 properties
EnrichmentPropertyData
object
2 properties
Vehicle
object
22 properties
VehicleCoverage
object
ID of the vehicle coverage
17 properties
VehicleDriver
object
17 properties
Dwelling
object
14 properties
DwellingCoverage
object
13 properties
PropertyData
object
Claim
object
15 properties
DrivingRecord
object
6 properties
NamedInsured
object
11 properties
CommercialNamedInsured
object
16 properties
LossEvent
object
9 properties
Monitoring
object
A Monitoring is an object that manages the synchronization of Pulls
6 properties
MonitoringEvent
object
A MonitoringEvent is an event that occurred between the two most recent Pulls in the Monitoring.
3 properties
Mortgagee
object
5 properties
AdditionalInterest
object
6 properties
PolicyCheck
object
2 properties
PolicyCheckDwellingSetting
object
3 properties
PolicyCheckPullVehicleSetting
object
2 properties
PolicyCheckVehicleSetting
object
11 properties
PolicyForm
object
7 properties
PremiumGroup
object
3 properties
ServicingAction
LifePolicy
objectnull
3 properties
LifePolicyBeneficiary
object
12 properties
LifePolicyDetails
object
26 properties
LifePolicyRider
object
7 properties
Location
object
8 properties
LocationCoverage
object
21 properties
LocationOperation
object
6 properties
Widget
object
13 properties
WebhookBody
object
10 properties
ValidationCompleteBody
object
Payload delivered on the parent document-upload pull's webhook when its document validation finalizes (reaches a terminal status). Fires in addition to (not in…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canopy-openapi.json Raw ↑
Where this information came from

This is an independent, third-party profile of Canopy Connect API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.