> ## 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 Estado de Empresa: Bloquear ou Sinalizar > Bloqueie, sinalize ou ative uma empresa KYB na Didit. O estado propaga-se a futuras sessões KYB e triagem de transações. Pago por chamada. Prompt de atualização do estado da empresa Copiar o prompt para a área de transferência \

\`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: 
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.`

\
Colar em ## Visão geralMove uma [entidade empresarial](https://docs.didit.me/pt/entities/businesses/overview.md) entre `ACTIVE`, `FLAGGED` e `BLOCKED`. Consulte o [ciclo de vida da entidade](https://docs.didit.me/pt/entities/lifecycle.md) para ver a máquina de estados completa.## Quando usar- **Bloquear** uma empresa sancionada ou confirmada como fraudulenta. - **Sinalizar** uma empresa pendente de revisão manual. - **Desbloquear** após a correção. - **Propagar sinais externos** a partir dos seus próprios sistemas de conformidade.## Notas- Valores válidos: `ACTIVE`, `FLAGGED`, `BLOCKED`. - Pode enviar um `reason` opcional (até 1000 caracteres) para registar o motivo da alteração de estado. A Didit guarda-o na entrada de alteração de estado em **Atividade** da empresa, na Business Console. Só é registado quando o estado muda efetivamente. - As empresas `BLOCKED` têm todas as novas sessões de Verificação de empresas (KYB) recusadas automaticamente, bem como todas as novas transações, incluindo quando aparecem como contraparte. - Emite `business.status.updated` com `previous_status` e `status`. O webhook não inclui `reason`.## Aplicação| Estado | 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 através de regras | | `BLOCKED` | Recusadas automaticamente | Recusadas automaticamente |## PermissõesA chave secreta principal e as [chaves de API](https://docs.didit.me/pt/console/api-keys.md) com acesso total podem sempre chamar este endpoint. Uma chave com acesso personalizado precisa da permissão de escrita em **Empresas** (`businesses`). Uma chave limitada a alguns fluxos ou a sessões aprovadas não consegue aceder a este endpoint.As [funções e permissões](https://docs.didit.me/pt/console/roles-permissions.md) da Business Console determinam o que um membro da equipa pode fazer na consola. Não são avaliadas para pedidos feitos com chaves de API.## Relacionados- [Ciclo de vida da entidade](https://docs.didit.me/pt/entities/lifecycle.md) - [Lista de bloqueio de empresas](https://docs.didit.me/pt/entities/businesses/blocklist.md) - [Webhooks da entidade](https://docs.didit.me/pt/entities/webhooks.md) ## OpenAPI ````yaml pt/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 estado da empresa description: >- Altera apenas o `status` do ciclo de vida de uma empresa: `ACTIVE`, `FLAGGED` ou `BLOCKED` (não os estados da sessão). `BLOCKED` adiciona o `vendor_data` à lista de bloqueio do sistema; sair de `BLOCKED` remove essa entrada. Cada alteração é registada na atividade da empresa, com o `reason` opcional. Enviar o estado atual não altera nada e não regista 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: >- O seu identificador exclusivo para a empresa (string de formato 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: >- O motivo da alteração de estado. Registado na entrada de alteração de estado em **Activity** da empresa na Business Console, apenas quando o estado realmente muda. Os webhooks não o transmitem. 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 registar o motivo value: status: BLOCKED reason: Registry shows the company dissolved responses: '200': description: Estado da empresa atualizado. Registo completo da empresa devolvido. 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` em falta ou inválido, ou um `reason` com mais de 1000 carateres. 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 em falta, inválida ou revogada, ou a chave não pode atualizar empresas para esta aplicação. Uma chave em falta devolve `403`; uma chave incorreta, revogada ou expirada devolve `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 eliminada) com o `vendor_data` fornecido para esta aplicação. content: application/json: examples: Not found: value: detail: Not found. '429': description: >- Limite de pedidos excedido; reduza a frequência 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: |- 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 estado do ciclo de vida. `BLOCKED` também adiciona o `vendor_data` à lista de bloqueio do sistema. BusinessDetailItem: type: object description: >- Detalhe completo da empresa. Estende BusinessListItem com metadados e updated_at. allOf: - $ref: '#/components/schemas/BusinessListItem' - type: object properties: metadata: type: object description: >- JSON de metadados personalizados que associou a esta empresa. O valor predefinido é `{}`. 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: >- O seu identificador exclusivo para esta empresa (transmitido ao criar sessões). Pode ser nulo quando não tiver sido fornecido nenhum identificador de fornecedor. display_name: type: string nullable: true description: Nome de apresentação personalizado definido por si legal_name: type: string nullable: true description: >- Denominação legal oficial proveniente do registo ou introduzida manualmente registration_number: type: string nullable: true description: Número de registo ou de constituição da empresa country_code: type: string nullable: true description: País de constituição (ISO 3166-1 alpha-2, por ex., `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: >- Estado do ciclo de vida do registo da empresa (NÃO é um estado da sessão). `ACTIVE` é o padrão, `FLAGGED` marca-o para atenção manual, `BLOCKED` impede novas sessões para este `vendor_data`. session_count: type: integer description: Número total de sessões de verificação para esta 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 análise features: type: object description: >- Estado agregado por funcionalidade em todas as sessões de KYB desta empresa. Atualmente, a única chave é `KYB` (o estado da verificação da empresa no registo). 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 que `features`, como um array ordenado de objetos `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Carimbo de data/hora da sessão mais recente first_session_at: type: string format: date-time nullable: true description: Carimbo de data/hora da primeira sessão last_activity_at: type: string format: date-time nullable: true description: >- Carimbo de data/hora da atividade mais recente (mudança de estado, 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: Etiquetas atribuídas a esta empresa created_at: type: string format: date-time 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.