> ## 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: редактирование KYC-формы

> Редактируйте KYC-анкету Didit через API: переименование, замена вопросов по порядку, многоязычные подписи. Оплата за вызов.



Обновление анкеты: промпт для API
        Скопировать промпт в буфер обмена



      
      

\<pre>

\`Update a simple Didit questionnaire through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/questionnaires/{questionnaire_uuid}/

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

Requirements:
\- Use PATCH and include only the fields I want to change.
\- To rename the questionnaire, send title or description only.
\- To change questions, send the full desired form_elements array. This replaces the existing question list.
\- Do not send graph, branches, next, required_if, or conditional logic.
\- Keep languages consistent with the questionnaire. Include en labels for every form element.
\- Capture the questionnaire_id returned by the response because published updates may return a new version id.

Example metadata update body:
\{
"title": "Updated Customer Onboarding"
}

Example full question replacement body:
\{
"form_elements": [
\{
  "id": "occupation",
  "element_type": "short_text",
  "label": { "en": "What is your occupation?" },
  "is_required": true
},
\{
  "id": "source_of_funds",
  "element_type": "multiple_choice",
  "label": { "en": "Source of funds" },
  "options": [
    \{ "value": "employment", "label": { "en": "Employment" } },
    \{ "value": "business", "label": { "en": "Business" } }
  ]
}
]
}

Build the API call, handle validation errors, and return the latest questionnaire_id from the response.`

\</pre>



      
      

Вставьте в

Используйте `PATCH` для частичных обновлений. Чтобы переименовать анкету, отправьте только `title` или `description`.```json theme={null}
{
  "title": "Updated Customer Onboarding"
}
```Чтобы обновить вопросы, отправьте полный нужный массив `form_elements`. Он заменит предыдущий список вопросов. Сохраните существующие вопросы, которые вы хотите оставить.```json theme={null}
{
  "form_elements": [
    {
      "id": "occupation",
      "element_type": "short_text",
      "label": { "en": "What is your occupation?" },
      "is_required": true
    },
    {
      "id": "source_of_funds",
      "element_type": "multiple_choice",
      "label": { "en": "Source of funds" },
      "options": [
        { "value": "employment", "label": { "en": "Employment" } },
        { "value": "business", "label": { "en": "Business" } }
      ]
    }
  ]
}
```API v3 поддерживает только простые линейные анкеты. Он отклоняет `graph`, `branches`, `next` и условные правила.Ответ содержит `questionnaire_id`. При обновлении анкеты со статусом `published` API может создать новую версию. Сохраните возвращённый `questionnaire_id` и используйте его в сценариях, а не считайте, что id из URL по-прежнему указывает на последнюю версию.


## OpenAPI

````yaml ru/openapi-25.json PATCH /v3/questionnaires/{questionnaire_uuid}/
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/questionnaires/{questionnaire_uuid}/:
    patch:
      tags:
        - Questionnaires
      summary: Обновить анкету
      description: >-
        Обновить анкету. Версионирование зависит от переданного поля `status` и
        текущего состояния версии: (1) нет `status` для **опубликованной**
        версии → опубликованная версия обновляется на месте (тот же
        `questionnaire_id`, та же `version`); (2) нет `status` для **черновика**
        → черновик обновляется и сразу публикуется; (3) `status: "published"`
        для **опубликованной** версии → создаётся и возвращается НОВАЯ
        опубликованная версия в той же `questionnaire_group_id` (новый
        `questionnaire_id`, `version` + 1), а любой существующий черновик в
        группе удаляется; (4) `status: "draft"` сохраняет черновик как черновик
        (автосохранение), но для опубликованной версии отклоняется с ошибкой 400
        (`"Cannot revert a published version to draft."`).
      operationId: update_questionnaire
      parameters:
        - name: questionnaire_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID конкретной версии обновляемой анкеты.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimpleQuestionnaireUpdateRequest'
            examples:
              Rename:
                summary: Переименовать анкету
                value:
                  title: Updated Customer Onboarding
              Replace questions:
                summary: Заменить весь линейный список вопросов
                value:
                  form_elements:
                    - id: occupation
                      element_type: short_text
                      label:
                        en: What is your occupation?
                      is_required: true
                    - id: source_of_funds
                      element_type: multiple_choice
                      label:
                        en: Source of funds
                      options:
                        - value: employment
                          label:
                            en: Employment
                        - value: business
                          label:
                            en: Business
      responses:
        '200':
          description: >-
            Анкета обновлена. Тело содержит последнее состояние полученной
            версии — обновлённую на месте версию или вновь созданную
            опубликованную версию, если вы передали `status: "published"` для
            опубликованной строки (в этом случае `questionnaire_id` и `version`
            отличаются от тех, к которым применялся патч). Поле
            `questionnaire_id` в ответе представляет собой UUID конкретной
            версии; используйте `questionnaire_group_id`, если вам нужен
            неизменный идентификатор группы.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionnaireDetail'
        '400':
          description: >-
            Ошибка валидации — неизвестный `element_type`, отсутствует перевод,
            неподдерживаемые поля ветвления/условий, в `languages` отсутствует
            `en`, `default_language` отсутствует в `languages`, вариант без
            метки, отправка необработанного `graph` или `status: "draft"` для
            опубликованной версии (`"Cannot revert a published version to
            draft."`). Тело ответа представляет собой ошибку валидации DRF с
            ключами по именам полей.
        '403':
          description: API-ключ отсутствует или недействителен.
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Анкета с таким `questionnaire_uuid` не существует для
            аутентифицированного приложения.
        '415':
          description: >-
            Неподдерживаемый тип содержимого. Укажите `Content-Type:
            application/json`.
        '429':
          description: >-
            Превышен лимит запросов. Повторите попытку с экспоненциальной
            задержкой.
        '500':
          description: Непредвиденная ошибка сервера. Повторная попытка безопасна.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -X PATCH
            'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"title": "Updated Customer Onboarding"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.questionnaires.update(
                "11111111-2222-3333-4444-555555555555",
                title="Updated Customer Onboarding",
            )
            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.questionnaires.update("11111111-2222-3333-4444-555555555555",
            {
              title: "Updated Customer Onboarding",
            });

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

            import me.didit.types.SimpleQuestionnaireUpdateRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.questionnaires().update("11111111-2222-3333-4444-555555555555",
            SimpleQuestionnaireUpdateRequest.builder()
                    .title("Updated Customer Onboarding")
                    .build());
            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->questionnaires->update('11111111-2222-3333-4444-555555555555',
            [
                'title' => 'Updated Customer Onboarding',
            ]);

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

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

            result = didit.questionnaires.update(
              "11111111-2222-3333-4444-555555555555",
              title: "Updated Customer Onboarding"
            )
            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.Questionnaires.UpdateAsync("11111111-2222-3333-4444-555555555555",
            new SimpleQuestionnaireUpdateRequest

            {
                Title = "Updated Customer Onboarding",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    SimpleQuestionnaireUpdateRequest:
      type: object
      description: >-
        Обновить метаданные анкеты или заменить полный линейный список
        `form_elements`.
      properties:
        title:
          type: string
        description:
          type: string
          nullable: true
        languages:
          type: array
          items:
            type: string
        default_language:
          type: string
        is_active:
          type: boolean
        status:
          type: string
          enum:
            - draft
            - published
        form_elements:
          type: array
          minItems: 1
          description: Если указано, полностью заменяет весь линейный список вопросов.
          items:
            $ref: '#/components/schemas/SimpleQuestionnaireElement'
    QuestionnaireDetail:
      type: object
      description: >-
        Полные сведения об анкете, возвращаемые из endpoint’ов GET, POST
        (создание) и PATCH (обновление).
      properties:
        questionnaire_id:
          type: string
          format: uuid
          description: >-
            Уникальный идентификатор анкеты. Используйте этот id при ссылке на
            анкету из сценария или в последующих запросах на
            обновление/удаление.
        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
        graph:
          type: object
          description: Структура графа с полем start_node и отображением nodes.
        sections:
          type: array
          description: Содержимое анкеты, сгруппированное по разделам (на основе графа).
          items:
            type: object
        questionnaire_group_id:
          type: string
          format: uuid
          description: >-
            Постоянный идентификатор, объединяющий все версии одной и той же
            анкеты.
        version:
          type: integer
        status:
          type: string
          enum:
            - draft
            - published
        published_at:
          type: string
          format: date-time
          nullable: true
        is_editable:
          type: boolean
          description: >-
            True, когда анкету всё ещё можно редактировать на месте (черновые
            версии).
    SimpleQuestionnaireElement:
      type: object
      required:
        - element_type
        - label
      properties:
        id:
          type: string
          description: >-
            Необязательный стабильный идентификатор вопроса. Если опущен, API
            генерирует `q1`, `q2` и т. д. Для удобства чтения используйте
            строчные буквы, цифры и символы подчеркивания.
          example: source_of_funds
        element_type:
          type: string
          description: >-
            Тип вопроса. API принимает эти значения в нижнем регистре, а также
            их эквиваленты в верхнем регистре.
          enum:
            - short_text
            - long_text
            - dropdown
            - single_choice
            - multiple_choice
            - number
            - image
            - file_upload
            - time
            - email
            - address
            - phone
            - country
            - date_picker
            - consent
            - section_header
            - separator
            - heading
            - paragraph
        label:
          type: object
          description: 'Метка вопроса по коду языка, например `{ "en": "Source of funds" }`.'
          additionalProperties:
            type: string
        description:
          type: object
          nullable: true
          additionalProperties:
            type: string
        placeholder:
          type: object
          nullable: true
          additionalProperties:
            type: string
        is_required:
          type: boolean
          default: false
        options:
          type: array
          description: >-
            Используется для `dropdown`, `single_choice` и `multiple_choice`.
            Если `value` не указано, API генерирует его на основе метки
            варианта.
          items:
            type: object
            required:
              - label
            properties:
              value:
                type: string
              label:
                type: object
                additionalProperties:
                  type: string
        max_files:
          type: integer
          minimum: 1
          maximum: 5
          description: Используется с `file_upload` или `image`.
        validation:
          type: object
          nullable: true
          description: >-
            Необязательная валидация формата для `short_text`, `long_text` или
            `number`. Применяется во время заполнения поля пользователем (он не
            сможет продолжить, пока проверка не будет пройдена) и повторно
            проверяется API при отправке.
          properties:
            pattern:
              type: string
              description: >-
                Регулярное выражение (подмножество ECMA-262), которому значение
                должно полностью соответствовать. Для `short_text` и
                `long_text`. Не добавляйте символы привязки ^/$; сопоставляется
                всё значение целиком.
            min_length:
              type: integer
              minimum: 0
              description: Минимальное количество символов. Для `short_text` и `long_text`.
            max_length:
              type: integer
              minimum: 0
              description: >-
                Максимальное количество символов. Для `short_text` и
                `long_text`.
            min:
              type: number
              description: Минимальное числовое значение. Для `number`.
            max:
              type: number
              description: Максимальное числовое значение. Для `number`.
            error_message:
              type: object
              description: >-
                Переведённое сообщение, отображаемое при сбое валидации, с
                ключом, соответствующим коду языка.
              additionalProperties:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        может иметь ограниченную область действия: без доступа, чтение или
        запись для каждого ресурса, ограничение определенными сценариями или
        одобренными сессиями, списком IP-адресов и сроком действия. 401
        означает, что ключ неверен, отозван или его срок действия истек; 403
        означает, что ключ не был передан, у ключа нет доступа к этому ресурсу
        или действию, либо запрос поступил с адреса вне его списка IP-адресов;
        404 на маршруте сессии означает, что сессия не входит в сценарии или
        статусы ключа. Ключ без доступа к медиа получает URL изображений, видео
        и PDF как null, а ключ без прав на запись сессий получает ссылки на
        сессии и токены как null. См. https://docs.didit.me/console/api-keys.

````

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