Skip to content

Documents for your own customers

Getting a document to the person it belongs to, without a human forwarding an email — either by giving them somewhere to collect it, or by putting it inside your own product.

What it produces

Either a branded destination your users sign into and download from, or documents fetched on demand by your application through the API.

How you build it

As a portal

  1. Build the report as usual
  2. Create a portal and add the pages your users need
  3. Apply your branding with White Label

Through the API

  1. Create a Personal Access Token
  2. Call the V1 API to generate or fetch a PDF for a given report and parameters
  3. Stream the result to your user, or store it on your side

What makes it tricky

  • Scope the data by the caller, not the template. A parameter that selects a customer is only as safe as the check that the caller is that customer — enforce it on your side of the API.
  • Branding is platform-wide, not per report. White Label changes the product's appearance; per-document branding belongs in a theme.
  • Portals are not yet generally released. The pages here describe current behaviour and may change before release.

Portals · API · Developer Resources · White Label