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 de mise à jour de la marque blanche Didit
Mettez à jour la marque blanche via l’API de gestion Didit : couleurs, polices, rayons de bordure, logo et options d’interface du parcours de vérification.
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
}Vue d’ensemble
Met à jour partiellement la marque blanche de l’application identifiée par votre clé API. Envoyezapplication/json pour modifier les couleurs, les polices, les rayons de courbure et les options d’interface, ou multipart/form-data pour importer des logos. Seuls les champs que vous incluez sont modifiés ; tout le reste reste inchangé.
Quand l’utiliser
- Personnaliser le parcours : définissez les couleurs de votre marque, la police et les rayons de courbure des angles.
- Importer des logos : définissez le logo carré, le logo rectangulaire et sa version pour le mode sombre, ainsi que le favicon.
- Ajuster l’expérience : définissez le nom public de l’application, l’URL de la politique de confidentialité, et des options comme le fait d’ignorer l’écran d’accueil ou le masquage de la barre de progression.
Importer des logos
Envoyez les logos enmultipart/form-data :
image_square: format 1:1.image_rectangular: format 2:1.image_rectangular_dark: format 2:1. Le logo rectangulaire pour le mode sombre, affiché sur un fond sombre.image_favicon: taille maximale 500 Ko.
image_square, image_rectangular et image_rectangular_dark doivent être des images PNG, JPG ou WebP, d’au moins 512 px sur le côté le plus long et d’au plus 1 Mo.
Les fichiers SVG sont refusés.
La réponse renvoie les URL logo_square, logo_rectangular, logo_rectangular_dark et favicon obtenues.
Pour supprimer un logo, envoyez l’indicateur delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark ou delete_favicon correspondant avec la valeur true.
Après la suppression du logo pour le mode sombre, logo_rectangular_dark vaut null.
Si une même requête importe un logo et envoie aussi son indicateur de suppression, l’import prévaut.
Un import rejeté renvoie 400 avec le nom du champ et la raison, par exemple :
{"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"]}
Remarques
- L’application est identifiée à partir de la clé API ; il n’y a pas de paramètres de chemin.
- Les couleurs hexadécimales acceptent
#RRGGBBou#RRGGBBAA.font_weightdoit être une graisse disponible pour lafont_familysélectionnée. - Le domaine personnalisé et l’e-mail en marque blanche ne sont pas configurables ici. Gérez-les dans la Business Console.
Autorisations
La clé API doit être autorisée à mettre à jour la personnalisation de l’application.Liens connexes
Autorisations
La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.
Corps
Corps de mise à jour partielle de la marque. Ne fournissez que les champs que vous souhaitez modifier. Les couleurs hexadécimales acceptent #RRGGBB ou #RRGGBBAA. Le domaine personnalisé et l'e-mail en marque blanche ne sont pas acceptés ici.
Couleur des en-têtes / du texte principal.
Couleur de paragraphe / texte secondaire.
Couleur d'arrière-plan de la page.
Couleur de panneau / d'accentuation.
Couleur de panneau à 10 % d'opacité.
Couleur du texte d'assistance sur les panneaux.
Couleur de la pastille / du badge sur les panneaux.
Couleur du texte sur l'arrière-plan.
Couleur du bouton principal.
Couleur du bouton secondaire.
Couleur du texte du bouton principal.
Couleur du texte du bouton secondaire.
Couleur du texte pour les badges, champs de saisie et sélecteurs.
Rayon des angles du panneau en pixels.
x >= 0Rayon d'arrondi des coins du bouton en pixels.
x >= 0Nom de la famille de polices Google (par exemple Inter, AR One Sans).
Graisse de police disponible pour la famille sélectionnée (par ex. regular, 500, 700).
Nom public affiché dans le flux de vérification.
URL de la politique de confidentialité affichée à l'utilisateur final.
Ignorer l'écran de bienvenue initial.
Continuer en tant qu'invité au lieu d'afficher l'écran de connexion avec Didit. Ne peut pas être remis à false tant qu'un domaine personnalisé est configuré (400).
Masquer la barre de progression pendant le flux.
Délai (secondes) avant la redirection vers l'URL de rappel.
x >= 0Lorsque la valeur est true, supprime le logo carré actuel.
Lorsque la valeur est true, supprime le logo rectangulaire actuel.
Lorsque la valeur est true, supprime le logo actuel en mode sombre, et logo_rectangular_dark renvoie alors null. Si la même requête multipart téléverse également image_rectangular_dark, le téléversement prévaut.
Lorsque la valeur est true, supprime le favicon actuel.
Réponse
Image de marque mise à jour. L'objet complet d'image de marque est renvoyé (tous les champs, pas seulement ceux modifiés).
Personnalisation en marque blanche pour une application : couleurs, polices, arrondis, URL des logos et options UI/UX. Les URL des logos sont en lecture seule (définissez-les en téléversant des images). Le domaine personnalisé et l'e-mail en marque blanche ne sont pas inclus.
Lecture seule. URL résolue de la feuille de style Google Fonts pour la famille sélectionnée.
URL en lecture seule du logo carré. Téléversez via image_square.
URL en lecture seule du logo rectangulaire. Téléversez via image_rectangular.
Lecture seule. URL signée temporaire du logo rectangulaire pour le mode sombre, affiché sur fond sombre. Vaut null lorsqu'aucun logo sombre n'est configuré ou que les logos rectangulaires ne sont pas affichés pour votre compte. Téléversez-le avec image_rectangular_dark.
URL en lecture seule du favicon. Téléversez via image_favicon.