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

v1.0.0Home API Reference

Overview

Getting Started
Sandbox Credentials
Common Issues

Documentation

Accounts API
- GET /widgetsget
Auth API
Consent API
Enrichment API
Misc API
- GET /healthget
Monitorings API
Policy Forms API
- GET /policyforms/:policyFormId/pdfget
Pulls API
Servicings API
Webhooks API

SDK

Using the SDK
Reference Documentation

Webhooks

Using Webhooks
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

COMPONENTS

Getting Started
Customizing Your Form
Reference Documentation

Schemas

EnrichmentHousehold

EnrichmentHousehold

field	type	description	properties
household_id	string(uuid)	Canopy Connect Household lookup ID
drivers	array
vehicles	array

Table of Contents
- EnrichmentHousehold