> ## 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 de flux de treball: obtenir flux de verificació

> Consulta la configuració completa d'un flux de treball KYC o KYB de Didit, inclosos funcionalitats, llindars i documents acceptats. Preu per ús.



Prompt de l'API per obtenir un flux de treball
        Copia el prompt al porta-retalls



      
      

\<pre>

\`Fetch the full configuration of a single Didit workflow through the Management API.

Endpoint:
GET https://verification.didit.me/v3/workflows/{settings_uuid}/

Authentication:
Use the x-api-key header with my Didit API key.

Goal:
\- Retrieve every editable field on the workflow (feature toggles, score thresholds, documents_allowed per country, KYB role config, retry policy, callback config, etc.).
\- Useful for back-office "view workflow" screens, debugging why a verification declined/routed to review, or verifying a freshly published version.

Path parameter:
\- settings_uuid — the per-version workflow UUID returned by GET /v3/workflows/ or POST /v3/workflows/. Each workflow version has its own settings_uuid; workflow_id is the stable group id shared by every version.

Example call:
curl -X GET "https://verification.didit.me/v3/workflows/{settings_uuid}/" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- workflow_id — stable group id; compare across versions to walk version history.
\- features and the underlying workflow_graph — describes which checks run and in what order.
\- Threshold and action fields per feature — see /management-api/workflows/feature-configs for the full reference.

Failure modes:
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope when the workflow belongs to a different application than the API key.
\- 404 — workflow not found in this application (also returned when settings_uuid is valid in another application).

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Enganxa a



## OpenAPI

````yaml ca/openapi-25.json GET /v3/workflows/{settings_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/workflows/{settings_uuid}/:
    get:
      tags:
        - Workflows
      summary: Obtenir el flux de treball
      description: >-
        Obtén la configuració completa d'una versió del flux de treball
        mitjançant `settings_uuid`: commutadors de funcionalitats, llindars,
        documents permesos, graf, política de reintents, crides de retorn i
        preus.
      operationId: get_workflow
      parameters:
        - name: settings_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            UUID per versió del flux de treball (el valor `uuid` retornat per
            l'endpoint de llistat). Cada versió d'un flux de treball té el seu
            propi `settings_uuid`.
      responses:
        '200':
          description: >-
            Configuració completa del flux de treball. L'estructura és la
            serialització en brut de `VerificationSettings` (~190 camps: cada
            commutador de funcionalitat, llindar, acció d'advertència,
            configuració de documents permesos, el `workflow_graph`, política de
            reintents, callbacks i preus). L'exemple següent està abreujat.
            Notes: `features` és una cadena unida per `" + "` (p. ex. `"OCR +
            LIVENESS"`), els preus són números JSON i `is_editable` és `true`
            només per a versions `draft`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowDetail'
              examples:
                KYC workflow with face match (abbreviated):
                  value:
                    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_liveness_enabled: true
                    face_liveness_method: passive
                    face_liveness_score_decline_threshold: 50
                    face_liveness_score_review_threshold: 70
                    is_face_match_enabled: true
                    face_match_score_decline_threshold: 40
                    face_match_score_review_threshold: 60
                    is_aml_enabled: false
                    is_phone_verification_enabled: false
                    is_email_verification_enabled: false
                    is_database_validation_enabled: false
                    is_ip_analysis_enabled: false
                    is_nfc_enabled: false
                    duplicated_user_action: no_action
                    documents_allowed:
                      ESP:
                        P:
                          sides: 1
                          enabled: 1
                          subtypes:
                            - EPASSPORT
                            - PASSPORT_GENERIC
                          preferred_characters: latin
                          expiration_check_mode: strict
                    max_retry_attempts: 3
                    retry_window_days: 7
                    session_expiration_time: 604800
                    version: 2
                    status: published
                    published_at: '2026-04-12T10:30:00Z'
                    is_simple_workflow: false
                    is_editable: false
                    workflow_url: https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ
                    total_price: 0.15
                    min_price: 0.15
                    max_price: 0.15
                    features: OCR + LIVENESS + FACE_MATCH
                    created_at: '2025-01-15T10:30:00Z'
                    updated_at: '2026-04-12T10:30:00Z'
        '403':
          description: >-
            Falta la clau d'API, està mal formada, ha caducat o està assignada a
            una aplicació diferent.
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            No existeix cap flux de treball amb aquest `settings_uuid` per a
            l'aplicació autenticada. O bé l'UUID és incorrecte o pertany a una
            altra aplicació; Didit no distingeix expressament entre ambdós casos
            per evitar revelar l'existència de registres d'altres aplicacions.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            S'ha superat el límit de freqüència. Reintenta amb un retrocés
            exponencial.
        '500':
          description: Error inesperat del servidor. Es pot reintentar amb seguretat.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.workflows.retrieve(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.workflows.retrieve("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.workflows().retrieve("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->workflows->retrieve('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.workflows.retrieve("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Workflows.RetrieveAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    WorkflowDetail:
      type: object
      description: >-
        Els camps següents estan tipats; l'objecte també conté la resta de
        columnes de la configuració del flux de treball (commutadors de
        funcionalitats, llindars, accions d'advertència, documents permesos,
        callbacks) com a propietats addicionals. Els camps que no s'apliquen al
        `workflow_type` són `null`.
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Identificador per versió (`settings_uuid`). Cada versió d'un flux de
            treball té el seu propi identificador.
        workflow_id:
          type: string
          format: uuid
          description: >-
            Identificador estable compartit per totes les versions del flux de
            treball. Les sessions creades amb aquest identificador utilitzen
            l'última versió publicada.
        workflow_label:
          type: string
          description: Nom visible del flux de treball.
        workflow_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - adaptive_age_verification
            - biometric_authentication
            - address_verification
            - questionnaire_verification
            - email_verification
            - phone_verification
            - null
          description: >-
            Plantilla de flux de treball. `null` per a fluxos de treball basats
            en grafs creats sense plantilla.
        is_default:
          type: boolean
          description: Si aquest és el flux de treball per defecte de l'aplicació.
        is_archived:
          type: boolean
          description: Els fluxos de treball arxivats no poden iniciar noves sessions.
        version:
          type: integer
          description: Número de versió dins del flux de treball.
        status:
          type: string
          enum:
            - draft
            - published
          description: >-
            Les versions en esborrany són editables; les versions publicades són
            immutables i s'utilitzen per a noves sessions.
        published_at:
          type: string
          format: date-time
          nullable: true
          description: Quan es va publicar aquesta versió. `null` per a esborranys.
        is_simple_workflow:
          type: boolean
          description: >-
            `true` quan el flux de treball no té cap `workflow_graph`
            personalitzat.
        is_editable:
          type: boolean
          description: '`true` només per a versions `draft`.'
        workflow_url:
          type: string
          format: uri
          description: URL pública que inicia una sessió amb aquest flux de treball.
        workflow_graph:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Estructura del graf del flux de treball (nodes i arestes). `null`
            per a fluxos de treball simples.
        features:
          type: string
          description: >-
            Funcionalitats habilitades unides amb `" + "`, per exemple `"OCR +
            LIVENESS"`.
        total_price:
          type: number
          nullable: true
          description: >-
            Preu per sessió; per als fluxos de treball amb graf, el camí més
            car.
        min_price:
          type: number
          nullable: true
          description: Preu del camí més econòmic a través del flux de treball.
        max_price:
          type: number
          nullable: true
          description: Preu del camí més car a través del flux de treball.
        special_add_on_prices:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Preus de complements específics de l'organització, o `null` si no
            n'hi ha cap de definit.
        max_retry_attempts:
          type: integer
          description: Reintents permesos després d'una verificació rebutjada.
        retry_window_days:
          type: integer
          nullable: true
          description: Dies durant els quals es permeten els reintents.
        session_expiration_time:
          type: integer
          description: Segons abans que caduqui una sessió no finalitzada.
        questionnaire:
          type: object
          nullable: true
          additionalProperties: true
          description: El qüestionari adjunt al flux de treball, o `null`.
        kyb_role_settings:
          type: array
          items:
            type: object
            additionalProperties: true
          description: Configuració de verificació per rol per a persones clau de KYB.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        signature_availability:
          type: object
          description: >-
            Quins nivells de signatura electrònica poden signar ara mateix.
            Comprova-ho abans d'establir `signature_level`. Es retorna en fluxos
            de treball `kyc`, `kyb` i de graf.
          properties:
            simple:
              type: boolean
              description: El pla Simple sempre està disponible.
            aes:
              type: boolean
              description: >-
                Indica si es pot signar amb signatura avançada (AES) en aquest
                moment. Mentre sigui `false`, desar un nou pas amb
                `signature_level: "aes"` es rebutjarà amb `aes_not_available`.
            qes:
              type: boolean
              description: >-
                Indica si es pot signar amb signatura qualificada (QES) en
                aquest moment. És `false` fins que es connecti un proveïdor
                qualificat.
        is_bank_verification_enabled:
          type: boolean
          description: >-
            Indica si un flux de treball senzill de KYC o KYB executa la
            verificació bancària. S'executa després dels passos de contacte (i
            la verificació d'ubicació) i abans de la validació en bases de
            dades, l'anàlisi AML i l'anàlisi d'IP. La verificació bancària
            encara no està disponible de manera general: activar-la es rebutjarà
            allà on no estigui habilitada.
        bank_verification_config:
          type: object
          additionalProperties: true
          description: >-
            Configuració de verificació bancària d'un flux de treball simple,
            amb les mateixes claus que accepta un node `BANK_VERIFICATION` (per
            exemple `bank_countries` i `bank_method_order`). Les claus
            desconegudes es descarten. Cada clau és opcional i una clau absent
            manté el seu valor per defecte, de manera que `{}` indica tots els
            valors per defecte. Consulta [Configuració de verificació
            bancària](/ca/management-api/workflows/feature-configs#verificació-bancària).
          example: {}
        is_geolocation_enabled:
          type: boolean
          description: >-
            Indica si un flux de treball senzill de KYC executa la verificació
            d'ubicació. S'executa després dels passos de contacte i abans de la
            verificació bancària i la validació en bases de dades. Els fluxos de
            treball d'empreses (KYB) no la poden executar.
        geolocation_config:
          type: object
          additionalProperties: true
          description: >-
            Configuració de verificació d'ubicació d'un flux de treball simple,
            amb les mateixes claus que accepta un node `GEOLOCATION` (per
            exemple, `is_geolocation_geofencing_enabled` i
            `geolocation_max_attempts`). S'ometen les claus desconegudes. Totes
            les claus són opcionals i una clau absent manté el seu valor per
            defecte, de manera que `{}` implica tots els valors per defecte.
          example: {}
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.