Saltar al contenido principal

Endpoint

GET /v1/analyses/{analysisId}/report

Solicitud

curl -X GET "http://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

ParameterTypeRequiredDefaultDescripción
localestringenIdioma del report: en, ko
includeRawDatabooleanfalseIncluir datos extraídos en bruto en el report

Respuesta (200 OK)

La respuesta es un archivo PDF binario con los siguientes headers:
HeaderValue
Content-Typeapplication/pdf
Content-Dispositionattachment; filename="analysis_{id}_report.pdf"
El cuerpo de la respuesta contiene datos binarios PDF. Use el flag -o con curl (o el equivalente en su cliente HTTP) para guardar el archivo directamente en disco.
Los reports solo están disponibles cuando el estado del análisis es completed. Solicitar un report para un análisis en cualquier otro estado devolverá un error 400.

Códigos de error

StatusCodeDescripción
400REPORT_NOT_AVAILABLEEl análisis no está en estado completed
404ANALYSIS_NOT_FOUNDEl análisis especificado no fue encontrado