> ## 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 d'actualització d'empreses: entitat KYB de proveïdor

> Actualitza els camps modificables d'una empresa de Didit (KYB): nom visible, metadades i etiquetes. Les dades d'identitat del registre no es poden modificar.



Actualitza el prompt de l'empresa
        Copia el prompt al porta-retalls



      
      

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



      
      

Enganxa a

## Visió generalActualitza els camps modificables d'una [entitat Business](https://docs.didit.me/ca/entities/businesses/overview.md). Els camps omplerts a partir de consultes al registre (`legal_name`, `registration_number`, `country_code`) passen a ser de només lectura després de la primera sessió de Verificació d'empreses (KYB) aprovada.## Quan utilitzar-lo- **Canvia el nom**: estableix un `display_name` més clar per a les vistes internes.
- **Actualitza les metadades**: mou una empresa entre nivells interns, registra una nota interna o canvia les etiquetes.
- **Sobreescriu les dades del registre** (amb precaució): les sobreescriptures s'accepten però queden marcades al [registre d'auditoria](https://docs.didit.me/ca/console/audit-logs.md).## Notes- `vendor_data` de la URL no es pot canviar amb aquest endpoint.
- Emet un webhook `business.data.updated` amb una matriu `changed_fields`.
- Cada edició queda registrada a **Activitat** de l'empresa a la Business Console.
  Un canvi de `status` es registra amb el `reason` opcional (fins a 1000 caràcters), i un canvi a `display_name`, `legal_name`, `registration_number`, `country_code` o `metadata` es registra com a actualització del perfil.
  El webhook `business.status.updated` no inclou `reason`.## PermisosLa clau secreta principal i les [claus d'API](https://docs.didit.me/ca/console/api-keys.md) amb accés complet sempre poden cridar aquest endpoint.
Una clau amb accés personalitzat necessita permís d'escriptura sobre **Empreses** (`businesses`).
Una clau limitada a alguns fluxos de treball o només a sessions aprovades no pot accedir a aquest endpoint.Els [rols i permisos](https://docs.didit.me/ca/console/roles-permissions.md) de la Business Console determinen què pot fer un membre de l'equip a la Console.
No s'avaluen per a les sol·licituds amb clau d'API.## Relacionat- [Operacions d'empreses](https://docs.didit.me/ca/entities/businesses/operations.md)
- [Model de dades](https://docs.didit.me/ca/entities/businesses/data-model.md)
- [Actualitza l'estat](https://docs.didit.me/ca/management-api/businesses/update-status.md)


## OpenAPI

````yaml ca/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ó d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/:
    patch:
      tags:
        - Businesses
      summary: Actualitzar empresa
      description: >-
        Actualització parcial d'una empresa: `display_name`, `legal_name`,
        `registration_number`, `country_code`, `status`, `metadata`. `metadata`
        es reemplaça completament. Si s'estableix `status` en `BLOCKED`,
        s'afegeix el `vendor_data` a la llista de bloqueig del sistema; si es
        canvia de `BLOCKED` a un altre estat, s'elimina aquesta entrada. Cada
        modificació queda registrada a l'activitat de l'empresa: un canvi
        d'estat amb el camp opcional `reason`, i un canvi a `display_name`,
        `legal_name`, `registration_number`, `country_code` o `metadata` com a
        actualització de perfil.
      operationId: update_business
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            El teu identificador únic per a l'empresa (cadena de text lliure, NO
            un UUID).
          example: company-123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Cos d'actualització parcial. Proporciona només els camps que
                vulguis canviar.
              properties:
                display_name:
                  type: string
                  nullable: true
                  description: >-
                    Nom descriptiu que es mostra a la consola (té prioritat
                    sobre `legal_name` per a la visualització a la interfície
                    d'usuari).
                legal_name:
                  type: string
                  nullable: true
                  description: >-
                    Nom legal oficial obtingut del registre mercantil o
                    introduït manualment.
                registration_number:
                  type: string
                  nullable: true
                  description: Número de registre o de constitució de l'empresa.
                country_code:
                  type: string
                  nullable: true
                  description: País de constitució (ISO 3166-1 alpha-2, p. ex. `GB`, `US`).
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  description: >-
                    Estat del cicle de vida de l'empresa. En establir `BLOCKED`,
                    s'afegeix automàticament el valor de `vendor_data` a la
                    llista de bloqueig del sistema; en canviar de `BLOCKED` a un
                    altre estat, s'elimina aquesta entrada de la llista de
                    bloqueig.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Objecte JSON arbitrari que adjuntes a l'empresa.
                    **Substitueix completament** les metadades existents en
                    actualitzar; fusiona-les al costat del client si només vols
                    afegir claus.
                reason:
                  type: string
                  nullable: true
                  maxLength: 1000
                  description: >-
                    Per què ha canviat l'estat. Es registra a l'entrada de canvi
                    d'estat de l'apartat **Activitat** de l'empresa a la
                    Business Console, només quan l'estat canvia realment. Els
                    webhooks no l'inclouen.
            examples:
              Update name:
                summary: Actualitza el nom visible
                value:
                  display_name: Acme Corp
              Flag for review:
                summary: Canvia l'estat
                value:
                  status: FLAGGED
              Add metadata:
                summary: Substitueix el JSON de metadades
                value:
                  metadata:
                    industry: fintech
                    risk_level: low
              Fix registry data:
                summary: Corregir els camps extrets
                value:
                  legal_name: Acme Trading International Ltd
                  registration_number: '12345678'
                  country_code: GB
              Flag with reason:
                summary: Marca l'empresa i registra'n el motiu
                value:
                  status: FLAGGED
                  reason: Ownership structure under review
      responses:
        '200':
          description: >-
            Empresa actualitzada. Es retorna el registre complet i actualitzat
            de l'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: >-
            Cos no vàlid: normalment un `status` desconegut, `metadata` amb
            format incorrecte o un `reason` de més de 1000 caràcters.
          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: >-
            Clau d'API absent, no vàlida o revocada, o bé la clau no pot
            actualitzar empreses per a aquesta aplicació. Una clau absent
            retorna `403`; una clau incorrecta, revocada o caducada retorna
            `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            No existeix cap empresa (no eliminada) amb el `vendor_data`
            proporcionat per a aquesta aplicació.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            S'ha superat el límit de freqüència; redueix el ritme de les
            sol·licituds i reintenta-ho després de l'interval indicat a
            `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: >-
        Detall complet de l'empresa. Amplia BusinessListItem amb metadades i
        updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de metadades personalitzades que has adjuntat a aquesta
                empresa. Per defecte és `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Una empresa verificada.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID intern estable de Didit per a aquesta empresa.
        vendor_data:
          type: string
          nullable: true
          description: >-
            El teu identificador únic per a aquesta empresa (passat en crear
            sessions). Pot ser nul quan no s'ha proporcionat cap identificador
            de proveïdor.
        display_name:
          type: string
          nullable: true
          description: Nom visible personalitzat definit per tu
        legal_name:
          type: string
          nullable: true
          description: >-
            Nom legal oficial obtingut del registre mercantil o introduït
            manualment
        registration_number:
          type: string
          nullable: true
          description: Número de registre o de constitució de l'empresa
        country_code:
          type: string
          nullable: true
          description: País de constitució (ISO 3166-1 alpha-2, p. ex. `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Millor nom disponible: display_name si està definit, en cas contrari
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Estat del cicle de vida del registre d'empresa (NO és un estat de la
            sessió). `ACTIVE` és el valor per defecte, `FLAGGED` el marca per a
            atenció manual, `BLOCKED` impedeix noves sessions per a aquest
            `vendor_data`.
        session_count:
          type: integer
          description: Nombre total de sessions de verificació per a aquesta empresa
        approved_count:
          type: integer
          description: Nombre de sessions aprovades
        declined_count:
          type: integer
          description: Nombre de sessions rebutjades
        in_review_count:
          type: integer
          description: Nombre de sessions en revisió
        features:
          type: object
          description: >-
            Estat agregat per funcionalitat a totes les sessions de KYB
            d'aquesta empresa. Actualment l'única clau és `KYB` (l'estat de la
            comprovació de l'empresa al registre). Valors possibles: `Approved`,
            `Declined`, `In Review`, `Not Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Les mateixes dades que `features`, com una llista ordenada
            d'objectes `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de temps de la sessió més recent
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de temps de la primera sessió
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Marca de temps de l'activitat més recent (canvi d'estat,
            actualització de la sessió, etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Etiquetes assignades a aquesta empresa
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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