> ## 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 empresas: entidad KYB de proveedor

> Actualiza campos editables de una empresa (KYB) en Didit: nombre visible, metadatos y etiquetas. Los datos de registro son inmutables. Pago por uso.



Prompt para actualizar una empresa
        Copiar el prompt al portapapeles



      
      

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



      
      

Pegar en

## Descripción generalActualiza los campos modificables de una [empresa](https://docs.didit.me/es/entities/businesses/overview.md). Los campos que se rellenan a partir de consultas al registro (`legal_name`, `registration_number`, `country_code`) pasan a ser de solo lectura tras la primera sesión aprobada de Verificación de empresas (KYB).## Cuándo usarlo- **Renombrar**: define un `display_name` más adecuado para las vistas internas.
- **Actualizar metadatos**: mueve una empresa entre niveles internos, registra una nota interna o cambia etiquetas.
- **Sobrescribir datos del registro** (con precaución): las sobrescrituras se aceptan, pero quedan marcadas en el [registro de auditoría](https://docs.didit.me/es/console/audit-logs.md).## Notas- El `vendor_data` de la URL no se puede cambiar mediante este endpoint.
- Emite un webhook `business.data.updated` con un array `changed_fields`.
- Cada edición queda registrada en la **Activity** de la empresa en la Business Console.
  Un cambio de `status` se registra con el `reason` opcional (hasta 1000 caracteres), y un cambio de `display_name`, `legal_name`, `registration_number`, `country_code` o `metadata`, como una actualización del perfil.
  El webhook `business.status.updated` no incluye `reason`.## 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 determinan lo que un miembro del equipo puede hacer en la Console.
No se evalúan en las solicitudes con clave de API.## Relacionado- [Operaciones con empresas](https://docs.didit.me/es/entities/businesses/operations.md)
- [Modelo de datos](https://docs.didit.me/es/entities/businesses/data-model.md)
- [Actualizar estado](https://docs.didit.me/es/management-api/businesses/update-status.md)


## OpenAPI

````yaml es/openapi-25.json PATCH /v3/businesses/{vendor_data}/
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}/:
    patch:
      tags:
        - Businesses
      summary: Actualizar empresa
      description: >-
        Actualización parcial de una empresa: `display_name`, `legal_name`,
        `registration_number`, `country_code`, `status`, `metadata`. `metadata`
        se reemplaza por completo. Establecer `status` en `BLOCKED` añade el
        `vendor_data` a la lista de bloqueo del sistema; salir de `BLOCKED`
        elimina esa entrada. Cada edición queda registrada en la actividad de la
        empresa: un cambio de estado con el `reason` opcional, y un cambio en
        `display_name`, `legal_name`, `registration_number`, `country_code` o
        `metadata` como una actualización del perfil.
      operationId: update_business
      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:
              type: object
              description: >-
                Cuerpo de actualización parcial. Indica solo los campos que
                quieras cambiar.
              properties:
                display_name:
                  type: string
                  nullable: true
                  description: >-
                    Nombre visible descriptivo que se muestra en la consola
                    (tiene prioridad sobre `legal_name` en la interfaz).
                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`).
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  description: >-
                    Estado del ciclo de vida de la empresa. Establecer `BLOCKED`
                    añade automáticamente el `vendor_data` a la lista de bloqueo
                    del sistema; cambiar de `BLOCKED` a otro estado elimina esa
                    entrada de la lista de bloqueo.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Objeto JSON arbitrario que adjuntas a la empresa.
                    **Reemplaza por completo** los metadatos existentes al
                    actualizar: combínalos en el cliente si solo quieres añadir
                    claves.
                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:
              Update name:
                summary: Actualizar nombre visible
                value:
                  display_name: Acme Corp
              Flag for review:
                summary: Cambiar estado
                value:
                  status: FLAGGED
              Add metadata:
                summary: Reemplazar el JSON de metadatos
                value:
                  metadata:
                    industry: fintech
                    risk_level: low
              Fix registry data:
                summary: Corregir campos extraídos
                value:
                  legal_name: Acme Trading International Ltd
                  registration_number: '12345678'
                  country_code: GB
              Flag with reason:
                summary: Marcar la empresa y registrar el motivo
                value:
                  status: FLAGGED
                  reason: Ownership structure under review
      responses:
        '200':
          description: >-
            Empresa actualizada. Se devuelve el registro completo y actualizado
            de la 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: >-
            Cuerpo no válido: normalmente un `status` desconocido, un `metadata`
            mal formado o un `reason` de más 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: >-
            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/' \
              -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: >-
        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.