GET /analyses/:analysisId/report

Available only while the analysis status is completed. The report is generated automatically when the analysis finishes, so you can download it directly without requesting generation first.

Endpoint

GET /v1/analyses/{analysisId}/report

Request

Path parameters

Parameter	Type	Description
`analysisId`	`string`	Analysis ID (`analysis_` prefix)

Query parameters

Parameter	Type	Default	Description
`locale`	`string`	`en`	Report language: `en` · `ko`
`includeRawData`	`boolean`	`false`	Deprecated. The value is ignored. The field is kept only for backward compatibility

curl "https://client-omni-api.argosidentity.com/v1/analyses/analysis_lsc7icgm9cjd/report?locale=en" \
  -H "x-api-key: your-api-key-here" \
  -o report.pdf

Response (200 OK)

The body is a binary PDF, not JSON, so save it to a file.

Header	Value
`Content-Type`	`application/pdf`
`Content-Disposition`	`attachment; filename="analysis_{id}_report.pdf"`

Use -o with curl, or the equivalent stream-to-file option in your client. Reading the response as a string corrupts the PDF.

In the dashboard, the Download PDF button on the analysis results screen downloads the same file. See analysis results.

Error codes

Status	Code	Description
400	`OMNI_2208`	The analysis is not in the `completed` state
404	`OMNI_3004`	Analysis not found

Common errors (400 validation · 401 authentication · 403 permission · 500 server) are listed in the API overview.

Overview

API Reference

GET /analyses/:analysisId/report

Endpoint

Request

Path parameters

Query parameters

Response (200 OK)

Error codes

​Endpoint

​Request

​Path parameters

​Query parameters

​Response (200 OK)

​Error codes

Endpoint

Request

Path parameters

Query parameters

Response (200 OK)

Error codes