Upcoming Release

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Topics

Introduction
Getting Started
Authentication
Troubleshooting
Test it out
Pagination
Document Versioning

Endpoints

api_users
products
- Get all available products GET
- Create a new product POST
customers
accounts
line_items
notes
- Get All Notes for a specific Account GET
- Create a note for a specific account. POST
statements
- Get a list of all current and prior statements for a specific account GET
- Get a specific statement for a specific account. GET
amortization_schedule
- Get the amortization schedule for a specific loan GET
event_subscriptions
- Subscribe to event triggers from Canopy. PUT
integrations
data_migrations
- Toggle Migration Mode for a product PUT
payout_entities
- Get all payout entities GET
- Create a new payout entity POST
credit_reporting
- Get a list of all current and Metro2 credit reports for a specific account GET
- Get a specific Metro2 credit report for a specific account. GET
audit_trails
- Get the history of account status changes for a specific account. GET
organization

Powered by Bump.sh

Authentication

To create your organization within Canopy, register for our public sandbox. You can find a full guide to authenticating in Canopy in our developer onboarding tutorial.