Skip to main content

​
Endpoint

GET /v1/workflows/{workflowId}

​
Request

curl -X GET "http://client-omni-api.argosidentity.com/v1/workflows/{workflowId}" \
  -H "x-api-key: your-api-key-here"

​
Response

​
id
string
required
Unique workflow identifier
​
name
string
required
Workflow name
​
policy
string
required
Natural language policy text
​
engines
array
required
List of selected engines for this workflow
​
outputSchema
object
required
JSON schema defining the structure of analysis results
{
  "success": true,
  "data": {
    "id": "wf_nowap27l46b2",
    "name": "KYB Business Verification",
    "policy": "Verify the business entity by extracting company data from registration documents, screening against AML watchlists, and validating registration details.",
    "engines": [
      { "id": "id_autoparser", "name": "ID AutoParser" },
      { "id": "aml_business", "name": "AML Business" },
      { "id": "text_verifier", "name": "Text Verifier" },
      { "id": "web_search", "name": "Web Search" }
    ],
    "outputSchema": {
      "company": {
        "name": "string",
        "registrationNumber": "string",
        "country": "string"
      },
      "verification": {
        "amlResult": "string",
        "registrationValid": "boolean"
      },
      "decision": {
        "result": "string",
        "verificationStatus": "pending_review | approved | rejected"
      }
    },
    "createdAt": "2026-01-15T09:00:00Z"
  }
}

​
GET /workflows/:workflowId/summary

A lightweight version that returns only essential workflow metadata — optimized for listing workflows. 
curl -X GET "http://client-omni-api.argosidentity.com/v1/workflows/{workflowId}/summary" \
  -H "x-api-key: your-api-key-here"

{
  "success": true,
  "data": {
    "id": "wf_nowap27l46b2",
    "name": "KYB Business Verification",
    "engineCount": 4,
    "profileCount": 128,
    "createdAt": "2026-01-15T09:00:00Z"
  }
}