Jump to Content
Canopy Connect
HomeAPI Reference
v1.0.0

Canopy Connect HomeDeveloper PlansRequest AccessAgent HelpCanopy Connect
API Reference
Canopy Connect HomeDeveloper PlansRequest AccessAgent Help
v1.0.0HomeAPI Reference

Overview

  • Getting Started
  • Sandbox Credentials
  • Common Issues

Documentation

  • Accounts API
    • GET /widgetsget
  • Auth API
    • GET /tosget
    • POST /consentAndConnectpost
    • POST /consentAndDocumentspost
    • POST /connectpost
    • GET /carriersget
    • GET /carriers/:carrierIdget
    • POST /idvpost
    • GET /pull/:pullIdget
    • POST /idvoptionspost
    • POST /reconnectTokenpost
    • POST /servicingActionpost
  • Consent API
    • How to use Consent API
    • POST /consentpost
    • GET /tos
  • Enrichment API
    • GET /propertyDataget
    • GET /driverLicenseget
    • GET /drivingRecordIqget
    • GET /householdget
  • Misc API
    • GET /healthget
  • Monitorings API
    • How to use Monitoring
    • GET /monitoringsget
    • POST /monitoringspost
    • PATCH /monitorings/:monitoringIdpatch
    • DELETE /monitorings/:monitoringIddelete
    • GET /monitorings/:monitoringIdget
    • GET /monitorings/:monitoringId/reconnectTokenget
    • POST /monitorings/:monitoringId/refreshpost
    • GET /monitorings/:monitoringId/eventsget
  • Policy Forms API
    • GET /policyforms/:policyFormId/pdfget
  • Pulls API
    • GET /pulls/:pullIdget
    • PATCH /pulls/:pullIdpatch
    • GET /pullsget
    • GET /:documentId/pdfget
  • Servicings API
    • How to use Servicing
    • GET /servicingsget
    • POST /servicingspost
    • GET /servicings/:servicingActionIdget
  • Webhooks API
    • GET /webhooksget
    • POST /webhookspost
    • PATCH /webhooks/:webhookIdpatch
    • DELETE /webhooks/:webhookIddelete

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

Webhooks API

The Webhooks API enables you to manage webhooks with code. You can also manage webhooks from the Settings Page on the Canopy Connect Dashboard.