> ## 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 workflows: fluxos de verificação
> Liste todos os workflows de KYC e KYB da sua organização Didit e gerencie fluxos de verificação via API. Pagamento por uso, sem contratos.
Prompt da API de listagem de fluxos
Copiar o prompt para a área de transferência
\
\`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.`
\
Colar em
## OpenAPI
````yaml pt-br/openapi-25.json GET /v3/workflows/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/workflows/:
get:
tags:
- Workflows
summary: Listar fluxos
description: >-
Lista seus fluxos, dos mais recentes para os mais antigos, em um
envelope de paginação limit/offset (`{count, next, previous, results}`,
com tamanho de página padrão de 50). Cada linha é uma versão.
`workflow_id` é o ID estável do grupo, e novas sessões usam a versão
`published` mais recente.
operationId: list_workflows
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 50
description: Tamanho da página (número de fluxos por página).
- name: offset
in: query
required: false
schema:
type: integer
default: 0
description: Número de linhas a pular antes do primeiro fluxo retornado.
responses:
'200':
description: >-
Uma página de fluxos ordenada por `created_at` em ordem decrescente,
envolvida no envelope de paginação. Cada item em `results` é um
`WorkflowListItem`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Número total de versões de fluxo da aplicação.
next:
type: string
format: uri
nullable: true
description: URL da próxima página, ou `null` na última página.
previous:
type: string
format: uri
nullable: true
description: URL da página anterior, ou `null` na primeira página.
results:
type: array
items:
$ref: '#/components/schemas/WorkflowListItem'
examples:
Two workflows:
summary: >-
Um fluxo de verificação (workflow) de KYC padrão e um
rascunho de fluxo 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: >-
A chave de API está ausente, malformada, expirada ou pertence a
outra aplicação. Corpo: `{"detail": "You do not have permission to
perform this action."}`. Renove o token pela [Auth
API](/pt-br/auth-api/get-credentials) e tente novamente.
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: >-
Limite de requisições excedido. Tente novamente com backoff
exponencial e respeite qualquer cabeçalho `Retry-After`.
'500':
description: >-
Erro inesperado do servidor ao montar a lista. A requisição pode ser
repetida com segurança.
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: Uma versão do fluxo na visualização em lista.
properties:
uuid:
type: string
format: uuid
description: >-
UUID da versão. Use como `{settings_uuid}` para
obter/atualizar/excluir e como `workflow_id` ao criar sessões.
workflow_id:
type: string
format: uuid
description: >-
ID de grupo estável compartilhado por todas as versões do mesmo
fluxo. É igual a `uuid` na versão 1.
workflow_label:
type: string
description: Nome de exibição do fluxo de verificação (workflow).
workflow_type:
type: string
nullable: true
description: >-
Tipo base para fluxos simples: `kyc`, `kyb`,
`adaptive_age_verification`, `biometric_authentication` etc. `null`
para fluxos baseados em grafo sem um recurso de KYB.
is_default:
type: boolean
description: >-
Se este é o fluxo de verificação (workflow) padrão para novas
sessões.
is_archived:
type: boolean
is_white_label_enabled:
type: boolean
description: >-
Se a personalização de marca própria se aplica às sessões criadas
com este fluxo.
total_price:
type: number
description: >-
Preço fixo por verificação em USD (número JSON; exclui recursos com
preço variável, como DATABASE_VALIDATION e PHONE_VERIFICATION).
min_price:
type: number
description: Menor preço fixo entre os caminhos do grafo do fluxo, em USD.
max_price:
type: number
description: Preço fixo mais alto entre os caminhos do grafo do fluxo, em USD.
features:
type: string
description: >-
Recursos ativados como uma única string unida por `" + "`, por
exemplo `"OCR + LIVENESS + FACE_MATCH"`. Divida por `" + "` para
obter uma lista.
is_simple_workflow:
type: boolean
description: True quando o fluxo não tem um grafo de fluxo personalizado.
is_editable:
type: boolean
description: >-
True quando esta versão é um `draft` (rascunhos podem ser editados
diretamente; versões publicadas são imutáveis no Console).
workflow_url:
type: string
format: uri
description: >-
URL pública e compartilhável de verificação para este fluxo
(`https://verify.didit.me/u/`).
max_retry_attempts:
type: integer
description: >-
Número máximo de novas tentativas permitidas após uma verificação
recusada (0-10).
retry_window_days:
type: integer
nullable: true
description: >-
Janela móvel em dias usada para contar as novas tentativas (1-365).
`null` = limite para todo o histórico.
session_expiration_time:
type: integer
description: Segundos até a expiração de uma sessão não concluída (3600-2419200).
version:
type: integer
description: Número da versão dentro do grupo `workflow_id`, começando em 1.
status:
type: string
enum:
- draft
- published
description: >-
Status da versão. Novas sessões usam a versão `published` mais
recente de um grupo.
has_draft:
type: boolean
description: >-
True quando alguma versão deste grupo de `workflow_id` está
atualmente em rascunho.
created_by:
type: object
nullable: true
description: >-
Quem criou esta versão: `{name, email, type}`, em que `type` é
`user` (usuário do Console, com `email` definido) ou `api_key`
(`name` é o client id, `email` é null). `null` quando nenhum criador
foi registrado.
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: >-
Chave de API da sua aplicação, em Developers -> API keys no Business
Console. A chave principal tem acesso total. Uma chave nomeada pode ter
escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
uma data de validade. 401 significa que a chave está errada, revogada ou
expirada; 403 significa que nenhuma chave foi enviada, que a chave não
tem acesso a este recurso ou ação, ou que a requisição veio de um
endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
que a sessão está fora dos fluxos ou status da chave. Uma chave sem
acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
sem permissão de escrita em sessões recebe links e tokens de sessão como
null. Consulte https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.