Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo de alteraçõescurl -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
}Atualizar marca branca via API de personalização
Atualize a marca branca com a API de Gestão da Didit: cores, tipos de letra, raios de borda, logótipos e opções de interface.
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
}Visão geral
Atualiza parcialmente a personalização de marca branca da aplicação associada à sua chave de API. Envieapplication/json para alterar cores, tipos de letra, raios dos cantos e opções de interface, ou multipart/form-data para carregar logótipos. Só são alterados os campos que incluir. Tudo o resto fica inalterado.
Quando usar
- Personalizar o fluxo: defina as cores da sua marca, o tipo de letra e os raios dos cantos.
- Carregar logótipos: defina o logótipo quadrado, o logótipo retangular e a sua versão para modo escuro, e o favicon.
- Ajustar a experiência: defina o nome público da aplicação, o URL da política de privacidade e opções como ignorar o ecrã de boas-vindas ou ocultar a barra de progresso.
Carregar logótipos
Envie os logótipos comomultipart/form-data:
image_square: proporção 1:1.image_rectangular: proporção 2:1.image_rectangular_dark: proporção 2:1. O logótipo retangular para modo escuro, apresentado sobre um fundo escuro.image_favicon: máximo de 500 KB.
image_square, image_rectangular e image_rectangular_dark têm de ser imagens PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo 1 MB.
Ficheiros SVG são recusados.
A resposta devolve os URLs resultantes de logo_square, logo_rectangular, logo_rectangular_dark e favicon.
Para remover um logótipo, envie a flag correspondente delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark ou delete_favicon com o valor true.
Depois de remover o logótipo para modo escuro, logo_rectangular_dark fica com o valor null.
Se um pedido carregar um logótipo e também enviar a respetiva flag de remoção, prevalece o carregamento.
Um carregamento rejeitado devolve 400 com o nome do campo e o motivo, por exemplo:
{"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"]}
Notas
- A aplicação é identificada pela chave de API, por isso não existem parâmetros de caminho.
- As cores hexadecimais aceitam
#RRGGBBou#RRGGBBAA.font_weighttem de ser um peso disponível para ofont_familyselecionado. - O domínio personalizado e o e-mail de marca branca não são configuráveis aqui. Faça essa gestão na Business Console.
Permissões
A chave de API tem de poder atualizar a personalização da aplicação.Relacionados
Autorizações
A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.
Corpo
Corpo de atualização parcial de personalização de marca. Forneça apenas os campos que pretende alterar. Cores hexadecimais aceitam #RRGGBB ou #RRGGBBAA. Domínio personalizado e e-mail com marca branca não são aceites aqui.
Cor dos cabeçalhos / texto principal.
Cor do parágrafo / texto secundário.
Cor de fundo da página.
Cor do painel / de destaque.
Cor do painel com 10% de opacidade.
Cor do texto de apoio nos painéis.
Cor da etiqueta / do distintivo nos painéis.
Cor do texto sobre o fundo.
Cor do botão principal.
Cor do botão secundário.
Cor do texto do botão principal.
Cor do texto do botão secundário.
Cor do texto para pílulas, campos de entrada e seletores.
Raio dos cantos do painel em píxeis.
x >= 0Raio dos cantos do botão em píxeis.
x >= 0Nome da família de tipos de letra do Google (ex.: Inter, AR One Sans).
Espessura da fonte disponível para a família selecionada (por exemplo, regular, 500, 700).
Nome público apresentado no fluxo de verificação.
URL da política de privacidade apresentado ao utilizador final.
Ignorar o ecrã inicial de boas-vindas.
Continuar como convidado em vez de mostrar o ecrã de início de sessão com o Didit. Não pode ser reposto para false enquanto um domínio personalizado estiver configurado (400).
Ocultar a barra de progresso durante o fluxo.
Atraso (segundos) antes de redirecionar para o URL de retorno.
x >= 0Quando true, remove o logótipo quadrado atual.
Quando true, remove o logótipo retangular atual.
Quando true, remove o logótipo atual do modo escuro, e logo_rectangular_dark passa a apresentar null. Se o mesmo pedido multipart também enviar image_rectangular_dark, o carregamento prevalece.
Quando true, remove o favicon atual.
Resposta
Identidade visual atualizada. É devolvido o objeto COMPLETO de identidade visual (todos os campos, não apenas os que alterou).
Personalização de marca branca para uma aplicação: cores, tipos de letra, raios, URLs do logótipo e opções de UI/UX. Os URLs do logótipo são apenas de leitura (defina-os carregando imagens). O domínio personalizado e o e-mail de marca branca não estão incluídos.
Apenas de leitura. URL resolvido da folha de estilos do Google Fonts para a família selecionada.
URL apenas de leitura do logótipo quadrado. Carregue através de image_square.
URL apenas de leitura do logótipo retangular. Carregue através de image_rectangular.
Apenas de leitura. URL assinado temporário do logótipo retangular para o modo escuro, apresentado num fundo escuro. null quando nenhum logótipo escuro estiver definido ou logótipos retangulares não forem apresentados para a sua conta. Carregue-o com image_rectangular_dark.
URL apenas de leitura do favicon. Carregue através de image_favicon.