> ## 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: सत्यापन फ़्लो
> Didit org के सभी KYC और KYB वर्कफ़्लो प्राप्त करें। सत्यापन फ़्लो प्रोग्रामेटिक रूप से प्रबंधित करें। प्रति उपयोग भुगतान, कोई अनुबंध नहीं।
वर्कफ़्लो सूची API प्रॉम्प्ट
प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें
\
\`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.`
\
यहाँ पेस्ट करें
## OpenAPI
````yaml hi/openapi-25.json GET /v3/workflows/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/workflows/:
get:
tags:
- Workflows
summary: वर्कफ़्लो सूचीबद्ध करें
description: >-
अपने वर्कफ़्लो को सबसे नए पहले क्रम में, limit/offset पेजिनेशन एन्वेलप
(`{count, next, previous, results}`, डिफ़ॉल्ट पेज आकार 50) में सूचीबद्ध
करें। प्रत्येक पंक्ति एक संस्करण है; `workflow_id` स्थिर समूह ID है और
नए सत्र नवीनतम `published` संस्करण का उपयोग करते हैं।
operationId: list_workflows
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 50
description: पेज का आकार (प्रति पेज वर्कफ़्लो की संख्या)।
- name: offset
in: query
required: false
schema:
type: integer
default: 0
description: पहले लौटाए गए वर्कफ़्लो से पहले छोड़ी जाने वाली पंक्तियों की संख्या।
responses:
'200':
description: >-
`created_at` के अवरोही क्रम में वर्कफ़्लो का एक पेज, जो पेजिनेशन
एनवलप में रैप किया गया है। `results` में प्रत्येक आइटम एक
`WorkflowListItem` है।
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: एप्लिकेशन के लिए वर्कफ़्लो संस्करणों की कुल संख्या।
next:
type: string
format: uri
nullable: true
description: अगले पेज का URL, या अंतिम पेज पर `null`।
previous:
type: string
format: uri
nullable: true
description: पिछले पेज का URL, या पहले पेज पर `null`।
results:
type: array
items:
$ref: '#/components/schemas/WorkflowListItem'
examples:
Two workflows:
summary: एक डिफ़ॉल्ट KYC वर्कफ़्लो और एक ड्राफ़्ट 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: >-
API कुंजी अनुपलब्ध, विकृत, समय-सीमा समाप्त हो चुकी है, या किसी भिन्न
एप्लिकेशन से संबंधित है। मुख्य भाग: `{"detail": "You do not have
permission to perform this action."}`। [Auth
API](/hi/auth-api/get-credentials) के माध्यम से token को रीफ्रेश
करें और पुनः प्रयास करें।
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: >-
रेट लिमिट पार हो गई। घातीय बैकऑफ़ के साथ पुनः प्रयास करें और किसी भी
`Retry-After` हेडर का पालन करें।
'500':
description: >-
सूची बनाते समय अप्रत्याशित सर्वर त्रुटि। अनुरोध का सुरक्षित रूप से
पुनः प्रयास किया जा सकता है।
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: सूची दृश्य में एक वर्कफ़्लो संस्करण।
properties:
uuid:
type: string
format: uuid
description: >-
प्रति-संस्करण UUID। get/update/delete के लिए `{settings_uuid}` के
रूप में और सत्र बनाते समय `workflow_id` के रूप में उपयोग करें।
workflow_id:
type: string
format: uuid
description: >-
एक ही वर्कफ़्लो के प्रत्येक संस्करण द्वारा साझा की गई स्थिर समूह ID।
संस्करण 1 के लिए `uuid` के बराबर है।
workflow_label:
type: string
description: वर्कफ़्लो के लिए डिस्प्ले नाम।
workflow_type:
type: string
nullable: true
description: >-
सरल वर्कफ़्लो के लिए आधार प्रकार: `kyc`, `kyb`,
`adaptive_age_verification`, `biometric_authentication`, आदि। बिना
KYB सुविधा वाले ग्राफ़-आधारित वर्कफ़्लो के लिए `null`।
is_default:
type: boolean
description: क्या यह नए सत्रों के लिए डिफ़ॉल्ट वर्कफ़्लो है।
is_archived:
type: boolean
is_white_label_enabled:
type: boolean
description: >-
क्या इस वर्कफ़्लो के साथ बनाए गए सत्रों पर व्हाइट लेबल कस्टमाइज़ेशन
लागू होता है।
total_price:
type: number
description: >-
प्रति सत्यापन USD में निश्चित कीमत (JSON संख्या, DATABASE_VALIDATION
और PHONE_VERIFICATION जैसी परिवर्तनीय-मूल्य वाली सुविधाओं को
छोड़कर)।
min_price:
type: number
description: वर्कफ़्लो-ग्राफ़ पथों में सबसे सस्ती निश्चित कीमत, USD में।
max_price:
type: number
description: वर्कफ़्लो-ग्राफ़ के सभी पाथ में सबसे महंगी निश्चित कीमत, USD में।
features:
type: string
description: >-
सक्षम सुविधाएँ एकल `" + "`-जुड़ी स्ट्रिंग के रूप में, उदा. `"OCR +
LIVENESS + FACE_MATCH"`। सूची प्राप्त करने के लिए `" + "` पर विभाजित
करें।
is_simple_workflow:
type: boolean
description: True जब वर्कफ़्लो में कोई कस्टम वर्कफ़्लो ग्राफ़ न हो।
is_editable:
type: boolean
description: >-
सही जब यह संस्करण `draft` होता है (ड्राफ़्ट सीधे संपादित किए जा सकते
हैं; प्रकाशित संस्करण Console में अपरिवर्तनीय होते हैं)।
workflow_url:
type: string
format: uri
description: >-
इस वर्कफ़्लो के लिए सार्वजनिक साझा करने योग्य सत्यापन URL
(`https://verify.didit.me/u/`)।
max_retry_attempts:
type: integer
description: अस्वीकृत सत्यापन के बाद अनुमत अधिकतम पुनः प्रयास (0-10)।
retry_window_days:
type: integer
nullable: true
description: >-
पुनः प्रयासों की गणना के लिए दिनों में रोलिंग विंडो (1-365)। `null`
= सर्वकालिक सीमा।
session_expiration_time:
type: integer
description: >-
किसी अधूरे सत्र की समय-सीमा समाप्त होने से पहले के सेकंड
(3600-2419200)।
version:
type: integer
description: '`workflow_id` समूह के भीतर संस्करण संख्या, 1 से शुरू होती है।'
status:
type: string
enum:
- draft
- published
description: >-
संस्करण स्थिति। नए सत्र किसी समूह के नवीनतम `published` संस्करण का
उपयोग करते हैं।
has_draft:
type: boolean
description: >-
True जब इस `workflow_id` समूह का कोई भी संस्करण वर्तमान में ड्राफ़्ट
हो।
created_by:
type: object
nullable: true
description: >-
यह संस्करण किसने बनाया: `{name, email, type}` जहाँ `type` या तो
`user` (कंसोल उपयोगकर्ता, `email` सेट है) या `api_key` (`name`
क्लाइंट आईडी है, `email` null है) है। कोई निर्माता रिकॉर्ड न होने पर
`null`।
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: >-
आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys
से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या
स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक
सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी
समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी,
कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP
सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी
के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को
छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write
के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं।
देखें https://docs.didit.me/console/api-keys।
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.