Primeiros passos
Integração / SDKs
Verificação de usuários
Verificação de empresas
Monitoramento de transações
Registro de alteraçõescurl -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));
}API para listar sessões: filtre sessões de KYC e KYB
Didit: GET /v3/sessions/ lista sessões de verificação com filtros por tipo, status, workflow e vendor data. API unificada KYC + KYB, pague por uso.
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));
}Filtro por tipo de sessão
Use o parâmetro de consultasession_kind para escolher o tipo de sessão a retornar:
| Valor | Retorna |
|---|---|
user (padrão) | Apenas sessões de Verificação de usuários (KYC). Comportamento retrocompatível: omita session_kind para obtê-lo. |
business | Apenas sessões de Verificação de empresas (KYB). |
all | Sessões de Verificação de usuários e de Verificação de empresas, concatenadas. |
session_kind: "user" | "business", para que seu cliente possa tratar o formato de cada linha conforme o tipo.
Filtros comuns
Estes filtros se aplicam aos dois tipos (os filtros exclusivos de usuários são ignorados quandosession_kind=business, e vice-versa):
| Parâmetro de consulta | Descrição |
|---|---|
session_kind | user, business ou all. Padrão: user. |
vendor_data | Correspondência exata com o seu identificador. |
status | Um ou mais status, separados por vírgula, escritos exatamente como a API os retorna: Approved, Declined, In Review e assim por diante (consulte Status de verificação). |
workflow_id | Filtra pelo fluxo de verificação (workflow) utilizado. |
country | Filtro por código de país (usuário: issuing_states, empresa: country_code). |
date_from, date_to | Intervalo da data de criação (ISO 8601). |
tags | IDs de tags separados por vírgula. Retorna as sessões que tenham qualquer uma delas. |
decided_from, decided_to | Datas e horas em ISO 8601. Retorna as sessões cujo status mudou pela última vez nesse intervalo (início inclusivo, fim exclusivo). Usam o horário da última mudança de status, não o horário de criação. |
search | Uma referência completa exibida, como S-0001 ou B-0001, corresponde apenas a esse número e tipo de sessão, ignorando zeros à esquerda e maiúsculas/minúsculas. Qualquer outra entrada pesquisa os campos existentes de nome, contato, documento, número de registro e vendor_data. |
Exemplos
- Listar sessões de Verificação de usuários (KYC) (padrão)
- Listar sessões de Verificação de empresas (KYB)
- Listar os dois tipos
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. Os consumidores devem tratar cada linha conforme session_kind.all concatena os resultados em vez de intercalá-los por data e hora. Para percorrer grandes volumes de resultados mistos, chame cada tipo separadamente e faça a mesclagem no cliente.O formato das linhas varia conforme o tipo
As linhas de Verificação de usuários (KYC) incluem:portrait_image, document_type, full_name, country (país emissor), phone_number, email_address e alguns campos de revisão: assignee (o revisor do Console responsável pela sessão, ou null), waiting_since e sla_due_at (definidos apenas enquanto a sessão está 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).
Ambas contêm: session_id, session_kind, session_number, status, vendor_data, created_at.
Consulte a visão geral de sessões para ver a matriz completa de recursos.
Paginação
A paginação usalimit (padrão 50) e offset (padrão 0), com URLs absolutas next e previous na resposta. Os dois parâmetros aceitam valores até 1000000; um valor maior retorna 400.
count é exato até 100 e permanece em 100 acima disso, portanto não o use como total. Continue fazendo requisições à URL next até que ela seja null. Com session_kind=all, count é a soma dos dois tipos, cada um limitado a 100.
Relacionados
- Visão geral de sessões
- Obter sessão: decisão completa para uma linha específica
- Visão geral de empresas: a entidade Business agregada entre sessões
- Visão geral de usuários: a entidade User agregada entre sessões
Autorizações
Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.
Parâmetros de consulta
Qual tipo de sessão listar: user (somente KYC, padrão), business (somente KYB) ou all (ambos, concatenados - consulte a descrição para a semântica da paginação combinada). A correspondência não diferencia maiúsculas de minúsculas (BUSINESS funciona); qualquer valor que não seja uma variação de maiúsculas e minúsculas de user/business/all retorna 400.
user, business, all Número máximo de linhas por página (por tipo quando session_kind=all). O padrão é 50.
1 <= x <= 1000000Número de linhas a pular antes da primeira linha retornada. O padrão é 0. Prefira seguir as URLs next/previous da resposta.
0 <= x <= 1000000Lista separada por vírgula de status de sessão a incluir, por exemplo, Approved,In Review. Os valores diferenciam maiúsculas de minúsculas; consulte Status de verificação. Valores desconhecidos não correspondem a nada.
Filtro de correspondência exata no vendor_data que você enviou na criação da sessão (seu próprio identificador de usuário/empresa). Para correspondências parciais, use search.
Uma referência exibida completa, como S-0001 (usuário) ou B-0001 (empresa), corresponde apenas àquele número e tipo de sessão; zeros à esquerda e maiúsculas ou minúsculas não afetam a correspondência. Busca inteligente de texto livre. Um UUID completo corresponde a session_id; uma entrada numérica corresponde ao prefixo do número da sessão, a números de documento ou pessoais, ao prefixo do telefone ou a vendor_data; uma entrada contendo @ corresponde a prefixos de e-mail; outros textos correspondem a nomes (sem diferenciar acentos) e a vendor_data. Um texto livre que contém dígitos também corresponde aos campos de busca de número de documento ou pessoal e a prefixos de número de sessão.
UUIDs de fluxo separados por vírgula (encontre-os na página Workflows do Console). UUIDs malformados na lista são ignorados; se nenhum for válido, o resultado fica vazio.
Somente sessões criadas nesta data ou depois dela (UTC), no formato YYYY-MM-DD. Datas malformadas retornam 400.
Somente sessões criadas até esta data (UTC), no 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), então use a data do dia seguinte para incluir um dia completo de sessões de KYB.
IDs de tags separados por vírgula (tags da sua aplicação). Retorna as sessões que têm qualquer um deles. IDs que não são UUIDs válidos são ignorados e, quando nenhum é válido, a lista fica vazia.
Data e hora ISO 8601. Retorna as sessões cujo status mudou pela última vez nesse momento ou depois dele. O filtro considera o momento da última mudança de status, não o momento de criação.
Data e hora ISO 8601. Retorna as sessões cujo status mudou pela última vez antes desse momento. Combine com decided_from para obter um intervalo semiaberto.
Filtro de país separado por vírgula. Para linhas de KYC: códigos ISO 3166-1 alpha-3 do Estado emissor do documento de identidade (por exemplo, ESP,USA), que pode ser diferente da nacionalidade. Para linhas de KYB: o código de país da empresa no registro de empresas.
Códigos de tipo de documento de identidade verificados na sessão, separados por vírgula (apenas linhas de KYC): P (passaporte), ID (carteira de identidade), DL (carteira de motorista), RP (autorização de residência), SSC (cartão de seguridade social), HIC (cartão de plano de saúde), WP (autorização de trabalho), TC (cartão fiscal), VISA, PSC (cartão de serviço público), BC (certidão de nascimento), OTHER. Observe que o campo document_type da resposta contém o nome de exibição, não o código.
Nomes exatos de documentos; é possível passar vários nomes separados por vírgula, mas o valor só é dividido nas vírgulas quando contém mais de um separador - (um nome isolado com uma vírgula interna é comparado por inteiro). Os nomes são os reconhecidos pela verificação de documentos (frente ou verso), por exemplo Spain - Id Card (2021). Somente linhas de KYC.
Valores de região/estado do documento separados por vírgula (para documentos emitidos por região, como carteiras de motorista dos EUA). Somente linhas de KYC.
Filtre pelo identificador interno de usuário da Didit (o campo de resposta didit_internal_id) para listar todas as sessões de um usuário verificado. Deve ser um UUID válido; valores malformados retornam 400. Somente linhas de KYC.
Canais de criação de sessão separados por vírgula: API, HOSTED, MIGRATED. O valor especial ALL (ou a omissão do parâmetro) desativa o filtro. Somente linhas de KYC.
Filtra sessões de API avulsas por serviço. Valores inválidos retornam 400. Somente linhas de KYC.
ID_VERIFICATION, FACE_MATCH, AGE_ESTIMATION, FACE_SEARCH, POA, AML, KYB_REGISTRY, PASSIVE_LIVENESS, DATABASE_VALIDATION, PHONE_VERIFICATION, EMAIL_VERIFICATION Busca por nome sem distinção de acentos nos dados analisados por AML e por validação de banco de dados. Quando combinada com api_service=AML ou api_service=DATABASE_VALIDATION, a busca fica restrita aos dados analisados desse recurso. Somente linhas de KYC.
Códigos de risco de aviso separados por vírgula; retorna as sessões que geraram qualquer um deles (por exemplo, POSSIBLE_FRAUD). Os códigos de risco estão listados por recurso na documentação de avisos. Aplica-se às linhas de KYC e, com códigos de aviso de empresas, às linhas de KYB.
Quando true, apenas sessões cuja decisão caiu inicialmente em In Review (útil para auditar o volume de revisão manual). Somente linhas de KYC.
true retorna as sessões cuja verificação de documento está sinalizada para revisão manual; false retorna as sessões com a verificação de documento explicitamente não sinalizada. Omita para desativar. Apenas linhas de KYC.
Filtra pelo euuid do usuário final (UUID atribuído ao usuário em verificação, usado pelos deep links do Console). Deve ser um UUID válido; valores malformados retornam um erro de campo 400. Somente linhas de KYC.
Nomes de organização separados por vírgula. Voltado ao Console; com uma chave de API (já restrita a uma aplicação), corresponde apenas ao nome da sua própria organização.
Resposta
Lista paginada de sessões. Os itens de results são linhas KYC, linhas KYB ou ambas, dependendo de session_kind; diferencie-os pelo campo session_kind de cada linha.
Número de sessões que correspondem aos filtros: exato até 100 e limitado a 100 acima disso, portanto não o use como total. Use next para saber se existem mais páginas. Para session_kind=all, é a soma dos dois tipos, cada um limitado a 100.
2
URL absoluta da próxima página, ou null na última página.
"https://verification.didit.me/v3/sessions/?limit=20&offset=20"
URL absoluta da página anterior, ou null na primeira página.
null
Linhas de sessões, das mais recentes para as mais antigas. Com session_kind=all, as linhas KYC vêm primeiro e depois as linhas KYB.
Linha de resumo de uma sessão de Verificação de usuários (KYC). Os campos de identidade (full_name, country, document_type, portrait_image, campos de contato) são preenchidos progressivamente à medida que o usuário conclui as etapas de verificação e ficam null até que a etapa correspondente termine. Os campos restringidos pela configuração de atributos de resposta do fluxo também são retornados como null.
- KYC session row (session_kind: user)
- KYB session row (session_kind: business)
Show child attributes
Show child attributes