Inicio rápido

Esta guía recorre el flujo completo de la Omni API: crear un profile, subir documentos y ejecutar un análisis.

Requisitos previos

Una Omni API key (consígala aquí)
Un proyecto con al menos un workflow configurado

Si todavía no ha configurado un workflow, créelo primero en el dashboard de Omni. Consulte Crear un workflow para ver el proceso completo.

Flujo de punta a punta

Obtener project y workflow

Primero, consulte su proyecto para identificar los workflows disponibles.

curl -X GET "https://client-omni-api.argosidentity.com/v1/projects/{projectId}" \
  -H "x-api-key: su-api-key-here"

Tome nota del workflowId que quiere usar.

Crear un profile

Cree un nuevo profile dentro del workflow. Cada profile representa un caso de verificación.

curl -X POST "https://client-omni-api.argosidentity.com/v1/workflows/{workflowId}/profiles" \
  -H "x-api-key: su-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp - KYB Verification"
  }'

La respuesta incluye el profileId y un folder predeterminado.

Subir items

Suba documentos al folder predeterminado. Omni admite imágenes (JPG, PNG), PDFs y documentos de oficina.

curl -X POST "https://client-omni-api.argosidentity.com/v1/folders/{folderId}/items/upload" \
  -H "x-api-key: su-api-key-here" \
  -F "file=@/path/to/id-document.jpg" \
  -F "type=file"

Tamaño máximo por archivo: 10MB. Máximo de items por folder: 5. Formatos compatibles: JPG, PNG, PDF, TXT, DOC, DOCX, XLS, XLSX, BMP, TIFF, WEBP, CSV, HTML y MD.

Esperar el procesamiento

Después de la carga, los items pasan por procesamiento automático (OCR, extracción de texto). Consulte el estado hasta que todos los items estén en ACTIVE.

curl -X GET "https://client-omni-api.argosidentity.com/v1/profiles/{profileId}/items/status" \
  -H "x-api-key: su-api-key-here"

{
  "total": 1,
  "pending": 0,
  "active": 1,
  "failed": 0
}

Haga polling cada 1 segundo con un timeout de 60 segundos. Todos los items deben llegar a estado ACTIVE antes de ejecutar el análisis.

Ejecutar el análisis

Cuando todos los items estén activos, dispare el análisis. La policy, los engines y el output schema del workflow se aplican automáticamente.

curl -X POST "https://client-omni-api.argosidentity.com/v1/profiles/{profileId}/analyze" \
  -H "x-api-key: su-api-key-here"

El análisis se ejecuta de forma asíncrona. Consulte el profile para revisar los resultados.

Recuperar resultados

Una vez finalizado el análisis, obtenga los resultados estructurados.

curl -X GET "https://client-omni-api.argosidentity.com/v1/profiles/{profileId}" \
  -H "x-api-key: su-api-key-here"

extractedData sigue el output schema del workflow. Además, toda respuesta incluye en el nivel superior el veredicto del sistema verificationStatus (verified, pending_review o rejected).

Primeros Pasos

Requisitos previos

Flujo de punta a punta

Siguientes pasos

Panel de control

Referencia de la API

​Requisitos previos

​Flujo de punta a punta

​Siguientes pasos

Panel de control

Referencia de la API

Requisitos previos

Flujo de punta a punta

Siguientes pasos