> ## 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 cuestionarios: formularios KYC

> Obtén todos los cuestionarios KYC y formularios de cumplimiento de tu organización en Didit con una sola llamada. Gestión programática, pago por llamada.



Prompt para la API de listado de cuestionarios
        Copiar el prompt al portapapeles



      
      

\<pre>

\`List every Didit questionnaire (custom form) defined for my application through the Management API.

Endpoint:
GET https://verification.didit.me/v3/questionnaires/

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

Goal:
\- Retrieve every questionnaire so I can render a picker in my back-office, sync ids into my config, or discover the questionnaire_id of a form created in the Console.
\- Use the returned questionnaire_id later as config.questionnaire_uuid on a QUESTIONNAIRE feature in a workflow (see POST /v3/workflows/).

Behavior:
\- Results are returned newest first (-created_at). The endpoint does not paginate today — all rows are returned in one response.
\- Each row is one version of a questionnaire group. questionnaire_group_id is the stable identifier shared by every version; version is the integer version number; status is "draft" or "published".
\- Workflows that reference a questionnaire group_id always resolve to the latest published version automatically.
\- is_editable: true means this row is a draft and can still be patched in place via PATCH /v3/questionnaires/{questionnaire_uuid}/.
\- question_types is an aggregated array of the form-element types present in each questionnaire (excluding section headers and separators) so you can label cards in the UI without a follow-up call.

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

What to read from the response:
\- uuid — per-version questionnaire id, used as path id in GET / PATCH / DELETE /v3/questionnaires/{questionnaire_uuid}/.
\- questionnaire_id / questionnaire_group_id — pass as config.questionnaire_uuid when attaching the questionnaire to a workflow.

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 questionnaires for this application.
\- 429 — rate limited; back off and retry.

Side effects: none. This is a pure read.

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

\</pre>



      
      

Pegar en



## OpenAPI

````yaml es/openapi-25.json GET /v3/questionnaires/
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/questionnaires/:
    get:
      tags:
        - Questionnaires
      summary: Listar cuestionarios
      description: >-
        Lista tus cuestionarios, 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;
        `questionnaire_group_id` es el ID de grupo estable que se resuelve a la
        última versión `published`.
      operationId: list_questionnaires
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
          description: Tamaño de página (número de cuestionarios 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 cuestionario
            devuelto.
      responses:
        '200':
          description: >-
            Una página de cuestionarios ordenados por `created_at` en orden
            descendente, dentro del sobre de paginación. Cada elemento de
            `results` es un `QuestionnaireListItem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Número total de versiones del cuestionario 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/QuestionnaireListItem'
              examples:
                One questionnaire:
                  summary: Un cuestionario bilingüe sencillo
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - uuid: 11111111-2222-3333-4444-555555555555
                        title: KYC Questionnaire
                        description: Additional verification questions
                        languages:
                          - en
                          - es
                        default_language: en
                        is_active: true
                        is_simple_questionnaire: true
                        created_at: '2026-04-23T09:55:00Z'
                        updated_at: '2026-04-23T10:00:00Z'
                        question_types:
                          - SHORT_TEXT
                          - MULTIPLE_CHOICE
                          - FILE_UPLOAD
                        workflow_names: []
                        questionnaire_group_id: 11111111-2222-3333-4444-555555555555
                        version: 1
                        status: published
                        published_at: '2026-04-23T10:00:00Z'
                        is_editable: false
        '403':
          description: >-
            Clave de API ausente, con formato incorrecto, expirada o asociada a
            otra aplicación.
          content:
            application/json:
              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.
        '500':
          description: >-
            Error inesperado del servidor al generar la lista. Se puede
            reintentar sin riesgo.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl -X GET 'https://verification.didit.me/v3/questionnaires/' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.questionnaires.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.questionnaires.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Questionnaires.ListAutoPaging(ctx, didit.QuestionnairesListParams{})\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.questionnaires().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->questionnaires->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.questionnaires.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.Questionnaires.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    QuestionnaireListItem:
      type: object
      description: Una versión de un cuestionario en la vista de lista.
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            UUID por versión. Úsalo como `{questionnaire_uuid}` para obtener,
            actualizar o eliminar, y como `questionnaire_uuid` en la
            configuración de la función QUESTIONNAIRE de un flujo.
        title:
          type: string
        description:
          type: string
          nullable: true
        languages:
          type: array
          items:
            type: string
        default_language:
          type: string
        is_active:
          type: boolean
        is_simple_questionnaire:
          type: boolean
          description: >-
            True para los cuestionarios lineales creados mediante esta API;
            false para los cuestionarios basados en grafos creados en la
            Console.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        question_types:
          type: array
          items:
            type: string
          description: >-
            Tipos de elemento, en mayúsculas, de las preguntas que admiten
            respuesta, en orden de creación (p. ej., `SHORT_TEXT`,
            `MULTIPLE_CHOICE`, `FILE_UPLOAD`). Se excluyen los elementos
            estructurales `SECTION_HEADER` y `SEPARATOR`. Hay una entrada por
            pregunta, por lo que los valores pueden repetirse.
        workflow_names:
          type: array
          items:
            type: string
          description: >-
            Nombres de los flujos que usan este cuestionario. Actualmente
            siempre es `[]` en este endpoint (solo se rellena en el listado de
            la Console).
        questionnaire_group_id:
          type: string
          format: uuid
          description: >-
            Identificador estable que agrupa todas las versiones del mismo
            cuestionario.
        version:
          type: integer
          description: Número de versión dentro del grupo, empezando por 1.
        status:
          type: string
          enum:
            - draft
            - published
        published_at:
          type: string
          format: date-time
          nullable: true
          description: Cuándo se publicó esta versión. `null` para los borradores.
        is_editable:
          type: boolean
          description: True cuando esta versión es un `draft`.
  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.