POST /profiles

Creates a profile that holds one verification subject. A default folder is created with it.

Endpoint

POST /v1/workflows/{workflowId}/profiles

Request

Path parameters

Parameter	Type	Description
`workflowId`	`string`	ID of the workflow to create the profile under (`wf_` prefix)

Request body

Field	Type	Required	Description
`name`	`string`	Required	Profile name (max 255 characters)
`description`	`string`		Description
`metadata`	`object`		Your own key-value pairs. Use it to attach an internal identifier

curl -X POST "https://client-omni-api.argosidentity.com/v1/workflows/wf_3p8k2m5r9v1t/profiles" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example",
    "description": "Example profile for document verification",
    "metadata": { "vendor_id": "VND-2026-0142" }
  }'

Response (201 Created)

{
  "id": "pf_6h4y8s2f0v9n",
  "workflowId": "wf_3p8k2m5r9v1t",
  "name": "example",
  "description": "Example profile for document verification",
  "metadata": { "vendor_id": "VND-2026-0142" },
  "itemsCount": 0,
  "lastAnalysisAt": null,
  "folders": [
    {
      "id": "fd_9pq2mklt83bx",
      "name": "default",
      "isDefault": true,
      "itemsCount": 0,
      "createdAt": "2026-09-10T05:32:47.118Z"
    }
  ],
  "createdAt": "2026-09-10T05:32:47.118Z",
  "updatedAt": "2026-09-10T05:32:47.118Z"
}

Response fields

Field	Type	Description
`id`	`string`	Profile ID (`pf_` prefix)
`workflowId`	`string`	Parent workflow ID
`name`	`string`	Profile name
`description`	`string \| null`	Description
`metadata`	`object \| null`	Your own metadata
`itemsCount`	`number`	Number of items. `0` right after creation
`lastAnalysisAt`	`string \| null`	Time of the last analysis. `null` right after creation
`folders`	`object[]`	Folder list. One default folder right after creation
`createdAt`	`string`	Creation time
`updatedAt`	`string`	Last update time

Items are added to folders. Use folders[0].id from this response directly as the folderId for adding an item, or create more folders to separate documents by type.

Error codes

Status	Code	Description
404	`OMNI_3003`	Workflow not found

Common errors (400 validation · 401 authentication · 403 permission · 500 server) are listed in the API overview.

Overview

API Reference

Endpoint

Request

Path parameters

Request body

Response (201 Created)

Response fields

Error codes

​Endpoint

​Request

​Path parameters

​Request body

​Response (201 Created)

​Response fields

​Error codes

Endpoint

Request

Path parameters

Request body

Response (201 Created)

Response fields

Error codes