For AI agents: visit https://docs.usecanopy.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Documentation Developer Plans Request Access Agent Help

Documentation

Jump to Content

Documentation Developer Plans Request Access Agent Help

Overview

Getting Started
Sandbox Credentials
Common Issues

API Credentials

Authentication
Canopy Connect Apps

API Reference

Accounts API
- GET /widgetsget
Whitelabel API
Consent API
Enrichment API
Policy Search API
- How to use Policy Search API
- POST /policySearchpost
Misc API
- GET /healthget
Monitorings API
Policy Forms API
- GET /policyforms/:policyFormId/pdfget
Policy Check Team Setting API
- GET /policyChecks/settingsget
- POST /policyChecks/settingspost
Pulls API
Servicings API
Teams API
Widgets API
Webhooks API

SDK

Using the SDK
Reference Documentation
Swift implementation
Kotlin implementation
React Native implementation

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

COMPONENTS

Getting Started
Customizing Your Form
Reference Documentation

Schemas

Powered by

PullAssignee

PullAssignee

field	type	description	properties
agent_id	string(uuid)
email	string(email)
first_name	string
last_name	string

Updated 9 months ago

Did this page help you?

Updated 9 months ago

Did this page help you?

- PullAssignee