> ## 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.

# Aggiornare un'azienda via API: entità KYB del fornitore

> Aggiorna nome visualizzato, metadati e tag di un'azienda in Didit (KYB). I campi del registro sono immutabili. A consumo.



Prompt per aggiornare l'azienda
        Copia il prompt negli appunti



      
      

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



      
      

Incolla in

## PanoramicaAggiorna i campi modificabili di una [entità aziendale](https://docs.didit.me/it/entities/businesses/overview.md). I campi popolati dalle ricerche nei registri (`legal_name`, `registration_number`, `country_code`) diventano di sola lettura dopo la prima sessione di Verifica aziendale (KYB) approvata.## Quando usarlo- **Rinomina** — imposta un `display_name` migliore per le viste interne.
- **Aggiorna i metadati** — sposta un'azienda tra livelli interni, registra una nota interna o modifica i tag.
- **Sovrascrivi i dati del registro** (con cautela) — le sovrascritture sono accettate ma contrassegnate nel [registro di audit](https://docs.didit.me/it/console/audit-logs.md).## Note- `vendor_data` nell'URL non può essere modificato tramite questo endpoint.
- Emette un webhook `business.data.updated` con un array `changed_fields`.
- Ogni modifica viene registrata nelle **Attività** dell'azienda nella Business Console.
  Una modifica di `status` viene registrata con il `reason` facoltativo (fino a 1000 caratteri), e una modifica di `display_name`, `legal_name`, `registration_number`, `country_code` o `metadata` come aggiornamento del profilo.
  Il webhook `business.status.updated` non include `reason`.## AutorizzazioniIl segreto primario e le [chiavi API](https://docs.didit.me/it/console/api-keys.md) con accesso completo possono sempre chiamare questo endpoint.
Una chiave con accesso personalizzato richiede l'autorizzazione di scrittura per **Aziende** (`businesses`).
Una chiave limitata ad alcuni workflow o alle sessioni approvate non può accedere a questo endpoint.I [ruoli e le autorizzazioni](https://docs.didit.me/it/console/roles-permissions.md) della Console determinano cosa può fare un membro del team nella Console.
Non vengono valutati per le richieste con chiave API.## Correlati- [Operazioni sulle aziende](https://docs.didit.me/it/entities/businesses/operations.md)
- [Modello dei dati](https://docs.didit.me/it/entities/businesses/data-model.md)
- [Aggiorna lo stato](https://docs.didit.me/it/management-api/businesses/update-status.md)


## OpenAPI

````yaml it/openapi-25.json PATCH /v3/businesses/{vendor_data}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API di verifica dell'identità. Autenticati con l'intestazione x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/:
    patch:
      tags:
        - Businesses
      summary: Aggiorna l'azienda
      description: >-
        Aggiornamento parziale di un'azienda: `display_name`, `legal_name`,
        `registration_number`, `country_code`, `status`, `metadata`. `metadata`
        sostituisce completamente. L'impostazione di `status` su `BLOCKED`
        aggiunge il `vendor_data` alla blocklist di sistema; allontanarsi da
        `BLOCKED` rimuove tale voce. Ogni modifica viene registrata
        nell'attività dell'azienda: una modifica di stato con il `reason`
        facoltativo, e una modifica a `display_name`, `legal_name`,
        `registration_number`, `country_code` o `metadata` come aggiornamento
        del profilo.
      operationId: update_business
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Il tuo identificatore univoco per l'azienda (stringa a formato
            libero, NON un UUID).
          example: company-123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Corpo dell'aggiornamento parziale. Fornisci solo i campi che
                desideri modificare.
              properties:
                display_name:
                  type: string
                  nullable: true
                  description: >-
                    Nome descrittivo mostrato nella console (ha la precedenza su
                    `legal_name` per la visualizzazione dell'interfaccia
                    utente).
                legal_name:
                  type: string
                  nullable: true
                  description: >-
                    Denominazione legale ufficiale dal registro o inserimento
                    manuale.
                registration_number:
                  type: string
                  nullable: true
                  description: Numero di registrazione o costituzione dell'azienda.
                country_code:
                  type: string
                  nullable: true
                  description: >-
                    Paese di costituzione (ISO 3166-1 alpha-2, ad es. `GB`,
                    `US`).
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  description: >-
                    Stato del ciclo di vita dell'azienda. L'impostazione di
                    `BLOCKED` aggiunge automaticamente il `vendor_data` alla
                    blocklist di sistema; la rimozione di `BLOCKED` elimina tale
                    voce dalla blocklist.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Oggetto JSON arbitrario da allegare all'azienda.
                    **Sostituisce completamente** i metadati esistenti in caso
                    di aggiornamento: esegui l'unione lato client se desideri
                    solo aggiungere chiavi.
                reason:
                  type: string
                  nullable: true
                  maxLength: 1000
                  description: >-
                    Il motivo per cui lo stato è cambiato. Registrato nella voce
                    di cambio di stato in **Activity** dell'azienda nella
                    Business Console, solo quando lo stato cambia
                    effettivamente. I webhook non lo includono.
            examples:
              Update name:
                summary: Aggiorna il nome visualizzato
                value:
                  display_name: Acme Corp
              Flag for review:
                summary: Modifica stato
                value:
                  status: FLAGGED
              Add metadata:
                summary: Sostituisci il JSON dei metadati
                value:
                  metadata:
                    industry: fintech
                    risk_level: low
              Fix registry data:
                summary: Campi estratti corretti
                value:
                  legal_name: Acme Trading International Ltd
                  registration_number: '12345678'
                  country_code: GB
              Flag with reason:
                summary: Segnala l'azienda e registra il motivo
                value:
                  status: FLAGGED
                  reason: Ownership structure under review
      responses:
        '200':
          description: >-
            Azienda aggiornata. Viene restituito il record aziendale completo
            aggiornato.
          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: >-
            Corpo non valido: in genere uno `status` sconosciuto, `metadata` non
            corretti o un `reason` superiore a 1000 caratteri.
          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: >-
            Chiave API mancante, non valida o revocata, oppure la chiave non può
            aggiornare aziende per questa applicazione. Una chiave mancante
            restituisce `403`; una chiave errata, revocata o scaduta restituisce
            `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Nessuna azienda (non eliminata) con il `vendor_data` fornito esiste
            per questa applicazione.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Limite di frequenza superato; rallenta e riprova dopo l'intervallo
            indicato in `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: >-
        Dettagli completi dell'azienda. Estende BusinessListItem con metadati e
        updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON di metadati personalizzati che hai allegato a questa
                azienda. Il valore predefinito è `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Un'azienda verificata.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interno stabile di Didit per questa azienda.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Il tuo identificatore univoco per questa azienda (passato durante la
            creazione delle sessioni). Può essere null se non è stato fornito
            alcun identificatore del fornitore.
        display_name:
          type: string
          nullable: true
          description: Nome visualizzato personalizzato impostato da te
        legal_name:
          type: string
          nullable: true
          description: Denominazione legale ufficiale dal registro o inserimento manuale
        registration_number:
          type: string
          nullable: true
          description: Numero di registrazione o costituzione dell'azienda
        country_code:
          type: string
          nullable: true
          description: Paese di costituzione (ISO 3166-1 alpha-2, ad es. `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Miglior nome disponibile: display_name se impostato, altrimenti
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Stato del ciclo di vita del record aziendale (NON uno stato della
            sessione). `ACTIVE` è il valore predefinito, `FLAGGED` lo
            contrassegna per una verifica manuale, `BLOCKED` impedisce nuove
            sessioni per questo `vendor_data`.
        session_count:
          type: integer
          description: Numero totale di sessioni di verifica per questa azienda
        approved_count:
          type: integer
          description: Numero di sessioni approvate
        declined_count:
          type: integer
          description: Numero di sessioni rifiutate
        in_review_count:
          type: integer
          description: Numero di sessioni in revisione
        features:
          type: object
          description: >-
            Stato aggregato per funzionalità in tutte le sessioni KYB di questa
            azienda. Attualmente l'unica chiave è `KYB` (lo stato del controllo
            aziendale nel registro). Valori possibili: `Approved`, `Declined`,
            `In Review`, `Not Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Gli stessi dati di `features`, sotto forma di array ordinato di
            oggetti `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp della sessione più recente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp della prima sessione
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Timestamp dell'attività più recente (cambio di stato, aggiornamento
            della sessione, ecc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Tag assegnati a questa azienda
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La chiave API della tua applicazione, da Developers -> API keys nella
        Business Console. La chiave primaria ha accesso completo. Una chiave con
        nome può avere un ambito definito: nessuno, lettura o scrittura per
        risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco
        di indirizzi IP e a una data di scadenza. 401 indica che la chiave è
        errata, revocata o scaduta; 403 indica che non è stata inviata alcuna
        chiave, che la chiave non ha accesso a questa risorsa o azione, oppure
        che la richiesta proviene da un indirizzo non incluso nel suo elenco IP;
        404 su una route di sessione indica che la sessione non rientra nei
        workflow o negli stati previsti dalla chiave. Una chiave senza accesso
        ai media riceve gli URL di immagini, video e PDF come null, e una chiave
        senza permessi di scrittura sulle sessioni riceve link e token di
        sessione come null. Consulta https://docs.didit.me/console/api-keys.

````

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