> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# API para listar flujos de trabajo de verificación
> Obtén todos los flujos de trabajo KYC y KYB de tu organización en Didit y gestiónalos por programación. Precios de pago por uso, sin contratos.
Prompt de la API para listar flujos de verificación
Copiar el prompt al portapapeles
\
\`List every Didit workflow in my application through the Management API.
Endpoint:
GET https://verification.didit.me/v3/workflows/
Authentication:
Use the x-api-key header with my Didit API key.
Goal:
\- Retrieve every workflow (verification settings record) defined for the application bound to my API key.
\- Use the results to render a workflow picker, sync workflow ids into my config, or discover the workflow_id of a workflow created in the Console.
Behavior:
\- Results are returned newest first (ordered by -created_at).
\- The endpoint does not paginate today — every workflow record comes back in one response.
\- Each row is a single version of a workflow group. workflow_id is the stable identifier shared by every version, version is the integer version number, and status is "draft" or "published".
\- The workflow with is_default: true is used whenever a session is created without an explicit workflow_id.
\- is_editable: true means the row is a draft and can still be patched via PATCH /v3/workflows/{settings_uuid}/.
\- Filter client-side by is_archived and status if you maintain hundreds of workflows.
Example call:
curl -X GET "https://verification.didit.me/v3/workflows/" \
-H "x-api-key: YOUR_API_KEY"
What to do with the response:
\- Use settings_uuid as the path id for GET / PATCH / DELETE /v3/workflows/{settings_uuid}/.
\- Use workflow_id when creating a session via POST /v3/session/.
Failure modes:
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope when the API key cannot list workflows for this application.
\- 429 — rate limited; back off and retry using Retry-After.
Side effects: none. This is a pure read.
For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`
\
Pegar en
## OpenAPI
````yaml es/openapi-25.json GET /v3/workflows/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/workflows/:
get:
tags:
- Workflows
summary: Listar flujos
description: >-
Lista tus flujos, de más reciente a más antiguo, en un sobre de
paginación limit/offset (`{count, next, previous, results}`, tamaño de
página predeterminado 50). Cada fila es una versión; `workflow_id` es el
ID de grupo estable y las nuevas sesiones usan la última versión
`published`.
operationId: list_workflows
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 50
description: Tamaño de página (número de flujos por página).
- name: offset
in: query
required: false
schema:
type: integer
default: 0
description: Número de filas que se omiten antes del primer flujo devuelto.
responses:
'200':
description: >-
Una página de flujos de verificación (workflows) ordenados por
`created_at` en orden descendente, dentro del sobre de paginación.
Cada elemento de `results` es un `WorkflowListItem`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Número total de versiones del flujo de la aplicación.
next:
type: string
format: uri
nullable: true
description: URL de la página siguiente, o `null` en la última página.
previous:
type: string
format: uri
nullable: true
description: URL de la página anterior, o `null` en la primera página.
results:
type: array
items:
$ref: '#/components/schemas/WorkflowListItem'
examples:
Two workflows:
summary: >-
Un flujo de verificación (workflow) de KYC predeterminado y
un borrador de flujo de KYC + AML
value:
count: 2
next: null
previous: null
results:
- uuid: a1b2c3d4-5678-90ab-cdef-111111111111
workflow_id: a1b2c3d4-5678-90ab-cdef-111111111111
workflow_label: Standard KYC
workflow_type: kyc
is_default: true
is_archived: false
is_white_label_enabled: false
total_price: 0.15
min_price: 0.15
max_price: 0.15
features: OCR + LIVENESS + FACE_MATCH
is_simple_workflow: true
is_editable: false
workflow_url: https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ
max_retry_attempts: 3
retry_window_days: 7
session_expiration_time: 604800
version: 2
status: published
has_draft: false
created_by:
name: Alex Mateo
email: alex@example.com
type: user
updated_at: '2026-04-12T10:30:00Z'
- uuid: b2c3d4e5-6789-01bc-defa-222222222222
workflow_id: b2c3d4e5-6789-01bc-defa-222222222222
workflow_label: Full Verification + AML
workflow_type: kyc
is_default: false
is_archived: false
is_white_label_enabled: false
total_price: 0.25
min_price: 0.25
max_price: 0.25
features: OCR + LIVENESS + FACE_MATCH + AML
is_simple_workflow: true
is_editable: true
workflow_url: https://verify.didit.me/u/Aq3kPOx8RWG3UAz5ZRQGVQ
max_retry_attempts: 3
retry_window_days: 7
session_expiration_time: 604800
version: 1
status: draft
has_draft: true
created_by: null
updated_at: '2026-04-15T18:05:21Z'
'403':
description: >-
Falta la clave de API, tiene un formato incorrecto, ha expirado o
pertenece a otra aplicación. Cuerpo: `{"detail": "You do not have
permission to perform this action."}`. Renueva el token mediante la
[Auth API](/es/auth-api/get-credentials) y vuelve a intentarlo.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
examples:
Invalid token:
value:
detail: You do not have permission to perform this action.
'429':
description: >-
Límite de solicitudes superado. Reintenta con retroceso exponencial
y respeta cualquier encabezado `Retry-After`.
'500':
description: >-
Error inesperado del servidor al generar la lista. La solicitud se
puede reintentar sin riesgo.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -X GET 'https://verification.didit.me/v3/workflows/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Accept: application/json'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.workflows.list():
print(item)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.workflows.list()) {
console.log(item);
}
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Workflows.ListAutoPaging(ctx, didit.WorkflowsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
- lang: java
label: Java
source: |-
import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.workflows().list()) {
System.out.println(item);
}
- lang: php
label: PHP
source: |-
workflows->list() as $item) {
print_r($item->toArray());
}
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.workflows.list.auto_paging_each do |item|
puts item.to_h
end
- lang: csharp
label: .NET
source: |-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Workflows.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}
components:
schemas:
WorkflowListItem:
type: object
description: Una versión de flujo en la vista de lista.
properties:
uuid:
type: string
format: uuid
description: >-
UUID por versión. Úsalo como `{settings_uuid}` para obtener,
actualizar o eliminar, y como `workflow_id` al crear sesiones.
workflow_id:
type: string
format: uuid
description: >-
ID de grupo estable compartido por todas las versiones del mismo
flujo. Es igual a `uuid` en la versión 1.
workflow_label:
type: string
description: Nombre visible del flujo de verificación.
workflow_type:
type: string
nullable: true
description: >-
Tipo base para flujos simples: `kyc`, `kyb`,
`adaptive_age_verification`, `biometric_authentication`, etc. `null`
para flujos basados en grafos sin una función de KYB.
is_default:
type: boolean
description: Si este es el flujo predeterminado para las sesiones nuevas.
is_archived:
type: boolean
is_white_label_enabled:
type: boolean
description: >-
Indica si la personalización de marca blanca se aplica a las
sesiones creadas con este flujo.
total_price:
type: number
description: >-
Precio fijo por verificación en USD (número JSON; excluye funciones
de precio variable como DATABASE_VALIDATION y PHONE_VERIFICATION).
min_price:
type: number
description: Precio fijo más bajo entre las rutas del grafo del flujo, en USD.
max_price:
type: number
description: Precio fijo más alto entre las rutas del grafo del flujo, en USD.
features:
type: string
description: >-
Funciones habilitadas como una única cadena unida con `" + "`, por
ejemplo `"OCR + LIVENESS + FACE_MATCH"`. Divide por `" + "` para
obtener una lista.
is_simple_workflow:
type: boolean
description: True cuando el flujo no tiene un grafo de flujo personalizado.
is_editable:
type: boolean
description: >-
True cuando esta versión es un `draft` (los borradores se pueden
editar directamente; las versiones publicadas son inmutables en la
Console).
workflow_url:
type: string
format: uri
description: >-
URL de verificación pública y compartible de este flujo
(`https://verify.didit.me/u/`).
max_retry_attempts:
type: integer
description: >-
Número máximo de reintentos permitidos tras una verificación
rechazada (0-10).
retry_window_days:
type: integer
nullable: true
description: >-
Ventana móvil en días que se usa para contar los reintentos (1-365).
`null` = límite sobre todo el historial.
session_expiration_time:
type: integer
description: >-
Segundos antes de que expire una sesión sin finalizar
(3600-2419200).
version:
type: integer
description: Número de versión dentro del grupo `workflow_id`, empezando por 1.
status:
type: string
enum:
- draft
- published
description: >-
Estado de la versión. Las nuevas sesiones usan la última versión
`published` de un grupo.
has_draft:
type: boolean
description: >-
True cuando alguna versión de este grupo `workflow_id` es
actualmente un borrador.
created_by:
type: object
nullable: true
description: >-
Quién creó esta versión: `{name, email, type}`, donde `type` es
`user` (usuario de la consola, con `email` definido) o `api_key`
(`name` es el ID de cliente y `email` es null). `null` cuando no se
registró ningún creador.
properties:
name:
type: string
email:
type: string
nullable: true
type:
type: string
enum:
- user
- api_key
updated_at:
type: string
format: date-time
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clave de API de tu aplicación, que encontrarás en Developers -> API
keys en la Business Console. La clave principal tiene acceso completo.
Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
a una lista de direcciones IP y a una fecha de caducidad. 401 significa
que la clave es incorrecta, se revocó o expiró; 403 significa que no se
envió ninguna clave, que la clave no tiene acceso a este recurso o
acción, o que la solicitud provino de una dirección fuera de su lista de
IP; 404 en una ruta de sesión significa que la sesión está fuera de los
flujos o estados de la clave. Una clave sin acceso a contenido
multimedia recibe las URL de imágenes, videos y PDF como null, y una
clave sin permiso de escritura en sesiones recibe los enlaces y tokens
de sesión como null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.