Saltar para o conteúdo principal
GET
curl

Visão geral

Devolve o branding de marca branca da aplicação identificada pela sua chave de API, ou seja, a mesma identidade visual apresentada aos utilizadores finais no fluxo de verificação. A resposta inclui cores, tipos de letra, raios das bordas, URLs dos logótipos e opções de UI/UX.

Quando utilizar

  • Ler o tema atual: obtenha a paleta, o tipo de letra e os logótipos ativos antes de os apresentar ou editar.
  • Sincronizar a identidade visual: replique a identidade visual da Didit na sua própria interface de administração.

Notas

  • A aplicação é identificada a partir da chave de API. Não existem parâmetros de caminho ou de consulta.
  • logo_square, logo_rectangular, logo_rectangular_dark, favicon e font_url são apenas de leitura. Defina os logótipos carregando imagens em Atualizar a identidade visual.
  • logo_rectangular_dark é o logótipo retangular para o modo escuro, apresentado sobre um fundo escuro. Tem o valor null quando não está definido nenhum logótipo escuro ou quando os logótipos retangulares não são apresentados na sua conta.
  • O domínio personalizado e o e-mail de marca branca não fazem parte desta resposta; continuam a ser geridos na Business Console.

Permissões

A chave de API tem de poder ler a personalização da aplicação.

Conteúdo relacionado

Autorizações

x-api-key
string
header
obrigatório

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.

Resposta

Personalização de marca atual para a aplicação.

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.

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

Apenas de leitura. URL resolvido da folha de estilos do Google Fonts para a família selecionada.

logo_square
string | null

URL apenas de leitura do logótipo quadrado. Carregue através de image_square.

logo_rectangular
string | null

URL apenas de leitura do logótipo retangular. Carregue através de image_rectangular.

logo_rectangular_dark
string<uri> | null

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.

favicon
string | null

URL apenas de leitura do favicon. Carregue através de image_favicon.

app_public_name
string | null
privacy_policy_url
string | null
skip_welcome_screen
boolean
disable_login_with_didit
boolean
hide_progress_bar
boolean
callback_seconds
integer
Última modificação em 7 de novembro de 2026