> ## 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 criar questionário: formulário KYC personalizado > Crie questionários de KYC e conformidade via API na Didit, com perguntas ordenadas, opções e traduções em 48+ idiomas. Pagamento por chamada. Prompt da API de criação de questionário Copiar o prompt para a área de transferência \

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

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

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

Requirements:
\- Use the simple v3 API shape with form_elements.
\- Do not send graph, branches, next, required_if, or conditional logic.
\- Include languages with en and default_language set to en.
\- Use customer-friendly element_type values such as short_text, multiple_choice, email, file_upload, or date_picker.
\- For choice questions, send options with value and label.
\- Store the questionnaire_id from the response because I will use it later as questionnaire_uuid in workflows.

Example request body:
\{
"title": "Customer Onboarding",
"languages": ["en"],
"default_language": "en",
"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" },
  "is_required": true,
  "options": [
    \{ "value": "employment", "label": { "en": "Employment" } },
    \{ "value": "business", "label": { "en": "Business" } },
    \{ "value": "investments", "label": { "en": "Investments" } }
  ]
}
]
}

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

\
Colar em Use este endpoint para criar questionários simples pela API. Envie um array `form_elements` na ordem em que os usuários devem responder às perguntas. A Didit monta o grafo interno do questionário para você.A API aceita apenas questionários lineares simples. Não envie `graph`, `branches`, `next` nem regras condicionais.## Campos obrigatórios- `title` é o nome interno do questionário. - `languages` deve incluir `en`. - `form_elements` deve conter pelo menos uma pergunta. - Cada elemento do formulário precisa de um `element_type` e de um `label` traduzido.Você também pode adicionar a um elemento do formulário uma `description` traduzida opcional como texto de ajuda. Ela é aceita em todos os tipos de elemento, exceto `separator`, e é retornada como a `description` do item no [relatório do questionário](https://docs.didit.me/pt-br/core-technology/questionnaires/report-questionnaire.md).## Tipos de elementoUse valores em minúsculas, como `short_text`, `multiple_choice`, `email`, `file_upload` ou `date_picker`. Valores de enum em maiúsculas, como `SHORT_TEXT`, também são aceitos.Para `dropdown`, `single_choice` e `multiple_choice`, adicione `options`. Se você omitir o `value` de uma opção, a Didit gera um a partir do rótulo.```json theme={null} { "title": "Customer Onboarding", "languages": ["en"], "default_language": "en", "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" }, "is_required": true, "options": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } }, { "value": "investments", "label": { "en": "Investments" } } ] } ] } ```## Validação de camposAdicione um objeto `validation` opcional a um elemento `short_text`, `long_text` ou `number` para exigir um formato na resposta do usuário. Isso é útil para identificadores com formatos rígidos, como identificações fiscais, documentos nacionais de identidade ou números de cartão. A validação é executada enquanto o usuário preenche o campo (o usuário não pode avançar até que ela seja aprovada) e é aplicada novamente pela API no envio.| Campo | Aplica-se a | Descrição | | - | - | - | | `pattern` | `short_text`, `long_text` | Expressão regular à qual o valor deve corresponder por completo. Use o subconjunto portátil do ECMA-262; não adicione as âncoras `^`/`$` (o valor inteiro é verificado). | | `min_length` | `short_text`, `long_text` | Número mínimo de caracteres. | | `max_length` | `short_text`, `long_text` | Número máximo de caracteres. | | `min` | `number` | Valor numérico mínimo. | | `max` | `number` | Valor numérico máximo. | | `error_message` | todos os acima | Mensagem traduzida exibida quando o valor não passa na validação. Se for omitida, é usada uma mensagem genérica. |```json theme={null} { "title": "Customer Onboarding", "languages": ["en"], "default_language": "en", "form_elements": [ { "id": "tax_id", "element_type": "short_text", "label": { "en": "Tax ID" }, "is_required": true, "validation": { "pattern": "[A-Z]{2}[0-9]{9}", "min_length": 11, "max_length": 11, "error_message": { "en": "Enter a valid Tax ID (2 letters followed by 9 digits)." } } } ] } ```A resposta inclui `questionnaire_id`. Guarde esse valor, porque você o usará como `questionnaire_uuid` ao adicionar o questionário a um workflow. ## OpenAPI ````yaml pt-br/openapi-25.json POST /v3/questionnaires/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/questionnaires/: post: tags: - Questionnaires summary: Criar questionário description: >- Cria um questionário linear simples. Envie `form_elements` na ordem de exibição; ramificações e grupos repetíveis exigem o Console. O padrão é `published` v1. operationId: create_questionnaire requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SimpleQuestionnaireRequest' examples: Simple: summary: Questionário básico value: title: Customer Onboarding description: Additional information needed for verification default_language: en languages: - en is_active: true form_elements: - id: occupation element_type: short_text label: en: What is your occupation? is_required: true placeholder: en: Software engineer - id: source_of_funds element_type: multiple_choice label: en: Source of funds is_required: true options: - value: employment label: en: Employment - value: business label: en: Business - value: investments label: en: Investments - value: other label: en: Other responses: '201': description: >- Questionário criado. A resposta inclui o `questionnaire_id`; armazene-o para referenciar este questionário em fluxos ou em futuras chamadas de atualização ou exclusão. content: application/json: schema: $ref: '#/components/schemas/QuestionnaireDetail' examples: Created: value: questionnaire_id: 11111111-2222-3333-4444-555555555555 title: Customer Onboarding description: Additional information needed for verification languages: - en default_language: en is_active: true is_simple_questionnaire: true graph: start_node: occupation nodes: occupation: element_type: SHORT_TEXT is_required: true title: en: What is your occupation? next: source_of_funds source_of_funds: element_type: MULTIPLE_CHOICE is_required: true title: en: Source of funds choices: - value: employment label: en: Employment - value: business label: en: Business next: null sections: [] questionnaire_group_id: 11111111-2222-3333-4444-555555555555 version: 1 status: published published_at: '2026-04-23T10:00:00Z' is_editable: false '400': description: >- Erro de validação. Causas comuns: um `element_type` desconhecido, um campo traduzível sem tradução para um dos `languages`, `languages` sem `en`, `default_language` fora de `languages`, uma opção sem `label`, uma pergunta que tem `branches`/`required_if`/`repeatable_config` (não suportado por este endpoint) ou o envio de um `graph` bruto em vez de `form_elements`. O corpo é um erro de validação do DRF indexado por nome de campo. content: application/json: examples: Graph not accepted: value: graph: >- The v3 questionnaire API only accepts simple `form_elements`, not `graph`. Missing label: value: form_elements: - label: - This field is required. '403': description: >- Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. content: application/json: examples: Invalid token: value: detail: You do not have permission to perform this action. '415': description: >- Tipo de mídia não suportado. Defina `Content-Type: application/json` e envie um corpo JSON. '429': description: >- Limite de requisições excedido. Tente novamente com backoff exponencial. '500': description: >- Erro inesperado do servidor ao criar o questionário. É seguro tentar novamente. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: cURL source: |- curl -X POST 'https://verification.didit.me/v3/questionnaires/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "title": "Customer Onboarding", "default_language": "en", "languages": ["en"], "form_elements": [ { "id": "occupation", "element_type": "short_text", "label": {"en": "What is your occupation?"}, "is_required": true } ] }' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.questionnaires.create( title="Customer Onboarding", description="Additional information needed for verification", languages=["en"], default_language="en", is_active=True, form_elements=[{ "id": "occupation", "element_type": "short_text", "label": {"en": "What is your occupation?"}, "placeholder": {"en": "Software engineer"}, "is_required": True, }, { "id": "source_of_funds", "element_type": "multiple_choice", "label": {"en": "Source of funds"}, "is_required": True, "options": [{ "value": "employment", "label": {"en": "Employment"}, }, { "value": "business", "label": {"en": "Business"}, }, { "value": "investments", "label": {"en": "Investments"}, }, { "value": "other", "label": {"en": "Other"}, }], }], ) 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.create({ title: "Customer Onboarding", description: "Additional information needed for verification", languages: ["en"], default_language: "en", is_active: true, form_elements: [{ id: "occupation", element_type: "short_text", label: { en: "What is your occupation?" }, placeholder: { en: "Software engineer" }, is_required: true, }, { id: "source_of_funds", element_type: "multiple_choice", label: { en: "Source of funds" }, is_required: true, options: [{ value: "employment", label: { en: "Employment" }, }, { value: "business", label: { en: "Business" }, }, { value: "investments", label: { en: "Investments" }, }, { value: "other", label: { en: "Other" }, }], }], }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Create(ctx, didit.SimpleQuestionnaireRequest{\n\tTitle: \"Customer Onboarding\",\n\tDescription: didit.String(\"Additional information needed for verification\"),\n\tLanguages: []string{\"en\"},\n\tDefaultLanguage: didit.String(\"en\"),\n\tIsActive: didit.Bool(true),\n\tFormElements: []didit.SimpleQuestionnaireElement{{\n\t\tID: didit.String(\"occupation\"),\n\t\tElementType: \"short_text\",\n\t\tLabel: map[string]string{\"en\": \"What is your occupation?\"},\n\t\tPlaceholder: didit.Some(map[string]string{\"en\": \"Software engineer\"}),\n\t\tIsRequired: didit.Bool(true),\n\t}, {\n\t\tID: didit.String(\"source_of_funds\"),\n\t\tElementType: \"multiple_choice\",\n\t\tLabel: map[string]string{\"en\": \"Source of funds\"},\n\t\tIsRequired: didit.Bool(true),\n\t\tOptions: didit.Some([]didit.SimpleQuestionnaireElementOptions{{\n\t\t\tValue: didit.String(\"employment\"),\n\t\t\tLabel: map[string]string{\"en\": \"Employment\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"business\"),\n\t\t\tLabel: map[string]string{\"en\": \"Business\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"investments\"),\n\t\t\tLabel: map[string]string{\"en\": \"Investments\"},\n\t\t}, {\n\t\t\tValue: didit.String(\"other\"),\n\t\t\tLabel: map[string]string{\"en\": \"Other\"},\n\t\t}}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.util.List; import java.util.Map; import me.didit.Didit; import me.didit.types.SimpleQuestionnaireElement; import me.didit.types.SimpleQuestionnaireRequest; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.questionnaires().create(SimpleQuestionnaireRequest.builder() .title("Customer Onboarding") .description("Additional information needed for verification") .languages(List.of("en")) .defaultLanguage("en") .isActive(true) .formElements(List.of( SimpleQuestionnaireElement.builder() .id("occupation") .elementType(SimpleQuestionnaireElement.ElementType.of("short_text")) .label(Map.of("en", "What is your occupation?")) .placeholder(Map.of("en", "Software engineer")) .isRequired(true) .build(), SimpleQuestionnaireElement.builder() .id("source_of_funds") .elementType(SimpleQuestionnaireElement.ElementType.of("multiple_choice")) .label(Map.of("en", "Source of funds")) .isRequired(true) .options(List.of( SimpleQuestionnaireElement.Options.builder() .value("employment") .label(Map.of("en", "Employment")) .build(), SimpleQuestionnaireElement.Options.builder() .value("business") .label(Map.of("en", "Business")) .build(), SimpleQuestionnaireElement.Options.builder() .value("investments") .label(Map.of("en", "Investments")) .build(), SimpleQuestionnaireElement.Options.builder() .value("other") .label(Map.of("en", "Other")) .build())) .build())) .build()); System.out.println(result); - lang: php label: PHP source: |- questionnaires->create([ 'title' => 'Customer Onboarding', 'description' => 'Additional information needed for verification', 'languages' => ['en'], 'default_language' => 'en', 'is_active' => true, 'form_elements' => [[ 'id' => 'occupation', 'element_type' => 'short_text', 'label' => ['en' => 'What is your occupation?'], 'placeholder' => ['en' => 'Software engineer'], 'is_required' => true, ], [ 'id' => 'source_of_funds', 'element_type' => 'multiple_choice', 'label' => ['en' => 'Source of funds'], 'is_required' => true, 'options' => [[ 'value' => 'employment', 'label' => ['en' => 'Employment'], ], [ 'value' => 'business', 'label' => ['en' => 'Business'], ], [ 'value' => 'investments', 'label' => ['en' => 'Investments'], ], [ 'value' => 'other', 'label' => ['en' => 'Other'], ]], ]], ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.questionnaires.create( title: "Customer Onboarding", description: "Additional information needed for verification", languages: ["en"], default_language: "en", is_active: true, form_elements: [{ id: "occupation", element_type: "short_text", label: { en: "What is your occupation?" }, placeholder: { en: "Software engineer" }, is_required: true, }, { id: "source_of_funds", element_type: "multiple_choice", label: { en: "Source of funds" }, is_required: true, options: [{ value: "employment", label: { en: "Employment" }, }, { value: "business", label: { en: "Business" }, }, { value: "investments", label: { en: "Investments" }, }, { value: "other", label: { en: "Other" }, }], }] ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Collections.Generic; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Questionnaires.CreateAsync(new SimpleQuestionnaireRequest { Title = "Customer Onboarding", Description = "Additional information needed for verification", Languages = new string[] { "en" }, DefaultLanguage = "en", IsActive = true, FormElements = new SimpleQuestionnaireElement[] { new() { Id = "occupation", ElementType = "short_text", Label = new Dictionary { ["en"] = "What is your occupation?" }, Placeholder = new Dictionary { ["en"] = "Software engineer" }, IsRequired = true, }, new() { Id = "source_of_funds", ElementType = "multiple_choice", Label = new Dictionary { ["en"] = "Source of funds" }, IsRequired = true, Options = new SimpleQuestionnaireElementOptions[] { new() { Value = "employment", Label = new Dictionary { ["en"] = "Employment" }, }, new() { Value = "business", Label = new Dictionary { ["en"] = "Business" }, }, new() { Value = "investments", Label = new Dictionary { ["en"] = "Investments" }, }, new() { Value = "other", Label = new Dictionary { ["en"] = "Other" }, }, }, }, }, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: SimpleQuestionnaireRequest: type: object description: >- Cria um questionário linear simples. A API converte `form_elements` no grafo interno do questionário. required: - title - languages - form_elements properties: title: type: string description: Nome interno do questionário. description: type: string nullable: true languages: type: array description: Idiomas incluídos em cada rótulo. Deve incluir `en`. items: type: string example: - en default_language: type: string description: Idioma padrão. Deve estar incluído em `languages`. example: en is_active: type: boolean default: true status: type: string enum: - draft - published description: >- Omita este campo para criar um questionário publicado, pronto para os fluxos. form_elements: type: array minItems: 1 description: >- Perguntas na ordem exata em que os usuários devem vê-las. Ramificações e campos condicionais não são suportados. items: $ref: '#/components/schemas/SimpleQuestionnaireElement' QuestionnaireDetail: type: object description: >- Detalhes completos do questionário retornados pelos endpoints GET, POST (criação) e PATCH (atualização). properties: questionnaire_id: type: string format: uuid description: >- Identificador único do questionário. Use este id ao referenciar o questionário a partir de um fluxo ou em requisições posteriores de atualização/exclusão. 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: Estrutura de grafo com start_node e o mapa de nós. sections: type: array description: Conteúdo do questionário agrupado em seções (derivado do grafo). items: type: object questionnaire_group_id: type: string format: uuid description: >- Identificador estável que agrupa todas as versões do mesmo questionário. version: type: integer status: type: string enum: - draft - published published_at: type: string format: date-time nullable: true is_editable: type: boolean description: >- True quando o questionário ainda pode ser editado diretamente (versões de rascunho). SimpleQuestionnaireElement: type: object required: - element_type - label properties: id: type: string description: >- ID estável opcional da pergunta. Se omitido, a API gera `q1`, `q2` etc. Use letras minúsculas, números e sublinhados para facilitar a leitura. example: source_of_funds element_type: type: string description: >- Tipo de pergunta. A API aceita estes valores em minúsculas e seus equivalentes em maiúsculas. 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: >- Rótulo da pergunta por código de idioma, por exemplo `{ "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: >- Use para `dropdown`, `single_choice` e `multiple_choice`. Se `value` for omitido, a API gera um a partir do rótulo da opção. items: type: object required: - label properties: value: type: string label: type: object additionalProperties: type: string max_files: type: integer minimum: 1 maximum: 5 description: Use com `file_upload` ou `image`. validation: type: object nullable: true description: >- Validação de formato opcional para `short_text`, `long_text` ou `number`. É aplicada enquanto o usuário preenche o campo (ele não pode avançar até que a validação seja aprovada) e verificada novamente pela API no envio. properties: pattern: type: string description: >- Expressão regular (subconjunto do ECMA-262) à qual o valor deve corresponder por completo. Para `short_text` e `long_text`. Não adicione as âncoras ^/$; o valor inteiro é verificado. min_length: type: integer minimum: 0 description: Número mínimo de caracteres. Para `short_text` e `long_text`. max_length: type: integer minimum: 0 description: Número máximo de caracteres. Para `short_text` e `long_text`. min: type: number description: Valor numérico mínimo. Para `number`. max: type: number description: Valor numérico máximo. Para `number`. error_message: type: object description: >- Mensagem traduzida exibida quando a validação falha, indexada pelo código do idioma. additionalProperties: type: string securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.