Listar sessões API: filtrar sessões KYC e 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 sessão

Use o parâmetro de consulta session_kind para escolher o tipo de sessões a devolver:

Valor	Devolve
`user` (predefinido)	Apenas sessões de Verificação de utilizadores (KYC). Comportamento compatível com versões anteriores: omita `session_kind` para obter este resultado.
`business`	Apenas sessões de Verificação de empresas (KYB).
`all`	Sessões de Verificação de utilizadores e de Verificação de empresas, concatenadas.

Cada linha da resposta inclui session_kind: "user" | "business", para que o seu cliente possa tratar a estrutura de cada linha de acordo com o tipo.

Filtros comuns

Estes filtros aplicam-se aos dois tipos (os filtros exclusivos de utilizadores são ignorados quando session_kind=business, e vice-versa):

Parâmetro de consulta	Descrição
`session_kind`	`user`, `business` ou `all`. Predefinido `user`.
`vendor_data`	Correspondência exata com o seu identificador.
`status`	Um ou mais estados, separados por vírgulas, escritos exatamente como a API os devolve: `Approved`, `Declined`, `In Review`, e assim por diante (ver Estados de verificação).
`workflow_id`	Filtra pelo fluxo utilizado.
`country`	Filtro por código de país (utilizadores: `issuing_states`, empresas: `country_code`).
`date_from`, `date_to`	Intervalo de datas de criação (ISO 8601).
`tags`	IDs de etiquetas separados por vírgulas. Devolve as sessões que tenham qualquer uma delas.
`decided_from`, `decided_to`	Datas e horas ISO 8601. Devolve as sessões cujo estado foi alterado pela última vez nesse intervalo (início inclusive, fim exclusivo). Usam a data e hora da última alteração de estado, não a data de criação.
`search`	Uma referência completa tal como é apresentada, como `S-0001` ou `B-0001`, corresponde apenas a esse número e tipo de sessão, ignorando zeros à esquerda e diferenças entre maiúsculas e minúsculas. Qualquer outro valor é pesquisado nos campos existentes de nome, contacto, documento, número de registo e `vendor_data`.

Exemplos

Listar sessões de Verificação de utilizadores (KYC) (predefinição)
Listar sessões de Verificação de empresas (KYB)
Listar ambos os tipos

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

Resposta (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"

Resposta (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"

Devolve linhas de Verificação de utilizadores e de Verificação de empresas num único array results. Os consumidores devem tratar cada linha de acordo com session_kind.

O modo all concatena os resultados em vez de os intercalar por data e hora. Para consultas de grande volume com tipos misturados, chame cada tipo separadamente e junte os resultados do lado do cliente.

A estrutura das linhas varia por tipo

As linhas de Verificação de utilizadores (KYC) incluem: portrait_image, document_type, full_name, country (estado emissor), phone_number, email_address e alguns campos de revisão: assignee (o revisor da Console que detém a sessão, ou null), waiting_since e sla_due_at (definidos apenas enquanto a sessão estiver In Review), top_warnings (os avisos mais importantes, cada um com risk, feature, log_type e short_description) e warnings_count. As linhas de Verificação de empresas (KYB) incluem: workflow_type, workflow_label, company_name, registration_number, country (país de constituição). Ambos incluem: session_id, session_kind, session_number, status, vendor_data, created_at. Consulte a visão geral das sessões para a matriz completa de funcionalidades.

Paginação

A paginação usa limit (predefinido 50) e offset (predefinido 0), com URLs absolutas next e previous na resposta. Ambos os parâmetros aceitam valores até 1000000; um valor superior devolve 400. count é exato até 100 e fica em 100 acima desse valor, por isso não o use como total. Continue a pedir a URL next até que seja null. Com session_kind=all, count é a soma dos dois tipos, limitada a 100 em cada um.

Relacionados

Visão geral das sessões
Obter sessão: decisão completa de uma única linha
Visão geral das empresas: a entidade Empresa agregada nas sessões
Visão geral dos utilizadores: a entidade Utilizador agregada nas sessões

Autorizações

x-api-key

string

header

obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de consulta

session_kind

enum<string>

padrão:user

Qual o tipo de sessões a listar: user (apenas KYC, predefinição), business (apenas KYB) ou all (ambas, concatenadas - consulte a descrição para a semântica de paginação combinada). A correspondência não diferencia maiúsculas de minúsculas (BUSINESS funciona); qualquer valor que não seja uma variante de maiúsculas/minúsculas de user/business/all devolve 400.

Opções disponíveis:

user,

business,

all

limit

integer

padrão:50

Número máximo de linhas por página (por tipo quando session_kind=all). O valor predefinido é 50.

Intervalo necessário: 1 <= x <= 1000000

offset

integer

padrão:0

Número de linhas a ignorar antes da primeira linha devolvida. O valor predefinido é 0. Prefira seguir os URLs next/previous da resposta.

Intervalo necessário: 0 <= x <= 1000000

status

string

Lista separada por vírgulas de estados de sessão a incluir, por exemplo, Approved,In Review. Os valores são sensíveis a maiúsculas e minúsculas; consulte Estados de verificação. Valores desconhecidos não correspondem a nada.

vendor_data

string

Filtro de correspondência exata no vendor_data que enviou na criação da sessão (o seu próprio identificador de utilizador/empresa). Para correspondências parciais, utilize search em alternativa.

string

Uma referência completa apresentada, como S-0001 (utilizador) ou B-0001 (empresa), corresponde apenas a esse número e tipo de sessão; os zeros à esquerda e maiúsculas/minúsculas não afetam a correspondência. Pesquisa inteligente de texto livre. Um UUID completo corresponde a session_id; uma entrada numérica corresponde ao prefixo do número da sessão, números de documento/pessoais, prefixo de telefone ou vendor_data; entradas que contenham @ correspondem a prefixos de e-mail; outro texto corresponde a nomes (não sensível a acentos) e a vendor_data. O texto livre que contenha dígitos corresponde adicionalmente a campos de pesquisa de número de documento/pessoal e a prefixos de número de sessão.

workflow_id

string

UUIDs de fluxos separados por vírgulas (encontre-os na página Fluxos na Consola). UUIDs malformados na lista são ignorados; se nenhum for válido, o resultado fica vazio.

date_from

string<date>

Apenas sessões criadas nesta data ou após a mesma (UTC), formato YYYY-MM-DD. Datas malformadas devolvem 400.

date_to

string<date>

Apenas sessões criadas até esta data (UTC), formato YYYY-MM-DD. Para linhas de KYC, o dia inteiro é incluído; para linhas de KYB, a comparação é created_at <= date_to (meia-noite), pelo que deve utilizar a data do dia seguinte para incluir um dia completo de sessões de KYB.

Resposta

Lista de sessões paginada. Os itens de results são linhas de KYC, linhas de KYB, ou ambos, dependendo de session_kind; diferencie através do campo session_kind de cada linha.

count

integer

obrigatório

Número de sessões que correspondem aos filtros: exato até 100 e limitado a 100 além disso, pelo que não deve ser usado como total. Use next para saber se existem mais páginas. Para session_kind=all, é a soma de ambos os tipos, cada um limitado a 100.

Exemplo:

2

string<uri> | null

obrigatório

URL absoluto da página seguinte, ou null na última página.

Exemplo:

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

string<uri> | null

obrigatório

URL absoluto da página anterior, ou null na primeira página.

Exemplo:

null

results

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

obrigatório

Linhas de sessão, as mais recentes primeiro. Com session_kind=all, as linhas KYC surgem primeiro, seguidas pelas linhas KYB.

Linha de resumo para uma sessão de Verificação de utilizadores (KYC). Os campos de identidade (full_name, country, document_type, portrait_image, campos de contacto) são preenchidos progressivamente à medida que o utilizador conclui os passos de verificação, ficando com valor null até à conclusão do passo relevante. Os campos restringidos pela configuração de response-attributes do fluxo também são devolvidos como null.

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

Show child attributes

Última modificação em 7 de novembro de 2026

​Filtro por tipo de sessão

​Filtros comuns

​Exemplos

​A estrutura das linhas varia por tipo

​Paginação

​Relacionados

Autorizações

Parâmetros de consulta

Resposta

Filtro por tipo de sessão

Filtros comuns

Exemplos

A estrutura das linhas varia por tipo

Paginação

Relacionados