> ## 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 Atualizar Status da Empresa: bloquear ou sinalizar

> Bloqueie, sinalize ou ative uma empresa (KYB) na Didit. O status vale para futuras sessões de KYB e a triagem de transações. Pago por chamada.



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



      
      

\<pre>

\`Goal: Flip ONLY the lifecycle status of a Didit Business (KYB) entity. Use the full PATCH /v3/businesses/{vendor_data}/ when you also need to touch other fields.

Endpoint: PATCH https://verification.didit.me/v3/businesses/{vendor_data}/update-status/
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:
\- status (enum, REQUIRED) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices, NOT the session enum).
\- 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 the status actually changes. Webhooks do not carry it.

Status semantics:
\- ACTIVE  → normal. New KYB sessions allowed for this vendor_data.
\- FLAGGED → still accepted, highlighted in Console for manual review; filterable with ?status=FLAGGED.
\- BLOCKED → terminal. Adds vendor_data to the system blocklist. Subsequent KYB session creations for the same identifier are rejected. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.

curl:
curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED", "reason": "Registry shows the company dissolved"}'

Response 200: full updated BusinessDetailItem (same shape as GET /v3/businesses/{vendor_data}/). See /reference/data-models.

Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one status-change entry to the company's activity (actor = API key identity), with reason as its comment.
\- Idempotent — re-sending the same status is a no-op (no extra audit row, no extra blocklist toggle).

Failure modes:
\- 400 — validation:
\{ "status": "This field is required." }
\{ "status": "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" }
\{ "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 (or deleted). { "detail": "Not found." }
\- 429 — rate-limited.

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

\</pre>



      
      

Colar em

## Visão geralMove uma [entidade empresarial](https://docs.didit.me/pt-br/entities/businesses/overview.md) entre `ACTIVE`, `FLAGGED` e `BLOCKED`. Consulte o [ciclo de vida das entidades](https://docs.didit.me/pt-br/entities/lifecycle.md) para ver a máquina de estados completa.## Quando usar- **Bloquear** uma empresa sancionada ou com fraude confirmada.
- **Sinalizar** uma empresa que aguarda revisão manual.
- **Desbloquear** após a remediação.
- **Propagar sinais externos** dos seus próprios sistemas de conformidade.## Observações- Valores válidos: `ACTIVE`, `FLAGGED`, `BLOCKED`.
- Envie um `reason` opcional (até 1000 caracteres) para registrar por que o status mudou.
  A Didit o armazena no registro da mudança de status na **Atividade** da empresa no Business Console.
  Ele só é registrado quando o status realmente muda.
- Empresas com status `BLOCKED` têm todas as novas sessões de Verificação de empresas (KYB) recusadas automaticamente e todas as novas transações recusadas automaticamente, inclusive quando aparecem como contraparte.
- Emite `business.status.updated` com `previous_status` e `status`.
  O webhook não inclui `reason`.## Aplicação| Status | Novas sessões de Verificação de empresas (KYB) | Transações que envolvem esta empresa |
| - | - | - |
| `ACTIVE` | Fluxo normal | Fluxo normal |
| `FLAGGED` | Encaminhadas para `IN_REVIEW` | Podem ser escaladas automaticamente por regras |
| `BLOCKED` | Recusadas automaticamente | Recusadas automaticamente |## 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 definem 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- [Ciclo de vida das entidades](https://docs.didit.me/pt-br/entities/lifecycle.md)
- [Lista de bloqueio de empresas](https://docs.didit.me/pt-br/entities/businesses/blocklist.md)
- [Webhooks de entidades](https://docs.didit.me/pt-br/entities/webhooks.md)


## OpenAPI

````yaml pt-br/openapi-25.json PATCH /v3/businesses/{vendor_data}/update-status/
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}/update-status/:
    patch:
      tags:
        - Businesses
      summary: Atualizar status da empresa
      description: >-
        Altera apenas o `status` de ciclo de vida de uma empresa: `ACTIVE`,
        `FLAGGED` ou `BLOCKED` (não os status de sessão). `BLOCKED` adiciona o
        `vendor_data` à lista de bloqueio do sistema; sair de `BLOCKED` remove
        essa entrada. Cada alteração é registrada na atividade da empresa, com o
        `reason` opcional. Enviar o status atual não altera nada e não registra
        nenhum `reason`. O webhook `business.status.updated` não inclui o
        `reason`.
      operationId: update_business_status
      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:
              allOf:
                - $ref: '#/components/schemas/EntityStatusUpdateRequest'
                - type: object
                  properties:
                    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:
              Flag:
                summary: Sinalizar a empresa para revisão
                value:
                  status: FLAGGED
              Block:
                summary: Bloquear a empresa (adiciona à lista de bloqueio do sistema)
                value:
                  status: BLOCKED
              Reactivate:
                summary: Reativar a empresa
                value:
                  status: ACTIVE
              Block with reason:
                summary: Bloquear a empresa e registrar o motivo
                value:
                  status: BLOCKED
                  reason: Registry shows the company dissolved
      responses:
        '200':
          description: >-
            Status da empresa atualizado. Retorna o registro completo da
            empresa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessDetailItem'
              examples:
                Blocked:
                  value:
                    didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890
                    vendor_data: company-123
                    display_name: null
                    legal_name: Acme Trading Ltd
                    registration_number: '12345678'
                    country_code: GB
                    effective_name: Acme Trading Ltd
                    status: BLOCKED
                    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
                    updated_at: '2026-03-15T10:30:00Z'
        '400':
          description: >-
            `status` ausente ou inválido, ou um `reason` com mais de 1000
            caracteres.
          content:
            application/json:
              examples:
                Missing status:
                  value:
                    status:
                      - This field is required.
                Bad status:
                  value:
                    status:
                      - >-
                        Invalid status. Valid options are: ACTIVE, FLAGGED,
                        BLOCKED
                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/update-status/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"status": "BLOCKED"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.businesses.update_status(
                "company-123",
                status="FLAGGED",
            )
            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.updateStatus("company-123", {
              status: "FLAGGED",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.UpdateStatus(ctx, \"company-123\", didit.BusinessesUpdateStatusParams{\n\tStatus: \"FLAGGED\",\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.BusinessesUpdateStatusParams;

            import me.didit.types.EntityStatusUpdateRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.businesses().updateStatus("company-123",
            BusinessesUpdateStatusParams.builder()
                    .status(EntityStatusUpdateRequest.Status.of("FLAGGED"))
                    .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->updateStatus('company-123', [
                'status' => 'FLAGGED',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.businesses.update_status(
              "company-123",
              status: "FLAGGED"
            )
            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.UpdateStatusAsync("company-123", new
            BusinessesUpdateStatusParams

            {
                Status = "FLAGGED",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    EntityStatusUpdateRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Novo status do ciclo de vida. `BLOCKED` também adiciona o
            `vendor_data` à lista de bloqueio do sistema.
    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.