Saltar al contenido principal
PATCH

Descripción general

Actualiza parcialmente la personalización de marca blanca de la aplicación que se determina a partir de tu clave de API. Envía application/json para cambiar colores, fuentes, radios de borde y opciones de la interfaz, o multipart/form-data para subir logotipos. Solo se modifican los campos que incluyas; todo lo demás queda intacto.

Cuándo usarlo

  • Personaliza el tema del flujo: define los colores de tu marca, la fuente y los radios de las esquinas redondeadas.
  • Sube logotipos: define el logotipo cuadrado, el logotipo rectangular y su versión para modo oscuro, y el favicon.
  • Ajusta la experiencia: define el nombre público de la aplicación, la URL de la política de privacidad y opciones como omitir la pantalla de bienvenida u ocultar la barra de progreso.

Subir logotipos

Envía los logotipos como multipart/form-data:
  • image_square: relación de aspecto 1:1.
  • image_rectangular: relación de aspecto 2:1.
  • image_rectangular_dark: relación de aspecto 2:1. El logotipo rectangular para el modo oscuro, que se muestra sobre un fondo oscuro.
  • image_favicon: máximo 500 KB.
image_square, image_rectangular e image_rectangular_dark deben ser imágenes PNG, JPG o WebP, de al menos 512 px en el lado más largo y de 1 MB como máximo. Los archivos SVG se rechazan. La respuesta devuelve las URL resultantes de logo_square, logo_rectangular, logo_rectangular_dark y favicon. Para eliminar un logotipo, envía con el valor true el indicador correspondiente: delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark o delete_favicon. Después de eliminar el logotipo para modo oscuro, logo_rectangular_dark pasa a ser null. Si una misma solicitud sube un logotipo y además envía su indicador de eliminación, prevalece la subida. Una subida rechazada devuelve 400 con el nombre del campo y el motivo, por ejemplo:
  • {"image_rectangular_dark": ["Upload a PNG, JPG or WebP image."]}
  • {"image_rectangular": ["Image must be at least 512 px on its long side. Got 400x200 image dimensions"]}
  • {"image_rectangular": ["Image aspect ratio must be 2:1. Got 1024x1024 image dimensions"]}
  • {"image_square": ["File size should not exceed 1 MB"]}

Notas

  • La aplicación se determina a partir de la clave de API; no hay parámetros de ruta.
  • Los colores hexadecimales aceptan #RRGGBB o #RRGGBBAA. font_weight debe ser un peso disponible para la font_family seleccionada.
  • El dominio personalizado y el correo electrónico de marca blanca no se configuran aquí. Gestiónalos en la Business Console.

Permisos

La clave de API debe tener permiso para actualizar la personalización de la aplicación.

Relacionado

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.

Cuerpo

Cuerpo de actualización parcial de la marca. Indica solo los campos que quieras cambiar. Los colores hexadecimales aceptan #RRGGBB o #RRGGBBAA. El dominio personalizado y el correo electrónico de marca blanca no se aceptan aquí.

color_primary
string

Color de los encabezados y del texto principal.

color_secondary
string

Color del texto de párrafo / secundario.

color_background
string

Color de fondo de la página.

color_panel
string

Color del panel / de acento.

color_panel_10
string

Color del panel con un 10% de opacidad.

color_on_panel_1
string

Color del texto de apoyo en los paneles.

color_on_panel_2
string

Color de la etiqueta o insignia en los paneles.

color_on_background
string

Color del texto sobre el fondo.

color_button_1
string

Color del botón principal.

color_button_2
string

Color del botón secundario.

color_button_text_1
string

Color del texto del botón principal.

color_button_text_2
string

Color del texto del botón secundario.

color_pill_text
string

Color del texto para píldoras, campos de entrada y selectores.

border_radius_panel
integer

Radio de las esquinas del panel en píxeles.

Rango requerido: x >= 0
border_radius_buttons
integer

Radio de las esquinas del botón en píxeles.

Rango requerido: x >= 0
font_family
string

Nombre de la familia tipográfica de Google Fonts (p. ej., Inter, AR One Sans).

font_weight
string

Grosor de fuente disponible para la familia seleccionada (p. ej., regular, 500, 700).

app_public_name
string | null

Nombre público que se muestra en el flujo de verificación.

privacy_policy_url
string | null

URL de la política de privacidad que se muestra al usuario final.

skip_welcome_screen
boolean

Omite la pantalla de bienvenida inicial.

disable_login_with_didit
boolean

Continuar como invitado en lugar de mostrar la pantalla de inicio de sesión con Didit. No se puede volver a establecer en false mientras haya un dominio personalizado configurado (400).

hide_progress_bar
boolean

Oculta la barra de progreso durante el flujo.

callback_seconds
integer

Retraso (en segundos) antes de redirigir a la URL de callback.

Rango requerido: x >= 0
delete_logo_square
boolean

Si es true, elimina el logotipo cuadrado actual.

delete_logo_rectangular
boolean

Si es true, elimina el logotipo rectangular actual.

delete_logo_rectangular_dark
boolean

Si es true, elimina el logotipo actual del modo oscuro y logo_rectangular_dark pasa a ser null. Si la misma solicitud multipart también sube image_rectangular_dark, prevalece la subida.

delete_favicon
boolean

Si es true, elimina el favicon actual.

Respuesta

Personalización de marca actualizada. Se devuelve el objeto de personalización de marca COMPLETO (todos los campos, no solo los que cambiaste).

Personalización de marca blanca de una aplicación: colores, fuentes, radios, URL de logotipos y opciones de UI/UX. Las URL de logotipos son de solo lectura (se definen subiendo imágenes). No se incluyen el dominio personalizado ni el correo electrónico de marca blanca.

color_primary
string
color_secondary
string
color_background
string
color_panel
string
color_panel_10
string
color_on_panel_1
string
color_on_panel_2
string
color_on_background
string
color_button_1
string
color_button_2
string
color_button_text_1
string
color_button_text_2
string
color_pill_text
string
border_radius_panel
integer
border_radius_buttons
integer
font_family
string
font_weight
string
font_url
string | null

Solo lectura. URL resuelta de la hoja de estilos de Google Fonts para la familia seleccionada.

logo_square
string | null

URL de solo lectura del logotipo cuadrado. Súbelo mediante image_square.

logo_rectangular
string | null

URL de solo lectura del logotipo rectangular. Súbelo mediante image_rectangular.

logo_rectangular_dark
string<uri> | null

Solo lectura. URL firmada temporal del logotipo rectangular para el modo oscuro, que se muestra sobre un fondo oscuro. Es null cuando no hay ningún logotipo oscuro configurado o cuando los logotipos rectangulares no se muestran en tu cuenta. Súbelo con image_rectangular_dark.

favicon
string | null

URL de solo lectura del favicon. Súbelo mediante image_favicon.

app_public_name
string | null
privacy_policy_url
string | null
skip_welcome_screen
boolean
disable_login_with_didit
boolean
hide_progress_bar
boolean
callback_seconds
integer
Última modificación el 1 de noviembre de 2026