Saltar al contenido principal

Listar profiles

GET /v1/workflows/{workflowId}/profiles

Solicitud

curl -X GET "http://client-omni-api.argosidentity.com/v1/workflows/{workflowId}/profiles?sort=createdAt&order=desc&limit=20" \
  -H "x-api-key: your-api-key-here"

Query Parameters

ParameterTypeDefaultDescripción
searchstringBuscar por nombre del profile
sortstringcreatedAtCampo de ordenación: name, createdAt, lastAnalysisAt
orderstringdescOrden: asc, desc
cursorstringCursor de paginación de la respuesta anterior
limitnumber10Elementos por página (máx. 100)

Respuesta

{
  "count": 10,
  "nextCursor": "dXNlcjpVMDYxTkZUVDI",
  "items": [
    {
      "id": "pf_a1b2c3d4",
      "workflowId": "wf_7a3f9c2e",
      "name": "Acme Corp - KYB Verification",
      "description": "KYB verification for Acme Corp",
      "metadata": {
        "region": "KR",
        "riskProfile": "standard"
      },
      "itemsCount": 3,
      "foldersCount": 1,
      "lastAnalysisAt": "2026-03-15T10:30:00Z",
      "createdAt": "2026-03-15T10:00:00Z",
      "updatedAt": "2026-03-15T10:30:00Z"
    }
  ]
}
count
number
requerido
Número total de elementos en la respuesta actual
nextCursor
string | null
requerido
Cursor para la siguiente página (null si no hay más resultados)
items[].id
string
requerido
ID del profile
items[].workflowId
string
requerido
ID del workflow padre
items[].name
string
requerido
Nombre visible del profile
items[].description
string | null
Descripción del profile
items[].metadata
object | null
Metadata personalizado
items[].itemsCount
number
requerido
Cantidad total de items en todos los folders
items[].foldersCount
number
requerido
Cantidad de folders
items[].lastAnalysisAt
string | null
Hora del último análisis (ISO 8601)
items[].createdAt
string
requerido
Hora de creación (ISO 8601)
items[].updatedAt
string
requerido
Hora de última actualización (ISO 8601)
Use paginación basada en cursor para obtener resultados consistentes. Pase el valor nextCursor de la respuesta como parámetro cursor en la siguiente solicitud.

Obtener profile por ID

GET /v1/profiles/{profileId}

Solicitud

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

Respuesta

{
  "id": "pf_a1b2c3d4",
  "workflowId": "wf_7a3f9c2e",
  "name": "Acme Corp - KYB Verification",
  "description": "KYB verification for Acme Corp",
  "metadata": {
    "region": "KR",
    "riskProfile": "standard"
  },
  "itemsCount": 3,
  "lastAnalysisAt": "2026-03-15T10:30:00Z",
  "folders": [
    {
      "id": "fld_default001",
      "name": "default",
      "isDefault": true,
      "itemsCount": 2,
      "createdAt": "2026-03-15T10:00:00Z"
    }
  ],
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-15T10:30:00Z"
}

Códigos de error

StatusCodeDescripción
404PROFILE_NOT_FOUNDProfile no encontrado

Obtener estado de items

GET /v1/profiles/{profileId}/items/status
Devuelve un resumen del estado de procesamiento de items en todos los folders del profile.
curl -X GET "http://client-omni-api.argosidentity.com/v1/profiles/{profileId}/items/status" \
  -H "x-api-key: your-api-key-here"
{
  "profileId": "pf_a1b2c3d4",
  "summary": {
    "total": 3,
    "pending": 0,
    "active": 3,
    "failed": 0
  },
  "isRagReady": true,
  "items": [
    {
      "id": "item_abc123",
      "name": "business_registration.pdf",
      "type": "file",
      "status": "ACTIVE",
      "processedAt": "2026-03-15T10:02:00Z"
    }
  ]
}
profileId
string
requerido
ID del profile
summary.total
number
requerido
Cantidad total de items
summary.pending
number
requerido
Items en estado PENDING
summary.active
number
requerido
Items en estado ACTIVE
summary.failed
number
requerido
Items en estado FAILED
isRagReady
boolean
requerido
true cuando todos los items están en ACTIVE (listos para análisis)
Haga polling de este endpoint cada 1 segundo hasta que isRagReady sea true antes de disparar el análisis.