Vai al contenuto principale
GET
curl

Filtro per tipo di sessione

Usa il parametro di query session_kind per scegliere quale tipo di sessione restituire: Ogni riga della risposta include session_kind: "user" | "business", così il tuo client può gestire la struttura di ogni riga in base a questo campo.

Filtri comuni

Questi filtri si applicano a entrambi i tipi (i filtri riservati agli utenti vengono ignorati quando session_kind=business, e viceversa):

Esempi

Risposta (troncata):

Le forme delle righe cambiano in base al tipo

Le righe di Verifica degli utenti (KYC) includono: portrait_image, document_type, full_name, country (paese di emissione), phone_number, email_address e alcuni campi di revisione: assignee (il revisore della Console che detiene la sessione, o null), waiting_since e sla_due_at (valorizzati solo mentre la sessione è In Review), top_warnings (gli avvisi più importanti, ciascuno con risk, feature, log_type e short_description) e warnings_count. Le righe di Verifica aziendale (KYB) includono: workflow_type, workflow_label, company_name, registration_number, country (paese di costituzione). Entrambe contengono: session_id, session_kind, session_number, status, vendor_data, created_at. Vedi Panoramica delle sessioni per la matrice completa delle funzionalità.

Paginazione

La paginazione usa limit (predefinito 50) e offset (predefinito 0), con URL assoluti next e previous nella risposta. Entrambi i parametri accettano valori fino a 1000000; un valore superiore restituisce 400. count è esatto fino a 100 e resta a 100 oltre tale valore, quindi non usarlo come totale. Continua a richiedere l’URL next finché non è null. Con session_kind=all, count è la somma dei due tipi, ciascuno limitato a 100.

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 della query

session_kind
enum<string>
predefinito:user

Quale tipo di sessioni elencare: user (solo KYC, predefinito), business (solo KYB) o all (entrambe, concatenate; consulta la descrizione per la semantica di paginazione unificata). La corrispondenza non fa distinzione tra maiuscole e minuscole (BUSINESS funziona); qualsiasi valore diverso da una variante di maiuscole/minuscole di user/business/all restituisce 400.

Opzioni disponibili:
user,
business,
all
limit
integer
predefinito:50

Numero massimo di righe per pagina (per tipologia quando session_kind=all). Il valore predefinito è 50.

Intervallo richiesto: 1 <= x <= 1000000
offset
integer
predefinito:0

Numero di righe da saltare prima della prima riga restituita. Il valore predefinito è 0. È preferibile seguire gli URL next/previous della risposta.

Intervallo richiesto: 0 <= x <= 1000000
status
string

Elenco separato da virgole degli stati della sessione da includere, ad es. Approved,In Review. I valori fanno distinzione tra maiuscole e minuscole; consulta Stati di verifica. I valori sconosciuti non corrispondono a nulla.

vendor_data
string

Filtro per corrispondenza esatta sul vendor_data inviato alla creazione della sessione (il tuo identificatore per l'utente/azienda). Per corrispondenze parziali, usa invece search.

Un riferimento visualizzato completo come S-0001 (utente) o B-0001 (azienda) corrisponde unicamente a quel numero e tipo di sessione; gli zeri iniziali e le maiuscole/minuscole non influiscono sulla corrispondenza. Ricerca intelligente a testo libero. Un UUID completo corrisponde a session_id; un input numerico corrisponde al prefisso del numero di sessione, ai numeri di documento/personali, al prefisso telefonico o a vendor_data; un input contenente @ corrisponde ai prefissi email; altro testo corrisponde ai nomi (senza distinzione di accenti) e a vendor_data. Il testo libero contenente cifre corrisponde inoltre ai campi di ricerca del numero di documento/personale e ai prefissi del numero di sessione.

workflow_id
string

UUID dei workflow separati da virgola (disponibili nella pagina Workflow della Console). Gli UUID non validi nell'elenco vengono ignorati; se nessuno è valido, il risultato è vuoto.

date_from
string<date>

Solo le sessioni create in questa data o successivamente (UTC), formato YYYY-MM-DD. Le date con formato non valido restituiscono 400.

date_to
string<date>

Solo le sessioni create fino a questa data (UTC), formato YYYY-MM-DD. Per le righe KYC viene inclusa l'intera giornata; per le righe KYB il confronto è created_at <= date_to (mezzanotte), quindi usa la data del giorno successivo per includere un'intera giornata di sessioni KYB.

tags
string

ID di tag separati da virgole (tags della tua applicazione). Restituisce le sessioni che contengono uno qualsiasi di essi. Gli ID che non sono UUID validi vengono ignorati e, se nessuno è valido, l'elenco è vuoto.

decided_from
string<date-time>

Data e ora ISO 8601. Restituisce le sessioni il cui stato è cambiato l'ultima volta a partire da tale momento. Filtra in base all'orario dell'ultimo cambio di stato, non all'orario di creazione.

decided_to
string<date-time>

Data e ora ISO 8601. Restituisce le sessioni il cui stato è cambiato l'ultima volta prima di tale momento. Combina con decided_from per un intervallo semiaperto.

country
string

Filtro per paese separato da virgole. Per le righe KYC: codici ISO 3166-1 alpha-3 dello stato di emissione del documento d'identità (ad es. ESP,USA), che possono differire dalla nazionalità. Per le righe KYB: il codice del paese dell'azienda nel registro.

document_type
string

Codici dei tipi di documento di identità verificati nella sessione, separati da virgole (solo righe KYC): P (passaporto), ID (carta d'identità), DL (patente di guida), RP (permesso di soggiorno), SSC (tessera di sicurezza sociale), HIC (tessera sanitaria), WP (permesso di lavoro), TC (tesserino del codice fiscale), VISA, PSC (carta dei servizi pubblici), BC (certificato di nascita), OTHER. Nota che il campo di risposta document_type contiene il nome visualizzato, non il codice.

document_name
string

Nomi esatti dei documenti; è possibile passare più nomi separati da virgola, ma il valore viene suddiviso in corrispondenza delle virgole solo se contiene più di un separatore - (un singolo nome contenente una virgola interna viene confrontato per intero). I nomi corrispondono a quelli riconosciuti dalla verifica del documento (fronte o retro), ad es. Spain - Id Card (2021). Solo righe KYC.

region
string

Valori di regione/stato del documento separati da virgole (per documenti emessi su base regionale, come le patenti di guida statunitensi). Solo righe KYC.

didit_internal_id
string<uuid>

Filtra per identificatore interno dell'utente di Didit (il campo di risposta didit_internal_id) per elencare tutte le sessioni di un utente verificato. Deve essere un UUID valido; i valori non validi restituiscono 400. Solo righe KYC.

session_type
string

Canali di creazione della sessione separati da virgole: API, HOSTED, MIGRATED. Il valore speciale ALL (o l'omissione del parametro) disabilita il filtro. Solo righe KYC.

api_service
enum<string>

Filtra le sessioni API standalone per servizio. I valori non validi restituiscono 400. Solo righe KYC.

Opzioni disponibili:
ID_VERIFICATION,
FACE_MATCH,
AGE_ESTIMATION,
FACE_SEARCH,
POA,
AML,
KYB_REGISTRY,
PASSIVE_LIVENESS,
DATABASE_VALIDATION,
PHONE_VERIFICATION,
EMAIL_VERIFICATION
screened_full_name
string

Ricerca del nome senza distinzione di accenti all'interno dei dati sottoposti a screening AML e validazione su database. Se combinata con api_service=AML o api_service=DATABASE_VALIDATION, la ricerca è limitata ai dati sottoposti a screening di tale funzionalità. Solo righe KYC.

warning
string

Codici di rischio degli avvisi separati da virgole; restituisce le sessioni che ne hanno generato alcuno (ad es. POSSIBLE_FRAUD). I codici di rischio sono elencati per funzionalità nella documentazione sugli avvisi. Si applica alle righe KYC e, con i codici di avviso aziendali, alle righe KYB.

status_initialized_as_in_review
boolean

Quando è true, include solo le sessioni la cui decisione è stata inizialmente impostata su In Review (utile per verificare il volume della revisione manuale). Solo righe KYC.

is_kyc_to_be_reviewed
boolean

true restituisce le sessioni la cui verifica del documento è contrassegnata per la revisione manuale; false restituisce le sessioni la cui verifica del documento non è esplicitamente contrassegnata. Ometti per disattivare. Solo righe KYC.

euuid
string<uuid>

Filtra in base all'euuid dell'utente finale (UUID assegnato all'utente in fase di verifica, utilizzato per i deep link della Console). Deve essere un UUID valido; valori non corretti restituiscono un errore di campo 400. Solo righe KYC.

organization_name
string

Nomi delle organizzazioni separati da virgole. Destinato alla Console; con una chiave API (già limitata a una singola applicazione) corrisponde solo al nome della tua organizzazione.

Risposta

Elenco sessioni impaginato. Gli elementi di results sono righe KYC, righe KYB o entrambe a seconda di session_kind; distingui con il campo session_kind di ciascuna riga.

count
integer
obbligatorio

Numero di sessioni corrispondenti ai filtri: esatto fino a 100 e limitato a 100 oltre tale soglia, pertanto non utilizzarlo come totale complessivo. Usa next per sapere se esistono altre pagine. Per session_kind=all corrisponde alla somma di entrambi i tipi, ciascuno limitato a 100.

Esempio:

2

next
string<uri> | null
obbligatorio

URL assoluto della pagina successiva, o null sull'ultima pagina.

Esempio:

"https://verification.didit.me/v3/sessions/?limit=20&offset=20"

previous
string<uri> | null
obbligatorio

URL assoluto della pagina precedente, o null sulla prima pagina.

Esempio:

null

results
(KYC session row (session_kind: user) · object | KYB session row (session_kind: business) · object)[]
obbligatorio

Righe delle sessioni, dalla più recente. Con session_kind=all, vengono prima le righe KYC, poi quelle KYB.

Riga di riepilogo per una sessione di Verifica degli utenti (KYC). I campi di identità (full_name, country, document_type, portrait_image, campi di contatto) vengono popolati progressivamente man mano che l'utente completa i passaggi di verifica, e sono null fino al termine del passaggio pertinente. Anche i campi soggetti a restrizioni dalla configurazione degli attributi di risposta del workflow vengono restituiti come null.

Ultima modifica il 7 novembre 2026