Erste Schritte
Integrieren / SDKs
Benutzerverifizierung
Unternehmensverifizierung
Transaktionsüberwachung
Changelogcurl -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
}White-Label-Branding per API aktualisieren
Mit der Didit Management API White-Label-Branding aktualisieren: Farben, Schriften und Eckradien ändern, Logos hochladen und UI-Optionen anpassen.
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
}Überblick
Aktualisiert Teile des White-Label-Brandings für die Anwendung, die über Ihren API-Schlüssel ermittelt wird. Senden Sieapplication/json, um Farben, Schriften, Radien und UI-Optionen zu ändern, oder multipart/form-data, um Logos hochzuladen. Nur die Felder, die Sie angeben, werden geändert, alles andere bleibt unverändert.
Wann verwenden
- Ablauf gestalten: Legen Sie Ihre Markenfarben, Schriftart und Eckradien fest.
- Logos hochladen: Legen Sie das quadratische Logo, das rechteckige Logo und dessen Dark-Mode-Version sowie das Favicon fest.
- Erlebnis anpassen: Legen Sie den öffentlichen App-Namen und die URL der Datenschutzerklärung fest und aktivieren Sie Optionen wie das Überspringen des Willkommensbildschirms oder das Ausblenden der Fortschrittsanzeige.
Logos hochladen
Senden Sie Logos alsmultipart/form-data:
image_square: Seitenverhältnis 1:1.image_rectangular: Seitenverhältnis 2:1.image_rectangular_dark: Seitenverhältnis 2:1. Das rechteckige Logo für den Dark Mode, angezeigt auf dunklem Hintergrund.image_favicon: maximal 500 KB.
image_square, image_rectangular und image_rectangular_dark müssen PNG-, JPG- oder WebP-Bilder sein, auf der langen Seite mindestens 512 px groß und höchstens 1 MB groß.
SVG-Dateien werden abgelehnt.
Die Antwort enthält die resultierenden URLs logo_square, logo_rectangular, logo_rectangular_dark und favicon.
Um ein Logo zu entfernen, senden Sie das passende Löschflag delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark oder delete_favicon mit dem Wert true.
Nachdem Sie das Dark-Mode-Logo entfernt haben, hat logo_rectangular_dark den Wert null.
Wenn eine Anfrage ein Logo hochlädt und zugleich das zugehörige Löschflag sendet, hat der Upload Vorrang.
Ein abgelehnter Upload gibt 400 mit dem Feldnamen und dem Grund zurück, zum Beispiel:
{"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"]}
Hinweise
- Die Anwendung wird über den API-Schlüssel ermittelt, es gibt keine Pfadparameter.
- Hex-Farben akzeptieren
#RRGGBBoder#RRGGBBAA.font_weightmuss eine Schriftstärke sein, die für die gewähltefont_familyverfügbar ist. - Benutzerdefinierte Domain und White-Label-E-Mail lassen sich hier nicht konfigurieren. Verwalten Sie diese in der Business Console.
Berechtigungen
Der API-Schlüssel muss die Berechtigung haben, die Anpassung für die Anwendung zu aktualisieren.Verwandte Themen
Autorisierungen
Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.
Body
Body für partielle Branding-Aktualisierung. Geben Sie nur die Felder an, die Sie ändern möchten. Hex-Farben akzeptieren #RRGGBB oder #RRGGBBAA. Benutzerdefinierte Domain und White-Label-E-Mail werden hier nicht akzeptiert.
Farbe für Überschriften / primären Text.
Absatz-/sekundäre Textfarbe.
Seitenhintergrundfarbe.
Panel-/Akzentfarbe.
Panelfarbe bei 10 % Deckkraft.
Farbe des Hilfetextes auf Panels.
Pill- / Badge-Farbe auf Panels.
Textfarbe auf Hintergrund.
Farbe des primären Buttons.
Farbe der sekundären Schaltfläche.
Textfarbe des primären Buttons.
Textfarbe der sekundären Schaltfläche.
Textfarbe für Badges, Eingabefelder und Auswahlelemente.
Panel-Eckenradius in Pixeln.
x >= 0Eckenradius der Schaltfläche in Pixeln.
x >= 0Google-Font-Familienname (z. B. Inter, AR One Sans).
Für die ausgewählte Schriftfamilie verfügbare Schriftstärke (z. B. regular, 500, 700).
Öffentlicher Name, der im Verifizierungsablauf angezeigt wird.
Dem Endbenutzer angezeigte Datenschutzrichtlinien-URL.
Den anfänglichen Willkommensbildschirm überspringen.
Als Gast fortfahren, anstatt den Bildschirm zur Anmeldung mit Didit anzuzeigen. Kann nicht wieder auf false gesetzt werden, solange eine benutzerdefinierte Domain konfiguriert ist (400).
Fortschrittsleiste während des Ablaufs ausblenden.
Verzögerung (Sekunden) vor der Weiterleitung zur Callback-URL.
x >= 0Wenn true, wird das aktuelle quadratische Logo entfernt.
Wenn true, wird das aktuelle rechteckige Logo entfernt.
Wenn true, wird das aktuelle Dark-Mode-Logo entfernt, und logo_rectangular_dark lautet dann null. Wenn dieselbe Multipart-Anfrage auch image_rectangular_dark hochlädt, hat der Upload Vorrang.
Wenn true, wird das aktuelle Favicon entfernt.
Antwort
Branding aktualisiert. Das VOLLSTÄNDIGE Branding-Objekt wird zurückgegeben (alle Felder, nicht nur die geänderten).
White-Label-Branding für eine Anwendung: Farben, Schriftarten, Radien, Logo-URLs und UI/UX-Optionen. Logo-URLs sind schreibgeschützt (legen Sie diese durch das Hochladen von Bildern fest). Eine benutzerdefinierte Domain und White-Label-E-Mail sind nicht enthalten.
Schreibgeschützt. Aufgelöste Google Fonts-Stylesheet-URL für die ausgewählte Schriftfamilie.
Schreibgeschützte URL des quadratischen Logos. Hochladen über image_square.
Schreibgeschützte URL des rechteckigen Logos. Hochladen über image_rectangular.
Schreibgeschützt. Temporäre signierte URL des rechteckigen Logos für den Dark Mode, dargestellt auf dunklem Hintergrund. null, wenn kein dunkles Logo festgelegt ist oder rechteckige Logos für Ihr Konto nicht angezeigt werden. Hochladen über image_rectangular_dark.
Schreibgeschützte URL des Favicons. Hochladen über image_favicon.