Vai al contenuto principale
GET
curl

Panoramica

Restituisce una singola entità aziendale identificata da vendor_data.

Quando usarlo

  • Consultazione dello stato attuale di verifica di un’azienda: la mappa features fornisce a colpo d’occhio lo stato più recente di ogni funzionalità KYB.
  • Viste di dettaglio nella tua interfaccia di amministrazione.
  • Calcolo del punteggio di rischio usando i contatori aggregati e gli stati delle funzionalità.

Note

  • vendor_data nell’URL è sensibile alle maiuscole e minuscole.
  • Restituisce 404 se non esiste alcuna azienda con questo vendor_data.
  • I contatori aggregati (session_count, approved_count, declined_count, in_review_count) si aggiornano in tempo reale man mano che le sessioni di Verifica aziendale (KYB) vengono completate.
  • I campi derivati dal registro (legal_name, registration_number, country_code) riflettono l’ultima sessione di Verifica aziendale (KYB) approvata.

Autorizzazioni

Il ruolo deve includere l’autorizzazione read:businesses.

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: una stringa a formato libero (NON un UUID), confrontata esattamente come inviata.

Risposta

Dettagli completi dell'azienda compresi metadati e dati aggregati della sessione.

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