Atualizar personalização de marca via API

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
}

PATCH

customization

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 identidade visual de marca branca da aplicação associada à sua chave de API. Envie application/json para alterar cores, fontes, raios de borda e opções de interface, ou multipart/form-data para enviar logotipos. Somente os campos que você incluir são alterados; todo o resto permanece intacto.

Quando usar

Personalizar o tema do fluxo: defina as cores da sua marca, a fonte e os raios de canto.
Enviar logotipos: defina o logotipo quadrado, o logotipo retangular e sua versão para o modo escuro, e o favicon.
Ajustar a experiência: defina o nome público do app, a URL da política de privacidade e opções como pular a tela de boas-vindas ou ocultar a barra de progresso.

Envio de logotipos

Envie os logotipos como multipart/form-data:

image_square: proporção 1:1.
image_rectangular: proporção 2:1.
image_rectangular_dark: proporção 2:1. O logotipo retangular para o modo escuro, exibido sobre um fundo escuro.
image_favicon: no máximo 500 KB.

image_square, image_rectangular e image_rectangular_dark devem ser imagens PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo 1 MB. Arquivos SVG são recusados. A resposta retorna as URLs resultantes de logo_square, logo_rectangular, logo_rectangular_dark e favicon. Para remover um logotipo, envie a flag correspondente delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark ou delete_favicon como true. Depois que você remove o logotipo do modo escuro, logo_rectangular_dark passa a ser null. Se uma mesma requisição enviar um logotipo e também o sinalizador de exclusão correspondente, o envio prevalece. Um envio rejeitado retorna 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"]}

Observações

A aplicação é identificada pela chave de API; não há parâmetros de caminho.
As cores hexadecimais aceitam #RRGGBB ou #RRGGBBAA. font_weight deve ser uma espessura disponível para a font_family selecionada.
O domínio personalizado e o e-mail de marca própria não são configuráveis aqui. Gerencie-os no Business Console.

Permissões

A chave de API deve ter permissão para atualizar 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.

Corpo

Corpo de atualização parcial da identidade visual. Informe apenas os campos que deseja alterar. As cores hexadecimais aceitam #RRGGBB ou #RRGGBBAA. Domínio personalizado e e-mail de marca própria não são aceitos aqui.

color_primary

string

Cor dos cabeçalhos / do texto principal.

color_secondary

string

Cor do texto de parágrafo / secundário.

color_background

string

Cor de fundo da página.

color_panel

string

Cor do painel / de destaque.

color_panel_10

string

Cor do painel com 10% de opacidade.

color_on_panel_1

string

Cor do texto de apoio nos painéis.

color_on_panel_2

string

Cor da pílula / badge nos painéis.

color_on_background

string

Cor do texto sobre o fundo.

color_button_1

string

Cor do botão principal.

color_button_2

string

Cor do botão secundário.

color_button_text_1

string

Cor do texto do botão principal.

color_button_text_2

string

Cor do texto do botão secundário.

color_pill_text

string

Cor do texto de pills, campos de entrada e seletores.

border_radius_panel

integer

Raio dos cantos do painel, em pixels.

Intervalo obrigatório: x >= 0

border_radius_buttons

integer

Raio dos cantos do botão em pixels.

Intervalo obrigatório: x >= 0

font_family

string

Nome da família de fontes do Google Fonts (por exemplo, Inter, AR One Sans).

font_weight

string

Peso da fonte disponível para a família selecionada (por exemplo, regular, 500, 700).

app_public_name

string | null

Nome público exibido no fluxo de verificação.

privacy_policy_url

string | null

URL da política de privacidade exibida ao usuário final.

skip_welcome_screen

boolean

Pular a tela de boas-vindas inicial.

Continuar como convidado em vez de mostrar a tela de login com a Didit. Não pode voltar a ser false enquanto houver um domínio personalizado configurado (400).

hide_progress_bar

boolean

Oculta a barra de progresso durante o fluxo.

callback_seconds

integer

Atraso (em segundos) antes do redirecionamento para a URL de retorno.

Intervalo obrigatório: x >= 0

delete_logo_square

boolean

Quando true, remove o logotipo quadrado atual.

delete_logo_rectangular

boolean

Quando true, remove o logotipo retangular atual.

delete_logo_rectangular_dark

boolean

Quando true, remove o logotipo atual do modo escuro, e logo_rectangular_dark passa a retornar null. Se a mesma requisição multipart também enviar image_rectangular_dark, o envio prevalece.

delete_favicon

boolean

Quando true, remove o favicon atual.

Resposta

Identidade visual atualizada. O objeto de identidade visual COMPLETO é retornado (todos os campos, não apenas os que você alterou).

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

hide_progress_bar

boolean

callback_seconds

integer

Última modificação em 1 de novembro de 2026

​Visão geral

​Quando usar

​Envio de logotipos

​Observações

​Permissões

​Relacionados

Autorizações

Corpo

Resposta

Visão geral

Quando usar

Envio de logotipos

Observações

Permissões

Relacionados