Saltar al contenido principal
GET
curl
Este endpoint devuelve el webhook a nivel de aplicación, el que se usaba antes de que existieran los destinos, junto con la lista de destinos. Didit entrega los webhooks a tus destinos de webhook, cada uno firmado con su propio secret_shared_key. Los campos de nivel superior webhook_url, webhook_version y secret_shared_key solo se usan mientras no haya ningún destino habilitado, y en ese caso únicamente para status.updated y data.updated.
La respuesta contiene todos los secretos de firma de tu aplicación. No la incluyas en registros ni en código del lado del cliente.
Para cambiar esta configuración, usa Actualizar configuración de webhook. Para la verificación de firma y los payloads, consulta la guía de webhooks. Para los campos de retención, consulta Retención de datos.

Autorizaciones

x-api-key
string
header
requerido

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.

Respuesta

La configuración del webhook.

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.

webhook_url
string<uri> | null
requerido

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
enum<string>
requerido

Versión del payload de la webhook_url heredada. Cada destino tiene su propia webhook_version.

Opciones disponibles:
v1,
v2,
v3
secret_shared_key
string
requerido

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
enum<string>
requerido

Configuración heredada de la aplicación. El flujo de verificación no la lee: las opciones de captura se configuran por flujo.

Opciones disponibles:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null
requerido

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.

Rango requerido: 1 <= x <= 120
face_retention_policy
enum<string>
requerido

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

Opciones disponibles:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null
requerido

Periodo de retención, en días, de las plantillas biométricas con retain_until_user_deleted. Obligatorio cuando se define esa política.

Rango requerido: 1 <= x <= 3650
available_events
object[]
requerido

Todos los tipos de evento a los que se puede suscribir un destino, con una etiqueta visible.

allowed_return_hosts
string[]
requerido

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.

Maximum array length: 20
Maximum string length: 253
endpoints
object[]
requerido

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

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.

Opciones disponibles:
auto,
always,
never
allowed_domains
string[]

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.

Maximum array length: 50
Maximum string length: 300
Ejemplo:
Última modificación el 1 de noviembre de 2026