> ## 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.

# Obter API de Personalização de Marca

> Obtenha a marca white-label da sua aplicação via API de Gestão da Didit: cores, tipos de letra, raios, URLs de logótipos e opções de UI.



Instrução para obter a identidade visual
        Copiar o prompt para a área de transferência



      
      

\<pre>

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

Endpoint: GET https://verification.didit.me/v3/customization/
Auth header: x-api-key: <DIDIT_API_KEY>

No path or query params. The application is resolved from the API key.

Response 200: a BrandingCustomization object:
\- Colors: 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 (hex strings)
\- border_radius_panel, border_radius_buttons (integers)
\- font_family, font_weight, font_url (font_url is read-only)
\- logo_square, logo_rectangular, logo_rectangular_dark, favicon (read-only URLs; null when unset)
\- logo_rectangular_dark: the rectangular logo for dark mode; null when no dark logo is set or rectangular logos are not shown for your account
\- app_public_name, privacy_policy_url, skip_welcome_screen, disable_login_with_didit, hide_progress_bar, callback_seconds

Not included: custom domain and white-label email settings (Business Console only).

curl:
curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'

Failure modes:
\- 401 — missing/invalid x-api-key.

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

\</pre>



      
      

Colar em

## Visão geralDevolve 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](https://docs.didit.me/pt/console/white-label.md). 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](https://docs.didit.me/pt/management-api/customization/update.md).
- `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õesA chave de API tem de poder ler a personalização da aplicação.## Conteúdo relacionado- [Atualizar a identidade visual](https://docs.didit.me/pt/management-api/customization/update.md)
- [Marca branca na Business Console](https://docs.didit.me/pt/console/white-label.md)


## OpenAPI

````yaml pt/openapi-25.json GET /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/:
    get:
      tags:
        - Customization
      summary: Obter personalização de marca
      description: >-
        Devolve a imagem de marca de marca branca para a aplicação, determinada
        a partir da chave de API: cores, tipos de letra, raios de curvatura dos
        cantos, URLs de logótipos e opções de UI/UX. As definições de domínio
        personalizado e de e-mail de marca branca são geridas apenas na Business
        Console e não fazem parte desta resposta.
      operationId: get_customization
      responses:
        '200':
          description: Personalização de marca atual para a aplicação.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingCustomization'
              examples:
                Default branding:
                  value:
                    color_primary: '#000000'
                    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: 12
                    font_family: Inter
                    font_weight: regular
                    font_url: https://fonts.googleapis.com/css2?family=Inter
                    logo_square: null
                    logo_rectangular: null
                    logo_rectangular_dark: null
                    favicon: null
                    app_public_name: Acme Verify
                    privacy_policy_url: https://acme.com/privacy
                    skip_welcome_screen: false
                    disable_login_with_didit: false
                    hide_progress_bar: false
                    callback_seconds: 3
        '403':
          description: >-
            Chave de API em falta, mal formatada, expirada ou com âmbito
            limitado a uma aplicação diferente. Uma chave em falta devolve
            `403`; uma chave incorreta, revogada ou expirada devolve `401`.
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: Limite de pedidos excedido. Tente novamente com recuo exponencial.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X GET 'https://verification.didit.me/v3/customization/' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.customization.retrieve()
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.customization.retrieve();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Customization.Retrieve(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.customization().retrieve();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->customization->retrieve();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.customization.retrieve
            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.RetrieveAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BrandingCustomization:
      type: object
      description: >-
        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.
      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: >-
            Apenas de leitura. URL resolvido da folha de estilos do Google Fonts
            para a família selecionada.
        logo_square:
          type: string
          nullable: true
          description: >-
            URL apenas de leitura do logótipo quadrado. Carregue através de
            `image_square`.
        logo_rectangular:
          type: string
          nullable: true
          description: >-
            URL apenas de leitura do logótipo retangular. Carregue através de
            `image_rectangular`.
        logo_rectangular_dark:
          type: string
          format: uri
          nullable: true
          description: >-
            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:
          type: string
          nullable: true
          description: >-
            URL apenas de leitura do favicon. Carregue através de
            `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: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.