Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo 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));{
"grouping_mode": "day",
"data_points": [
{
"rounded_date": "2026-10-14",
"total": 12,
"approved": 8,
"declined": 1,
"canceled": 1,
"pending": 2,
"in_review": 1,
"expired": 1,
"abandoned": 0,
"in_progress": 1,
"not_started": 0,
"manually_approved": 1,
"manually_declined": 0
},
{
"rounded_date": "2026-10-15",
"total": 10,
"approved": 6,
"declined": 2,
"canceled": 0,
"pending": 2,
"in_review": 2,
"expired": 0,
"abandoned": 0,
"in_progress": 0,
"not_started": 0,
"manually_approved": 0,
"manually_declined": 1
}
],
"request_breakdown": {
"total_approved": 14,
"total_in_review": 3,
"total_declined": 3,
"total_canceled": 1,
"total_pending": 4,
"total_expired": 1,
"total_abandoned": 0,
"total_in_progress": 1,
"total_not_started": 0,
"total_manually_approved": 1,
"total_manually_declined": 1
},
"conversion_rate": 70,
"location_stats": {
"countries": [
{
"session_count": 15,
"country": "Spain",
"country_code": "ES"
},
{
"session_count": 7,
"country": "Portugal",
"country_code": "PT"
}
],
"ip_countries": [
{
"session_count": 15,
"country": "Spain",
"country_code": "ES"
},
{
"session_count": 7,
"country": "Portugal",
"country_code": "PT"
}
],
"id_countries": [
{
"country": "Spain",
"country_code": "ES",
"session_count": 14
},
{
"country": "Portugal",
"country_code": "PT",
"session_count": 6
}
],
"conversion_by_country": [
{
"country": "Spain",
"country_code": "ES",
"finished": 13,
"approved": 10
},
{
"country": "Portugal",
"country_code": "PT",
"finished": 6,
"approved": 4
}
],
"cities": [
{
"session_count": 9,
"location": "Madrid, Spain",
"latitude": 40.4168,
"longitude": -3.7038
}
]
},
"demographic_stats": {
"age_distribution": {
"under_18": 0,
"18_24": 5,
"25_34": 8,
"35_44": 4,
"45_64": 2,
"65_plus": 1
},
"gender_distribution": {
"M": 11,
"F": 9
}
},
"device_details": {
"device_models": [
{
"device": "Apple",
"count": 12
},
{
"device": "Android",
"count": 10
}
],
"browsers": [
{
"browser": "Safari",
"count": 12
},
{
"browser": "Chrome",
"count": 10
}
],
"operating_systems": [
{
"os": "iOS",
"count": 12
},
{
"os": "Android",
"count": 10
}
]
},
"workflow_funnel_stats": {
"33333333-4444-5555-6666-777777777777": {
"total": 22,
"steps": {
"OCR": {
"reached": 21
},
"LIVENESS": {
"reached": 19
},
"FACE_MATCH": {
"reached": 19
},
"AML": {
"reached": 18
}
}
}
},
"verification_time_stats": {
"overall_avg_seconds": 64,
"overall_count": 18,
"per_feature": {
"OCR": {
"avg_seconds": 41.2,
"total_seconds": 741.6,
"count": 18
},
"LIVENESS": {
"avg_seconds": 22.8,
"total_seconds": 410.4,
"count": 18
}
},
"per_sub_step": {
"OCR": {
"front_id_photo": {
"avg_seconds": 18.3,
"total_seconds": 329.4,
"count": 18
}
}
}
},
"resubmission_stats": {
"first_pass": 17,
"second": 2,
"third_plus": 1,
"abandoned": 0
},
"warning_stats": {
"ID_VERIFICATION": {
"total": 21,
"risks": {
"DOCUMENT_EXPIRED": {
"error": 1,
"warning": 0,
"information": 0
}
}
},
"LIVENESS": {
"total": 19,
"risks": {
"LOW_LIVENESS_SCORE": {
"error": 0,
"warning": 2,
"information": 0
}
}
}
},
"original_status_stats": {
"approved": 13,
"in_review": 5,
"declined": 2
},
"demographic_time_series": [
{
"date": "2026-10-14",
"age_distribution": {
"under_18": 0,
"18_24": 3,
"25_34": 4,
"35_44": 2,
"45_64": 1,
"65_plus": 0
},
"gender_distribution": {
"M": 6,
"F": 4
}
},
{
"date": "2026-10-15",
"age_distribution": {
"under_18": 0,
"18_24": 2,
"25_34": 4,
"35_44": 2,
"45_64": 1,
"65_plus": 1
},
"gender_distribution": {
"M": 5,
"F": 5
}
}
],
"device_time_series": [
{
"date": "2026-10-14",
"devices": {
"Apple": 7,
"Android": 5
},
"browsers": {
"Safari": 7,
"Chrome": 5
},
"operating_systems": {
"iOS": 7,
"Android": 5
}
},
{
"date": "2026-10-15",
"devices": {
"Apple": 5,
"Android": 5
},
"browsers": {
"Safari": 5,
"Chrome": 5
},
"operating_systems": {
"iOS": 5,
"Android": 5
}
}
],
"verification_time_time_series": [
{
"date": "2026-10-14",
"overall_avg": 66.1,
"per_feature": {
"OCR": 42,
"LIVENESS": 24.1
}
},
{
"date": "2026-10-15",
"overall_avg": 61.5,
"per_feature": {
"OCR": 40.2,
"LIVENESS": 21.3
}
}
],
"resubmission_time_series": [
{
"date": "2026-10-14",
"first_pass": 9,
"second": 1,
"third_plus": 0,
"abandoned": 0
},
{
"date": "2026-10-15",
"first_pass": 8,
"second": 1,
"third_plus": 1,
"abandoned": 0
}
],
"original_status_time_series": [
{
"date": "2026-10-14",
"approved": 7,
"in_review": 3,
"declined": 1
},
{
"date": "2026-10-15",
"approved": 6,
"in_review": 2,
"declined": 1
}
],
"previous_data_points": [
{
"rounded_date": "2026-10-12",
"total": 9,
"approved": 6,
"declined": 1,
"canceled": 1,
"pending": 1
},
{
"rounded_date": "2026-10-13",
"total": 11,
"approved": 7,
"declined": 2,
"canceled": 0,
"pending": 2
}
],
"previous_request_breakdown": {
"total_approved": 13,
"total_in_review": 2,
"total_declined": 3,
"total_canceled": 1,
"total_pending": 3
}
}API de análise da aplicação
Consulte as análises da sua aplicação Didit por intervalo de datas: sessões KYC, conversão, funis ou widgets KYB e de 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));{
"grouping_mode": "day",
"data_points": [
{
"rounded_date": "2026-10-14",
"total": 12,
"approved": 8,
"declined": 1,
"canceled": 1,
"pending": 2,
"in_review": 1,
"expired": 1,
"abandoned": 0,
"in_progress": 1,
"not_started": 0,
"manually_approved": 1,
"manually_declined": 0
},
{
"rounded_date": "2026-10-15",
"total": 10,
"approved": 6,
"declined": 2,
"canceled": 0,
"pending": 2,
"in_review": 2,
"expired": 0,
"abandoned": 0,
"in_progress": 0,
"not_started": 0,
"manually_approved": 0,
"manually_declined": 1
}
],
"request_breakdown": {
"total_approved": 14,
"total_in_review": 3,
"total_declined": 3,
"total_canceled": 1,
"total_pending": 4,
"total_expired": 1,
"total_abandoned": 0,
"total_in_progress": 1,
"total_not_started": 0,
"total_manually_approved": 1,
"total_manually_declined": 1
},
"conversion_rate": 70,
"location_stats": {
"countries": [
{
"session_count": 15,
"country": "Spain",
"country_code": "ES"
},
{
"session_count": 7,
"country": "Portugal",
"country_code": "PT"
}
],
"ip_countries": [
{
"session_count": 15,
"country": "Spain",
"country_code": "ES"
},
{
"session_count": 7,
"country": "Portugal",
"country_code": "PT"
}
],
"id_countries": [
{
"country": "Spain",
"country_code": "ES",
"session_count": 14
},
{
"country": "Portugal",
"country_code": "PT",
"session_count": 6
}
],
"conversion_by_country": [
{
"country": "Spain",
"country_code": "ES",
"finished": 13,
"approved": 10
},
{
"country": "Portugal",
"country_code": "PT",
"finished": 6,
"approved": 4
}
],
"cities": [
{
"session_count": 9,
"location": "Madrid, Spain",
"latitude": 40.4168,
"longitude": -3.7038
}
]
},
"demographic_stats": {
"age_distribution": {
"under_18": 0,
"18_24": 5,
"25_34": 8,
"35_44": 4,
"45_64": 2,
"65_plus": 1
},
"gender_distribution": {
"M": 11,
"F": 9
}
},
"device_details": {
"device_models": [
{
"device": "Apple",
"count": 12
},
{
"device": "Android",
"count": 10
}
],
"browsers": [
{
"browser": "Safari",
"count": 12
},
{
"browser": "Chrome",
"count": 10
}
],
"operating_systems": [
{
"os": "iOS",
"count": 12
},
{
"os": "Android",
"count": 10
}
]
},
"workflow_funnel_stats": {
"33333333-4444-5555-6666-777777777777": {
"total": 22,
"steps": {
"OCR": {
"reached": 21
},
"LIVENESS": {
"reached": 19
},
"FACE_MATCH": {
"reached": 19
},
"AML": {
"reached": 18
}
}
}
},
"verification_time_stats": {
"overall_avg_seconds": 64,
"overall_count": 18,
"per_feature": {
"OCR": {
"avg_seconds": 41.2,
"total_seconds": 741.6,
"count": 18
},
"LIVENESS": {
"avg_seconds": 22.8,
"total_seconds": 410.4,
"count": 18
}
},
"per_sub_step": {
"OCR": {
"front_id_photo": {
"avg_seconds": 18.3,
"total_seconds": 329.4,
"count": 18
}
}
}
},
"resubmission_stats": {
"first_pass": 17,
"second": 2,
"third_plus": 1,
"abandoned": 0
},
"warning_stats": {
"ID_VERIFICATION": {
"total": 21,
"risks": {
"DOCUMENT_EXPIRED": {
"error": 1,
"warning": 0,
"information": 0
}
}
},
"LIVENESS": {
"total": 19,
"risks": {
"LOW_LIVENESS_SCORE": {
"error": 0,
"warning": 2,
"information": 0
}
}
}
},
"original_status_stats": {
"approved": 13,
"in_review": 5,
"declined": 2
},
"demographic_time_series": [
{
"date": "2026-10-14",
"age_distribution": {
"under_18": 0,
"18_24": 3,
"25_34": 4,
"35_44": 2,
"45_64": 1,
"65_plus": 0
},
"gender_distribution": {
"M": 6,
"F": 4
}
},
{
"date": "2026-10-15",
"age_distribution": {
"under_18": 0,
"18_24": 2,
"25_34": 4,
"35_44": 2,
"45_64": 1,
"65_plus": 1
},
"gender_distribution": {
"M": 5,
"F": 5
}
}
],
"device_time_series": [
{
"date": "2026-10-14",
"devices": {
"Apple": 7,
"Android": 5
},
"browsers": {
"Safari": 7,
"Chrome": 5
},
"operating_systems": {
"iOS": 7,
"Android": 5
}
},
{
"date": "2026-10-15",
"devices": {
"Apple": 5,
"Android": 5
},
"browsers": {
"Safari": 5,
"Chrome": 5
},
"operating_systems": {
"iOS": 5,
"Android": 5
}
}
],
"verification_time_time_series": [
{
"date": "2026-10-14",
"overall_avg": 66.1,
"per_feature": {
"OCR": 42,
"LIVENESS": 24.1
}
},
{
"date": "2026-10-15",
"overall_avg": 61.5,
"per_feature": {
"OCR": 40.2,
"LIVENESS": 21.3
}
}
],
"resubmission_time_series": [
{
"date": "2026-10-14",
"first_pass": 9,
"second": 1,
"third_plus": 0,
"abandoned": 0
},
{
"date": "2026-10-15",
"first_pass": 8,
"second": 1,
"third_plus": 1,
"abandoned": 0
}
],
"original_status_time_series": [
{
"date": "2026-10-14",
"approved": 7,
"in_review": 3,
"declined": 1
},
{
"date": "2026-10-15",
"approved": 6,
"in_review": 2,
"declined": 1
}
],
"previous_data_points": [
{
"rounded_date": "2026-10-12",
"total": 9,
"approved": 6,
"declined": 1,
"canceled": 1,
"pending": 1
},
{
"rounded_date": "2026-10-13",
"total": 11,
"approved": 7,
"declined": 2,
"canceled": 0,
"pending": 2
}
],
"previous_request_breakdown": {
"total_approved": 13,
"total_in_review": 2,
"total_declined": 3,
"total_canceled": 1,
"total_pending": 3
}
}| O que envia | O que recebe |
|---|---|
Nem scope nem widget_keys | O resumo de verificação de utilizadores (KYC) do intervalo |
scope, widget_keys ou ambos | Widgets do painel para um separador: kyc, kyb, transactions ou home (qualquer combinação dos três) |
kind e um title; os restantes campos dependem do kind. Envie uma vez scope sem widget_keys para ler available_widget_keys e, depois, peça apenas os widgets de que precisa.
403, independentemente do acesso que tenha, e o mesmo acontece com a chave de outra aplicação. Consulte Chaves de API.Relacionados
Autorizações
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 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-o juntamente com end_date: quando algum estiver em falta, ambos são ignorados e o intervalo abrange desde 30 dias antes de hoje até hoje.
"2026-10-01"
Último dia do intervalo, YYYY-MM-DD, inclusive (UTC). Uma data futura conta como hoje. O intervalo não pode exceder 730 dias.
"2026-10-15"
Separador do painel para o qual devolver widgets (insensível a maiúsculas e minúsculas). Omita-o, juntamente com widget_keys, para o resumo de KYC. Enviar apenas widget_keys pressupõe kyc. home aceita qualquer widget de KYC, KYB ou transação e usa por predefinição o esquema inicial guardado da aplicação.
home, kyc, kyb, transactions Chaves de widgets separadas por vírgulas, respondidas por esta ordem. As chaves não aceites pelo âmbito são ignoradas; se nenhuma restar, obtém as predefinições do âmbito. 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 fluxos separados por vírgulas. Limita o resumo de KYC e os widgets de KYC e KYB a esses fluxos. Os valores que não sejam UUIDs são ignorados; quando nenhum for 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írgulas. Aplica-se apenas em conjunto com workflow_ids; os valores que não sejam números inteiros são ignorados. version é aceite como alias.
"3,4"
IDs de caminhos de ramificação separados por vírgulas. Aplica-se apenas em conjunto com workflow_ids e apenas a números de KYC. Os números são registados atualmente apenas para default (todos os caminhos combinados), pelo que qualquer outro valor devolve valores vazios. branch_path_id é aceite como alias.
"default"
Apenas widgets de transações: UUIDs de etiquetas ou nomes de etiquetas separados por vírgulas.
Apenas widgets de transações: categorias de transação separadas por vírgulas.
"finance"
Apenas widgets de transações: tipos de ação separados por vírgulas (insensível a maiúsculas/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 utilizadores (KYC), devolvido quando não é enviado nem scope nem widget_keys.
Um ponto por dia, desde o primeiro dia com sessões no intervalo até end_date. Sempre diário, independentemente do que indicar grouping_mode.
Show child attributes
Show child attributes
Totais de estado para o intervalo. A discriminação do período anterior contém, no mínimo, os campos obrigatórios.
Show child attributes
Show child attributes
Pontos diários para o período da mesma duração imediatamente anterior a start_date.
Show child attributes
Show child attributes
Totais de estado para o intervalo. A discriminação do período anterior contém, no mínimo, os campos obrigatórios.
Show child attributes
Show child attributes
total_approved / (total_approved + total_declined + total_in_review) x 100, uma casa decimal. null quando nada tiver terminado.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Os cinco principais de cada, primeiro as sessões mais frequentes.
Show child attributes
Show child attributes
Indexado por ID do fluxo. total representa as sessões iniciadas nesse fluxo; steps contabiliza as sessões que alcançaram cada passo (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Alcançar um passo não significa concluí-lo.
Show child attributes
Show child attributes
Tempo ativo que os utilizadores passaram a verificar-se, ignorando intervalos de inatividade. Um objeto vazio quando não existem dados.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Indexado por funcionalidade (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE e as funcionalidades de KYB). total representa as sessões que alcançaram a funcionalidade; risks contabiliza as sessões por código e nível de aviso.
Show child attributes
Show child attributes
O veredicto automático do fluxo, antes de qualquer revisor o alterar.
Show child attributes
Show child attributes
Como as listas *_time_series são agrupadas: day para até 14 dias, week até 90, month para períodos superiores. 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