GET /analyses/:analysisId/report

Endpoint

GET /v1/analyses/{analysisId}/report

Request

curl -X GET "https://client-omni-api.argosidentity.com/v1/analyses/{analysisId}/report?locale=en&includeRawData=false" \
  -H "x-api-key: your-api-key-here" \
  -o report.pdf

Query Parameters

Parameter	Type	Required	Default	Description
`locale`	`string`		`en`	Report language: `en`, `ko`
`includeRawData`	`boolean`		`false`	Include raw extracted data in the report

Response (200 OK)

The response is a binary PDF file with the following headers:

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

The response body is binary PDF data. Use the -o flag with curl (or equivalent in your HTTP client) to save the file directly to disk.

Reports are only available when the analysis status is completed. Requesting a report for an analysis in any other status will return a 400 error.

Error Codes

Status	Code	Description
400	`REPORT_NOT_AVAILABLE`	The analysis is not in `completed` status
404	`ANALYSIS_NOT_FOUND`	The specified analysis was not found

⌘I

Overview

API Reference

GET /analyses/:analysisId/report

Endpoint

Request

Query Parameters

Response (200 OK)

Error Codes

​Endpoint

​Request

​Query Parameters

​Response (200 OK)

​Error Codes

Endpoint

Request

Query Parameters

Response (200 OK)

Error Codes