Saltar al contenido principal
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

1

Obtener project y workflow

Primero, consulte su proyecto para identificar los workflows disponibles.
curl -X GET "http://client-omni-api.argosidentity.com/v1/projects/{projectId}" \
  -H "x-api-key: su-api-key-here"
Tome nota del workflowId que quiere usar.
2

Crear un profile

Cree un nuevo profile dentro del workflow. Cada profile representa un caso de verificación.
curl -X POST "http://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.
3

Subir items

Suba documentos al folder predeterminado. Omni admite imágenes (JPG, PNG), PDFs y documentos de oficina.
curl -X POST "http://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.
4

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 "http://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.
5

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 "http://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.
6

Recuperar resultados

Una vez finalizado el análisis, obtenga los resultados estructurados.
curl -X GET "http://client-omni-api.argosidentity.com/v1/profiles/{profileId}" \
  -H "x-api-key: su-api-key-here"
Los resultados siguen el output schema del workflow; el objeto decision incluye verificationStatus (pending_review, approved o rejected).

​
Siguientes pasos

Panel de control

Aprenda a configurar workflows, policies y engines desde el dashboard.

Referencia de la API

Explore la documentación completa de la API.