API per aggiornare il branding white label

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
}

PATCH

customization

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
}

Panoramica

Aggiorna parzialmente il branding White label dell’applicazione identificata dalla tua chiave API. Invia application/json per modificare colori, font, raggi degli angoli e opzioni dell’interfaccia, oppure multipart/form-data per caricare i loghi. Vengono modificati solo i campi che includi: tutto il resto resta invariato.

Quando usarlo

Personalizza il flusso — imposta i colori del brand, il font e i raggi degli angoli.
Carica i loghi: imposta il logo quadrato, il logo rettangolare e la sua versione per la modalità scura, e la favicon.
Personalizza l’esperienza — imposta il nome pubblico dell’app, l’URL dell’informativa sulla privacy e le opzioni per saltare la schermata di benvenuto o nascondere la barra di avanzamento.

Caricamento dei loghi

Invia i loghi come multipart/form-data:

image_square: proporzioni 1:1.
image_rectangular: proporzioni 2:1.
image_rectangular_dark: proporzioni 2:1. Il logo rettangolare per la modalità scura, mostrato su sfondo scuro.
image_favicon: massimo 500 KB.

image_square, image_rectangular e image_rectangular_dark devono essere immagini PNG, JPG o WebP, con il lato più lungo di almeno 512 px e un peso massimo di 1 MB. I file SVG vengono rifiutati. La risposta restituisce gli URL risultanti logo_square, logo_rectangular, logo_rectangular_dark e favicon. Per rimuovere un logo, invia il flag di eliminazione corrispondente delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark o delete_favicon impostato a true. Dopo aver rimosso il logo per la modalità scura, logo_rectangular_dark risulta null. Se una richiesta carica un logo e invia anche il relativo flag di eliminazione, prevale il caricamento. Un caricamento rifiutato restituisce 400 con il nome del campo e il motivo, per esempio:

{"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"]}

Note

L’applicazione viene identificata dalla chiave API: non ci sono parametri di percorso.
I colori esadecimali accettano il formato #RRGGBB o #RRGGBBAA. font_weight deve essere un peso disponibile per il font_family selezionato.
Il dominio personalizzato e l’email White label non sono configurabili qui. Gestiscili nella Business Console.

Permessi

La chiave API deve poter aggiornare la personalizzazione dell’applicazione.

Correlati

Autorizzazioni

x-api-key

string

header

obbligatorio

La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys.

Corpo

Corpo di aggiornamento parziale del branding. Fornisci solo i campi che desideri modificare. I colori esadecimali accettano #RRGGBB o #RRGGBBAA. Il dominio personalizzato e l'email white label non sono accettati qui.

color_primary

string

Colore delle intestazioni / del testo principale.

color_secondary

string

Colore del testo secondario / dei paragrafi.

color_background

string

Colore di sfondo della pagina.

color_panel

string

Colore del pannello / accento.

color_panel_10

string

Colore del pannello al 10% di opacità.

color_on_panel_1

string

Colore del testo di supporto sui pannelli.

color_on_panel_2

string

Colore del badge sui pannelli.

color_on_background

string

Colore del testo sullo sfondo.

color_button_1

string

Colore del pulsante principale.

color_button_2

string

Colore del pulsante secondario.

color_button_text_1

string

Colore del testo del pulsante principale.

color_button_text_2

string

Colore del testo del pulsante secondario.

color_pill_text

string

Colore del testo per pill, campi di input e selettori.

border_radius_panel

integer

Raggio degli angoli del pannello in pixel.

Intervallo richiesto: x >= 0

border_radius_buttons

integer

Raggio dell'angolo del pulsante in pixel.

Intervallo richiesto: x >= 0

font_family

string

Nome della famiglia di Google Font (es. Inter, AR One Sans).

font_weight

string

Spessore del carattere disponibile per la famiglia selezionata (es. regular, 500, 700).

app_public_name

string | null

Nome pubblico mostrato nel flusso di verifica.

privacy_policy_url

string | null

URL dell'informativa sulla privacy mostrato all'utente finale.

skip_welcome_screen

boolean

Salta la schermata iniziale di benvenuto.

Continua come ospite invece di mostrare la schermata di accesso con Didit. Non può essere reimpostato a false mentre è configurato un dominio personalizzato (400).

hide_progress_bar

boolean

Nascondi la barra di avanzamento durante il flusso.

callback_seconds

integer

Ritardo (secondi) prima del reindirizzamento all'URL di callback.

Intervallo richiesto: x >= 0

delete_logo_square

boolean

Quando è true, rimuove il logo quadrato corrente.

delete_logo_rectangular

boolean

Quando è true, rimuove il logo rettangolare corrente.

delete_logo_rectangular_dark

boolean

Quando è true, rimuove l'attuale logo per la modalità scura e logo_rectangular_dark assume il valore null. Se la stessa richiesta multipart carica anche image_rectangular_dark, prevale il caricamento.

delete_favicon

boolean

Quando è true, rimuove la favicon corrente.

Risposta

Branding aggiornato. Viene restituito l'oggetto branding COMPLETO (tutti i campi, non solo quelli modificati).

Branding White label per un'applicazione: colori, font, raggi dei bordi, URL dei loghi e opzioni UI/UX. Gli URL dei loghi sono di sola lettura (impostali caricando le immagini). Il dominio personalizzato e l'email White label non sono inclusi.

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

Sola lettura. URL del foglio di stile Google Fonts risolto per la famiglia di caratteri selezionata.

logo_square

string | null

URL di sola lettura del logo quadrato. Carica tramite image_square.

logo_rectangular

string | null

URL di sola lettura del logo rettangolare. Carica tramite image_rectangular.

logo_rectangular_dark

string<uri> | null

Sola lettura. URL firmato temporaneo del logo rettangolare per la modalità scura, visualizzato su sfondo scuro. null quando non è impostato alcun logo per la modalità scura o i loghi rettangolari non sono visualizzati per il tuo account. Caricalo con image_rectangular_dark.

favicon

string | null

URL di sola lettura della favicon. Carica tramite image_favicon.

app_public_name

string | null

privacy_policy_url

string | null

skip_welcome_screen

boolean

hide_progress_bar

boolean

callback_seconds

integer

Ultima modifica il 7 novembre 2026

​Panoramica

​Quando usarlo

​Caricamento dei loghi

​Note

​Permessi

​Correlati

Autorizzazioni

Corpo

Risposta

Panoramica

Quando usarlo

Caricamento dei loghi

Note

Permessi

Correlati