Reports let you generate a completed verification report for a submission using one of your own document templates. Instead of assembling findings by hand, you pick a template and Niva fills it with the submission's verified data, returning a ready-to-file document.The endpoints below only return the templates belonging to your account. Both endpoints are nested under a submission: you first list the templates available for that submission's country, then request the report for the template you want.Templates are authored and uploaded through the Niva dashboard, not through the API. The API is read-only: it lists the templates available to you and generates reports from them.
Availability#
Reports are only available once verification has produced results. A request for a report will be rejected with a 422 when:| Condition | Description |
|---|
Submission is pending or processing | Verification has not finished, so there is no result data to populate the report with. Wait until the submission reaches needs_review, pending_rfi, approved, or rejected. |
| Template country does not match the submission country | A template can only be applied to submissions from the same country. Use the list endpoint to get the valid templates for a given submission. |
| Template file is not available | The template has no usable .docx file attached. Re-upload the template in the dashboard. |
The list endpoint returns JSON. The report endpoint returns the generated document itself as a binary downloadFor details on the submission that a report is generated from, see the Submissions section of the API documentation. 