curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"color_primary": "#123456", "font_family": "AR One Sans"}'{
"color_primary": "#123456",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 16,
"font_family": "AR One Sans",
"font_weight": "400",
"font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
"logo_square": null,
"logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": true,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}API para actualizar la personalización de marca
Actualiza la marca blanca de Didit con la Management API: cambia colores, fuentes y bordes, sube logos y ajusta la interfaz del flujo de verificación.
curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"color_primary": "#123456", "font_family": "AR One Sans"}'{
"color_primary": "#123456",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 16,
"font_family": "AR One Sans",
"font_weight": "400",
"font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
"logo_square": null,
"logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": true,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}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íaapplication/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 comomultipart/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
#RRGGBBo#RRGGBBAA.font_weightdebe ser un peso disponible para lafont_familyseleccionada. - 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
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 de los encabezados y del texto principal.
Color del texto de párrafo / secundario.
Color de fondo de la página.
Color del panel / de acento.
Color del panel con un 10% de opacidad.
Color del texto de apoyo en los paneles.
Color de la etiqueta o insignia en los paneles.
Color del texto sobre el fondo.
Color del botón principal.
Color del botón secundario.
Color del texto del botón principal.
Color del texto del botón secundario.
Color del texto para píldoras, campos de entrada y selectores.
Radio de las esquinas del panel en píxeles.
x >= 0Radio de las esquinas del botón en píxeles.
x >= 0Nombre de la familia tipográfica de Google Fonts (p. ej., Inter, AR One Sans).
Grosor de fuente disponible para la familia seleccionada (p. ej., regular, 500, 700).
Nombre público que se muestra en el flujo de verificación.
URL de la política de privacidad que se muestra al usuario final.
Omite la pantalla de bienvenida inicial.
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).
Oculta la barra de progreso durante el flujo.
Retraso (en segundos) antes de redirigir a la URL de callback.
x >= 0Si es true, elimina el logotipo cuadrado actual.
Si es true, elimina el logotipo rectangular actual.
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.
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.
Solo lectura. URL resuelta de la hoja de estilos de Google Fonts para la familia seleccionada.
URL de solo lectura del logotipo cuadrado. Súbelo mediante image_square.
URL de solo lectura del logotipo rectangular. Súbelo mediante image_rectangular.
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.
URL de solo lectura del favicon. Súbelo mediante image_favicon.