> ## 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 atualizar workflow: editar fluxo de KYC > Atualize um workflow de KYC ou KYB da Didit via API: renomeie, substitua recursos ordenados ou ajuste limiares. Pague por chamada, sem contratos. Prompt da API para atualizar fluxo de verificação Copiar o prompt para a área de transferência \

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

Endpoint:
PATCH https://verification.didit.me/v3/workflows/{settings_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 workflow, send workflow_label only.
\- To change workflow checks, send the full desired features array. This replaces the previous feature order and config.
\- Do not send workflow_graph, branches, actions, webhooks, or conditional logic.
\- Send features in the exact execution order.
\- Use uppercase feature values such as OCR, LIVENESS, FACE_MATCH, AML, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE_VERIFICATION, or PROOF_OF_ADDRESS.
\- Configure each feature with the fields from /management-api/workflows/feature-configs.
\- For an OCR feature, omit config.documents_allowed or send an empty object to allow every supported document type. Send config.documents_allowed only to restrict the allowed documents.
\- Keep dependency order valid. For example, put OCR before FACE_MATCH.
\- If the workflow includes QUESTIONNAIRE, use the latest questionnaire_id as config.questionnaire_uuid.

Example metadata update body:
\{
"workflow_label": "Premium KYC"
}

Example full feature replacement body:
\{
"features": [
\{
  "feature": "OCR",
  "config": {
    "documents_allowed": {
      "USA": {
        "DL": {
          "enabled": 1,
          "sides": 2
        }
      }
    }
  }
},
\{
  "feature": "AML",
  "config": {
    "aml_score_review_threshold": 70,
    "aml_score_approve_threshold": 30
  }
}
]
}

Build the API call, handle validation errors, and return the updated workflow response.`

\
Colar em Use `PATCH` para atualizações parciais. Para renomear um fluxo de verificação (workflow), envie apenas `workflow_label`.```json theme={null} { "workflow_label": "Premium KYC" } ```Para alterar as verificações do fluxo, envie o array `features` completo que você deseja. Ele substitui a ordem e a configuração anteriores dos recursos.```json theme={null} { "features": [ { "feature": "OCR", "config": { "documents_allowed": { "USA": { "DL": { "enabled": 1, "sides": 2 } } } } }, { "feature": "AML", "config": { "aml_score_review_threshold": 70, "aml_score_approve_threshold": 30 } } ] } ```A API v3 mantém os fluxos simples: um caminho linear e uma etapa final de status. Ramificações, nós de ação e nós de webhook não são aceitos aqui.## Referência de configuração de recursosQuando você envia `features` em um `PATCH`, o array substitui a ordem e a configuração anteriores dos recursos. Inclua novamente todas as configurações obrigatórias.O objeto `config` específico depende do recurso. Consulte a lista completa de campos, os valores padrão, as configurações obrigatórias, os intervalos de valores e os exemplos em [Configurações de recursos do fluxo](https://docs.didit.me/pt-br/management-api/workflows/feature-configs.md).Para `OCR`, omita `config.documents_allowed`, envie `null` ou envie `{}` para permitir todos os tipos de documento compatíveis. Inclua esse campo apenas quando quiser restringir o fluxo a países ou tipos de documento específicos. Para `QUESTIONNAIRE`, `config.questionnaire_uuid` é obrigatório.## Atualizando as configurações do fluxoVocê pode atualizar parcialmente as configurações das sessões sem alterar a lista de recursos. Envie apenas os campos que deseja alterar.| Campo | Tipo | Descrição | | - | - | - | | `is_white_label_enabled` | boolean | Ativa a personalização de marca própria para as sessões criadas com este fluxo. | | `is_desktop_allowed` | boolean | Permite que o fluxo de verificação seja executado em navegadores de desktop. | | `max_retry_attempts` | integer (0–10) | Número máximo de novas tentativas permitidas após uma verificação recusada. `0` bloqueia o usuário após a primeira recusa. | | `retry_window_days` | integer (1–365) ou `null` | Janela móvel, em dias, usada para contar as novas tentativas (`null` = limite total). | | `session_expiration_time` | integer (3600–2419200) | Segundos até que uma sessão não concluída expire. Mínimo de 1 hora, máximo de 4 semanas. |```json theme={null} { "is_white_label_enabled": true, "is_desktop_allowed": true, "max_retry_attempts": 5, "retry_window_days": 14, "session_expiration_time": 86400 } ```Use o `uuid` do fluxo retornado pelo endpoint de listagem, criação ou consulta como `settings_uuid` nesta URL. ## OpenAPI ````yaml pt-br/openapi-25.json PATCH /v3/workflows/{settings_uuid}/ 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/workflows/{settings_uuid}/: patch: tags: - Workflows summary: Atualizar fluxo de verificação description: >- Atualiza um fluxo. O versionamento depende do campo `status` que você envia e do estado atual da versão: (1) sem `status` em uma versão **publicada** → a versão publicada é atualizada no próprio lugar (mesmo `uuid`, mesma `version`); (2) sem `status` em um **rascunho** → o rascunho é atualizado e publicado imediatamente; (3) `status: "published"` em uma versão **publicada** → uma NOVA versão publicada é criada sob o mesmo `workflow_id` (novo `uuid`, `version` + 1) e retornada, e qualquer rascunho existente no grupo é excluído; (4) `status: "draft"` mantém um rascunho como rascunho (salvamento automático), mas é rejeitado com 400 em uma versão publicada (`"Cannot revert a published version to draft."`). O corpo aceita a mesma lista estrita de campos permitidos da criação: chaves desconhecidas são rejeitadas com 400. operationId: update_workflow parameters: - name: settings_uuid in: path required: true schema: type: string format: uuid description: UUID da versão do fluxo a ser atualizada. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SimpleWorkflowUpdateRequest' examples: Replace features: summary: Enviar a ordem completa desejada dos recursos value: features: - feature: OCR - feature: AML Rename: summary: Renomear um fluxo de verificação (workflow) value: workflow_label: Premium KYC Set as default: summary: Tornar este fluxo o padrão da aplicação value: is_default: true Update config: summary: Alterar a configuração do recurso value: features: - feature: OCR - feature: LIVENESS config: face_liveness_method: passive Publish a draft: summary: Promover um rascunho a publicado value: status: published responses: '200': description: >- Fluxo atualizado. O corpo é a configuração COMPLETA da versão resultante (mesmo formato bruto de `VerificationSettings` que `GET /v3/workflows/{settings_uuid}/`). Quando a atualização cria uma nova versão (`status: "published"` enviado em um registro publicado), o `uuid` e a `version` retornados diferem dos que você alterou; use o `uuid` retornado nas chamadas seguintes. content: application/json: schema: $ref: '#/components/schemas/WorkflowDetail' '400': description: >- Erro de validação: uma chave de nível superior fora da lista de chaves aceitas, um recurso desconhecido, uma ordenação inválida, um limiar fora do intervalo, referência a um questionário inexistente, um recurso `SIGNATURE` que entraria em produção sem nenhum documento para assinar, um novo recurso `SIGNATURE` com `signature_level: "aes"` enquanto a assinatura avançada (AES) não está disponível (`aes_not_available`, consulte `signature_availability` no fluxo; uma etapa que já armazena `aes` o mantém) ou `status: "draft"` enviado para uma versão publicada (`"Cannot revert a published version to draft."`). O corpo da resposta é um erro de validação do DRF com chaves por nome de campo. '403': description: Chave de API ausente ou inválida. content: application/json: examples: Invalid token: value: detail: You do not have permission to perform this action. '404': description: >- Não existe nenhum fluxo de verificação (workflow) com este `settings_uuid` para a aplicação autenticada. '415': description: >- Tipo de mídia não suportado. Defina `Content-Type: application/json`. '429': description: >- Limite de requisições excedido. Tente novamente com backoff exponencial. '500': description: Erro inesperado do servidor. É seguro tentar novamente. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: cURL source: >- curl -X PATCH 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"workflow_label": "Premium KYC"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.workflows.update( "11111111-2222-3333-4444-555555555555", features=[{ "feature": "OCR", }, { "feature": "AML", }], ) 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.update("11111111-2222-3333-4444-555555555555", { features: [{ feature: "OCR", }, { feature: "AML", }], }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SimpleWorkflowUpdateRequest{\n\tFeatures: didit.Some([]didit.SimpleWorkflowFeature{{\n\t\tFeature: \"OCR\",\n\t}, {\n\t\tFeature: \"AML\",\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 me.didit.Didit; import me.didit.types.SimpleWorkflowFeature; import me.didit.types.SimpleWorkflowUpdateRequest; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.workflows().update("11111111-2222-3333-4444-555555555555", SimpleWorkflowUpdateRequest.builder() .features(List.of( SimpleWorkflowFeature.builder() .feature(SimpleWorkflowFeature.Feature.of("OCR")) .build(), SimpleWorkflowFeature.builder() .feature(SimpleWorkflowFeature.Feature.of("AML")) .build())) .build()); System.out.println(result); - lang: php label: PHP source: >- workflows->update('11111111-2222-3333-4444-555555555555', [ 'features' => [[ 'feature' => 'OCR', ], [ 'feature' => 'AML', ]], ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.workflows.update( "11111111-2222-3333-4444-555555555555", features: [{ feature: "OCR", }, { feature: "AML", }] ) 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.UpdateAsync("11111111-2222-3333-4444-555555555555", new SimpleWorkflowUpdateRequest { Features = new SimpleWorkflowFeature[] { new() { Feature = "OCR", }, new() { Feature = "AML", }, }, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: SimpleWorkflowUpdateRequest: type: object description: >- Atualize os metadados do fluxo de verificação ou substitua a lista linear completa de recursos. Lista de campos permitidos ESTRITA: qualquer chave não listada aqui é rejeitada com 400. properties: workflow_label: type: string maxLength: 50 description: >- Nome de exibição do fluxo de verificação (workflow) (máximo de 50 caracteres). is_default: type: boolean description: Define este fluxo como padrão para novas sessões. status: type: string enum: - draft - published description: >- Controla o versionamento. Omita para atualizar a versão atual no próprio lugar (rascunhos são publicados automaticamente). `published` em uma versão já publicada cria e retorna uma NOVA versão. `draft` só é válido enquanto a versão ainda é um rascunho. features: type: array minItems: 1 description: Se informado, substitui toda a ordem e a configuração dos recursos. items: $ref: '#/components/schemas/SimpleWorkflowFeature' is_white_label_enabled: type: boolean description: >- Ativa a personalização de marca própria para as sessões criadas com este fluxo. is_desktop_allowed: type: boolean description: >- Permite que o fluxo de verificação seja executado em navegadores desktop. max_retry_attempts: type: integer minimum: 0 maximum: 10 description: >- Número máximo de novas tentativas permitidas após uma verificação recusada. `0` bloqueia o usuário após a primeira recusa. retry_window_days: type: integer minimum: 1 maximum: 365 nullable: true description: >- Janela móvel em dias usada para contar as novas tentativas. `null` aplica um limite para todo o histórico. face_liveness_max_attempts: type: integer minimum: 1 maximum: 3 description: >- Número máximo de envios de prova de vida por sessão. Esse valor também é copiado para os nós de prova de vida e de estimativa de idade gerados no fluxo de verificação (workflow), a menos que a configuração no nível do recurso o substitua. face_match_max_attempts: type: integer minimum: 1 maximum: 3 description: >- Número máximo de envios de correspondência facial por sessão. Esse valor também é copiado para os nós de correspondência facial gerados no fluxo de verificação (workflow), a menos que a configuração no nível do recurso o substitua. session_expiration_time: type: integer minimum: 3600 maximum: 2419200 description: >- Segundos até a expiração de uma sessão não concluída. Mínimo de 1 hora (3600), máximo de 4 semanas (2419200). WorkflowDetail: type: object description: >- Os campos abaixo são tipados; o objeto também traz todas as outras colunas da configuração do fluxo de verificação (ativação de recursos, limiares, ações de aviso, documentos permitidos, callbacks) como propriedades adicionais. Os campos que não se aplicam ao `workflow_type` são `null`. properties: uuid: type: string format: uuid description: >- Identificador da versão (`settings_uuid`). Cada versão de um fluxo tem o seu próprio. workflow_id: type: string format: uuid description: >- Identificador estável compartilhado por todas as versões do fluxo. As sessões criadas com ele usam a versão publicada mais recente. workflow_label: type: string description: Nome de exibição do fluxo. workflow_type: type: string nullable: true enum: - kyc - kyb - adaptive_age_verification - biometric_authentication - address_verification - questionnaire_verification - email_verification - phone_verification - null description: Modelo do fluxo. `null` para fluxos em grafo criados sem modelo. is_default: type: boolean description: Se este é o fluxo de verificação (workflow) padrão da aplicação. is_archived: type: boolean description: Fluxos arquivados não podem iniciar novas sessões. version: type: integer description: Número da versão dentro do fluxo. status: type: string enum: - draft - published description: >- As versões de rascunho são editáveis; as versões publicadas são imutáveis e usadas para novas sessões. published_at: type: string format: date-time nullable: true description: Quando esta versão foi publicada. `null` para rascunhos. is_simple_workflow: type: boolean description: '`true` quando o fluxo não tem um `workflow_graph` personalizado.' is_editable: type: boolean description: '`true` apenas para versões `draft`.' workflow_url: type: string format: uri description: URL pública que inicia uma sessão com este fluxo. workflow_graph: type: object nullable: true additionalProperties: true description: >- Estrutura de grafo do fluxo (nós e arestas). `null` para fluxos simples. features: type: string description: >- Recursos ativados unidos por `" + "`, por exemplo `"OCR + LIVENESS"`. total_price: type: number nullable: true description: Preço por sessão; para fluxos em grafo, o caminho mais caro. min_price: type: number nullable: true description: Preço do caminho mais barato do fluxo. max_price: type: number nullable: true description: Preço do caminho mais caro do fluxo. special_add_on_prices: type: object nullable: true additionalProperties: true description: >- Preços de complementos específicos da organização, ou `null` quando nenhum está definido. max_retry_attempts: type: integer description: Novas tentativas permitidas após uma verificação recusada. retry_window_days: type: integer nullable: true description: Dias durante os quais as novas tentativas são permitidas. session_expiration_time: type: integer description: Segundos até a expiração de uma sessão não concluída. questionnaire: type: object nullable: true additionalProperties: true description: O questionário vinculado ao fluxo, ou `null`. kyb_role_settings: type: array items: type: object additionalProperties: true description: >- Configurações de verificação por função para as pessoas-chave do KYB. created_at: type: string format: date-time updated_at: type: string format: date-time signature_availability: type: object description: >- Quais níveis de Assinatura eletrônica podem assinar neste momento. Verifique antes de definir `signature_level`. Retornado em fluxos `kyc`, `kyb` e de grafo. properties: simple: type: boolean description: O Simple está sempre disponível. aes: type: boolean description: >- Indica se a assinatura Avançada (AES) pode assinar agora. Enquanto for `false`, salvar uma nova etapa com `signature_level: "aes"` é recusado com `aes_not_available`. qes: type: boolean description: >- Indica se a assinatura Qualificada (QES) pode assinar agora. É `false` até que um provedor qualificado seja conectado. is_bank_verification_enabled: type: boolean description: >- Indica se um fluxo simples de KYC ou KYB executa a Verificação bancária. Ela é executada após as etapas de contato (e a Verificação de localização) e antes da validação de banco de dados, da AML e da análise de IP. A Verificação bancária ainda não está disponível para todos: ativá-la é recusado onde quer que ela não esteja habilitada. bank_verification_config: type: object additionalProperties: true description: >- Configurações de verificação bancária de um fluxo simples, com as mesmas chaves aceitas por um nó `BANK_VERIFICATION` (por exemplo, `bank_countries` e `bank_method_order`). Chaves desconhecidas são descartadas. Todas as chaves são opcionais e uma chave ausente mantém seu valor padrão, então `{}` significa todos os valores padrão. Consulte [Configurações de verificação bancária](/pt-br/management-api/workflows/feature-configs#verificação-bancária). example: {} is_geolocation_enabled: type: boolean description: >- Indica se um fluxo simples de KYC executa a Verificação de localização. Ela é executada após as etapas de contato e antes da Verificação bancária e da validação de banco de dados. Fluxos de empresas (KYB) não podem executá-la. geolocation_config: type: object additionalProperties: true description: >- Configurações de verificação de localização de um fluxo de verificação (workflow) simples, com as mesmas chaves que um nó `GEOLOCATION` aceita (por exemplo, `is_geolocation_geofencing_enabled` e `geolocation_max_attempts`). Chaves desconhecidas são descartadas. Todas as chaves são opcionais e uma chave ausente mantém seu valor padrão, então `{}` significa todos os valores padrão. example: {} additionalProperties: true SimpleWorkflowFeature: type: object required: - feature properties: feature: type: string description: >- Recurso a ser executado. Use os valores em maiúsculas mostrados aqui. enum: - OCR - NFC - LIVENESS - FACE_MATCH - PROOF_OF_ADDRESS - QUESTIONNAIRE - DOCUMENT_AI - PHONE_VERIFICATION - EMAIL_VERIFICATION - DATABASE_VALIDATION - AML - IP_ANALYSIS - AGE_ESTIMATION - KYB_REGISTRY - KYB_DOCUMENTS - KYB_KEY_PEOPLE - SIGNATURE config: type: object description: >- Configurações específicas do recurso. Para `QUESTIONNAIRE`, inclua `questionnaire_uuid` com o `questionnaire_id` retornado pelo endpoint de criação de questionário. Para `SIGNATURE`, um fluxo de verificação (workflow) que entra em produção precisa de um documento para assinar: defina `signature_documents_source` como `session` ou `both` para que cada sessão possa trazer o seu, ou envie `status: "draft"` e adicione os documentos antes de publicar. `signature_level: "aes"` é recusado com `aes_not_available` enquanto `signature_availability.aes` for `false` no fluxo. Para `OCR`, `methods` seleciona quais métodos de Verificação de identidade cada país pode usar (captura de documento, consulta sem documento a uma fonte governamental ou outra fonte oficial e carteiras de identidade digital); se omitido, todos os países usam somente captura de documento. Para `SIGNATURE`, consulte as [configurações de Assinatura eletrônica](/pt-br/management-api/workflows/feature-configs#assinatura-eletrônica): `signature_level` aceita, por enquanto, `simple` (o padrão, sem necessidade de verificação de identidade, e-mail ou telefone) e `aes`, e os documentos do fluxo e seus campos são gerenciados no console; por isso, pela API, envie documentos e campos por sessão com `signature_documents_source: "session"`. additionalProperties: true label: type: string description: Rótulo interno opcional para este nó do fluxo. 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.