> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Atualizar personalização de marca via API | Didit > Atualize o white-label na Management API da Didit: cores, fontes e raios de borda, envio de logos e opções da interface do fluxo de verificação. Prompt para atualizar a identidade visual Copiar o prompt para a área de transferência \

\`Goal: Update the white-label branding for the application tied to an API key.

Endpoint: PATCH https://verification.didit.me/v3/customization/
Auth header: x-api-key: 

Two content types:
\- application/json  -> change colors, fonts, radii and UI options
\- multipart/form-data -> upload logo images (image_square, image_rectangular, image_rectangular_dark, image_favicon)

PARTIAL update: only the fields you send are changed. The application is resolved from the API key (no path params).

JSON body fields:
\- Colors (hex '#RRGGBB' or '#RRGGBBAA'): color_primary, color_secondary, color_background, color_panel, color_panel_10, color_on_panel_1, color_on_panel_2, color_on_background, color_button_1, color_button_2, color_button_text_1, color_button_text_2, color_pill_text
\- border_radius_panel, border_radius_buttons (integers >= 0)
\- font_family (Google Font name), font_weight (must be available for the family)
\- app_public_name (string|null), privacy_policy_url (string|null)
\- skip_welcome_screen, disable_login_with_didit, hide_progress_bar (boolean)
\- callback_seconds (integer >= 0)
\- delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark, delete_favicon (boolean) -> remove an existing logo; an upload sent in the same request wins over its delete flag

Logo upload (multipart/form-data) fields:
\- image_square (1:1)
\- image_rectangular (2:1)
\- image_rectangular_dark (2:1, the rectangular logo for dark mode; returned as logo_rectangular_dark)
\- image_favicon (max 500 KB)
Logo rules for image_square, image_rectangular and image_rectangular_dark: PNG, JPG or WebP (SVG is refused), at least 512 px on the long side, max 1 MB.

NOT allowed here (Business Console only): custom domain and white-label email.

curl (JSON):
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"}'

curl (logo upload):
curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'image_rectangular=@logo.png' \
-F 'image_rectangular_dark=@logo-dark.png' \
-F 'image_favicon=@favicon.ico'

Response 200: the full updated BrandingCustomization object (same shape as GET).

Failure modes:
\- 400: validation. Examples: { "color_primary": ["Invalid color format. Use '#RRGGBB' or '#RRGGBBAA' format."] }, { "image_rectangular": ["Image aspect ratio must be 2:1. Got 1024x1024 image dimensions"] }, { "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_square": ["File size should not exceed 1 MB"] }
\- 401 — missing/invalid x-api-key.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Colar em ## Visão geralAtualiza 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 logotiposEnvie 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](https://docs.didit.me/pt-br/console/white-label.md).## PermissõesA chave de API deve ter permissão para atualizar a personalização da aplicação.## Relacionados- [Obter a identidade visual](https://docs.didit.me/pt-br/management-api/customization/get.md) - [Marca própria no Console](https://docs.didit.me/pt-br/console/white-label.md) ## OpenAPI ````yaml pt-br/openapi-25.json PATCH /v3/customization/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/customization/: patch: tags: - Customization summary: Atualizar a personalização da marca description: >- Atualização parcial da identidade visual de marca própria da aplicação. Envie `application/json` para alterar cores, fontes, raios e opções de interface, ou `multipart/form-data` para enviar imagens de logotipo. Apenas os campos incluídos são alterados. Domínio personalizado e e-mail de marca própria não podem ser definidos por este endpoint; use o Business Console para isso. operationId: update_customization requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BrandingCustomizationUpdate' examples: Update colors and font: summary: Alterar cores e fonte da marca value: color_primary: '#123456' color_button_1: '#2567FF' font_family: AR One Sans border_radius_buttons: 16 Update UI options: summary: Alterar nome público e opções do fluxo value: app_public_name: Acme Verify privacy_policy_url: https://acme.com/privacy skip_welcome_screen: true hide_progress_bar: true callback_seconds: 5 Remove a logo: summary: Excluir o logotipo retangular atual value: delete_logo_rectangular: true Remove the dark-mode logo: summary: Excluir o logotipo atual do modo escuro value: delete_logo_rectangular_dark: true multipart/form-data: schema: type: object description: >- Use multipart/form-data apenas para enviar imagens de logotipo. Os campos de identidade visual acima também podem ser enviados como campos de formulário na mesma requisição. properties: image_square: type: string format: binary description: >- Logotipo quadrado (proporção 1:1). PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo **1 MB**. image_rectangular: type: string format: binary description: >- Logo retangular (proporção 2:1). PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo **1 MB**. image_rectangular_dark: type: string format: binary description: >- Logo retangular para o modo escuro (proporção 2:1), exibido sobre fundo escuro. PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo **1 MB**. Retornado como `logo_rectangular_dark`. image_favicon: type: string format: binary description: Imagem do favicon. Máximo de **500 KB**. example: image_rectangular: (binary PNG logo, 2:1) image_rectangular_dark: (binary PNG logo for dark mode, 2:1) image_favicon: (binary favicon) responses: '200': description: >- Identidade visual atualizada. O objeto de identidade visual COMPLETO é retornado (todos os campos, não apenas os que você alterou). content: application/json: schema: $ref: '#/components/schemas/BrandingCustomization' examples: Updated: value: 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 '400': description: >- Corpo inválido. Por exemplo: uma cor hexadecimal malformada, uma família ou peso de fonte desconhecido, um campo exclusivo do Business Console (`domain`, `from_email`, `verify_domain`, `force_remove_domain`, `verify_email_domain`, `force_remove_email_domain` e seus campos complementares somente leitura), ou um upload de logo que não é uma imagem PNG, JPG ou WebP, tem menos de 512 px no lado maior, tem mais de 1 MB ou tem a proporção errada. Também retornado ao definir `disable_login_with_didit` como `false` enquanto um domínio personalizado está configurado. content: application/json: examples: Bad color: value: color_primary: - >- Invalid color format. Use '#RRGGBB' or '#RRGGBBAA' format. Bad logo: value: image_rectangular: - >- Image aspect ratio must be 2:1. Got 1024x1024 image dimensions Unsupported logo format: summary: Não é uma imagem PNG, JPG ou WebP (um SVG, por exemplo) value: image_rectangular_dark: - Upload a PNG, JPG or WebP image. Logo too small: summary: Menos de 512 px no lado maior value: image_rectangular: - >- Image must be at least 512 px on its long side. Got 400x200 image dimensions Logo too large: summary: Acima de 1 MB value: image_square: - File size should not exceed 1 MB Console-only field: value: domain: - Manage this field in the Business Console. Bad font weight: value: font_weight: - >- Font weight 950 is not available for Inter. Available weights are: 100, 200, 300, 400, 500, 600, 700, 800, 900 '403': description: >- Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`. content: application/json: examples: Invalid token: value: detail: You do not have permission to perform this action. '429': description: >- Limite de requisições excedido. Tente novamente com backoff exponencial. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- 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"}' - lang: curl label: curl (logo upload) source: |- curl -X PATCH 'https://verification.didit.me/v3/customization/' \ -H 'x-api-key: YOUR_API_KEY' \ -F 'image_rectangular=@logo.png' \ -F 'image_rectangular_dark=@logo-dark.png' \ -F 'image_favicon=@favicon.ico' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.customization.update( image_rectangular=open("image_rectangular.jpg", "rb"), image_rectangular_dark=open("image_rectangular_dark.jpg", "rb"), image_favicon=open("image_favicon.jpg", "rb"), ) print(result) - lang: javascript label: Node.js source: |- import Didit, { fileFromPath } from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.customization.update({ image_rectangular: await fileFromPath("image_rectangular.jpg"), image_rectangular_dark: await fileFromPath("image_rectangular_dark.jpg"), image_favicon: await fileFromPath("image_favicon.jpg"), }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Update(ctx, didit.CustomizationUpdateParams{\n\tImageRectangular: didit.Some(didit.FileFromPath(\"image_rectangular.jpg\")),\n\tImageRectangularDark: didit.Some(didit.FileFromPath(\"image_rectangular_dark.jpg\")),\n\tImageFavicon: didit.Some(didit.FileFromPath(\"image_favicon.jpg\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.nio.file.Path; import me.didit.Didit; import me.didit.types.CustomizationUpdateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.customization().update(CustomizationUpdateParams.builder() .imageRectangular(Path.of("image_rectangular.jpg")) .imageRectangularDark(Path.of("image_rectangular_dark.jpg")) .imageFavicon(Path.of("image_favicon.jpg")) .build()); System.out.println(result); - lang: php label: PHP source: |- customization->update([ 'image_rectangular' => File::fromPath('image_rectangular.jpg'), 'image_rectangular_dark' => File::fromPath('image_rectangular_dark.jpg'), 'image_favicon' => File::fromPath('image_favicon.jpg'), ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.customization.update( image_rectangular: Pathname("image_rectangular.jpg"), image_rectangular_dark: Pathname("image_rectangular_dark.jpg"), image_favicon: Pathname("image_favicon.jpg") ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Customization.UpdateAsync(new CustomizationUpdateParams { ImageRectangular = FileUpload.FromPath("image_rectangular.jpg"), ImageRectangularDark = FileUpload.FromPath("image_rectangular_dark.jpg"), ImageFavicon = FileUpload.FromPath("image_favicon.jpg"), }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: BrandingCustomizationUpdate: type: object description: >- 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. properties: color_primary: type: string description: Cor dos cabeçalhos / do texto principal. color_secondary: type: string description: Cor do texto de parágrafo / secundário. color_background: type: string description: Cor de fundo da página. color_panel: type: string description: Cor do painel / de destaque. color_panel_10: type: string description: Cor do painel com 10% de opacidade. color_on_panel_1: type: string description: Cor do texto de apoio nos painéis. color_on_panel_2: type: string description: Cor da pílula / badge nos painéis. color_on_background: type: string description: Cor do texto sobre o fundo. color_button_1: type: string description: Cor do botão principal. color_button_2: type: string description: Cor do botão secundário. color_button_text_1: type: string description: Cor do texto do botão principal. color_button_text_2: type: string description: Cor do texto do botão secundário. color_pill_text: type: string description: Cor do texto de pills, campos de entrada e seletores. border_radius_panel: type: integer minimum: 0 description: Raio dos cantos do painel, em pixels. border_radius_buttons: type: integer minimum: 0 description: Raio dos cantos do botão em pixels. font_family: type: string description: >- Nome da família de fontes do Google Fonts (por exemplo, `Inter`, `AR One Sans`). font_weight: type: string description: >- Peso da fonte disponível para a família selecionada (por exemplo, `regular`, `500`, `700`). app_public_name: type: string nullable: true description: Nome público exibido no fluxo de verificação. privacy_policy_url: type: string nullable: true description: URL da política de privacidade exibida ao usuário final. skip_welcome_screen: type: boolean description: Pular a tela de boas-vindas inicial. disable_login_with_didit: type: boolean description: >- 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: type: boolean description: Oculta a barra de progresso durante o fluxo. callback_seconds: type: integer minimum: 0 description: >- Atraso (em segundos) antes do redirecionamento para a URL de retorno. delete_logo_square: type: boolean description: Quando `true`, remove o logotipo quadrado atual. delete_logo_rectangular: type: boolean description: Quando `true`, remove o logotipo retangular atual. delete_logo_rectangular_dark: type: boolean description: >- 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: type: boolean description: Quando `true`, remove o favicon atual. BrandingCustomization: type: object description: >- 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. properties: color_primary: type: string color_secondary: type: string color_background: type: string color_panel: type: string color_panel_10: type: string color_on_panel_1: type: string color_on_panel_2: type: string color_on_background: type: string color_button_1: type: string color_button_2: type: string color_button_text_1: type: string color_button_text_2: type: string color_pill_text: type: string border_radius_panel: type: integer border_radius_buttons: type: integer font_family: type: string font_weight: type: string font_url: type: string nullable: true description: >- Somente leitura. URL resolvida da folha de estilo do Google Fonts para a família selecionada. logo_square: type: string nullable: true description: URL somente leitura do logotipo quadrado. Envie via `image_square`. logo_rectangular: type: string nullable: true description: >- URL somente leitura do logotipo retangular. Envie via `image_rectangular`. logo_rectangular_dark: type: string format: uri nullable: true description: >- 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: type: string nullable: true description: URL somente leitura do favicon. Envie via `image_favicon`. app_public_name: type: string nullable: true privacy_policy_url: type: string nullable: true skip_welcome_screen: type: boolean disable_login_with_didit: type: boolean hide_progress_bar: type: boolean callback_seconds: type: integer securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.