> ## 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 Lista Workflow: Flussi di Verifica
> Recupera tutti i workflow KYC e KYB della tua organizzazione Didit. Gestisci i flussi di verifica in modo programmatico. Prezzi a consumo, nessun contratto.
Prompt API per elencare i workflow
Copia il prompt negli appunti
\
\`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.`
\
Incolla in
## OpenAPI
````yaml it/openapi-25.json GET /v3/workflows/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API di verifica dell'identità. Autenticati con l'intestazione x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/workflows/:
get:
tags:
- Workflows
summary: Elenca i workflow
description: >-
Elenca i tuoi workflow, dal più recente al meno recente, in un
contenitore di paginazione limit/offset (`{count, next, previous,
results}`, dimensione predefinita della pagina 50). Ogni riga
rappresenta una versione; `workflow_id` è l'ID di gruppo stabile e le
nuove sessioni utilizzano l'ultima versione `published`.
operationId: list_workflows
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 50
description: Dimensione della pagina (numero di workflow per pagina).
- name: offset
in: query
required: false
schema:
type: integer
default: 0
description: Numero di righe da saltare prima del primo workflow restituito.
responses:
'200':
description: >-
Una pagina di workflow ordinati per `created_at` in ordine
decrescente, inclusi nella struttura di paginazione. Ciascun
elemento in `results` è un `WorkflowListItem`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Numero totale di versioni del workflow per l'applicazione.
next:
type: string
format: uri
nullable: true
description: URL della pagina successiva, o `null` nell'ultima pagina.
previous:
type: string
format: uri
nullable: true
description: URL della pagina precedente, o `null` nella prima pagina.
results:
type: array
items:
$ref: '#/components/schemas/WorkflowListItem'
examples:
Two workflows:
summary: >-
Un workflow KYC predefinito e una bozza di workflow 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: >-
La chiave API è mancante, malformata, scaduta o appartiene a
un'applicazione diversa. Corpo: `{"detail": "You do not have
permission to perform this action."}`. Aggiorna il token tramite
l'[Auth API](/it/auth-api/get-credentials) e riprova.
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 di frequenza superato. Riprova con backoff esponenziale e
rispetta l'eventuale intestazione `Retry-After`.
'500':
description: >-
Errore imprevisto del server durante la compilazione dell'elenco. È
possibile riprovare la richiesta in sicurezza.
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 singola versione del workflow nella vista a elenco.
properties:
uuid:
type: string
format: uuid
description: >-
UUID per versione. Utilizzalo come `{settings_uuid}` per
recuperare/aggiornare/eliminare e come `workflow_id` durante la
creazione delle sessioni.
workflow_id:
type: string
format: uuid
description: >-
ID di gruppo stabile condiviso da tutte le versioni dello stesso
workflow. Equivale a `uuid` per la versione 1.
workflow_label:
type: string
description: Nome visualizzato per il workflow.
workflow_type:
type: string
nullable: true
description: >-
Tipo base per workflow semplici: `kyc`, `kyb`,
`adaptive_age_verification`, `biometric_authentication`, ecc. `null`
per workflow basati su grafi senza una funzionalità KYB.
is_default:
type: boolean
description: Indica se questo è il workflow predefinito per le nuove sessioni.
is_archived:
type: boolean
is_white_label_enabled:
type: boolean
description: >-
Indica se la personalizzazione White label si applica alle sessioni
create con questo workflow.
total_price:
type: number
description: >-
Prezzo fisso per verifica in USD (numero JSON, esclude le
funzionalità a prezzo variabile come DATABASE_VALIDATION e
PHONE_VERIFICATION).
min_price:
type: number
description: >-
Prezzo fisso più economico tra i percorsi del grafo del workflow, in
USD.
max_price:
type: number
description: >-
Prezzo fisso più elevato tra i percorsi del grafo del workflow, in
USD.
features:
type: string
description: >-
Funzionalità abilitate sotto forma di singola stringa unita da `" +
"`, ad es. `"OCR + LIVENESS + FACE_MATCH"`. Suddividi usando `" + "`
per ottenere un elenco.
is_simple_workflow:
type: boolean
description: True quando il workflow non ha un grafo del workflow personalizzato.
is_editable:
type: boolean
description: >-
True quando questa versione è una `draft` (le bozze possono essere
modificate direttamente; le versioni pubblicate sono immutabili
nella Console).
workflow_url:
type: string
format: uri
description: >-
URL di verifica pubblico e condivisibile per questo workflow
(`https://verify.didit.me/u/`).
max_retry_attempts:
type: integer
description: >-
Numero massimo di nuovi tentativi consentiti dopo una verifica
rifiutata (0-10).
retry_window_days:
type: integer
nullable: true
description: >-
Finestra mobile in giorni utilizzata per contare i nuovi tentativi
(1-365). `null` = limite complessivo.
session_expiration_time:
type: integer
description: >-
Secondi prima della scadenza di una sessione non completata
(3600-2419200).
version:
type: integer
description: >-
Numero di versione all'interno del gruppo `workflow_id`, a partire
da 1.
status:
type: string
enum:
- draft
- published
description: >-
Stato della versione. Le nuove sessioni utilizzano l'ultima versione
`published` di un gruppo.
has_draft:
type: boolean
description: >-
True quando qualsiasi versione in questo gruppo `workflow_id` è
attualmente una bozza.
created_by:
type: object
nullable: true
description: >-
Chi ha creato questa versione: `{name, email, type}` dove `type` è
`user` (utente della Console, `email` impostata) o `api_key` (`name`
è il client id, `email` è null). `null` quando non è stato
registrato alcun creatore.
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 chiave API della tua applicazione, da Developers -> API keys nella
Business Console. La chiave primaria ha accesso completo. Una chiave con
nome può avere un ambito definito: nessuno, lettura o scrittura per
risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco
di indirizzi IP e a una data di scadenza. 401 indica che la chiave è
errata, revocata o scaduta; 403 indica che non è stata inviata alcuna
chiave, che la chiave non ha accesso a questa risorsa o azione, oppure
che la richiesta proviene da un indirizzo non incluso nel suo elenco IP;
404 su una route di sessione indica che la sessione non rientra nei
workflow o negli stati previsti dalla chiave. Una chiave senza accesso
ai media riceve gli URL di immagini, video e PDF come null, e una chiave
senza permessi di scrittura sulle sessioni riceve link e token di
sessione come null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.