Canopy Servicing Core API - Latest
1.10.6

API Overview
Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective - whether newly launched or migrated from existing systems. Using Canopy, you can track balances and transactions for each customer of your product, both in real-time and historically. You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

Canopy additionally surfaces information around all of your lending activity through its intuitive UI which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

Simply configure your product’s policies through our Create Product API endpoint, and then you can immediately begin adding customer accounts and relying on Canopy for accurate servicing information.

This is the documentation for version 1.10.6 of the API. Last update on Jan 24, 2023.

Base URL
https://sandbox-api.canopyservicing.com

Getting Started

Get started in three easy steps.

1) Review the Authentication tutorial to connect and experiment with our Sandbox environment.

2) Create your own credentials in our public sandbox.

3) Follow the onboarding steps once you've logged into the public sandbox.

Once your product is configured and launched in Canopy, you have access to the full power of the Servicing API! You can take advantage of sample workflows provided by our team, or construct your own using this API documentation.

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.

Troubleshooting

Test it out

To get going quickly, we recommend using an API collaboration tool called Postman. You can use the buttons below to import our public collections, which point to our public test environment and already has our API endpoints configured. Be sure to define the required environment variables before sending requests.

If you'd just like to get set up with Canopy and send some requests with pre-populated sample data, we recommend using our Quickstart collection.

Our Use Cases collection contains some workflows that help demonstrate how our API serves business needs today.

When you'd like to start applying some business logic and try formulating what your actual implementation looks like, our Canopy API collection contains examples of all our API calls.

Once you've explored our public sandbox and formulated your business model, contact us to start the conversation on integrating Canopy with your business.

Quickstart: Quickstart

Use Cases: Use Cases

Canopy API: Canopy API

Pagination

Canopy uses a two-factor basis to drive the order of responses in GET requests with an array of results. They are first ordered by effective_at by when the entity is effective in the system, and second by an internal index to make sure the order is always universal. From the caller's perspective, you can let Canopy know where to start its pagination response by providing a starting_after or ending_before string value. If neither a starting_after nor ending_before value is provided, we'll assume you're requesting the very first page of responses. In subsequent requests, you can simply grab these values from the paging key in the response body from your previous request. If you're aiming to provide your users with a link to the previous page, use the ending_before query parameter in your next request. If going to the next page, use the starting_after value instead.

Document Versioning

Canopy currently supports two methods of identifying resources in our API endpoints. Please see your organization's features for which document describes your implementation.
If strict_entity_client_id = true, then see our latest documentation here.
Otherwise, please see our legacy documentation here