curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.customization.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.customization.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Customization.Retrieve(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.customization().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->customization->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.customization.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Customization.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"color_primary": "#000000",
"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": 12,
"font_family": "Inter",
"font_weight": "regular",
"font_url": "https://fonts.googleapis.com/css2?family=Inter",
"logo_square": null,
"logo_rectangular": null,
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": false,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}{
"detail": "You do not have permission to perform this action."
}Obtener la personalización de marca con la API
Consulta la marca blanca de tu aplicación con la Management API de Didit: colores, fuentes, bordes, URLs de logos y opciones del flujo de verificación.
curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.customization.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.customization.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Customization.Retrieve(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.customization().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->customization->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.customization.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Customization.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"color_primary": "#000000",
"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": 12,
"font_family": "Inter",
"font_weight": "regular",
"font_url": "https://fonts.googleapis.com/css2?family=Inter",
"logo_square": null,
"logo_rectangular": null,
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": false,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}{
"detail": "You do not have permission to perform this action."
}Descripción general
Devuelve la branding de marca blanca de la aplicación resuelta a partir de tu clave de API, la misma marca que ven los usuarios finales en el flujo de verificación. La respuesta incluye colores, fuentes, radios de borde, URL de logotipos y opciones de UI/UX.Cuándo usarlo
- Leer el tema actual: recupera la paleta, la fuente y los logotipos activos antes de mostrarlos o editarlos.
- Sincronizar la marca: replica la marca de Didit en tu propia interfaz de administración.
Notas
- La aplicación se resuelve a partir de la clave de API; no hay parámetros de ruta ni de consulta.
logo_square,logo_rectangular,logo_rectangular_dark,faviconyfont_urlson de solo lectura. Para configurar los logotipos, sube imágenes en Actualizar la marca.logo_rectangular_darkes el logotipo rectangular para el modo oscuro, que se muestra sobre un fondo oscuro. Esnullcuando no hay ningún logotipo oscuro configurado o cuando los logotipos rectangulares no se muestran en tu cuenta.- El dominio personalizado y el correo electrónico de marca blanca no forman parte de esta respuesta; se siguen gestionando en la Business Console.
Permisos
La clave de API debe tener permiso para leer 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.
Respuesta
Personalización de marca actual de la aplicación.
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.