Jump to Content
Documentation
Developer Plans
Request Access
Agent Help
Documentation
Jump to Content
Documentation
Developer Plans
Request Access
Agent Help
How to use Consent API
All
Pages
Start typing to search…
JUMP TO
Overview
Getting Started
Sandbox Credentials
Common Issues
API Reference
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
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
Policy Search API
How to use Policy Search API
POST /policySearch
post
Misc API
GET /health
get
Monitorings API
How to use Monitoring
GET /monitorings
get
POST /monitorings
post
PATCH /monitorings/:monitoringId
patch
DELETE /monitorings/:monitoringId
del
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
Policy Check Team Setting API
GET /policyChecks/settings
get
POST /policyChecks/settings
post
Pulls API
GET /pulls/:pullId
get
PATCH /pulls/:pullId
patch
GET /pulls
get
GET /:documentId/pdf
get
POST /policyCheck
post
Servicings API
How to use Servicing
GET /servicings
get
POST /servicings
post
GET /servicings/:servicingActionId
get
Teams API
GET /:teamId
get
DELETE /:teamId
del
POST /teams
post
Widgets API
POST /widgets
post
GET /:widgetId
get
PATCH /:widgetId
patch
DELETE /:widgetId
del
PUT /:widgetId/logo
put
PUT /:widgetId/icon
put
Webhooks API
GET /webhooks
get
POST /webhooks
post
PATCH /webhooks/:webhookId
patch
DELETE /webhooks/:webhookId
del
SDK
Using the SDK
Reference Documentation
Swift implementation
Kotlin implementation
React Native implementation
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
Address
Agent
AgentInfo
AnswerField
AnswerSection
Claim
CommercialNamedInsured
Document
Driver
DrivingRecord
Dwelling
DwellingCoverage
EnrichmentDriverLicense
EnrichmentDrivingRecordIq
EnrichmentHousehold
EnrichmentPropertyData
LifePolicy
LifePolicyBeneficiary
LifePolicyDetails
LifePolicyRider
Location
LocationCoverage
LocationOperation
LossEvent
Monitoring
MonitoringEvent
Mortgagee
NamedInsured
Policy
PolicyCheck
PolicyCheckDwellingSetting
PolicyCheckPullVehicleSetting
PolicyCheckVehicleSetting
PolicyForm
PremiumGroup
PropertyData
Pull
PullAssignee
PullFunnel
ServicingAction
Vehicle
VehicleCoverage
VehicleDriver
Widget
Powered by
How to use Consent API
Ask AI
