> ## 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.

# Atualizar configuração de webhook API

> Atualize na Didit o webhook da aplicação, rode o segredo, defina a retenção de dados e templates biométricos e registe hosts de retorno da wallet.



Prompt da API de atualização da configuração do webhook
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Update my Didit application's webhook configuration through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/webhook/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs webhooks: write.

Goal:
\- Change application-level settings: the legacy webhook URL and version, the application secret, the data-retention and biometric-template retention policy, the Digital ID wallet return hosts, or the allowed origins of the hosted flow.

Behavior:
\- Partial update: send only the fields to change. The response is the full configuration, the same shape as GET /v3/webhook/.
\- webhook_url and webhook_version change the application-level (legacy) webhook only. Didit uses it only while the application has no enabled destination, and only for status.updated and data.updated. It does not create a destination, and the next create, update or delete of a destination replaces webhook_url. To receive webhooks, create a destination with POST /v3/webhook/destinations/ instead.
\- rotate_secret_key: true replaces the application-level secret_shared_key immediately. Destination secrets are not changed. Each call generates a new secret, so it is not idempotent.
\- data_retention_months (1 to 120, or null for no automatic deletion): user verification sessions older than this many 30-day months are deleted automatically. Business verification sessions are not affected.
\- face_retention_policy (delete_with_session or retain_until_user_deleted) and face_retention_days (1 to 3650). retain_until_user_deleted needs face_retention_days in the same request or already set.
\- allowed_return_hosts replaces the registered list: up to 20 bare hostnames such as app.example.com (no scheme, port, path or wildcard). Send [] to clear it.
\- allowed_domains replaces the list of web origins (for example https://app.example.com; http only for localhost) that the hosted verification flow may be embedded in and may send the user back to with a session callback: up to 50 entries of at most 300 characters. Send [] to remove the restriction. Server-to-server calls are not affected. An invalid entry returns 400 on allowed_domains.
\- Manage destinations with the /v3/webhook/destinations/ endpoints, not here. Never send an endpoints field to this call: it is not part of this contract.

Example call:
curl -X PATCH "https://verification.didit.me/v3/webhook/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'

What to read from the response:
\- The updated fields, and secret_shared_key when you rotated it: store the new value before you discard the response.

Failure modes:
\- 400: field errors, each field mapped to a list of messages, for example { "face_retention_days": ["A finite retention duration is required when face retention is enabled."] }. Nothing is changed.
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." } or { "detail": "This API key has no write access to webhooks." }
\- 429: more than 300 write requests per minute with this key; wait for Retry-After.

Side effects:
\- Rotating the secret changes how deliveries to the legacy webhook_url are signed from then on, retries included.
\- A data_retention_months change applies to existing sessions too: every session older than the new window is deleted automatically, and that deletion is irreversible.
\- A face_retention_policy change applies to session deletions from then on; it creates or purges no existing biometric template.

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

\</pre>



      
      

Colar em

> [!NOTE]
>
> `rotate_secret_key` faz a rotação apenas do segredo ao nível da aplicação, que assina as entregas enviadas para o `webhook_url` legado. Cada [destino do webhook](https://docs.didit.me/pt/management-api/webhook/list-destinations.md) assina com o seu próprio `secret_shared_key`, que este pedido não altera.Os campos de retenção seguem a mesma política que define em Business Console → App Settings → Data retention. Leia [Conservação de dados](https://docs.didit.me/pt/console/data-retention.md) antes de os alterar, em especial a [retenção de templates biométricos](https://docs.didit.me/pt/console/data-retention.md#retenção-de-modelo-biométrico). O `allowed_return_hosts` é descrito em [Registe o seu destino de retorno](https://docs.didit.me/pt/standalone-apis/digital-id-wallets.md#registe-o-seu-destino-de-retorno).`biometric_consent_mode` (`auto`, `always` ou `never`) define quando o fluxo de verificação pede o consentimento biométrico explícito antes de uma captura facial. Consulte [Consentimento biométrico](https://docs.didit.me/pt/getting-started/biometric-consent.md).Para ler primeiro os valores atuais, chame [Obter a configuração do webhook](https://docs.didit.me/pt/management-api/webhook/get-config.md).


## OpenAPI

````yaml pt/openapi-25.json PATCH /v3/webhook/
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/webhook/:
    patch:
      tags:
        - Webhook
      summary: Atualizar configuração do webhook
      description: >-
        Atualize parcialmente as definições ao nível da aplicação: o URL, a
        versão e o segredo do webhook legado, a política de conservação de dados
        e de templates biométricos, e os hosts de retorno da carteira Digital
        ID. Envie apenas os campos a alterar; a resposta é a configuração
        completa, com a mesma estrutura que `GET /v3/webhook/`. Os destinos não
        são geridos aqui: crie-os, atualize-os e elimine-os com os endpoints
        `/v3/webhook/destinations/`, e não envie um campo `endpoints` para este
        endpoint. Uma alteração em `data_retention_months` também se aplica às
        sessões existentes, e as sessões que esta eliminar não podem ser
        restauradas; leia primeiro [Conservação de
        dados](https://docs.didit.me/pt/console/data-retention). Uma chave de
        API com âmbito necessita de `webhooks: write`.
      operationId: update_webhook_config
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Envie apenas os campos a alterar. Os destinos não são geridos
                aqui.
              properties:
                webhook_url:
                  type: string
                  format: uri
                  nullable: true
                  maxLength: 2000
                  description: >-
                    URL de webhook legado ao nível da aplicação. O Didit
                    utiliza-o apenas enquanto a aplicação não tiver nenhum
                    destino ativado e, mesmo assim, apenas para `status.updated`
                    e `data.updated`. Não cria um destino, e a próxima criação,
                    atualização ou eliminação de um destino substitui-o. Para
                    receber webhooks, crie antes um destino com `POST
                    /v3/webhook/destinations/`.
                webhook_version:
                  type: string
                  enum:
                    - v1
                    - v2
                    - v3
                  description: Versão do payload do `webhook_url` legado.
                rotate_secret_key:
                  type: boolean
                  default: false
                  description: >-
                    `true` substitui imediatamente a `secret_shared_key` ao
                    nível da aplicação por um novo valor aleatório; o novo valor
                    está na resposta. Os segredos dos destinos não são
                    alterados. Cada chamada com `true` gera um novo segredo,
                    pelo que não é idempotente.
                capture_method:
                  type: string
                  enum:
                    - MOBILE
                    - MOBILE_AND_DESKTOP
                  description: >-
                    Definição legada da aplicação. O fluxo de verificação não a
                    lê.
                data_retention_months:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 120
                  description: >-
                    Janela de eliminação automática em meses (um mês conta como
                    30 dias), ou `null` para nenhuma eliminação automática. Uma
                    alteração aplica-se também a sessões existentes: todas as
                    sessões de verificação de utilizadores com uma antiguidade
                    superior à nova janela são eliminadas automaticamente, e
                    essa eliminação é irreversível.
                face_retention_policy:
                  type: string
                  enum:
                    - delete_with_session
                    - retain_until_user_deleted
                  description: >-
                    O que acontece ao embedding facial de uma sessão quando a
                    sessão é eliminada. `retain_until_user_deleted` requer
                    `face_retention_days` no mesmo pedido ou já definido. Uma
                    alteração aplica-se às eliminações de sessões a partir desse
                    momento; não cria nem elimina definitivamente nenhum
                    template biométrico existente.
                face_retention_days:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 3650
                  description: >-
                    Período de conservação, em dias, dos templates biométricos
                    sob `retain_until_user_deleted`.
                biometric_consent_mode:
                  type: string
                  enum:
                    - auto
                    - always
                    - never
                  description: >-
                    Quando o fluxo alojado e os SDKs nativos solicitam à pessoa
                    consentimento biométrico explícito antes de uma captura de
                    rosto. `auto` (predefinição) solicita apenas quando se
                    aplica um acionador: um estado declarado, o IP da pessoa ou
                    o emissor do documento de identificação situa-se em
                    Illinois, Texas ou Colorado, ou a pessoa aparenta estar nos
                    EUA sem um estado conhecido. `always` solicita a todas as
                    pessoas cujo fluxo capture um rosto. `never` nunca apresenta
                    o passo, e recolhe o consentimento por sua conta antes da
                    selfie. Cada alteração é registada no registo de auditoria.
                    Consulte [Consentimento
                    biométrico](https://docs.didit.me/pt/getting-started/biometric-consent).
                allowed_return_hosts:
                  type: array
                  maxItems: 20
                  description: >-
                    Substitui toda a lista de anfitriões de retorno da carteira
                    de Digital ID. Apenas nomes de anfitrião simples, como
                    `shop.example.com`: sem esquema, porta, caminho ou caráter
                    universal. Os valores são convertidos para minúsculas e os
                    duplicados são eliminados. Envie `[]` para limpar a lista.
                  items:
                    type: string
                    maxLength: 253
                allowed_domains:
                  type: array
                  maxItems: 50
                  items:
                    type: string
                    maxLength: 300
                  description: >-
                    Substitui toda a lista de origens permitidas. Origens (por
                    exemplo `https://app.example.com`; `http` apenas para
                    `localhost`) nas quais o fluxo de verificação alojado pode
                    ser incorporado e para as quais pode redirecionar o
                    utilizador com um callback de sessão. As chamadas servidor a
                    servidor não são afetadas. Uma lista vazia significa sem
                    restrições. A Didit armazena cada origem em minúsculas sem
                    uma porta predefinida. Uma entrada inválida falha com `400`
                    em `allowed_domains`. Envie `[]` para remover a restrição.
                  example:
                    - https://app.example.com
            examples:
              Enable biometric template retention:
                value:
                  face_retention_policy: retain_until_user_deleted
                  face_retention_days: 365
                  biometric_consent_mode: auto
              Rotate the legacy secret:
                value:
                  rotate_secret_key: true
              Set data retention:
                value:
                  data_retention_months: 24
              Register return hosts:
                value:
                  allowed_return_hosts:
                    - shop.example.com
                    - app.example.com
      responses:
        '200':
          description: >-
            A configuração completa após a atualização, com a mesma estrutura de
            `GET /v3/webhook/`. Quando rodar o segredo, guarde a nova
            `secret_shared_key` antes de descartar a resposta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfig'
              examples:
                Retention enabled:
                  value:
                    webhook_url: https://yourapp.com/webhooks/didit
                    webhook_version: v3
                    secret_shared_key: dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA
                    capture_method: MOBILE
                    data_retention_months: 24
                    face_retention_policy: retain_until_user_deleted
                    face_retention_days: 365
                    biometric_consent_mode: auto
                    available_events:
                      - value: status.updated
                        label: Session status updated
                      - value: data.updated
                        label: Session data updated
                      - value: user.status.updated
                        label: User status updated
                      - value: user.data.updated
                        label: User data updated
                      - value: business.status.updated
                        label: Business status updated
                      - value: business.data.updated
                        label: Business data updated
                      - value: activity.created
                        label: Activity created
                      - value: transaction.created
                        label: Transaction created
                      - value: transaction.status.updated
                        label: Transaction status updated
                      - value: travel_rule.status.updated
                        label: Travel Rule Status Updated
                      - value: workflow.compliance_changed
                        label: Workflow Compliance Changed
                    allowed_return_hosts:
                      - shop.example.com
                    endpoints:
                      - uuid: 11111111-2222-3333-4444-555555555555
                        label: Production session webhooks
                        url: https://yourapp.com/webhooks/didit
                        enabled: true
                        webhook_version: v3
                        secret_shared_key: dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA
                        subscribed_events:
                          - status.updated
                          - data.updated
                        created_at: '2026-01-04T08:00:00.000000Z'
                        updated_at: '2026-04-22T14:09:11.523671Z'
        '400':
          description: >-
            A validação falhou: cada campo inválido é mapeado para uma lista de
            mensagens e nada é alterado. Um corpo que não seja JSON válido
            devolve `{"detail": "JSON parse error - ..."}`.
          content:
            application/json:
              schema:
                type: object
                description: Cada campo inválido mapeado para uma lista de mensagens.
                additionalProperties:
                  type: array
                  items:
                    type: string
              examples:
                Retention days missing:
                  value:
                    face_retention_days:
                      - >-
                        A finite retention duration is required when face
                        retention is enabled.
                    biometric_consent_mode: auto
                Retention window out of range:
                  value:
                    data_retention_months:
                      - Ensure this value is less than or equal to 120.
                Invalid return host:
                  value:
                    allowed_return_hosts:
                      - >-
                        'https://shop.example.com' is not a hostname. Register
                        the bare host (e.g. shop.example.com): no scheme, port,
                        path or wildcard.
                Invalid choice:
                  value:
                    face_retention_policy:
                      - '"forever" is not a valid choice.'
        '401':
          description: >-
            A chave de API expirou: foi criada com uma data de validade que já
            passou. Uma chave incorreta ou revogada também recebe `401`; uma
            chave em falta recebe `403`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            O pedido não é permitido. Um `x-api-key` em falta, inválido ou
            revogado recebe `You do not have permission to perform this action.`
            Uma chave com âmbito sem o acesso de que este endpoint necessita
            recebe uma mensagem a indicar o acesso em falta, e uma chave
            utilizada fora da sua lista de permissões de IP recebe `This API key
            can't be used from this IP address.`
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Missing or invalid key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without webhooks write:
                  value:
                    detail: This API key has no write access to webhooks.
                Outside the IP allowlist:
                  value:
                    detail: This API key can't be used from this IP address.
        '429':
          description: >-
            Limite de pedidos excedido: mais de 300 pedidos de escrita (POST,
            PATCH, PUT, DELETE) na janela atual de um minuto para esta chave de
            API. Aguarde `Retry-After` segundos antes de tentar novamente.
          headers:
            Retry-After:
              description: Segundos a aguardar antes de tentar novamente.
              schema:
                type: integer
                minimum: 1
                example: 30
            X-RateLimit-Limit:
              description: Pedidos permitidos na janela de um minuto (300).
              schema:
                type: integer
                example: 300
            X-RateLimit-Remaining:
              description: Pedidos restantes na janela atual.
              schema:
                type: integer
                example: 0
            X-RateLimit-Reset:
              description: Hora Unix (segundos) em que a janela atual é reposta.
              schema:
                type: integer
                example: 1792056120
            X-RateLimit-Scope:
              description: Nome do orçamento que foi excedido.
              schema:
                type: string
                example: generic-write
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Throttled:
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.webhooks.update_config(
                face_retention_policy="retain_until_user_deleted",
                face_retention_days=365,
                biometric_consent_mode="auto",
            )
            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.webhooks.updateConfig({
              face_retention_policy: "retain_until_user_deleted",
              face_retention_days: 365,
              biometric_consent_mode: "auto",
            });
            console.log(result);
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.WebhooksUpdateConfigParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
                    .faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
                    .faceRetentionDays(365L)
                    .biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
                    .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->webhooks->updateConfig([
                'face_retention_policy' => 'retain_until_user_deleted',
                'face_retention_days' => 365,
                'biometric_consent_mode' => 'auto',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.webhooks.update_config(
              face_retention_policy: "retain_until_user_deleted",
              face_retention_days: 365,
              biometric_consent_mode: "auto"
            )
            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.Webhooks.UpdateConfigAsync(new
            WebhooksUpdateConfigParams

            {
                FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
                FaceRetentionDays = 365,
                BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    WebhookConfig:
      type: object
      description: >-
        Configuração de webhooks ao nível da aplicação, política de conservação
        e anfitriões de retorno de carteira Digital ID, com todos os destinos de
        webhook.
      required:
        - webhook_url
        - webhook_version
        - secret_shared_key
        - capture_method
        - data_retention_months
        - face_retention_policy
        - face_retention_days
        - available_events
        - allowed_return_hosts
        - endpoints
      properties:
        webhook_url:
          type: string
          format: uri
          nullable: true
          description: >-
            URL de webhook ao nível da aplicação (legado). O Didit apenas envia
            para este URL enquanto a aplicação não tiver nenhum destino ativado,
            e apenas envia `status.updated` e `data.updated`. Cada criação,
            atualização ou eliminação de um destino define-o para o URL do
            destino ativado mais antigo, ou `null` quando nenhum estiver
            ativado.
        webhook_version:
          type: string
          enum:
            - v1
            - v2
            - v3
          description: >-
            Versão do payload do `webhook_url` legado. Cada destino tem o seu
            próprio `webhook_version`.
        secret_shared_key:
          type: string
          description: >-
            Segredo de assinatura ao nível da aplicação (token de 43 carateres
            seguro para URL). Assina apenas entregas para o `webhook_url`
            legado; cada destino assina com a sua própria `secret_shared_key`.
            Chamadas autenticadas com chave de API recebem-no sempre na íntegra;
            utilizadores da Consola sem `read:webhooks` recebem uma cadeia de
            carateres vazia.
        capture_method:
          type: string
          enum:
            - MOBILE
            - MOBILE_AND_DESKTOP
          description: >-
            Definição legada da aplicação. O fluxo de verificação não a lê: as
            opções de captura são configuradas por fluxo.
        data_retention_months:
          type: integer
          nullable: true
          minimum: 1
          maximum: 120
          description: >-
            Janela de eliminação automática. As sessões de verificação de
            utilizadores criadas há mais meses do que este valor (um mês conta
            como 30 dias) são eliminadas automaticamente, e essa eliminação é
            irreversível. `null` significa que as sessões nunca são eliminadas
            automaticamente. Consulte [Conservação de
            dados](https://docs.didit.me/pt/console/data-retention).
        face_retention_policy:
          type: string
          enum:
            - delete_with_session
            - retain_until_user_deleted
          description: >-
            O que acontece ao embedding facial de uma sessão quando a sessão é
            eliminada. `delete_with_session` (predefinição) elimina-o com a
            sessão. `retain_until_user_deleted` é a opção de adesão à
            [conservação de templates
            biométricos](https://docs.didit.me/pt/console/data-retention#retenção-de-modelo-biométrico):
            um template biométrico sem imagem associado ao Utilizador é gerido
            separadamente até que o seu período de conservação termine, o
            Utilizador seja eliminado ou o elimine definitivamente.
        face_retention_days:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3650
          description: >-
            Período de conservação, em dias, dos templates biométricos sob
            `retain_until_user_deleted`. Obrigatório quando essa política está
            definida.
        biometric_consent_mode:
          type: string
          enum:
            - auto
            - always
            - never
          description: >-
            Quando o fluxo alojado e os SDKs nativos solicitam à pessoa
            consentimento biométrico explícito antes de uma captura de rosto.
            `auto` (predefinição) solicita apenas quando se aplica um acionador:
            um estado declarado, o IP da pessoa ou o emissor do documento de
            identificação situa-se em Illinois, Texas ou Colorado, ou a pessoa
            aparenta estar nos EUA sem um estado conhecido. `always` solicita a
            todas as pessoas cujo fluxo capture um rosto. `never` nunca
            apresenta o passo, e recolhe o consentimento por sua conta antes da
            selfie. Cada alteração é registada no registo de auditoria. Consulte
            [Consentimento
            biométrico](https://docs.didit.me/pt/getting-started/biometric-consent).
        available_events:
          type: array
          description: >-
            Todos os tipos de eventos que um destino pode subscrever, com uma
            etiqueta de exibição.
          items:
            type: object
            required:
              - value
              - label
            properties:
              value:
                $ref: '#/components/schemas/WebhookEvent'
              label:
                type: string
                description: Etiqueta visível, por exemplo `Session status updated`.
        allowed_return_hosts:
          type: array
          maxItems: 20
          description: >-
            Nomes de anfitrião (correspondência exata, apenas HTTPS) para os
            quais uma verificação autónoma de carteira de Identidade Digital
            pode reenviar o utilizador com o seu `return_url`. O seu domínio de
            marca branca também é sempre permitido. Consulte [Registar o seu
            destino de
            retorno](https://docs.didit.me/pt/standalone-apis/digital-id-wallets#registe-o-seu-destino-de-retorno).
          items:
            type: string
            maxLength: 253
        endpoints:
          type: array
          description: >-
            Todos os destinos de webhook da aplicação, do mais antigo para o
            mais recente, cada um com o respetivo segredo de assinatura. Apenas
            de leitura aqui: faça a gestão dos destinos com os endpoints
            `/v3/webhook/destinations/`.
          items:
            $ref: '#/components/schemas/WebhookConfigDestination'
        allowed_domains:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 300
          description: >-
            Origens (por exemplo `https://app.example.com`; `http` apenas para
            `localhost`) nas quais o fluxo de verificação alojado pode ser
            incorporado e para as quais pode redirecionar o utilizador com um
            retorno de chamada da sessão. As chamadas servidor a servidor não
            são afetadas. Uma lista vazia significa nenhuma restrição. A Didit
            armazena cada origem em minúsculas sem uma porta predefinida. Uma
            entrada inválida falha com `400` em `allowed_domains`.
          example:
            - https://app.example.com
    WebhookEvent:
      type: string
      description: >-
        Nome de evento de webhook suportado. Utilize estas strings exatas em
        `subscribed_events`; valores não suportados são rejeitados.
      enum:
        - status.updated
        - data.updated
        - user.status.updated
        - user.data.updated
        - business.status.updated
        - business.data.updated
        - activity.created
        - transaction.created
        - transaction.status.updated
        - travel_rule.status.updated
        - workflow.compliance_changed
        - transaction_rule_suggestions.created
        - auth.signup
        - auth.login
        - auth.login_failed
        - auth.password_reset_requested
        - auth.password_reset_completed
        - auth.mfa_changed
        - auth.new_device
        - auth.account_locked
        - investigator.report.ready
        - investigator.decision.automated
        - investigator.decision.overridden
        - investigator.decision.contested
        - investigator.question.raised
        - investigator.automation.paused
        - investigator.rfi.answered
        - investigator.rfi.overdue
        - investigator.drift.detected
        - investigator.sla.breached
        - investigator.qa.failed
        - investigator.external.report.ready
    WebhookConfigDestination:
      type: object
      description: >-
        Um destino do webhook conforme listado na configuração de webhooks, sem
        métricas de entrega. `GET /v3/webhook/destinations/{destination_uuid}/`
        adiciona o seu resumo de entrega.
      required:
        - uuid
        - label
        - url
        - enabled
        - webhook_version
        - secret_shared_key
        - subscribed_events
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
          format: uuid
          description: ID do destino.
        label:
          type: string
          maxLength: 255
          description: Nome legível por humanos.
        url:
          type: string
          format: uri
          maxLength: 2000
          description: Endpoint HTTPS para o qual a Didit envia eventos.
        enabled:
          type: boolean
          description: '`false` pausa as entregas para este destino.'
        webhook_version:
          type: string
          enum:
            - v1
            - v2
            - v3
          description: Versão do payload enviada para este destino.
        secret_shared_key:
          type: string
          description: >-
            O segredo de assinatura deste destino (token de 43 carateres
            compatível com URL). Verifique cada webhook com o segredo do destino
            para onde foi enviado. Quem chama a API com uma chave de API
            recebe-o sempre por extenso; os utilizadores da Consola sem
            `read:webhooks` recebem uma cadeia vazia.
        subscribed_events:
          type: array
          uniqueItems: true
          description: >-
            Tipos de eventos entregues a este destino. Vazios quando o destino
            foi criado sem eventos, caso em que não recebe nada.
          items:
            $ref: '#/components/schemas/WebhookEvent'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A chave de API da sua aplicação, a partir de Programadores -> Chaves de
        API na Business Console. A chave principal tem acesso total. Uma chave
        nomeada pode ter o âmbito definido: nenhum, 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á
        incorreta, 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 o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs
        como nulos, e uma chave sem permissão de escrita em sessões recebe
        ligações de sessão e tokens como nulos. Consulte
        https://docs.didit.me/console/api-keys.

````

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