Skip to main content
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

1

Get Your Project and Workflow

First, retrieve your project to find the available workflows.
curl -X GET "http://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.
2

Create a Profile

Create a new profile under your workflow. Each profile represents one verification case.
curl -X POST "http://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.
3

Upload Items

Upload documents to the default folder. Omni supports images (JPG, PNG), PDFs, and office documents.
curl -X POST "http://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.
4

Wait for Processing

After upload, items go through automatic processing (OCR, text extraction). Poll the status until all items are ACTIVE.
curl -X GET "http://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.
5

Run Analysis

Once all items are active, trigger the analysis. The workflow’s policy, engines, and output schema are applied automatically.
curl -X POST "http://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.
6

Retrieve Results

Once analysis is complete, retrieve the structured results.
curl -X GET "http://client-omni-api.argosidentity.com/v1/profiles/{profileId}" \
  -H "x-api-key: your-api-key-here"
Results follow your workflow’s output schema; the decision object includes verificationStatus (pending_review, approved, or rejected).

​
What’s Next?

Dashboard

Learn how to configure workflows, policies, and engines in the dashboard.

API Reference

Explore the full API documentation.