Saltar al contenido principal

Endpoint

GET /v1/analyses/{analysisId}

Solicitud

curl -X GET "http://client-omni-api.argosidentity.com/v1/analyses/{analysisId}?waitForReport=true&timeoutSeconds=120" \
  -H "x-api-key: your-api-key-here"

Query Parameters

ParameterTypeRequiredDefaultDescripción
waitForReportbooleanfalseEspera a que se genere el report (long polling)
timeoutSecondsnumber120Tiempo máximo de espera en segundos (10-300)
Cuando waitForReport es true, la solicitud mantiene la conexión abierta hasta que se genere el report o se alcance el umbral de timeoutSeconds. Esto es útil para flujos síncronos donde necesita el report inmediatamente después de completar el análisis.

Estructura de la respuesta

La respuesta del análisis tiene un esqueleto fijo (campos de nivel superior, risk assessment, metadatos del sistema, findings, etc.) que siempre está presente independientemente de la configuración del workflow.
Las secciones extractedData y outputSchema están determinadas por la configuración del output schema de su workflow. Los campos dentro de ellas cambian según cómo haya definido su output schema. El ejemplo a continuación muestra un workflow de verificación KYB; sus resultados tendrán campos diferentes según su propio schema.

Campos de nivel superior

Estos campos están siempre presentes en cada respuesta de análisis.
id
string
requerido
ID único del análisis (prefijo analysis_)
profileId
string
requerido
ID del profile al que pertenece este análisis
folderId
string | null
requerido
ID del folder objetivo (null para análisis de profile completo)
engineId
string | null
requerido
ID del engine utilizado (null cuando se usa el engine predeterminado)
playbookId
string
requerido
ID del playbook utilizado para el análisis (prefijo PB-)
engine
object | null
requerido
Detalles del engine (null cuando se usa el engine predeterminado)
status
string
requerido
Estado del análisis: pending / processing / completed / failed
processingTimeMs
number
requerido
Tiempo de procesamiento en milisegundos
verificationStatus
string
requerido
Estado final de verificación: pending_review / approved / rejected
error
string | null
requerido
Mensaje de error (null si fue exitoso)
options
object | null
Opciones pasadas cuando se solicitó el análisis
clientMetadata
object | null
Metadata del cliente pasada cuando se solicitó el análisis
primaryReportId
string | null
ID del report principal generado para este análisis (prefijo rpt_)
requestedAt
string
requerido
Hora de solicitud del análisis (ISO 8601)
completedAt
string | null
requerido
Hora de finalización del análisis (ISO 8601, null si no se ha completado)
createdAt
string
requerido
Hora de creación del registro (ISO 8601)

riskAssessment — Evaluación de riesgo

Evaluación de riesgo final calculada por el agente de IA después de todos los pasos de verificación.
FieldTypeDescripción
riskLevelstringNivel de riesgo: low / medium / high
riskScorenumberPuntuación de riesgo (0-100, mayor = más riesgoso)
riskFactorsstring[]Lista de factores que contribuyen al nivel de riesgo

systemMetadata — Metadatos de ejecución

Información interna de ejecución del agente de IA durante el análisis.
FieldTypeDescripción
totalIterationsnumberTotal de iteraciones realizadas por el agente
completedWorkIdsnumber[]IDs de los work items completados exitosamente
workflowHistoryobject[]Resumen de ejecución de cada work item

systemMetadata.workflowHistory[]

FieldTypeDescripción
workIdnumberNúmero de secuencia del work (comienza en 1)
actionNamestringNombre de la función de acción ejecutada
querystringConsulta/instrucción utilizada por el agente
reasonstringRazonamiento del agente para el resultado
successbooleanSi el work fue exitoso
iterationnumberNúmero de iteración al completarse
timestampstringHora de finalización (ISO 8601)

extractedData — Datos estructurados extraídos

Esta sección es dinámica. Los campos dentro de extractedData están determinados por el output schema definido en su workflow. El ejemplo a continuación es de un workflow KYB con verificación de registro empresarial; sus campos serán diferentes.
La IA extrae datos de los documentos y los estructura según su output schema. Las siguientes subsecciones son patrones comunes:

extractedData.review_result — Resultado final de revisión

FieldTypeDescripción
final_actionstringAcción final: approve / reject / manual_review
final_risk_levelstringNivel de riesgo final: low / medium / high
final_action_reasonstringRazonamiento de la acción final
final_risk_level_reasonstringRazonamiento del nivel de riesgo final

extractedData.extracted_values — Valores extraídos en bruto

Valores extraídos directamente de los documentos enviados. Los campos dependen de la definición de su output schema. Ejemplo (KYB con registro empresarial):
FieldTypeDescripción
brc_business_namestringNombre de la empresa del certificado de registro empresarial
brc_business_registration_numberstringNúmero de registro empresarial
brc_corporate_registration_numberstringNúmero de registro corporativo
brc_representative_namestringNombre del representante
brc_addressstringDirección de la empresa
brc_opening_datestringFecha de apertura
brc_issue_datestringFecha de emisión

extractedData.category_judgements — Juicios de verificación

Resultados de verificación por categoría con estado pass/fail y razonamiento.
FieldTypeDescripción
{field}_check_resultstringResultado de la verificación: pass / fail / unverifiable / needs_review
{field}_check_reasonstringRazonamiento del resultado de la verificación
overall_consistency_resultstringConsistencia general: pass / needs_review / fail
overall_consistency_reasonstringRazonamiento de la consistencia general

extractedData.document_validations — Validez documental

FieldTypeDescripción
{document}_is_validbooleanSi el documento es válido
{document}_is_valid_reasonstringRazonamiento de la verificación de validez

outputSchema — Output schema enriquecido

Contiene los mismos datos que extractedData, estructurados como el JSON Schema de su workflow con los valores reales completados. Use extractedData como campo canónico.

Campos comunes en outputSchema.properties

FieldTypeDescripción
request_idstringIdentificador de solicitud (igual que el profile ID)
policy_flagsstring[]Flags de violación/advertencia de policy
review_resultobjectResultado final de revisión
extracted_valuesobjectValores en bruto extraídos de los documentos
category_judgementsobjectJuicios de verificación por categoría
document_validationsobjectResultados de validez documental
recommended_next_stepsstring[]Acciones de seguimiento recomendadas por la IA

extractionStatus — Estado de extracción de campos

Mapa de estado que indica si cada campo de nivel superior del output schema fue extraído exitosamente.
ValorSignificado
"extracted"El campo fue extraído/generado exitosamente
"missing"La extracción del campo falló (sin documento o información)

rawActionResults — Resultados de acciones en bruto

Datos de resultado en bruto devueltos por cada acción de IA. Las claves son actionName.
FieldTypeDescripción
answerstringTexto del resultado de la acción (respuesta RAG o salida LLM)
workIdnumberNúmero de secuencia del work
citationsCountnumberNúmero de fragmentos de citas utilizados
verificationStatusstringResultado de verificación: passed / needs_review / failed

agentAuditLog[] — Registro de auditoría del agente

Registro detallado de ejecución de cada paso realizado por el agente de IA. Más granular que rawActionResults; incluye detalles de llamadas MCP tool.
FieldTypeDescripción
workIdnumberNúmero de secuencia del work
actionNamestringNombre de la acción
categorystringCategoría de la acción. Ejemplos incluyen Document Classification, Data Extraction, Format Validation, Status Validation, Data Consistency, Document Processing y mcp (herramientas externas). Los valores reales dependen de la policy del workflow.
querystringConsulta o instrucción enviada por el agente
reasoningstringRazonamiento del agente (puede estar vacío)
successbooleanSi la ejecución fue exitosa
iterationnumberNúmero de iteración
durationMsnumberDuración de la ejecución en milisegundos
executedAtstringHora de ejecución (ISO 8601)
verificationStatus`stringnull`Resultado de verificación por paso cuando aplica (p. ej., passed / needs_review / failed). Puede omitirse para pasos que no producen un pass/fail (como algunas acciones solo MCP).
targetItemIdsstring[]IDs de items referenciados por esta acción
ragResponse`objectnull`Resultado de consulta RAG (si aplica)
mcpToolCalls`object[]null`Detalles de llamadas MCP tool (si aplica)

agentAuditLog[].ragResponse

Presente solo para acciones que realizaron consultas RAG.
FieldTypeDescripción
answerstringTexto de respuesta generado por RAG
citationsobject[]Fragmentos de citas utilizados en la respuesta
chunksSearchednumberNúmero de fragmentos buscados
processingTimeMsnumberTiempo de procesamiento RAG en milisegundos

agentAuditLog[].mcpToolCalls[]

Presente solo para acciones que llamaron herramientas MCP externas (p. ej., screening AML).
FieldTypeDescripción
toolNamestringNombre de la herramienta MCP (p. ej., search_individual)
engineCodestringIdentificador del engine para esta herramienta (p. ej., aml-search)
engineNamestringNombre visible del engine (p. ej., AML Search - Person)
paramsobjectParámetros de la llamada a la herramienta
successbooleanSi la llamada fue exitosa
startedAtstringHora de inicio de la llamada (ISO 8601)
executionTimeMsnumberDuración de la llamada a la herramienta en milisegundos
rawContentobjectDatos de respuesta en bruto de la herramienta
fallbackToRagbooleanSi se activó el fallback a RAG por fallo
selectionReasonstringRazón del agente para seleccionar esta herramienta

findings[] — Hallazgos de verificación

Resumen ordenado del resultado de cada acción. Diseñado para visualización en UI.
FieldTypeDescripción
idstringID del hallazgo (prefijo af_)
categorystringCategoría (igual que el nombre de la acción)
resultstringResultado: passed / warning / failed
detailsstringDetalles del resultado (puede estar truncado)
sortOrdernumberOrden de visualización

recommendations[] — Recomendaciones

Recomendaciones de acciones de seguimiento generadas por el sistema.
FieldTypeDescripción
idstringID de la recomendación (prefijo ar_)
contentstringContenido de la recomendación
prioritynumberPrioridad (menor = mayor prioridad)
sortOrdernumberOrden de visualización

targetItems[] — Items objetivo

Items referenciados en este análisis.
FieldTypeDescripción
itemIdstringID del item (prefijo item_)
namestringNombre del item
typestringTipo de item: file / text / json
sourceRef`stringnull`Información de referencia de origen

Enumeraciones de estado

ValorDescripción
pendingEn espera de análisis
processingAnálisis en progreso
completedAnálisis completado
failedAnálisis fallido