> ## 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. # Obter configuração de webhook (API) > Consulte na API da Didit as definições de webhook: URL e segredo, destinos, eventos, retenção de dados e domínios de retorno da carteira. Prompt da API para obter a configuração do webhook Copiar o prompt para a área de transferência \

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

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

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

Goal:
\- Get every setting that controls how Didit sends webhooks for my application, plus the data-retention policy and the Digital ID wallet return hosts, in one call. Use it to audit the setup or to show the current configuration in a back office.

Behavior:
\- Didit delivers webhooks to webhook destinations (/v3/webhook/destinations/). Each destination has its own url, webhook_version, secret_shared_key and subscribed_events.
\- webhook_url, webhook_version and secret_shared_key at the top level are the application-level (legacy) webhook. Didit uses them only while the application has no enabled destination, and then only for status.updated and data.updated.
\- Every create, update or delete of a destination sets webhook_url to the URL of the oldest enabled destination, or null when none is enabled.
\- API-key callers always receive the application secret and every destination secret in full.

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

What to read from the response:
\- endpoints: every destination, oldest first, with uuid, label, url, enabled, webhook_version, secret_shared_key and subscribed_events. Verify each webhook with the secret of the destination it was sent to.
\- available_events: every event type you can subscribe a destination to ({ value, label }).
\- webhook_url, webhook_version, secret_shared_key: the legacy webhook, only relevant when no destination is enabled.
\- data_retention_months (null means no automatic deletion), face_retention_policy and face_retention_days: the retention policy.
\- allowed_return_hosts: hosts a Digital ID wallet verification may send the person back to.
\- allowed_domains: web origins the hosted verification flow may be embedded in and may send the user back to; empty means no restriction.
\- capture_method: MOBILE or MOBILE_AND_DESKTOP. A legacy setting with no effect; capture options are set per workflow.

Failure modes:
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." } for a missing key (a wrong, revoked or expired key gets 401); { "detail": "This API key has no read access to webhooks." } for a scoped key without webhooks: read.
\- 429: more than 600 GET requests per minute with this key; wait for Retry-After.

Side effects: none. This is a pure read, and the response contains signing secrets: never log it.

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

\
Colar em Este endpoint devolve o webhook a nível da aplicação, anterior à existência dos destinos, juntamente com a lista de destinos. A Didit entrega os webhooks aos seus [destinos do webhook](https://docs.didit.me/pt/management-api/webhook/list-destinations.md), cada um assinado com o seu próprio `secret_shared_key`. Os campos de nível superior `webhook_url`, `webhook_version` e `secret_shared_key` só são usados enquanto nenhum destino estiver ativado, e nesse caso apenas para `status.updated` e `data.updated`.> [!WARNING] > > A resposta contém todos os segredos de assinatura da sua aplicação. Não a inclua em registos nem em código do lado do cliente.Para alterar estas definições, use [Atualizar configuração do webhook](https://docs.didit.me/pt/management-api/webhook/update-config.md). Para a verificação da assinatura e os payloads, consulte o [guia de webhooks](https://docs.didit.me/pt/integration/webhooks.md). Para os campos de conservação de dados, consulte [Conservação de dados](https://docs.didit.me/pt/console/data-retention.md). ## OpenAPI ````yaml pt/openapi-25.json GET /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/: get: tags: - Webhook summary: Obter configuração do webhook description: >- Devolve as definições de webhook da aplicação numa única chamada: cada [destino do webhook](https://docs.didit.me/pt/management-api/webhook/list-destinations) com o respetivo segredo de assinatura, os tipos de evento a que um destino pode subscrever-se, o URL, versão e segredo de webhook ao nível da aplicação (legados), a política de conservação de dados e de templates biométricos e os hosts de retorno da carteira Digital ID. A Didit entrega webhooks nos destinos, cada um assinado com a sua própria `secret_shared_key`; os campos de nível superior `webhook_url`, `webhook_version` e `secret_shared_key` são utilizados apenas enquanto nenhum destino estiver ativado e, mesmo assim, apenas para `status.updated` e `data.updated`. A resposta contém segredos de assinatura, pelo que deve mantê-la fora de registos e do código do lado do cliente. Uma chave de API com âmbito necessita de `webhooks: read`. operationId: get_webhook_config parameters: [] responses: '200': description: A configuração do webhook. content: application/json: schema: $ref: '#/components/schemas/WebhookConfig' examples: One destination: 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: delete_with_session face_retention_days: null 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' '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 read: value: detail: This API key has no read 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 600 pedidos GET 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 (600). schema: type: integer example: 600 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-get content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Throttled: value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X GET 'https://verification.didit.me/v3/webhook/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.webhooks.retrieve_config() 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.retrieveConfig(); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.RetrieveConfig(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.webhooks().retrieveConfig(); System.out.println(result); - lang: php label: PHP source: |- webhooks->retrieveConfig(); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.webhooks.retrieve_config 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.RetrieveConfigAsync(); 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.