Primers passos
Integració / SDK
Verificació d'usuaris
Verificació d'empreses
Monitoratge de transaccions
Registre de canviscurl -s 'https://verification.didit.me/v3/sessions/?status=Approved,In%20Review&date_from=2026-06-01&limit=20' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.sessions.list():
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.sessions.list()) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
iter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.sessions().list()) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
foreach ($didit->sessions->list() as $item) {
print_r($item);
}require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.sessions.list.auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Sessions.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"session_id": "5b3720ed-d429-42ef-b67f-37ea805f48ee",
"session_kind": "user",
"session_number": 720,
"session_url": "https://verify.didit.me/session/CuXoBYCYVO5Y",
"portrait_image": "https://<media-host>/portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=...",
"document_type": "Passport",
"full_name": "Jane Marie Doe",
"country": "ESP",
"status": "Approved",
"vendor_data": "your-user-id-123",
"didit_internal_id": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147",
"created_at": "2026-06-09T12:26:54.328364Z",
"features": [
{
"feature": "ID_VERIFICATION",
"status": "Approved"
},
{
"feature": "LIVENESS",
"status": "Approved"
},
{
"feature": "FACE_MATCH",
"status": "Approved"
},
{
"feature": "AML",
"status": "Approved"
},
{
"feature": "IP_ANALYSIS",
"status": "Approved"
}
],
"phone_number": {
"number": "+14155552671",
"is_verified": true
},
"email_address": {
"email": "jane@example.com",
"is_verified": true
},
"additional_details": {
"aml": {
"total_hits": 0,
"entity_type": "person",
"is_adverse_media_fetched": false
},
"liveness": {
"method": "PASSIVE",
"score": 0.98
},
"face_match": {
"score": 0.95
}
}
},
{
"session_id": "038ad62f-5ebd-46c2-afe9-4b2956bf687f",
"session_kind": "user",
"session_number": 719,
"session_url": "https://verify.didit.me/session/7RGKiO6ioGH6",
"portrait_image": null,
"document_type": null,
"full_name": null,
"country": null,
"status": "Not Started",
"vendor_data": "your-user-id-124",
"didit_internal_id": "eb4e679d-ca4b-461f-9685-687bac29ebdb",
"created_at": "2026-06-09T08:02:23.343053Z",
"features": [
{
"feature": "ID_VERIFICATION",
"status": "Not Finished"
},
{
"feature": "LIVENESS",
"status": "Not Finished"
},
{
"feature": "FACE_MATCH",
"status": "Not Finished"
},
{
"feature": "AML",
"status": "Not Finished"
},
{
"feature": "IP_ANALYSIS",
"status": "Not Finished"
}
],
"phone_number": null,
"email_address": null,
"additional_details": null
}
]
}API per llistar sessions: filtra KYC i KYB
Llista sessions de verificació de Didit amb GET /v3/sessions/ i filtres per tipus, estat i flux. API KYC i KYB unificada, preu per ús.
curl -s 'https://verification.didit.me/v3/sessions/?status=Approved,In%20Review&date_from=2026-06-01&limit=20' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.sessions.list():
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.sessions.list()) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
iter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.sessions().list()) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
foreach ($didit->sessions->list() as $item) {
print_r($item);
}require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.sessions.list.auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Sessions.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"session_id": "5b3720ed-d429-42ef-b67f-37ea805f48ee",
"session_kind": "user",
"session_number": 720,
"session_url": "https://verify.didit.me/session/CuXoBYCYVO5Y",
"portrait_image": "https://<media-host>/portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=...",
"document_type": "Passport",
"full_name": "Jane Marie Doe",
"country": "ESP",
"status": "Approved",
"vendor_data": "your-user-id-123",
"didit_internal_id": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147",
"created_at": "2026-06-09T12:26:54.328364Z",
"features": [
{
"feature": "ID_VERIFICATION",
"status": "Approved"
},
{
"feature": "LIVENESS",
"status": "Approved"
},
{
"feature": "FACE_MATCH",
"status": "Approved"
},
{
"feature": "AML",
"status": "Approved"
},
{
"feature": "IP_ANALYSIS",
"status": "Approved"
}
],
"phone_number": {
"number": "+14155552671",
"is_verified": true
},
"email_address": {
"email": "jane@example.com",
"is_verified": true
},
"additional_details": {
"aml": {
"total_hits": 0,
"entity_type": "person",
"is_adverse_media_fetched": false
},
"liveness": {
"method": "PASSIVE",
"score": 0.98
},
"face_match": {
"score": 0.95
}
}
},
{
"session_id": "038ad62f-5ebd-46c2-afe9-4b2956bf687f",
"session_kind": "user",
"session_number": 719,
"session_url": "https://verify.didit.me/session/7RGKiO6ioGH6",
"portrait_image": null,
"document_type": null,
"full_name": null,
"country": null,
"status": "Not Started",
"vendor_data": "your-user-id-124",
"didit_internal_id": "eb4e679d-ca4b-461f-9685-687bac29ebdb",
"created_at": "2026-06-09T08:02:23.343053Z",
"features": [
{
"feature": "ID_VERIFICATION",
"status": "Not Finished"
},
{
"feature": "LIVENESS",
"status": "Not Finished"
},
{
"feature": "FACE_MATCH",
"status": "Not Finished"
},
{
"feature": "AML",
"status": "Not Finished"
},
{
"feature": "IP_ANALYSIS",
"status": "Not Finished"
}
],
"phone_number": null,
"email_address": null,
"additional_details": null
}
]
}Filtre de tipus de sessió
Fes servir el paràmetre de consultasession_kind per triar quin tipus de sessions es retornen:
| Valor | Retorna |
|---|---|
user (predeterminat) | Només sessions de Verificació d’usuaris (KYC). Comportament compatible amb versions anteriors: omet session_kind per obtenir-lo. |
business | Només sessions de Verificació d’empreses (KYB). |
all | Sessions de Verificació d’usuaris i de Verificació d’empreses, concatenades. |
session_kind: "user" | "business" perquè el client pugui seleccionar l’estructura adequada per a cada fila.
Filtres comuns
Aquests filtres s’apliquen als dos tipus (els filtres només per a usuaris s’ignoren quansession_kind=business, i a la inversa):
| Paràmetre de consulta | Descripció |
|---|---|
session_kind | user, business o all. Predeterminat user. |
vendor_data | Coincidència exacta amb el teu identificador. |
status | Un o diversos estats, separats per comes, escrits exactament com els retorna l’API: Approved, Declined, In Review, etc. (vegeu Estats de verificació). |
workflow_id | Filtra pel flux de treball utilitzat. |
country | Filtre per codi de país (usuari: issuing_states, empresa: country_code). |
date_from, date_to | Finestra de data de creació (ISO 8601). |
tags | Identificadors d’etiqueta separats per comes. Retorna les sessions que en tenen alguna. |
decided_from, decided_to | Dates i hores ISO 8601. Retorna les sessions l’estat de les quals va canviar per última vegada dins d’aquesta finestra (inici inclòs, fi exclòs). Fan servir l’hora de l’últim canvi d’estat, no l’hora de creació. |
search | Una referència completa tal com es mostra, com S-0001 o B-0001, coincideix només amb aquell número de sessió i tipus, i ignora els zeros inicials i les majúscules i minúscules. Qualsevol altra entrada fa una cerca en els camps existents de nom, contacte, document, número de registre i vendor_data. |
Exemples
- Llista les sessions de Verificació d'usuaris (KYC) (predeterminat)
- Llista les sessions de Verificació d'empreses (KYB)
- Llista els dos tipus
curl -G https://verification.didit.me/v3/sessions/ \
-H "x-api-key: YOUR_API_KEY" \
--data-urlencode "vendor_data=user-42"
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"session_id": "...",
"session_kind": "user",
"session_number": 1024,
"session_url": "...",
"portrait_image": "...",
"document_type": "Passport",
"full_name": "John Doe",
"country": "GBR",
"status": "Approved",
"vendor_data": "user-42",
"didit_internal_id": "...",
"created_at": "2026-04-10T09:00:00Z",
"features": "ID_VERIFICATION,LIVENESS,FACE_MATCH,AML",
"phone_number": "+14155550123",
"email_address": "jane@example.com",
"additional_details": null
}
]
}
curl -G https://verification.didit.me/v3/sessions/ \
-H "x-api-key: YOUR_API_KEY" \
--data-urlencode "session_kind=business" \
--data-urlencode "status=Approved"
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"session_id": "...",
"session_kind": "business",
"session_number": 89,
"status": "Approved",
"vendor_data": "biz-acme-001",
"created_at": "2026-04-01T09:00:00Z",
"workflow_id": "wf_kyb_standard",
"workflow_type": "business",
"workflow_label": "Standard KYB",
"company_name": "Acme Corporation Limited",
"registration_number": "12345678",
"country": "GBR"
}
]
}
curl -G https://verification.didit.me/v3/sessions/ \
-H "x-api-key: YOUR_API_KEY" \
--data-urlencode "session_kind=all" \
--data-urlencode "date_from=2026-04-01T00:00:00Z"
results. Els consumidors han de seleccionar l’estructura adequada per a cada fila segons session_kind.all concatena els resultats en lloc d’intercalar-los per marca de temps. Per a recorreguts mixtos d’alt volum, fes una crida per separat a cada tipus i fusiona els resultats al client.Les estructures de les files varien segons el tipus
Les files de Verificació d’usuaris (KYC) inclouen:portrait_image, document_type, full_name, country (estat emissor), phone_number, email_address, i alguns camps de revisió: assignee (el revisor de la Console que té la sessió, o null), waiting_since i sla_due_at (només s’estableixen mentre la sessió està In Review), top_warnings (les advertències més importants, cadascuna amb risk, feature, log_type i short_description) i warnings_count.
Les files de Verificació d’empreses (KYB) inclouen: workflow_type, workflow_label, company_name, registration_number, country (país de constitució).
Totes dues inclouen: session_id, session_kind, session_number, status, vendor_data, created_at.
Consulta la visió general de sessions per veure la matriu de funcionalitats completa.
Paginació
La paginació utilitzalimit (predeterminat 50) i offset (predeterminat 0), amb URL absolutes next i previous a la resposta. Tots dos paràmetres accepten valors fins a 1000000; un valor més gran retorna 400.
count és exacte fins a 100 i es queda en 100 a partir d’aquí, així que no l’utilitzis com a total. Continua sol·licitant la URL next fins que sigui null. Amb session_kind=all, count és la suma dels dos tipus, cadascun limitat a 100.
Relacionat
- Visió general de sessions
- Recuperar sessió — decisió completa per a una sola fila
- Visió general d’empreses — l’entitat empresa agregada a partir de les sessions
- Visió general d’usuaris — l’entitat usuari agregada a partir de les sessions
Autoritzacions
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.
Paràmetres de consulta
Quin tipus de sessions s'han de llistar: user (només KYC, per defecte), business (només KYB) o all (ambdues, concatenades; consulta la descripció per a la semàntica de paginació combinada). No distingeix entre majúscules i minúscules (BUSINESS funciona); qualsevol valor que no sigui una variant de majúscules/minúscules de user/business/all retorna 400.
user, business, all Nombre màxim de files per pàgina (per tipus quan session_kind=all). Per defecte és 50.
1 <= x <= 1000000Nombre de files que cal ometre abans de la primera fila retornada. Per defecte és 0. És preferible seguir els URL next/previous de la resposta.
0 <= x <= 1000000Llista separada per comes dels estats de sessió que cal incloure, p. ex. Approved,In Review. Els valors distingeixen entre majúscules i minúscules; consulta Estats de verificació. Els valors desconeguts no coincideixen amb res.
Filtre de coincidència exacta sobre el vendor_data que vas enviar en crear la sessió (el teu propi identificador d'usuari/empresa). Per a coincidències parcials, utilitza search en el seu lloc.
Una referència mostrada completa com ara S-0001 (usuari) o B-0001 (empresa) només coincideix amb aquest número i tipus de sessió; els zeros inicials i les majúscules o minúscules no afecten la coincidència. Cerca intel·ligent de text lliure. Un UUID complet coincideix amb session_id; una entrada numèrica coincideix amb el prefix del número de sessió, números de document/personals, prefix de telèfon o vendor_data; una entrada que conté @ coincideix amb prefixos de correu electrònic; la resta de text coincideix amb noms (sense distingir accents) i vendor_data. El text lliure que conté dígits coincideix addicionalment amb camps de cerca de número de document/personal i prefixos de número de sessió.
UUID de flux de treball separats per comes (troba'ls a la pàgina de Fluxos de treball a la Console). Els UUID amb format incorrecte a la llista s'ignoren; si cap no és vàlid, el resultat és buit.
Només sessions creades en o després d'aquesta data (UTC), format YYYY-MM-DD. Les dates amb format incorrecte retornen 400.
Només sessions creades fins a aquesta data (UTC), format YYYY-MM-DD. Per a files de KYC s'inclou el dia sencer; per a files de KYB la comparació és created_at <= date_to (mitjanit), així que utilitza la data de l'endemà per incloure un dia complet de sessions de KYB.
Identificadors d'etiquetes separats per comes (tags de la teva aplicació). Retorna les sessions que en continguin qualsevol. Els identificadors que no siguin UUID vàlids s'ignoren, i quan cap no és vàlid la llista és buida.
Data i hora ISO 8601. Retorna les sessions l'estat de les quals ha canviat per darrera vegada en aquest moment o després. Filtra per l'hora de l'últim canvi d'estat, no per l'hora de creació.
Data i hora ISO 8601. Retorna les sessions l'estat de les quals ha canviat per darrera vegada abans d'aquest moment. Combina-ho amb decided_from per a una finestra semioberta.
Filtre de països separat per comes. Per a files de KYC: codis ISO 3166-1 alfa-3 de l'estat emissor del document d'identitat (p. ex. ESP,USA), que poden diferir de la nacionalitat. Per a files de KYB: el codi de país de l'empresa al registre.
Codis de tipus de document d'identitat verificats a la sessió separats per comes (només files de KYC): P (passaport), ID (document d'identitat), DL (permís de conduir), RP (permís de residència), SSC (targeta de la Seguretat Social), HIC (targeta d'assegurança mèdica), WP (permís de treball), TC (targeta fiscal), VISA, PSC (targeta de serveis públics), BC (certificat de naixement), OTHER. Tingues en compte que el camp de resposta document_type conté el nom visible, no el codi.
Noms exactes de documents; es poden passar diversos noms separats per comes, però el valor només es divideix per comes quan conté més d'un separador - (un nom sol amb una coma integrada es fa coincidir sencer). Els noms són tal com els reconeix la verificació de documents (anvers o revers), p. ex. Spain - Id Card (2021). Només files de KYC.
Valors de regió/estat del document separats per comes (per a documents emesos per regió, com ara els permisos de conduir dels EUA). Només files de KYC.
Filtra per l'identificador intern d'usuari de Didit (el camp de resposta didit_internal_id) per llistar totes les sessions d'un usuari verificat. Ha de ser un UUID vàlid; els valors mal formats retornen 400. Només files de KYC.
Canals de creació de sessions separats per comes: API, HOSTED, MIGRATED. El valor especial ALL (o ometre el paràmetre) desactiva el filtre. Només per a files de KYC.
Filtra les sessions d'API independents per servei. Els valors no vàlids retornen 400. Només files de KYC.
ID_VERIFICATION, FACE_MATCH, AGE_ESTIMATION, FACE_SEARCH, POA, AML, KYB_REGISTRY, PASSIVE_LIVENESS, DATABASE_VALIDATION, PHONE_VERIFICATION, EMAIL_VERIFICATION Cerca de noms insensible als accents dins de les dades cribrades d'AML i de validació en bases de dades. Quan es combina amb api_service=AML o api_service=DATABASE_VALIDATION, la cerca es restringeix a les dades cribrades d'aquesta funcionalitat. Només files de KYC.
Codis de risc d'advertència separats per comes; retorna les sessions que n'hagin generat algun (p. ex. POSSIBLE_FRAUD). Els codis de risc s'enumeren per funcionalitat a la documentació d'advertències. S'aplica a files de KYC i, amb codis d'advertència d'empresa, a files de KYB.
Quan és true, només les sessions la decisió de les quals hagi quedat inicialment a In Review (útil per auditar el volum de revisió manual). Només files de KYC.
true retorna sessions la verificació de documents de les quals s'ha marcat per a revisió manual; false retorna sessions amb la verificació de documents no marcada explícitament. Omet-ho per desactivar-ho. Només files de KYC.
Filtra per l'euuid de l'usuari final (UUID assignat a l'usuari que es verifica, utilitzat pels enllaços profunds de la Console). Ha de ser un UUID vàlid; els valors malformats retornen un error de camp 400. Només files de KYC.
Noms d'organització separats per comes. Orientat a la consola; amb una clau d'API (ja restringida a una aplicació), només coincideix amb el nom de la teva pròpia organització.
Resposta
Llista de sessions paginada. Els elements de results són files de KYC, files de KYB o ambdues segons session_kind; distingeix-los mitjançant el camp session_kind de cada fila.
Nombre de sessions que coincideixen amb els filtres: exacte fins a 100 i limitat a 100 a partir d'aquí, de manera que no l'has d'utilitzar com a total. Fes servir next per saber si hi ha més pàgines. Per a session_kind=all és la suma de tots dos tipus, cadascun limitat a 100.
2
URL absoluta de la pàgina següent, o null a l'última pàgina.
"https://verification.didit.me/v3/sessions/?limit=20&offset=20"
URL absoluta de la pàgina anterior, o null a la primera pàgina.
null
Files de sessió, les més recents primer. Amb session_kind=all, les files de KYC van primer, seguides de les files de KYB.
Fila de resum per a una sessió de Verificació d'usuaris (KYC). Els camps d'identitat (full_name, country, document_type, portrait_image, camps de contacte) s'emplenen progressivament a mesura que l'usuari completa els passos de verificació, i són null fins que finalitza el pas corresponent. Els camps restringits per la configuració dels atributs de resposta del flux de treball també es retornen com a null.
- KYC session row (session_kind: user)
- KYB session row (session_kind: business)
Show child attributes
Show child attributes