Quickstart

This guide walks you through the complete Omni API flow: creating a profile, uploading documents, and running an analysis.

Prerequisites

An Omni API key (get one here)
A project with at least one configured workflow

If you have not set up a workflow yet, create one in the Omni dashboard before you follow the steps below. See Creating a workflow for the full walkthrough.

End-to-End Flow

Get Your Project and Workflow

First, retrieve your project to find the available workflows.

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

Note the workflowId you want to use from the response.

Create a Profile

Create a new profile under your workflow. Each profile represents one verification case.

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

The response includes the profileId and a default folder.

Upload Items

Upload documents to the default folder. Omni supports images (JPG, PNG), PDFs, and office documents.

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

Max file size: 10MB. Max items per folder: 5. Supported formats: JPG, PNG, PDF, TXT, DOC, DOCX, XLS, XLSX, BMP, TIFF, WEBP, CSV, HTML, MD.

Wait for Processing

After upload, items go through automatic processing (OCR, text extraction). Poll the status until all items are ACTIVE.

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

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

Poll at 1-second intervals with a 60-second timeout. All items must reach ACTIVE status before running analysis.

Run Analysis

Once all items are active, trigger the analysis. The workflow’s policy, engines, and output schema are applied automatically.

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

The analysis runs asynchronously. Poll the profile to check for results.

Retrieve Results

Once analysis is complete, retrieve the structured results.

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

extractedData follows your workflow’s output schema. Separately, every response carries a top-level system verdict verificationStatus (verified, pending_review, or rejected).

Getting Started

Prerequisites

End-to-End Flow

What’s Next?

Dashboard

API Reference

​Prerequisites

​End-to-End Flow

​What’s Next?

Dashboard

API Reference

Prerequisites

End-to-End Flow

What’s Next?