Jump to Content
Home
API Reference
v1.0.0
Canopy Connect Home
Developer Plans
Request Access
Agent Help
API Reference
Canopy Connect Home
Developer Plans
Request Access
Agent Help
Moon (Dark Mode)
Sun (Light Mode)
v1.0.0
Home
API Reference
Getting Started
Search
JUMP TO
Overview
Getting Started
Sandbox Credentials
Common Issues
Documentation
Accounts API
GET /widgets
get
Auth API
GET /tos
get
POST /consentAndConnect
post
POST /consentAndDocuments
post
POST /connect
post
GET /carriers
get
GET /carriers/:carrierId
get
POST /idv
post
GET /pull/:pullId
get
POST /idvoptions
post
POST /reconnectToken
post
POST /servicingAction
post
Consent API
How to use Consent API
POST /consent
post
GET /tos
Enrichment API
GET /propertyData
get
GET /driverLicense
get
GET /drivingRecordIq
get
GET /household
get
Misc API
GET /health
get
Monitorings API
How to use Monitoring
GET /monitorings
get
POST /monitorings
post
PATCH /monitorings/:monitoringId
patch
DELETE /monitorings/:monitoringId
delete
GET /monitorings/:monitoringId
get
GET /monitorings/:monitoringId/reconnectToken
get
POST /monitorings/:monitoringId/refresh
post
GET /monitorings/:monitoringId/events
get
Policy Forms API
GET /policyforms/:policyFormId/pdf
get
Pulls API
GET /pulls/:pullId
get
PATCH /pulls/:pullId
patch
GET /pulls
get
GET /:documentId/pdf
get
Servicings API
How to use Servicing
GET /servicings
get
POST /servicings
post
GET /servicings/:servicingActionId
get
Webhooks API
GET /webhooks
get
POST /webhooks
post
PATCH /webhooks/:webhookId
patch
DELETE /webhooks/:webhookId
delete
SDK
Using the SDK
Reference Documentation
Webhooks
Using Webhooks
AUTH_STATUS
POLICY_AVAILABLE
POLICIES_AVAILABLE
COMPLETE
ERROR
MONITORING_RECONNECT
DATA_UPDATED
SERVICING_WAITING_FOR_CONSUMER_CONFIRMATION
MONITORING_EVENTS
Verifying Webhook Signatures
Webhook Retries
Metadata
Attaching metadata to a Pull with the SDK
Attaching metadata to a Pull using your widget link
API Credentials
How to create an API Key
Canopy Connect Apps
Creating Your App
Authorization
Access Tokens
Refresh Tokens
Making API Requests
Example App
Resources
COMPONENTS
Getting Started
Customizing Your Form
Reference Documentation
Schemas
Pull
Policy
Address
AgentInfo
Driver
Document
Vehicle
VehicleCoverage
VehicleDriver
Dwelling
DwellingCoverage
PropertyData
Claim
DrivingRecord
LossEvent
NamedInsured
CommercialNamedInsured
Monitoring
MonitoringEvent
Mortgagee
PolicyForm
ServicingAction
Location
LocationCoverage
LocationOperation
AnswerSection
AnswerField
EnrichmentDrivingRecordIq
EnrichmentDriverLicense
EnrichmentPropertyData
EnrichmentHousehold
Getting Started
