API para listar sesiones: filtrar sesiones KYC y KYB

curl

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'

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)
}

using 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
    }
  ]
}

GET

sessions

curl

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'

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)
}

using 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
    }
  ]
}

Filtro por tipo de sesión

Usa el parámetro de consulta session_kind para elegir qué tipo de sesiones devolver:

Valor	Devuelve
`user` (predeterminado)	Solo sesiones de Verificación de usuarios (KYC). Comportamiento compatible con versiones anteriores: omite `session_kind` para obtener este comportamiento.
`business`	Solo sesiones de Verificación de empresas (KYB).
`all`	Sesiones de Verificación de usuarios y de Verificación de empresas, concatenadas.

Cada fila de la respuesta incluye session_kind: "user" | "business" para que tu cliente pueda elegir la estructura fila por fila.

Filtros comunes

Estos filtros se aplican a ambos tipos (los filtros exclusivos de usuarios se ignoran cuando session_kind=business, y viceversa):

Parámetro de consulta	Descripción
`session_kind`	`user`, `business` o `all`. Valor predeterminado: `user`.
`vendor_data`	Coincidencia exacta con tu identificador.
`status`	Uno o varios estados, separados por comas, escritos exactamente como los devuelve la API: `Approved`, `Declined`, `In Review`, etc. (consulta Estados de verificación).
`workflow_id`	Filtra por el flujo de verificación (workflow) utilizado.
`country`	Filtro por código de país (usuario: `issuing_states`, empresa: `country_code`).
`date_from`, `date_to`	Intervalo de fecha de creación (ISO 8601).
`tags`	IDs de etiquetas separados por comas. Devuelve las sesiones que tengan cualquiera de ellas.
`decided_from`, `decided_to`	Fechas y horas en ISO 8601. Devuelve las sesiones cuyo estado cambió por última vez en ese intervalo (inicio incluido, fin excluido). Estos filtros usan la hora del último cambio de estado, no la hora de creación.
`search`	Una referencia mostrada completa, como `S-0001` o `B-0001`, coincide solo con ese número y tipo de sesión, sin tener en cuenta los ceros iniciales ni las mayúsculas y minúsculas. Cualquier otra entrada busca en los campos existentes de nombre, contacto, documento, número de registro y `vendor_data`.

Ejemplos

Listar sesiones de Verificación de usuarios (KYC) (predeterminado)
Listar sesiones de Verificación de empresas (KYB)
Listar ambos tipos

curl -G https://verification.didit.me/v3/sessions/ \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "vendor_data=user-42"

Respuesta (truncada):

{
  "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"

Respuesta (truncada):

{
  "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"

Devuelve filas de Verificación de usuarios y de Verificación de empresas en un único array results. Los consumidores deben distinguir cada fila según session_kind.

El modo all concatena los resultados en lugar de intercalarlos por marca de tiempo. Para recorridos mixtos de gran volumen, consulta cada tipo por separado y combínalos en el cliente.

La estructura de las filas varía según el tipo

Las filas de Verificación de usuarios (KYC) incluyen: portrait_image, document_type, full_name, country (estado emisor), phone_number, email_address y algunos campos de revisión: assignee (el revisor de la Console que tiene asignada la sesión, o null), waiting_since y sla_due_at (solo se rellenan mientras la sesión está en In Review), top_warnings (las advertencias más importantes, cada una con risk, feature, log_type y short_description) y warnings_count. Las filas de Verificación de empresas (KYB) incluyen: workflow_type, workflow_label, company_name, registration_number, country (país de constitución). Ambas contienen: session_id, session_kind, session_number, status, vendor_data, created_at. Consulta la visión general de sesiones para ver la matriz completa de funciones.

Paginación

La paginación usa limit (valor predeterminado 50) y offset (valor predeterminado 0), con URL absolutas next y previous en la respuesta. Ambos parámetros aceptan valores de hasta 1000000; un valor mayor devuelve 400. count es exacto hasta 100 y se queda en 100 a partir de ahí, así que no lo uses como total. Sigue solicitando la URL next hasta que sea null. Con session_kind=all, count es la suma de ambos tipos, cada uno limitado a 100.

Relacionado

Visión general de sesiones
Obtener sesión: decisión completa de una sola fila
Visión general de empresas: la entidad Business agregada a lo largo de las sesiones
Visión general de usuarios: la entidad User agregada a lo largo de las sesiones

Autorizaciones

x-api-key

string

header

requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de consulta

session_kind

enum<string>

predeterminado:user

Qué tipo de sesiones listar: user (solo KYC, valor predeterminado), business (solo KYB) o all (ambas, concatenadas; consulta la descripción para conocer la semántica de la paginación combinada). La coincidencia no distingue mayúsculas de minúsculas (BUSINESS funciona); cualquier valor que no sea una variante en mayúsculas o minúsculas de user/business/all devuelve 400.

Opciones disponibles:

user,

business,

all

limit

integer

predeterminado:50

Número máximo de filas por página (por tipo cuando session_kind=all). El valor predeterminado es 50.

Rango requerido: 1 <= x <= 1000000

offset

integer

predeterminado:0

Número de filas que se omiten antes de la primera fila devuelta. El valor predeterminado es 0. Es preferible seguir las URL next/previous de la respuesta.

Rango requerido: 0 <= x <= 1000000

status

string

Lista separada por comas de los estados de sesión que se incluirán, por ejemplo, Approved,In Review. Los valores distinguen mayúsculas de minúsculas; consulta Estados de verificación. Los valores desconocidos no coinciden con nada.

vendor_data

string

Filtro de coincidencia exacta sobre el vendor_data que enviaste al crear la sesión (tu propio identificador de usuario o empresa). Para coincidencias parciales, usa search.

string

Una referencia completa tal como se muestra, como S-0001 (usuario) o B-0001 (empresa), coincide solo con ese número y tipo de sesión; los ceros iniciales y las mayúsculas o minúsculas no afectan a la coincidencia. Búsqueda inteligente de texto libre. Un UUID completo coincide con session_id; una entrada numérica coincide con el prefijo del número de sesión, números de documento o personales, el prefijo de teléfono o vendor_data; una entrada que contiene @ coincide con prefijos de correo electrónico; el resto del texto coincide con nombres (sin distinguir acentos) y vendor_data. El texto libre que contiene dígitos también coincide con los campos de búsqueda de números de documento o personales y con los prefijos del número de sesión.

workflow_id

string

UUID de flujos separados por comas (los encontrarás en la página Workflows de la Console). Los UUID mal formados de la lista se ignoran; si ninguno es válido, el resultado queda vacío.

date_from

string<date>

Solo sesiones creadas en esta fecha o después (UTC), con formato YYYY-MM-DD. Las fechas mal formadas devuelven 400.

date_to

string<date>

Solo sesiones creadas hasta esta fecha (UTC), con formato YYYY-MM-DD. En las filas de KYC se incluye el día completo; en las filas de KYB la comparación es created_at <= date_to (medianoche), así que usa la fecha del día siguiente para incluir un día completo de sesiones de KYB.

Respuesta

Lista paginada de sesiones. Los elementos de results son filas de KYC, de KYB o de ambos tipos según session_kind; distínguelos con el campo session_kind de cada fila.

count

integer

requerido

Número de sesiones que coinciden con los filtros: exacto hasta 100 y limitado a 100 por encima de esa cifra, así que no lo uses como total. Usa next para saber si hay más páginas. Con session_kind=all es la suma de ambos tipos, cada uno limitado a 100.

Ejemplo:

2

string<uri> | null

requerido

URL absoluta de la página siguiente, o null en la última página.

Ejemplo:

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

string<uri> | null

requerido

URL absoluta de la página anterior, o null en la primera página.

Ejemplo:

null

results

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

requerido

Filas de sesiones, de la más reciente a la más antigua. Con session_kind=all, primero van las filas KYC y después las KYB.

Fila de resumen de una sesión de Verificación de usuarios (KYC). Los campos de identidad (full_name, country, document_type, portrait_image, campos de contacto) se rellenan progresivamente a medida que el usuario completa los pasos de verificación y son null hasta que finaliza el paso correspondiente. Los campos restringidos por la configuración de atributos de respuesta del flujo también se devuelven como null.

KYC session row (session_kind: user)
KYB session row (session_kind: business)

Show child attributes

Última modificación el 1 de noviembre de 2026

​Filtro por tipo de sesión

​Filtros comunes

​Ejemplos

​La estructura de las filas varía según el tipo

​Paginación

​Relacionado

Autorizaciones

Parámetros de consulta

Respuesta

Filtro por tipo de sesión

Filtros comunes

Ejemplos

La estructura de las filas varía según el tipo

Paginación

Relacionado