Download a report

Production

https://api.niva.co/v1

GET

/submissions/{submission_id}/reports/{report_template_id}

Generates the report from the template with the submission's current data and returns the Word document (.docx) as an attachment (Content-Disposition: attachment; filename="<business name>-<template file name>").

Returns 422 with Reports are unavailable for pending or processing submissions, Report template country does not match the submission country or Report template file is not available.

Request

Authorization

Add parameter in header

apiKey

Example:

apiKey: ********************

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.niva.co/v1/submissions/sub_3ZMd9KJnvAdYt4mOyW7YQRAp/reports/rtmp_4Rt8YzK1Qa' \
--header 'Accept-Language: en' \
--header 'apiKey: <api-key>'

Responses

🟢200OK

application/vnd.openxmlformats-officedocument.wordprocessingml.document

The generated Word document (.docx)

Headers

🟠401Unauthorized

🟠404Not Found

🟠422Unprocessable Content

🔴500Internal Server Error

List available report templates

Create new submission