Handling Statements
Overview of Statements in Canopy#
Statements in Canopy are automatically generated once-per-cycle at the very end of the cycle for each account. They act as a snapshot of activity for the account from the start to the end of the cycle in which they occur. At the base-level, statements in Canopy are generated as JSON objects; however, they can very easily be transformed into relevant consumer-facing patterns such as PDFs or online views.
Accessing Generated Statements#
Once generated, statements can be detected via webhook.
They are also then available to be queried from the account on an ongoing basis. The general design pattern to follow is:
- Get Statements List to access a list of historical statements for the account (newest first)
- Get Individual Statement to access a specific statement from the list.
Presenting Statements To Borrowers#
Via UI#
As statement data is accessible in JSON, you can create a beautiful HTML statement view in your consumer portal. See CanopyUI's statement templates for some out-of-the-box components to help you set up this view.
Via PDF#
Either upon catching a webhook, or upon querying or polling Canopy's API, we recommend converting statements into PDFs to present to your borrowers. You can pick relevant fields from the JSON that make sense for your business model and compliance team, as something to present to your borrowers.
While every organization's statement look-and-feel is unique, our solutions engineering team can provide your team with out-of-the-box code that interprets Canopy's statement JSON into a PDF. You can modify the styling and representation of this statement in a way that makes sense for your business. See an example template statement at the bottom of this page. Whether working with our solutions engineering team or not, we recommend translating JSON into an HTML, and then utilize Puppeteer or alternative headless Chrome libraries to generate a PDF.
- handlebars.js as a templating engine
- pdf-puppeteer for pdf generation from an HTML template
For those using React, we've also found success replacing handlebars.js with
htmandvhtmlto generate HTML templates with the expressiveness of jsx.
Once you've got an HTML template in place for your team's statements, Canopy can also be configured to auto-generate and store PDF statements for each of your borrowers that can be retrieved from our secure storage.
Check out our demo on using the above technologies to develop stored
Via Mail#
Once you've generated a PDF view of the statement as outlined above, you may want to mail it directly to borrowers. Canopy can connect directly with any API-based mail provider, and includes an out-of-the-box integration with Lob to make sending mail to borrowers for important events such as statement generation an easy, no-code process. Simply configure the rules under which PDF statements should be sent to borrowers, and Canopy will trigger communications automatically when handling the statement generation event.
Create your own integration using our generated PDFs:
Example Statement Template#
This is what Canopy's base statement template looks like. The content and colors are customizable to fit your product construct and brand. This template has been designed and optimized to meet the requirements for automated mailer services such as Lob and CompuMail.
1 of 3