Vai al contenuto principale
PATCH
curl

Panoramica

Aggiorna i campi modificabili di una entità aziendale. 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.

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.

Autorizzazioni

Il segreto primario e le chiavi API 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 della Console determinano cosa può fare un membro del team nella Console. Non vengono valutati per le richieste con chiave API.

Correlati

Autorizzazioni

x-api-key
string
header
obbligatorio

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.

Parametri del percorso

vendor_data
string
obbligatorio

Il tuo identificatore univoco per l'azienda (stringa a formato libero, NON un UUID).

Corpo

application/json

Corpo dell'aggiornamento parziale. Fornisci solo i campi che desideri modificare.

display_name
string | null

Nome descrittivo mostrato nella console (ha la precedenza su legal_name per la visualizzazione dell'interfaccia utente).

Denominazione legale ufficiale dal registro o inserimento manuale.

registration_number
string | null

Numero di registrazione o costituzione dell'azienda.

country_code
string | null

Paese di costituzione (ISO 3166-1 alpha-2, ad es. GB, US).

status
enum<string>

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.

Opzioni disponibili:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

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
string | null

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.

Maximum string length: 1000

Risposta

Azienda aggiornata. Viene restituito il record aziendale completo aggiornato.

Dettagli completi dell'azienda. Estende BusinessListItem con metadati e updated_at.

didit_internal_id
string<uuid>

UUID interno stabile di Didit per questa azienda.

vendor_data
string | null

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
string | null

Nome visualizzato personalizzato impostato da te

Denominazione legale ufficiale dal registro o inserimento manuale

registration_number
string | null

Numero di registrazione o costituzione dell'azienda

country_code
string | null

Paese di costituzione (ISO 3166-1 alpha-2, ad es. GB, US).

effective_name
string | null

Miglior nome disponibile: display_name se impostato, altrimenti legal_name

status
enum<string>

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.

Opzioni disponibili:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Numero totale di sessioni di verifica per questa azienda

approved_count
integer

Numero di sessioni approvate

declined_count
integer

Numero di sessioni rifiutate

in_review_count
integer

Numero di sessioni in revisione

features
object

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
object[]

Gli stessi dati di features, sotto forma di array ordinato di oggetti {feature, status}.

last_session_at
string<date-time> | null

Timestamp della sessione più recente

first_session_at
string<date-time> | null

Timestamp della prima sessione

last_activity_at
string<date-time> | null

Timestamp dell'attività più recente (cambio di stato, aggiornamento della sessione, ecc.)

tags
object[]

Tag assegnati a questa azienda

created_at
string<date-time>
metadata
object

JSON di metadati personalizzati che hai allegato a questa azienda. Il valore predefinito è {}.

updated_at
string<date-time>
Ultima modifica il 7 novembre 2026