Pular para o conteúdo principal
GET
curl

Visão geral

Retorna a identidade visual white-label da aplicação identificada pela sua chave de API, a mesma exibida aos usuários finais no fluxo de verificação. A resposta inclui cores, fontes, raios de borda, URLs de logotipos e opções de UI/UX.

Quando usar

  • Ler o tema atual: obtenha a paleta, as fontes e os logotipos ativos antes de exibi-los ou editá-los.
  • Sincronizar a identidade visual: replique a identidade visual da Didit na sua própria interface administrativa.

Observações

  • A aplicação é identificada pela chave de API, portanto não há parâmetros de caminho nem de consulta.
  • logo_square, logo_rectangular, logo_rectangular_dark, favicon e font_url são somente para leitura. Defina os logotipos enviando imagens em Atualizar identidade visual.
  • logo_rectangular_dark é o logotipo retangular para o modo escuro, exibido sobre fundo escuro. Ele é null quando nenhum logotipo escuro foi definido ou quando os logotipos retangulares não são exibidos para a sua conta.
  • O domínio personalizado e o e-mail de marca própria não fazem parte desta resposta; eles continuam sendo gerenciados no Business Console.

Permissões

A chave de API precisa ter permissão para ler a personalização da aplicação.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Resposta

Personalização de marca atual da aplicação.

Identidade visual de marca própria de uma aplicação: cores, fontes, raios, URLs de logotipo e opções de UI/UX. As URLs de logotipo são somente leitura (defina-as enviando imagens). Domínio personalizado e e-mail de marca própria 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

Somente leitura. URL resolvida da folha de estilo do Google Fonts para a família selecionada.

logo_square
string | null

URL somente leitura do logotipo quadrado. Envie via image_square.

logo_rectangular
string | null

URL somente leitura do logotipo retangular. Envie via image_rectangular.

logo_rectangular_dark
string<uri> | null

Somente leitura. URL assinada temporária do logotipo retangular para o modo escuro, exibido sobre fundo escuro. null quando nenhum logotipo escuro está definido ou quando logotipos retangulares não são exibidos para a sua conta. Envie-o com image_rectangular_dark.

favicon
string | null

URL somente leitura do favicon. Envie via 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 1 de novembro de 2026