Saltar al contenido principal
PATCH
cURL
Usa PATCH para actualizaciones parciales. Para cambiar el nombre de un flujo de verificación (workflow), envía solo workflow_label.
Para cambiar las comprobaciones del flujo, envía el array features completo tal como lo quieres. Esto reemplaza el orden y la configuración anteriores de las funciones.
La API v3 mantiene los flujos simples: una única ruta lineal y un único paso de estado final. Aquí no se aceptan ramas, nodos de acción ni nodos de webhook.

Referencia de configuración de funciones

Cuando envías features en un PATCH, el array reemplaza el orden y la configuración anteriores de las funciones. Vuelve a incluir toda la configuración obligatoria. El objeto config exacto depende de la función. Consulta la lista completa de campos, los valores predeterminados, los ajustes obligatorios, los rangos de valores y los ejemplos en Configuración de funciones del flujo. Para OCR, omite config.documents_allowed, envía null o envía {} para permitir todos los tipos de documento admitidos. Inclúyelo solo cuando quieras restringir el flujo a países o tipos de documento concretos. Para QUESTIONNAIRE, config.questionnaire_uuid es obligatorio.

Actualizar la configuración del flujo

Puedes modificar ajustes a nivel de sesión sin tocar la lista de funciones. Envía solo los campos que quieras cambiar.
Usa el uuid del flujo que devuelve el endpoint de listado, creación u obtención como settings_uuid en esta URL.

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.

Parámetros de ruta

settings_uuid
string<uuid>
requerido

UUID por versión del flujo que se va a actualizar.

Cuerpo

application/json

Actualiza los metadatos del flujo o reemplaza la lista lineal completa de funciones. Lista ESTRICTA de campos permitidos: cualquier clave que no figure aquí se rechaza con un 400.

workflow_label
string

Nombre visible del flujo de verificación (máx. 50 caracteres).

Maximum string length: 50
is_default
boolean

Establece este flujo de verificación (workflow) como predeterminado para las nuevas sesiones.

status
enum<string>

Controla el versionado. Omítelo para actualizar la versión actual sin crear una nueva (los borradores se publican automáticamente). published en una versión ya publicada crea y devuelve una versión NUEVA. draft solo es válido mientras la versión siga siendo un borrador.

Opciones disponibles:
draft,
published
features
object[]

Si se proporciona, sustituye por completo el orden y la configuración de las funciones.

Minimum array length: 1
is_white_label_enabled
boolean

Activa la personalización de marca blanca para las sesiones creadas con este flujo de verificación (workflow).

is_desktop_allowed
boolean

Permite que el flujo de verificación se ejecute en navegadores de escritorio.

max_retry_attempts
integer

Número máximo de reintentos permitidos tras una verificación rechazada. 0 bloquea al usuario tras el primer rechazo.

Rango requerido: 0 <= x <= 10
retry_window_days
integer | null

Ventana móvil en días que se usa para contar los reintentos. null aplica un límite sobre todo el historial.

Rango requerido: 1 <= x <= 365
face_liveness_max_attempts
integer

Número máximo de envíos de prueba de vida por sesión. Este valor también se copia en los nodos de prueba de vida y de estimación de edad generados en el flujo, salvo que la configuración a nivel de función lo sobrescriba.

Rango requerido: 1 <= x <= 3
face_match_max_attempts
integer

Número máximo de envíos de coincidencia facial por sesión. Este valor también se copia en los nodos de coincidencia facial generados en el flujo, salvo que la configuración a nivel de función lo sobrescriba.

Rango requerido: 1 <= x <= 3
session_expiration_time
integer

Segundos antes de que expire una sesión sin finalizar. Mínimo 1 hora (3600), máximo 4 semanas (2419200).

Rango requerido: 3600 <= x <= 2419200

Respuesta

Flujo actualizado. El cuerpo es la configuración COMPLETA de la versión resultante (con la misma forma VerificationSettings sin procesar que GET /v3/workflows/{settings_uuid}/). Cuando la actualización crea una versión nueva (al enviar status: "published" sobre una fila publicada), los valores de uuid y version devueltos son distintos de los que modificaste: usa el uuid devuelto en las llamadas posteriores.

Los campos siguientes están tipados; el objeto también incluye todas las demás columnas de la configuración del flujo (activación de funciones, umbrales, acciones ante advertencias, documentos permitidos, callbacks) como propiedades adicionales. Los campos que no se aplican al workflow_type son null.

uuid
string<uuid>

Identificador por versión (settings_uuid). Cada versión de un flujo tiene el suyo.

workflow_id
string<uuid>

Identificador estable compartido por todas las versiones del flujo. Las sesiones creadas con él usan la última versión publicada.

workflow_label
string

Nombre visible del flujo.

workflow_type
enum<string> | null

Plantilla del flujo. null en los flujos de grafo creados sin plantilla.

Opciones disponibles:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

Si este es el flujo predeterminado de la aplicación.

is_archived
boolean

Los flujos archivados no pueden iniciar nuevas sesiones.

version
integer

Número de versión dentro del flujo.

status
enum<string>

Las versiones en borrador son editables; las versiones publicadas son inmutables y se usan para las nuevas sesiones.

Opciones disponibles:
draft,
published
published_at
string<date-time> | null

Cuándo se publicó esta versión. null para los borradores.

is_simple_workflow
boolean

true cuando el flujo no tiene un workflow_graph personalizado.

is_editable
boolean

true solo para las versiones draft.

workflow_url
string<uri>

URL pública que inicia una sesión con este flujo.

workflow_graph
object | null

Estructura de grafo del flujo de verificación (workflow) (nodos y aristas). null para flujos simples.

features
string

Funciones habilitadas unidas con " + ", por ejemplo "OCR + LIVENESS".

total_price
number | null

Precio por sesión; en los flujos de tipo grafo, la ruta más cara.

min_price
number | null

Precio de la ruta más económica del flujo.

max_price
number | null

Precio de la ruta más cara del flujo.

special_add_on_prices
object | null

Precios de complementos específicos de la organización, o null si no hay ninguno configurado.

max_retry_attempts
integer

Reintentos permitidos tras una verificación rechazada.

retry_window_days
integer | null

Días durante los que se permiten los reintentos.

session_expiration_time
integer

Segundos antes de que expire una sesión sin finalizar.

questionnaire
object | null

El cuestionario asociado al flujo, o null.

kyb_role_settings
object[]

Configuración de verificación por rol para las personas clave de KYB.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

Qué niveles de Firma electrónica pueden firmar en este momento. Consúltalo antes de definir signature_level. Se devuelve en los flujos kyc, kyb y de grafo.

is_bank_verification_enabled
boolean

Indica si un flujo de verificación (workflow) simple de KYC o KYB ejecuta la verificación bancaria. Se ejecuta después de los pasos de contacto (y de la verificación de ubicación) y antes de la validación de base de datos, el análisis AML y el análisis de IP. La verificación bancaria aún no está disponible de forma general: se rechaza su activación donde no esté habilitada.

bank_verification_config
object

Configuración de verificación bancaria de un flujo simple, con las mismas claves que admite un nodo BANK_VERIFICATION (por ejemplo, bank_countries y bank_method_order). Las claves desconocidas se descartan. Todas las claves son opcionales y una clave ausente mantiene su valor predeterminado, por lo que {} significa todos los valores predeterminados. Consulta Configuración de verificación bancaria.

Ejemplo:
is_geolocation_enabled
boolean

Indica si un flujo de verificación (workflow) simple de KYC ejecuta la verificación de ubicación. Se ejecuta después de los pasos de contacto y antes de la verificación bancaria y la validación de base de datos. Los flujos de empresas (KYB) no pueden ejecutarla.

geolocation_config
object

Configuración de verificación de ubicación de un flujo simple, con las mismas claves que admite un nodo GEOLOCATION (por ejemplo, is_geolocation_geofencing_enabled y geolocation_max_attempts). Las claves desconocidas se descartan. Todas las claves son opcionales y una clave ausente conserva su valor predeterminado, por lo que {} significa todos los valores predeterminados.

Ejemplo:
Última modificación el 1 de noviembre de 2026