Primers passos
Integració / SDK
Verificació d'usuaris
Verificació d'empreses
Monitoratge de transaccions
Registre de canviscurl -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
}Marca blanca: actualitzar la personalització via API
Actualitza la marca blanca de Didit amb l’API de gestió: colors, tipografies, radis de vora, logotips i opcions de la interfície del flux de verificació.
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
}Visió general
Actualitza parcialment la marca blanca de l’aplicació resolta a partir de la teva clau d’API. Enviaapplication/json per canviar colors, tipografies, radis i opcions de la interfície, o multipart/form-data per pujar logos. Només es modifiquen els camps que incloguis; la resta no es toca.
Quan s’ha d’utilitzar
- Personalitza el flux: defineix els colors de la teva marca, la tipografia i els radis de les cantonades.
- Puja logos: defineix el logo quadrat, el logo rectangular i la seva versió per al mode fosc, i el favicon.
- Ajusta l’experiència: defineix el nom públic de l’aplicació, l’URL de la política de privacitat i interruptors com ometre la pantalla de benvinguda o amagar la barra de progrés.
Càrrega de logos
Envia els logos com amultipart/form-data:
image_square: relació d’aspecte 1:1.image_rectangular: relació d’aspecte 2:1.image_rectangular_dark: relació d’aspecte 2:1. El logo rectangular per al mode fosc, que es mostra sobre un fons fosc.image_favicon: mida màxima de 500 KB.
image_square, image_rectangular i image_rectangular_dark han de ser imatges PNG, JPG o WebP, amb almenys 512 px al costat més llarg i com a màxim 1 MB.
Els fitxers SVG es rebutgen.
La resposta retorna les URL resultants logo_square, logo_rectangular, logo_rectangular_dark i favicon.
Per eliminar un logo, envia com a true l’indicador de supressió corresponent: delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark o delete_favicon.
Després d’eliminar el logo del mode fosc, logo_rectangular_dark val null.
Si una mateixa petició puja un logo i també envia el seu indicador de supressió, la pujada prevaleix.
Una pujada rebutjada retorna 400 amb el nom del camp i el motiu, per 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"]}
Notes
- L’aplicació es resol a partir de la clau d’API; no hi ha paràmetres de ruta.
- Els colors hexadecimals accepten
#RRGGBBo#RRGGBBAA.font_weightha de ser un pes disponible per a lafont_familyseleccionada. - El domini personalitzat i el correu de marca blanca no es poden configurar aquí. Gestiona’ls a la Business Console.
Permisos
La clau d’API ha de poder actualitzar la personalització de l’aplicació.Relacionat
Autoritzacions
La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.
Cos
Cos d'actualització parcial de la marca. Proporciona només els camps que vulguis canviar. Els colors hexadecimals accepten #RRGGBB o #RRGGBBAA. El domini personalitzat i el correu de marca blanca no s'accepten aquí.
Color de les capçaleres / del text principal.
Color del paràgraf / text secundari.
Color de fons de la pàgina.
Color del panell / d'accent.
Color del panell al 10% d'opacitat.
Color del text de suport als panells.
Color de la píndola / distintiu als panells.
Color del text sobre el fons.
Color del botó principal.
Color del botó secundari.
Color del text del botó principal.
Color del text del botó secundari.
Color del text per a pastilles, camps d'entrada i selectors.
Radi de les cantonades del panell en píxels.
x >= 0Radi de cantonada del botó en píxels.
x >= 0Nom de la família de fonts de Google (p. ex. Inter, AR One Sans).
Pes de la font disponible per a la família seleccionada (p. ex., regular, 500, 700).
Nom públic que es mostra al flux de verificació.
URL de la política de privadesa que es mostra a l'usuari final.
Omet la pantalla inicial de benvinguda.
Continua com a convidat en lloc de mostrar la pantalla d'inici de sessió amb Didit. No es pot tornar a establir a false mentre hi hagi un domini personalitzat configurat (400).
Amaga la barra de progrés durant el flux.
Retard (segons) abans de redirigir a l'URL de callback.
x >= 0Quan és true, elimina el logotip quadrat actual.
Quan és true, elimina el logotip rectangular actual.
Quan és true, elimina el logotip actual del mode fosc, i logo_rectangular_dark passa a ser null. Si la mateixa sol·licitud multipart també puja image_rectangular_dark, preval la pujada.
Quan és true, elimina la icona de favorits (favicon) actual.
Resposta
Imatge de marca actualitzada. Es retorna l'objecte de marca COMPLET (tots els camps, no només els que has modificat).
Personalització de marca blanca per a una aplicació: colors, tipografies, radis, URL de logotips i opcions d'UI/UX. Les URL de logotips són de només lectura (s'estableixen pujant imatges). El domini personalitzat i el correu electrònic de marca blanca no s'inclouen.
Només de lectura. URL resolta del full d'estils de Google Fonts per a la família seleccionada.
URL de només lectura del logotip quadrat. Puja'l mitjançant image_square.
URL de només lectura del logotip rectangular. Puja'l mitjançant image_rectangular.
Només de lectura. URL temporal signada del logotip rectangular per al mode fosc, que es mostra sobre un fons fosc. null quan no s'ha configurat cap logotip fosc o no es mostren logotips rectangulars per al teu compte. Puja'l amb image_rectangular_dark.
URL de només lectura del favicon. Puja'l mitjançant image_favicon.