Skip to main content
Reports group insights into a named, ordered layout for one entity. The same report definition works for every entity in your organization: open it from the entity’s Reports section in the dashboard, or download it as a PDF document with the Exports API.

​
Built-in and custom reports

Built-in reports such as full_report cover the standard credit-review layout: company summary, Syntage Score, risk indicators, corporate structure, revenue, financial statements, clients, and providers. Custom reports select and order the insight entries you care about. Create one with POST /reports, setting organizational to true to share it with your organization. Insight entries gated by a feature flag that is disabled for your organization are omitted from the report layout.

​
Download a report as a PDF

Report PDFs are generated asynchronously through the Exports API:
  1. List your reports with GET /reports and store the ID of the report you want.
  2. Create an export with format set to pdf and uri set to /entities/{entityId}/reports/{reportId}?exporting=true.
  3. Retrieve the export until its status is finished.
  4. Download the generated report.insights.pdf file from the File resource referenced by the export.
The generated PDF renders the report the same way the dashboard shows it to the requesting user: it uses the user’s locale, the report’s default period, and only the insight sections visible to that user. The exporting=true query parameter is required; other query parameters are not supported on report URIs.
PDF generation renders every insight in the report, so it can take a few minutes for entities with large datasets. Poll the export status instead of assuming a fixed completion time.
For endpoint details, see the Reports API Reference.