> ## 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 actualizar la configuración del webhook > Didit: actualiza el webhook de la aplicación, rota su secreto y fija la retención de datos, plantillas biométricas y hosts de retorno de Digital ID. Prompt de la API para actualizar la configuración de webhooks Copiar el prompt al portapapeles \

\`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.`

\
Pegar en > [!NOTE] > > `rotate_secret_key` rota solo el secreto de la aplicación, que firma las entregas al `webhook_url` heredado. Cada [destino de webhook](https://docs.didit.me/es/management-api/webhook/list-destinations.md) firma con su propio `secret_shared_key`, que esta llamada no modifica.Los campos de retención corresponden a la misma política que configuras en **Business Console → App Settings → Data retention**. Lee [Retención de datos](https://docs.didit.me/es/console/data-retention.md) antes de modificarlos, en particular la [retención de plantillas biométricas](https://docs.didit.me/es/console/data-retention.md#retención-de-plantillas-biométricas). `allowed_return_hosts` se describe en [Registra tu destino de retorno](https://docs.didit.me/es/standalone-apis/digital-id-wallets.md#registra-tu-destino-de-retorno).`biometric_consent_mode` (`auto`, `always` o `never`) define cuándo el flujo de verificación solicita el consentimiento biométrico explícito antes de una captura facial. Consulta [Consentimiento biométrico](https://docs.didit.me/es/getting-started/biometric-consent.md).Para consultar primero los valores actuales, llama a [Obtener la configuración de webhooks](https://docs.didit.me/es/management-api/webhook/get-config.md). ## OpenAPI ````yaml es/openapi-25.json PATCH /v3/webhook/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificación de identidad. Autentícate con el encabezado x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/webhook/: patch: tags: - Webhook summary: Actualizar la configuración de webhooks description: >- Actualiza parcialmente la configuración a nivel de aplicación: la URL, la versión y el secreto del webhook heredado, la política de retención de datos y de plantillas biométricas, y los hosts de retorno de la wallet de Digital ID. Envía solo los campos que quieras cambiar; la respuesta es la configuración completa, con la misma estructura que `GET /v3/webhook/`. Los destinos no se gestionan aquí: créalos, actualízalos y elimínalos con los endpoints `/v3/webhook/destinations/`, y no envíes un campo `endpoints` a este endpoint. Un cambio en `data_retention_months` también se aplica a las sesiones existentes, y las sesiones que elimina no se pueden restaurar; lee primero [Retención de datos](https://docs.didit.me/es/console/data-retention). Una clave de API con alcance limitado necesita `webhooks: write`. operationId: update_webhook_config parameters: [] requestBody: required: true content: application/json: schema: type: object description: >- Envía solo los campos que quieras cambiar. Los destinos no se gestionan aquí. properties: webhook_url: type: string format: uri nullable: true maxLength: 2000 description: >- URL de webhook heredada a nivel de aplicación. Didit solo la usa mientras la aplicación no tiene ningún destino habilitado, y en ese caso solo para `status.updated` y `data.updated`. No crea un destino, y la siguiente creación, actualización o eliminación de un destino la reemplaza. Para recibir webhooks, crea un destino con `POST /v3/webhook/destinations/`. webhook_version: type: string enum: - v1 - v2 - v3 description: Versión del payload de la `webhook_url` heredada. rotate_secret_key: type: boolean default: false description: >- `true` sustituye de inmediato la `secret_shared_key` a nivel de aplicación por un nuevo valor aleatorio; el nuevo valor viene en la respuesta. Los secretos de los destinos no cambian. Cada llamada con `true` genera un secreto nuevo, por lo que no es idempotente. capture_method: type: string enum: - MOBILE - MOBILE_AND_DESKTOP description: >- Configuración heredada de la aplicación. El flujo de verificación no la lee. data_retention_months: type: integer nullable: true minimum: 1 maximum: 120 description: >- Plazo de eliminación automática en meses (un mes equivale a 30 días), o `null` para no eliminar automáticamente. Un cambio también se aplica a las sesiones existentes: toda sesión de verificación de usuarios con una antigüedad mayor que el nuevo plazo se elimina automáticamente, y esa eliminación es irreversible. face_retention_policy: type: string enum: - delete_with_session - retain_until_user_deleted description: >- Qué ocurre con el embedding facial de una sesión cuando se elimina la sesión. `retain_until_user_deleted` requiere `face_retention_days` en la misma solicitud o ya configurado. Un cambio se aplica a las eliminaciones de sesiones a partir de ese momento; no crea ni purga ninguna plantilla biométrica existente. face_retention_days: type: integer nullable: true minimum: 1 maximum: 3650 description: >- Periodo de retención, en días, de las plantillas biométricas con `retain_until_user_deleted`. biometric_consent_mode: type: string enum: - auto - always - never description: >- Cuándo el flujo alojado y los SDK nativos piden a la persona su consentimiento biométrico explícito antes de capturar el rostro. `auto` (predeterminado) lo pide solo donde aplica un disparador: un estado declarado, la IP de la persona o el emisor del documento de identidad está en Illinois, Texas o Colorado, o la persona parece estar en EE. UU. sin un estado conocido. `always` lo pide a toda persona cuyo flujo capture el rostro. `never` nunca muestra el paso, y tú mismo recoges el consentimiento antes del selfie. Cada cambio se registra en el registro de auditoría. Consulta [Consentimiento biométrico](https://docs.didit.me/es/getting-started/biometric-consent). allowed_return_hosts: type: array maxItems: 20 description: >- Reemplaza toda la lista de hosts de retorno de wallets de Digital ID. Solo nombres de host simples, como `shop.example.com`: sin esquema, puerto, ruta ni comodines. Los valores se convierten a minúsculas y se eliminan los duplicados. Envía `[]` para vaciar la lista. items: type: string maxLength: 253 allowed_domains: type: array maxItems: 50 items: type: string maxLength: 300 description: >- Reemplaza toda la lista de orígenes permitidos. Son los orígenes (por ejemplo, `https://app.example.com`; `http` solo para `localhost`) en los que se puede integrar el flujo de verificación alojado y a los que puede devolver al usuario con un callback de sesión. Las llamadas de servidor a servidor no se ven afectadas. Una lista vacía significa que no hay ninguna restricción. Didit guarda cada origen en minúsculas y sin el puerto predeterminado. Una entrada no válida falla con `400` en `allowed_domains`. Envía `[]` para eliminar la restricción. 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: >- La configuración completa después de la actualización, con la misma forma que `GET /v3/webhook/`. Si rotaste el secreto, guarda el nuevo `secret_shared_key` antes de descartar la respuesta. 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: >- Error de validación: cada campo no válido se asigna a una lista de mensajes y no se modifica nada. Un cuerpo que no es JSON válido devuelve `{"detail": "JSON parse error - ..."}`. content: application/json: schema: type: object description: Cada campo no válido asociado a una lista de mensajes. 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: >- La clave de API ha expirado: se creó con una fecha de caducidad que ya pasó. Una clave incorrecta o revocada también recibe `401`; si falta la clave, se recibe `403`. content: application/json: schema: type: object properties: detail: type: string description: Mensaje de error legible. examples: Expired key: value: detail: This API key has expired. '403': description: >- La solicitud no está permitida. Si falta `x-api-key`, o no es válida o está revocada, se recibe `You do not have permission to perform this action.` Una clave con alcance limitado sin el acceso que necesita este endpoint recibe un mensaje que indica el acceso que falta, y una clave usada desde fuera de su lista de IP permitidas recibe `This API key can't be used from this IP address.` content: application/json: schema: type: object properties: detail: type: string description: Mensaje de error legible. 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: >- Límite de solicitudes superado: más de 300 solicitudes de escritura (POST, PATCH, PUT, DELETE) en la ventana actual de un minuto para esta clave de API. Espera `Retry-After` segundos antes de reintentar. headers: Retry-After: description: Segundos que hay que esperar antes de reintentar. schema: type: integer minimum: 1 example: 30 X-RateLimit-Limit: description: Solicitudes permitidas en la ventana de un minuto (300). schema: type: integer example: 300 X-RateLimit-Remaining: description: Solicitudes restantes en la ventana actual. schema: type: integer example: 0 X-RateLimit-Reset: description: Tiempo Unix (segundos) en que se restablece la ventana actual. schema: type: integer example: 1792056120 X-RateLimit-Scope: description: Nombre del presupuesto que se superó. schema: type: string example: generic-write content: application/json: schema: type: object properties: detail: type: string description: Mensaje de error legible. 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: |- 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: >- Configuración de webhooks a nivel de aplicación, política de retención y hosts de retorno de la wallet de Digital ID, con todos los 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 a nivel de aplicación (heredada). Didit envía a ella solo mientras la aplicación no tiene ningún destino de webhook habilitado, y en ese caso solo `status.updated` y `data.updated`. Cada vez que se crea, actualiza o elimina un destino, se establece en la URL del destino habilitado más antiguo, o en `null` si no hay ninguno habilitado. webhook_version: type: string enum: - v1 - v2 - v3 description: >- Versión del payload de la `webhook_url` heredada. Cada destino tiene su propia `webhook_version`. secret_shared_key: type: string description: >- Secreto de firma a nivel de aplicación (token de 43 caracteres seguro para URL). Solo firma las entregas al `webhook_url` heredado; cada destino firma con su propio `secret_shared_key`. Quien llama con una clave de API siempre lo recibe completo; los usuarios de la consola sin `read:webhooks` reciben una cadena vacía. capture_method: type: string enum: - MOBILE - MOBILE_AND_DESKTOP description: >- Configuración heredada de la aplicación. El flujo de verificación no la lee: las opciones de captura se configuran por flujo. data_retention_months: type: integer nullable: true minimum: 1 maximum: 120 description: >- Plazo de eliminación automática. Las sesiones de verificación de usuarios creadas hace más de este número de meses (un mes equivale a 30 días) se eliminan automáticamente, y esa eliminación es irreversible. `null` significa que las sesiones nunca se eliminan automáticamente. Consulta [Retención de datos](https://docs.didit.me/es/console/data-retention). face_retention_policy: type: string enum: - delete_with_session - retain_until_user_deleted description: >- Qué ocurre con el embedding facial de una sesión cuando se elimina la sesión. `delete_with_session` (valor predeterminado) lo elimina junto con la sesión. `retain_until_user_deleted` es la [retención de plantillas biométricas](https://docs.didit.me/es/console/data-retention#retención-de-plantillas-biométricas) opcional: una plantilla biométrica sin imágenes vinculada al User se gestiona por separado hasta que finaliza su periodo de retención, se elimina el User o la purgas. face_retention_days: type: integer nullable: true minimum: 1 maximum: 3650 description: >- Periodo de retención, en días, de las plantillas biométricas con `retain_until_user_deleted`. Obligatorio cuando se define esa política. biometric_consent_mode: type: string enum: - auto - always - never description: >- Cuándo el flujo alojado y los SDK nativos piden a la persona su consentimiento biométrico explícito antes de capturar el rostro. `auto` (predeterminado) lo pide solo donde aplica un disparador: un estado declarado, la IP de la persona o el emisor del documento de identidad está en Illinois, Texas o Colorado, o la persona parece estar en EE. UU. sin un estado conocido. `always` lo pide a toda persona cuyo flujo capture el rostro. `never` nunca muestra el paso, y tú mismo recoges el consentimiento antes del selfie. Cada cambio se registra en el registro de auditoría. Consulta [Consentimiento biométrico](https://docs.didit.me/es/getting-started/biometric-consent). available_events: type: array description: >- Todos los tipos de evento a los que se puede suscribir un destino, con una etiqueta visible. items: type: object required: - value - label properties: value: $ref: '#/components/schemas/WebhookEvent' label: type: string description: Etiqueta visible, por ejemplo `Session status updated`. allowed_return_hosts: type: array maxItems: 20 description: >- Nombres de host (coincidencia exacta, solo HTTPS) a los que una verificación independiente de wallet de Digital ID puede devolver al usuario con su `return_url`. Tu dominio de marca blanca también está siempre permitido. Consulta [Registra tu destino de retorno](https://docs.didit.me/es/standalone-apis/digital-id-wallets#registra-tu-destino-de-retorno). items: type: string maxLength: 253 endpoints: type: array description: >- Todos los destinos de webhook de la aplicación, del más antiguo al más reciente, cada uno con su secreto de firma. Aquí solo se pueden leer: gestiona los destinos con los endpoints `/v3/webhook/destinations/`. items: $ref: '#/components/schemas/WebhookConfigDestination' allowed_domains: type: array maxItems: 50 items: type: string maxLength: 300 description: >- Orígenes (por ejemplo `https://app.example.com`; `http` solo para `localhost`) en los que puede incrustarse el flujo de verificación alojado y a los que puede devolver al usuario con un callback de sesión. Las llamadas de servidor a servidor no se ven afectadas. Una lista vacía significa que no hay restricción. Didit almacena cada origen en minúsculas y sin puerto predeterminado. Una entrada no válida falla con `400` en `allowed_domains`. example: - https://app.example.com WebhookEvent: type: string description: >- Nombre de evento de webhook admitido. Usa exactamente estas cadenas en `subscribed_events`; los valores no admitidos se rechazan. 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: >- Un destino de webhook tal como aparece en la configuración de webhooks, sin métricas de entrega. `GET /v3/webhook/destinations/{destination_uuid}/` añade su resumen de entregas. required: - uuid - label - url - enabled - webhook_version - secret_shared_key - subscribed_events - created_at - updated_at properties: uuid: type: string format: uuid description: ID del destino. label: type: string maxLength: 255 description: Nombre legible. url: type: string format: uri maxLength: 2000 description: Endpoint HTTPS al que Didit envía los eventos. enabled: type: boolean description: '`false` pausa las entregas a este destino.' webhook_version: type: string enum: - v1 - v2 - v3 description: Versión del payload que se envía a este destino. secret_shared_key: type: string description: >- El secreto de firma de este destino (token URL-safe de 43 caracteres). Verifica cada webhook con el secreto del destino al que se envió. Quienes llaman con clave de API siempre lo reciben completo; los usuarios de la Console sin `read:webhooks` reciben una cadena vacía. subscribed_events: type: array uniqueItems: true description: >- Tipos de evento que se entregan a este destino. Está vacío si el destino se creó sin eventos; en ese caso no recibe 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: >- La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.