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

# API para atualizar empresa (KYB): entidade do fornecedor

> Atualize campos editáveis de uma empresa (KYB) na Didit: nome de exibição, metadados e tags. Campos do registro são imutáveis. Pagamento por chamada.



Prompt para atualizar empresa
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Goal: Partial-update a Didit Business (KYB) entity by vendor_data.

Endpoint: PATCH https://verification.didit.me/v3/businesses/{vendor_data}/
Auth header: x-api-key: <DIDIT_API_KEY>
Content-Type: application/json

Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.

Request body (PARTIAL — only included fields are touched; counters and session history are left alone):
\- display_name (string, nullable)
\- legal_name (string, nullable)
\- registration_number (string, nullable)
\- country_code (string, nullable) — ISO 3166-1 alpha-2.
\- region (string, nullable) — ISO 3166-2.
\- status (enum) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices). Setting "BLOCKED" auto-adds vendor_data to the system blocklist.
\- metadata (object, nullable) — REPLACES existing metadata wholesale; merge client-side if you only want to add keys.
\- reason (string, optional, max 1000): why the status changed. Recorded on the status-change entry in the company's Activity in the Business Console, only when this update actually changes status. Webhooks do not carry it.

curl:
curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Acme", "metadata": {"tier": "enterprise"}}'

Response 200: full updated BusinessDetailItem (same shape as GET). See /reference/data-models.

Side effects:
\- Every edit is recorded in the company's activity (actor derived from the API key): a status change with reason, and a profile update when display_name, legal_name, registration_number, country_code or metadata change.
\- last_activity_at bumped to now().
\- Re-sending an unchanged body is safe.

Failure modes:
\- 400 — validation. Common: { "status": ["Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED"] }, { "metadata": ["Metadata must be a JSON object."] }
\{ "reason": ["Ensure this field has no more than 1000 characters."] }
\- 401 — missing/invalid x-api-key.
\- 403: a scoped API key without businesses write. { "detail": "This API key has no write access to companies." }
\- 404 — vendor_data not found.
\- 429 — rate-limited.

Notes:
\- vendor_data in the URL cannot be changed via this endpoint.
\- For status-only flips, prefer the dedicated PATCH /v3/businesses/{vendor_data}/update-status/.
\- Overriding registry-derived fields is allowed but flagged in the audit log.

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

\</pre>



      
      

Colar em

## Visão geralAtualiza os campos mutáveis de uma [entidade empresarial](https://docs.didit.me/pt-br/entities/businesses/overview.md). Os campos preenchidos a partir de consultas ao registro (`legal_name`, `registration_number`, `country_code`) passam a ser somente leitura após a primeira sessão de Verificação de empresas (KYB) aprovada.## Quando usar- **Renomear**: defina um `display_name` melhor para as visualizações internas.
- **Atualizar metadados**: mova uma empresa entre categorias internas, registre uma nota interna, altere tags.
- **Substituir dados do registro** (com cautela): as substituições são aceitas, mas sinalizadas no [registro de auditoria](https://docs.didit.me/pt-br/console/audit-logs.md).## Observações- O `vendor_data` na URL não pode ser alterado por meio deste endpoint.
- Emite um webhook `business.data.updated` com um array `changed_fields`.
- Toda edição é registrada na **Activity** da empresa no Business Console.
  Uma alteração de `status` é registrada com o `reason` opcional (até 1000 caracteres), e uma alteração em `display_name`, `legal_name`, `registration_number`, `country_code` ou `metadata` é registrada como atualização do perfil.
  O webhook `business.status.updated` não inclui o `reason`.## PermissõesO segredo principal e as [chaves de API](https://docs.didit.me/pt-br/console/api-keys.md) com acesso total sempre podem chamar este endpoint.
Uma chave com acesso personalizado precisa de permissão de escrita em **Empresas** (`businesses`).
Uma chave limitada a alguns fluxos ou a sessões aprovadas não consegue acessar este endpoint.As [funções e permissões](https://docs.didit.me/pt-br/console/roles-permissions.md) do Console determinam o que um membro da equipe pode fazer no Console.
Elas não são avaliadas em requisições feitas com chave de API.## Relacionados- [Operações de empresas](https://docs.didit.me/pt-br/entities/businesses/operations.md)
- [Modelo de dados](https://docs.didit.me/pt-br/entities/businesses/data-model.md)
- [Atualizar status](https://docs.didit.me/pt-br/management-api/businesses/update-status.md)


## OpenAPI

````yaml pt-br/openapi-25.json PATCH /v3/businesses/{vendor_data}/
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/businesses/{vendor_data}/:
    patch:
      tags:
        - Businesses
      summary: Atualizar empresa
      description: >-
        Atualização parcial de uma empresa: `display_name`, `legal_name`,
        `registration_number`, `country_code`, `status`, `metadata`. `metadata`
        é substituído por completo. Definir `status` como `BLOCKED` adiciona o
        `vendor_data` à lista de bloqueio do sistema; sair de `BLOCKED` remove
        essa entrada. Toda edição é registrada na atividade da empresa: uma
        mudança de status com o `reason` opcional, e uma alteração em
        `display_name`, `legal_name`, `registration_number`, `country_code` ou
        `metadata` como atualização de perfil.
      operationId: update_business
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: Seu identificador exclusivo da empresa (string livre, NÃO um UUID).
          example: company-123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Corpo de atualização parcial. Informe apenas os campos que
                deseja alterar.
              properties:
                display_name:
                  type: string
                  nullable: true
                  description: >-
                    Nome de exibição amigável mostrado no console (tem
                    prioridade sobre `legal_name` na exibição da interface).
                legal_name:
                  type: string
                  nullable: true
                  description: >-
                    Razão social oficial obtida do registro de empresas ou
                    inserida manualmente.
                registration_number:
                  type: string
                  nullable: true
                  description: Número de registro ou de constituição da empresa.
                country_code:
                  type: string
                  nullable: true
                  description: >-
                    País de constituição (ISO 3166-1 alpha-2, por exemplo, `GB`,
                    `US`).
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  description: >-
                    Status do ciclo de vida da empresa. Definir `BLOCKED`
                    adiciona automaticamente o `vendor_data` à lista de bloqueio
                    do sistema; mudar de `BLOCKED` para outro status remove essa
                    entrada da lista de bloqueio.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Objeto JSON arbitrário que você anexa à empresa. **Substitui
                    totalmente** os metadados existentes na atualização — faça a
                    mesclagem no lado do cliente se quiser apenas adicionar
                    chaves.
                reason:
                  type: string
                  nullable: true
                  maxLength: 1000
                  description: >-
                    Por que o status mudou. Registrado na entrada de mudança de
                    status em **Activity** da empresa no Business Console,
                    apenas quando o status realmente muda. Os webhooks não o
                    incluem.
            examples:
              Update name:
                summary: Atualizar nome de exibição
                value:
                  display_name: Acme Corp
              Flag for review:
                summary: Alterar status
                value:
                  status: FLAGGED
              Add metadata:
                summary: Substituir o JSON de metadados
                value:
                  metadata:
                    industry: fintech
                    risk_level: low
              Fix registry data:
                summary: Corrigir campos extraídos
                value:
                  legal_name: Acme Trading International Ltd
                  registration_number: '12345678'
                  country_code: GB
              Flag with reason:
                summary: Sinalizar a empresa e registrar o motivo
                value:
                  status: FLAGGED
                  reason: Ownership structure under review
      responses:
        '200':
          description: >-
            Empresa atualizada. Retorna o registro completo e atualizado da
            empresa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessDetailItem'
              examples:
                Updated:
                  value:
                    didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890
                    vendor_data: company-123
                    display_name: Acme Corp
                    legal_name: Acme Trading Ltd
                    registration_number: '12345678'
                    country_code: GB
                    effective_name: Acme Corp
                    status: FLAGGED
                    session_count: 2
                    approved_count: 1
                    declined_count: 0
                    in_review_count: 1
                    features:
                      KYB: Approved
                    features_list:
                      - feature: KYB
                        status: Approved
                    last_session_at: '2026-03-15T10:30:00Z'
                    last_activity_at: '2026-03-15T10:30:00Z'
                    first_session_at: '2026-01-10T08:00:00Z'
                    tags:
                      - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
                        name: VIP
                        color: '#2567FF'
                    created_at: '2026-01-10T08:00:00Z'
                    metadata:
                      industry: fintech
                      risk_level: low
                    updated_at: '2026-03-15T10:30:00Z'
        '400':
          description: >-
            Corpo inválido: normalmente um `status` desconhecido, `metadata`
            malformado ou um `reason` com mais de 1000 caracteres.
          content:
            application/json:
              examples:
                Bad status:
                  value:
                    status:
                      - >-
                        Invalid status. Valid options are: ACTIVE, FLAGGED,
                        BLOCKED
                Bad metadata:
                  value:
                    metadata:
                      - Metadata must be a JSON object.
                Reason too long:
                  value:
                    reason:
                      - Ensure this field has no more than 1000 characters.
        '403':
          description: >-
            Chave de API ausente, inválida ou revogada, ou a chave não pode
            atualizar empresas desta aplicação. Uma chave ausente retorna `403`;
            uma chave incorreta, revogada ou expirada retorna `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Não existe nenhuma empresa (não excluída) com o `vendor_data`
            informado para esta aplicação.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Limite de requisições excedido; aguarde e tente novamente após o
            intervalo indicado em `Retry-After`.
          content:
            application/json:
              examples:
                Rate limited:
                  value:
                    detail: Request was throttled. Expected available in 30 seconds.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X PATCH
            'https://verification.didit.me/v3/businesses/company-123/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"display_name": "Acme Corp", "status": "FLAGGED"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.businesses.update(
                "company-123",
                display_name="Acme Corp",
            )
            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.businesses.update("company-123", {
              display_name: "Acme Corp",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Update(ctx, \"company-123\", didit.BusinessesUpdateParams{\n\tDisplayName: didit.String(\"Acme Corp\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.BusinessesUpdateParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.businesses().update("company-123",
            BusinessesUpdateParams.builder()
                    .displayName("Acme Corp")
                    .build());
            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->businesses->update('company-123', [
                'display_name' => 'Acme Corp',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.businesses.update(
              "company-123",
              display_name: "Acme Corp"
            )
            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.Businesses.UpdateAsync("company-123", new
            BusinessesUpdateParams

            {
                DisplayName = "Acme Corp",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BusinessDetailItem:
      type: object
      description: >-
        Detalhes completos da empresa. Estende BusinessListItem com metadata e
        updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de metadados personalizados que você anexou a esta empresa.
                O padrão é `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Uma empresa verificada.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interno estável da Didit para esta empresa.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Seu identificador exclusivo desta empresa (passado ao criar
            sessões). Pode ser nulo quando nenhum identificador do fornecedor
            foi informado.
        display_name:
          type: string
          nullable: true
          description: Nome de exibição personalizado definido por você
        legal_name:
          type: string
          nullable: true
          description: >-
            Razão social oficial obtida do registro de empresas ou inserida
            manualmente
        registration_number:
          type: string
          nullable: true
          description: Número de registro ou de constituição da empresa
        country_code:
          type: string
          nullable: true
          description: País de constituição (ISO 3166-1 alpha-2, por exemplo, `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Melhor nome disponível: display_name, se definido; caso contrário,
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Status do ciclo de vida do registro da empresa (NÃO é um status de
            sessão). `ACTIVE` é o padrão, `FLAGGED` o marca para atenção manual
            e `BLOCKED` impede novas sessões para este `vendor_data`.
        session_count:
          type: integer
          description: Número total de sessões de verificação desta empresa
        approved_count:
          type: integer
          description: Número de sessões aprovadas
        declined_count:
          type: integer
          description: Número de sessões recusadas
        in_review_count:
          type: integer
          description: Número de sessões em revisão
        features:
          type: object
          description: >-
            Status agregado por recurso em todas as sessões de KYB desta
            empresa. Atualmente, a única chave é `KYB` (o status da verificação
            da empresa no registro). Valores possíveis: `Approved`, `Declined`,
            `In Review`, `Not Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Os mesmos dados de `features`, como um array ordenado de objetos
            `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Data e hora da sessão mais recente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Data e hora da primeira sessão
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Data e hora da atividade mais recente (mudança de status,
            atualização da sessão etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Tags atribuídas a esta empresa
        created_at:
          type: string
          format: date-time
  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.