> ## 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 actualizar estado de empresa: bloquear o marcar

> Bloquea, marca o activa una empresa (KYB) en Didit. El estado se aplica a futuras sesiones KYB y al análisis de transacciones. Pago por llamada.



Prompt para actualizar el estado de una empresa
        Copiar el prompt al portapapeles



      
      

\<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>



      
      

Pegar en

## Descripción generalCambia una [entidad empresarial](https://docs.didit.me/es/entities/businesses/overview.md) entre `ACTIVE`, `FLAGGED` y `BLOCKED`. Consulta el [ciclo de vida de las entidades](https://docs.didit.me/es/entities/lifecycle.md) para ver la máquina de estados completa.## Cuándo usarlo- **Bloquear** una empresa sancionada o con fraude confirmado.
- **Marcar** una empresa pendiente de revisión manual.
- **Desbloquear** después de la remediación.
- **Propagar señales externas** desde tus propios sistemas de cumplimiento.## Notas- Valores válidos: `ACTIVE`, `FLAGGED`, `BLOCKED`.
- Pasa un `reason` opcional (hasta 1000 caracteres) para registrar por qué cambió el estado.
  Didit lo guarda en la entrada del cambio de estado en la **Activity** de la empresa en Business Console.
  Solo se registra cuando el estado cambia realmente.
- Las empresas en estado `BLOCKED` tienen todas las nuevas sesiones de Verificación de empresas (KYB) rechazadas automáticamente y todas las nuevas transacciones rechazadas automáticamente, incluso cuando aparecen como contraparte.
- Emite `business.status.updated` con `previous_status` y `status`.
  El webhook no incluye `reason`.## Aplicación| Estado | Nuevas sesiones de Verificación de empresas (KYB) | Transacciones en las que participa esta empresa |
| - | - | - |
| `ACTIVE` | Flujo normal | Flujo normal |
| `FLAGGED` | Se envían a `IN_REVIEW` | Pueden escalarse automáticamente mediante reglas |
| `BLOCKED` | Rechazadas automáticamente | Rechazadas automáticamente |## PermisosEl secreto principal y las [claves de API](https://docs.didit.me/es/console/api-keys.md) con acceso completo siempre pueden invocar este endpoint.
Una clave con acceso personalizado necesita permiso de escritura en **Empresas** (`businesses`).
Una clave limitada a algunos flujos o a sesiones aprobadas no puede acceder a este endpoint.Los [roles y permisos](https://docs.didit.me/es/console/roles-permissions.md) de la Console deciden lo que un miembro del equipo puede hacer en la Console.
No se evalúan en las solicitudes con clave de API.## Relacionado- [Ciclo de vida de las entidades](https://docs.didit.me/es/entities/lifecycle.md)
- [Lista de bloqueo de empresas](https://docs.didit.me/es/entities/businesses/blocklist.md)
- [Webhooks de entidades](https://docs.didit.me/es/entities/webhooks.md)


## OpenAPI

````yaml es/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 verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/update-status/:
    patch:
      tags:
        - Businesses
      summary: Actualizar el estado de la empresa
      description: >-
        Cambia solo el `status` del ciclo de vida de una empresa: `ACTIVE`,
        `FLAGGED` o `BLOCKED` (no los estados de sesión). `BLOCKED` añade el
        `vendor_data` a la lista de bloqueo del sistema; salir de `BLOCKED`
        elimina esa entrada. Cada cambio se registra en la actividad de la
        empresa, con el `reason` opcional. Enviar el estado actual no cambia
        nada y no registra ningún `reason`. El webhook `business.status.updated`
        no incluye `reason`.
      operationId: update_business_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Tu identificador único de la empresa (cadena de texto libre, NO un
            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 qué cambió el estado. Se registra en la entrada de
                        cambio de estado de **Activity** de la empresa en
                        Business Console, solo cuando el estado cambia
                        realmente. Los webhooks no lo incluyen.
            examples:
              Flag:
                summary: Marcar la empresa para revisión
                value:
                  status: FLAGGED
              Block:
                summary: >-
                  Bloquear la empresa (la añade a la lista de bloqueo del
                  sistema)
                value:
                  status: BLOCKED
              Reactivate:
                summary: Reactivar la empresa
                value:
                  status: ACTIVE
              Block with reason:
                summary: Bloquear la empresa y registrar el motivo
                value:
                  status: BLOCKED
                  reason: Registry shows the company dissolved
      responses:
        '200':
          description: >-
            Estado de la empresa actualizado. Se devuelve el registro completo
            de la 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 o no válido, o un `reason` de más 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: >-
            Falta la clave de API, no es válida o fue revocada, o la clave no
            puede actualizar las empresas de esta aplicación. Si falta la clave,
            se devuelve `403`; si es incorrecta, fue revocada o expiró, se
            devuelve `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            No existe ninguna empresa (no eliminada) con el `vendor_data`
            proporcionado para esta aplicación.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Límite de solicitudes superado; espera y reintenta cuando haya
            pasado el intervalo indicado en `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: >-
            Nuevo estado del ciclo de vida. `BLOCKED` también añade el
            `vendor_data` a la lista de bloqueo del sistema.
    BusinessDetailItem:
      type: object
      description: >-
        Detalle completo de la empresa. Amplía BusinessListItem con los
        metadatos y updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de metadatos personalizados que adjuntaste a esta empresa.
                Valor predeterminado: `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Una empresa verificada.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interno estable de Didit para esta empresa.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Tu identificador único de esta empresa (el que se envía al crear
            sesiones). Puede ser null si no se proporcionó ningún identificador
            propio.
        display_name:
          type: string
          nullable: true
          description: Nombre visible personalizado que has definido
        legal_name:
          type: string
          nullable: true
          description: Razón social oficial obtenida del registro o introducida manualmente
        registration_number:
          type: string
          nullable: true
          description: Número de registro o de constitución de la empresa
        country_code:
          type: string
          nullable: true
          description: País de constitución (ISO 3166-1 alfa-2, p. ej., `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Mejor nombre disponible: display_name si está definido; si no,
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Estado del ciclo de vida del registro de la empresa (NO es un estado
            de sesión). `ACTIVE` es el valor predeterminado, `FLAGGED` lo marca
            para atención manual y `BLOCKED` impide nuevas sesiones para este
            `vendor_data`.
        session_count:
          type: integer
          description: Número total de sesiones de verificación de esta empresa
        approved_count:
          type: integer
          description: Número de sesiones aprobadas
        declined_count:
          type: integer
          description: Número de sesiones rechazadas
        in_review_count:
          type: integer
          description: Número de sesiones en revisión
        features:
          type: object
          description: >-
            Estado agregado por función de todas las sesiones KYB de esta
            empresa. Actualmente la única clave es `KYB` (el estado de la
            comprobación de la empresa en el registro). Valores posibles:
            `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub
            Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Los mismos datos que `features`, como un array ordenado de objetos
            `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de tiempo de la sesión más reciente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de tiempo de la primera sesión
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Marca de tiempo de la actividad más reciente (cambio de estado,
            actualización de la sesión, etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Etiquetas asignadas a esta empresa
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, que encontrarás en Developers -> API
        keys en la Business Console. La clave principal tiene acceso completo.
        Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
        escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
        a una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, se revocó o expiró; 403 significa que no se
        envió ninguna clave, que la clave no tiene acceso a este recurso o
        acción, o que la solicitud provino de una dirección fuera de su lista de
        IP; 404 en una ruta de sesión significa que la sesión está fuera de los
        flujos o estados de la clave. Una clave sin acceso a contenido
        multimedia recibe las URL de imágenes, videos y PDF como null, y una
        clave sin permiso de escritura en sesiones recibe los enlaces y tokens
        de sesión como null. Consulta https://docs.didit.me/console/api-keys.

````

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