Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo de alteraçõescurl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"value": "+14155552671", "comment": "Reported fraud"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.lists.entries.create(
"11111111-2222-3333-4444-555555555555",
value="+14155552671",
comment="Reported fraud",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.lists.entries.create("11111111-2222-3333-4444-555555555555", {
value: "+14155552671",
comment: "Reported fraud",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Lists.Entries.Create(ctx, "11111111-2222-3333-4444-555555555555", didit.ListsEntriesCreateParams{
Value: didit.String("+14155552671"),
Comment: didit.String("Reported fraud"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.ListsEntriesCreateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.lists().entries().create("11111111-2222-3333-4444-555555555555", ListsEntriesCreateParams.builder()
.value("+14155552671")
.comment("Reported fraud")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->lists->entries->create('11111111-2222-3333-4444-555555555555', [
'value' => '+14155552671',
'comment' => 'Reported fraud',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.lists.entries.create(
"11111111-2222-3333-4444-555555555555",
value: "+14155552671",
comment: "Reported fraud"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Lists.Entries.CreateAsync("11111111-2222-3333-4444-555555555555", new ListsEntriesCreateParams
{
Value = "+14155552671",
Comment = "Reported fraud",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"value": "+14155552671",
"display_label": "",
"comment": "Reported fraud",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_session_type": null,
"reference_object_uuid": null,
"metadata": null,
"created_at": "2026-10-12T10:04:51.220391Z"
}Criar Entrada em Lista de Bloqueio e Permissões: API
Adicione à Didit uma entrada (rosto, documento, IP, carteira, e-mail, telefone) numa lista de bloqueio ou de permissões.
curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"value": "+14155552671", "comment": "Reported fraud"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.lists.entries.create(
"11111111-2222-3333-4444-555555555555",
value="+14155552671",
comment="Reported fraud",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.lists.entries.create("11111111-2222-3333-4444-555555555555", {
value: "+14155552671",
comment: "Reported fraud",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Lists.Entries.Create(ctx, "11111111-2222-3333-4444-555555555555", didit.ListsEntriesCreateParams{
Value: didit.String("+14155552671"),
Comment: didit.String("Reported fraud"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.ListsEntriesCreateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.lists().entries().create("11111111-2222-3333-4444-555555555555", ListsEntriesCreateParams.builder()
.value("+14155552671")
.comment("Reported fraud")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->lists->entries->create('11111111-2222-3333-4444-555555555555', [
'value' => '+14155552671',
'comment' => 'Reported fraud',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.lists.entries.create(
"11111111-2222-3333-4444-555555555555",
value: "+14155552671",
comment: "Reported fraud"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Lists.Entries.CreateAsync("11111111-2222-3333-4444-555555555555", new ListsEntriesCreateParams
{
Value = "+14155552671",
Comment = "Reported fraud",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"value": "+14155552671",
"display_label": "",
"comment": "Reported fraud",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_session_type": null,
"reference_object_uuid": null,
"metadata": null,
"created_at": "2026-10-12T10:04:51.220391Z"
}- email: um endereço de e-mail válido
- phone: um número de telefone internacional válido, armazenado em E.164 (por exemplo
+14155552671) - ip_address: um endereço IP válido ou um intervalo CIDR (por exemplo
192.168.1.1ou10.0.0.0/8) - device_fingerprint: pelo menos 8 caracteres entre letras, algarismos,
-,_,:e.. Uma lista de bloqueio recusa uma impressão digital que tenha sido reportada por vários dispositivos distintos, porque bloqueá-la recusaria pessoas sem relação entre si. - country: um código de país ISO 3166-1 alfa-3 válido (por exemplo
USA,GBR,ESP). Os códigos alfa-2 (por exemploUS) são aceites e convertidos automaticamente para alfa-3. - user, business: o
vendor_datado utilizador ou da empresa - face, document, wallet_address, bank_account, key: qualquer cadeia de caracteres não vazia
User@Example.COM também deteta user@example.com. Uma lista guarda cada valor apenas uma vez: adicionar um valor que já está na lista devolve 400.reference_session_id para usar o rosto de uma sessão existente. Uma entrada de rosto precisa de um rosto armazenado contra o qual comparar, o que um value introduzido não fornece.
Adicionar a partir de uma sessão
Quando fornece umreference_session_id, a Didit:
- Procura a sessão (esta tem de pertencer à mesma aplicação)
- Lê o valor do registo mais recente da sessão do tipo de entrada da lista:
- face: o rosto da selfie de prova de vida;
valueé o UUID do rosto - document: o número do documento; o nome completo, o estado emissor, o tipo de documento, a região e o número do documento ficam armazenados em
metadata, edisplay_labelassume por predefinição o nome do titular e o número do documento - phone: o número de telefone
- email: o endereço de e-mail
- ip_address: o endereço IP da sessão
- device_fingerprint: uma impressão digital que identifica um dispositivo, dando preferência a um dispositivo que tenha concluído um passo de verificação. Numa lista de bloqueio, a Didit recusa uma sessão que tenha apenas uma impressão digital de classe de dispositivo, ou uma concluída em mais do que um dispositivo: nesse caso, envie a impressão digital exata como
value.
- face: o rosto da selfie de prova de vida;
- Associa a entrada à sessão (
reference_session_id) e ao registo (reference_object_uuid) para rastreabilidade
value.
Devolve 400 se a sessão não for encontrada ou não contiver dados do tipo de entrada pedido.
Rostos da selfie da captura do documento
Enquanto o utilizador fotografa o seu documento, a câmara frontal pode tirar-lhe uma selfie (as imagensfront_image_camera_front e back_image_camera_front do relatório de verificação de identidade). Esse rosto pode ser adicionado também à lista de bloqueio de rostos, para além do rosto da prova de vida: envie face_image_source com a imagem que pretende.
{
"reference_session_id": "33333333-4444-5555-6666-777777777777",
"face_image_source": "front_image_camera_front"
}
- A entrada é criada apenas na lista de bloqueio de rostos do sistema, e
valuetem de ficar vazio: a Didit obtém o rosto a partir da selfie da sessão. - A selfie tem de conter um único rosto nítido. Caso contrário, o pedido devolve
400e nada é adicionado. - Cada selfie só pode ser adicionada uma vez. Os campos
metadata.face_image_sourceemetadata.reference_node_idindicam de que selfie provém a entrada. - Num fluxo com mais do que um passo de verificação de identidade,
reference_node_idescolhe o passo cuja selfie é usada. Por predefinição, a Didit usa a verificação de identidade mais recente que tenha essa selfie. - A partir daí, o rosto é verificado como qualquer outro rosto da lista de bloqueio: contra a selfie de prova de vida de cada nova sessão e contra cada nova selfie da captura do documento (ver
FRONT_CAMERA_FACE_IN_BLOCKLIST). - Eliminar a entrada remove o rosto da lista de bloqueio, e este deixa de corresponder a novas sessões.
Sessões com vários registos do mesmo tipo
Uma sessão pode ter mais do que um registo de um tipo, por exemplo dois números de telefone num fluxo de vários passos. A Didit lê sempre o mais recente. Se enviarvalue juntamente com reference_session_id, a entrada armazena o seu value, mas continua associada a esse registo mais recente e, numa lista de bloqueio do sistema, é esse o registo assinalado.
Para adicionar um valor de um registo anterior, adicione-o apenas por value, sem reference_session_id:
{
"value": "+34612345678",
"comment": "First phone number of session 42"
}
Referenciar transações, utilizadores e empresas
Ao colocar na lista de bloqueio dados de uma transação ou de um utilizador ou empresa do fornecedor, passe o UUID da entidade comoreference_object_uuid e indique o tipo de origem em metadata:
{
"value": "0x52908400098527886E0F7030069857D2E4169EE7",
"reference_object_uuid": "55555555-6666-7777-8888-999999999999",
"metadata": {
"reference_type": "transaction",
"reference_id": "55555555-6666-7777-8888-999999999999"
}
}
metadata que envia, exceto reference_image_url e front_image_url, que só a Didit define. Para uma entrada lida de uma sessão, a Didit acrescenta as suas próprias chaves às suas, e as chaves da Didit prevalecem.
| Entidade de origem | reference_object_uuid | metadata.reference_type |
|---|---|---|
| Sessão de verificação | Definido pela Didit (o registo de rosto, documento, telefone ou e-mail) | Não é necessário: use reference_session_id |
| Transação | UUID da transação | "transaction" |
| Utilizador do fornecedor | didit_internal_id | "vendor_user" |
| Empresa do fornecedor | didit_internal_id | "vendor_business" |
BLOCKED os utilizadores ou empresas cujo vendor_data é igual a value, ou cujo didit_internal_id é igual a reference_object_uuid. Ver Lista de bloqueio de utilizadores e Lista de bloqueio de empresas.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 lista à qual adicionar. Para um rosto do qual só tenha a imagem, utilize Carregar um rosto para uma lista.
Corpo
Envie value, reference_session_id ou ambos. Os campos aplicáveis dependem do entry_type da lista.
O valor a listar, validado relativamente ao entry_type da lista: email um endereço de e-mail válido; phone um número internacional válido, guardado em E.164; ip_address um endereço IP ou intervalo CIDR (por exemplo 10.0.0.0/8); device_fingerprint pelo menos 8 carateres entre letras, dígitos, -, _, : e . (uma lista de bloqueio recusa uma fingerprint que vários dispositivos distintos tenham reportado); country um código ISO 3166-1 alfa-2 ou alfa-3, guardado como alfa-3; user e business o vendor_data; qualquer outro tipo uma cadeia não vazia. Guardado em minúsculas, exceto números de telefone e códigos de país, e uma lista contém cada valor apenas uma vez (não sensível a maiúsculas/minúsculas). Obrigatório exceto se reference_session_id for enviado; deve ser deixado em branco com um face_image_source de captura de documentos.
Uma sessão de verificação de pessoa ou empresa da sua aplicação da qual obter o valor. A Didit lê o registo mais recente da sessão do tipo de entrada da lista (face, document, phone, email, ip_address ou device_fingerprint), associa a entrada à sessão e a esse registo, e preenche display_label e metadata para documentos. Para uma lista de bloqueio de device_fingerprint, uma sessão que apenas tenha uma impressão digital de classe de dispositivo, ou que tenha sido concluída em mais de um dispositivo, é recusada: envie a impressão digital exata como value. Para outros tipos de entrada, ou quando a sessão não tiver tal registo, envie também value; o seu value é então armazenado e a entrada continua associada à sessão.
UUID do registo que a entrada representa quando não provém de uma sessão: um UUID de transação, ou o didit_internal_id de um utilizador ou empresa. Combine-o com metadata.reference_type. Substituído pelo registo da sessão quando reference_session_id fornece um.
Listas de rostos com reference_session_id: de qual das imagens da sessão o rosto é retirado. liveness (predefinição) é a selfie de prova de vida. front_image_camera_front e back_image_camera_front são as selfies que a câmara frontal tirou enquanto o utilizador fotografava a frente ou o verso do seu documento: aceites apenas na lista de bloqueio de rostos do sistema, com reference_session_id e um value vazio. Cada selfie pode ser adicionada uma vez e deve mostrar um rosto nítido.
liveness, front_image_camera_front, back_image_camera_front Com um face_image_source de captura de documento: o nó de verificação de identidade cuja selfie deve ser utilizada, para fluxos com mais de um. O valor padrão é a verificação de identidade mais recente que tenha essa imagem. Recusado com liveness.
100Rótulo legível. Quando vazio, a Didit deriva um a partir da sessão sempre que possível (por exemplo, o nome do titular e o número do documento).
512Nota em texto livre, como o motivo da inclusão na lista.
JSON de formato livre armazenado com a entrada e devolvido tal como foi guardado. Utilize reference_type e reference_id para que a consola estabeleça uma ligação para a origem. reference_image_url e front_image_url são definidos apenas pela Didit e são descartados se os enviar. Para uma entrada lida a partir de uma sessão, as chaves da Didit são combinadas com as suas.
Show child attributes
Show child attributes
Resposta
A entrada foi criada.
Um valor numa lista.
Identificador da entrada. Utilize-o como entry_uuid em Eliminar uma entrada da lista.
O valor listado: um número de telefone em E.164, um endereço de e-mail, um número de documento, um endereço IP ou intervalo CIDR, uma impressão digital do dispositivo, um endereço de carteira, uma conta bancária, um código de país ISO 3166-1 alfa-3, um vendor_data, qualquer cadeia de carateres numa lista de key, ou o UUID do rosto armazenado numa lista de rostos. Os valores que envia são armazenados em minúsculas, exceto números de telefone e códigos de país. A correspondência não diferencia maiúsculas de minúsculas.
Rótulo legível. A Didit preenche-o para entradas obtidas de uma sessão (por exemplo, o nome do titular e o número do documento) quando não envia nenhum.
512Nota em texto livre. String vazia quando não definida.
Quem adicionou a entrada: api (uma chave de API), o endereço de e-mail de um utilizador da consola ou console, system ou migration (entradas criadas pela Didit), ou rule (uma ação de regra de transação ou de monitorização).
Sessão de verificação da qual a entrada foi retirada. null quando a entrada foi adicionada por valor.
Número dessa sessão no âmbito da aplicação, como mostrado na consola.
kyc para uma sessão de verificação de pessoa, kyb para uma sessão de verificação de empresa, null quando não existe sessão.
kyc, kyb, null O registo que a entrada representa: o registo de rosto, documento, telefone ou e-mail lido a partir de uma sessão, o rosto criado por Carregar um rosto para uma lista, ou o UUID que enviou (por exemplo, o UUID de uma transação ou o didit_internal_id de um utilizador).
Contexto adicional. Contém as chaves definidas pela Didit (aqui listadas) combinadas com quaisquer metadata que tenha enviado ao criar a entrada, devolvidas conforme armazenadas. null quando não existir nenhum.
Show child attributes
Show child attributes
Quando a entrada foi adicionada.