POST /folders

Add a folder when you want to separate items by document type. A profile already has one default folder from the moment it is created.

Endpoint

POST /v1/profiles/{profileId}/folders

Request

Path parameters

Parameter	Type	Description
`profileId`	`string`	ID of the profile to create the folder in (`pf_` prefix)

Request body

Field	Type	Required	Description
`name`	`string`	Required	Folder name

curl -X POST "https://client-omni-api.argosidentity.com/v1/profiles/pf_6h4y8s2f0v9n/folders" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Supporting documents" }'

Response (201 Created)

{
  "id": "fd_5t9j1r4b7m2q",
  "profileId": "pf_6h4y8s2f0v9n",
  "name": "Supporting documents",
  "isDefault": false,
  "itemsCount": 0,
  "createdAt": "2026-09-10T06:00:12.004Z",
  "updatedAt": "2026-09-10T06:00:12.004Z"
}

Response fields

Field	Type	Description
`id`	`string`	Folder ID (`fd_` prefix)
`profileId`	`string`	Parent profile ID
`name`	`string`	Folder name
`isDefault`	`boolean`	Whether this is the default folder. Always `false` for a folder you create
`itemsCount`	`number`	Number of items in the folder
`createdAt`	`string`	Creation time
`updatedAt`	`string`	Last update time

There is no limit on how many items a folder can hold. What is capped is the total upload size per profile, at 100MB. Use folders to organize documents by type.

Error codes

Status	Code	Description
404	`OMNI_3005`	Profile 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