Primeiros passos
Integração / SDKs
Verificação de usuários
Verificação de empresas
Monitoramento de transações
Registro de alteraçõescurl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/?start_date=2026-10-01&end_date=2026-10-15' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
client = Didit()
result = client.analytics.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();
const result = await didit.analytics.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
result, err := client.Analytics.Retrieve(ctx, didit.AnalyticsRetrieveParams{})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();
var result = client.analytics().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
$result = $didit->analytics->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
didit = Didit::Client.new
result = didit.analytics.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();
var result = await client.Analytics.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));API de analytics da aplicação
Consulte na Didit as métricas de verificação da sua aplicação por período: totais de sessões KYC, conversão, funis ou widgets de KYB e transações.
curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/?start_date=2026-10-01&end_date=2026-10-15' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
client = Didit()
result = client.analytics.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();
const result = await didit.analytics.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
result, err := client.Analytics.Retrieve(ctx, didit.AnalyticsRetrieveParams{})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();
var result = client.analytics().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
$result = $didit->analytics->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
didit = Didit::Client.new
result = didit.analytics.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();
var result = await client.Analytics.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));| O que você envia | O que você recebe |
|---|---|
Nem scope nem widget_keys | O resumo da verificação de usuários (KYC) no intervalo |
scope, widget_keys ou ambos | Widgets do painel de uma aba: kyc, kyb, transactions ou home (qualquer combinação dos três) |
kind e um title; os demais campos dependem do tipo. Envie scope sem widget_keys uma vez para ler available_widget_keys e, depois, solicite apenas os widgets de que você precisa.
403, independentemente do acesso que tenha, assim como uma chave de outra aplicação. Consulte Chaves de API.Conteúdo relacionado
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 caminho
UUID da organização.
UUID da aplicação. Deve ser a aplicação à qual a chave de API pertence: uma chave usada em qualquer outra aplicação recebe 403.
Parâmetros de consulta
Primeiro dia do intervalo, YYYY-MM-DD, inclusive (UTC). Envie junto com end_date: quando um dos dois está ausente, ambos são ignorados e o intervalo vai de 30 dias antes de hoje até hoje.
"2026-10-01"
Último dia do intervalo, YYYY-MM-DD, inclusivo (UTC). Uma data futura conta como hoje. O intervalo não pode exceder 730 dias.
"2026-10-15"
Aba do painel para a qual retornar widgets (sem diferenciar maiúsculas de minúsculas). Omita-a, junto com widget_keys, para obter o resumo de KYC. Enviar apenas widget_keys implica kyc. home aceita qualquer widget de KYC, KYB ou de transações e usa por padrão o layout inicial salvo da aplicação.
home, kyc, kyb, transactions Chaves de widget separadas por vírgula, respondidas nesta ordem. As chaves que o escopo não aceita são descartadas; quando não sobra nenhuma, você recebe os padrões do escopo. KYC: kyc_sessions_volume, kyc_warning_insights, kyc_id_locations, kyc_ip_locations, kyc_workflow_funnel, kyc_average_verification_time, kyc_conversion_rate, kyc_conversion_by_country, kyc_resubmission_insights, kyc_original_status_distribution, kyc_database_validation_coverage, kyc_database_validation_latency, kyc_demographics, kyc_device_details. KYB: kyb_sessions_volume, kyb_workflow_funnel, kyb_average_verification_time, kyb_ip_locations, kyb_business_country_distribution, kyb_warning_insights, kyb_conversion_rate, kyb_conversion_by_country, kyb_industry_breakdown, kyb_resubmission_insights, kyb_original_status_distribution, kyb_registry_coverage, kyb_registry_data_completeness, kyb_device_details. Transações: tx_count_total, tx_count_daily, tx_volume_total_preferred_currency, tx_volume_daily_preferred_currency, tx_average_amount, tx_average_amount_daily, tx_transaction_category_breakdown, tx_action_type_breakdown, tx_status_volume_trend, tx_user_ip_or_country_distribution, tx_tag_breakdown, tx_top_rules_triggered, tx_team_member_performance, tx_score_histogram.
"tx_count_total,tx_count_daily"
IDs de fluxo separados por vírgula. Limita o resumo de KYC e os widgets de KYC e KYB a esses fluxos. Valores que não são UUIDs são ignorados; quando nenhum é válido, o filtro é descartado. O resumo também aceita workflow_id.
"33333333-4444-5555-6666-777777777777"
Números de versão do fluxo separados por vírgula. Aplica-se somente em conjunto com workflow_ids; valores que não são números inteiros são ignorados. version é aceito como alias.
"3,4"
IDs de caminhos de ramificação separados por vírgula. Só se aplica junto com workflow_ids e apenas aos números de KYC. Atualmente, os números são registrados apenas para default (todos os caminhos combinados), então qualquer outro valor retorna números vazios. branch_path_id é aceito como alias.
"default"
Somente widgets de transações: UUIDs ou nomes de tags separados por vírgula.
Somente widgets de transações: categorias de transação separadas por vírgula.
"finance"
Somente widgets de transações: tipos de ação separados por vírgula (sem distinção entre maiúsculas e minúsculas).
"withdrawal"
Resposta
O resumo de KYC, ou os widgets solicitados quando scope ou widget_keys é enviado.
- Option 1
- Option 2
Resumo da verificação de usuários (KYC), retornado quando nem scope nem widget_keys são enviados.
Um ponto por dia, do primeiro dia com sessões no intervalo até end_date. Sempre diário, independentemente do que grouping_mode indicar.
Show child attributes
Show child attributes
Totais por status no intervalo. O detalhamento do período anterior contém pelo menos os campos obrigatórios.
Show child attributes
Show child attributes
Pontos diários do período de mesma duração imediatamente anterior a start_date.
Show child attributes
Show child attributes
Totais por status no intervalo. O detalhamento do período anterior contém pelo menos os campos obrigatórios.
Show child attributes
Show child attributes
total_approved / (total_approved + total_declined + total_in_review) x 100, com uma casa decimal. null quando nada foi concluído.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Os cinco primeiros de cada, do maior para o menor número de sessões.
Show child attributes
Show child attributes
Indexado por ID do fluxo. total são as sessões iniciadas nesse fluxo; steps conta as sessões que chegaram a cada etapa (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Chegar a uma etapa não significa ser aprovado nela.
Show child attributes
Show child attributes
Tempo ativo que os usuários passaram na verificação, desconsiderando os intervalos de inatividade. Um objeto vazio quando não há dados.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Indexado por recurso (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE e os recursos de KYB). total são as sessões que chegaram ao recurso; risks conta as sessões por código e nível de aviso.
Show child attributes
Show child attributes
O veredito automático do fluxo, antes de qualquer alteração por um revisor.
Show child attributes
Show child attributes
Como as listas *_time_series são agrupadas: day para até 14 dias, week até 90, month acima disso. Medido a partir do primeiro dia com sessões no intervalo.
day, week, month Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes