Primeiros passos
Integração / SDKs
Verificação de usuários
Verificação de empresas
Monitoramento de transações
Registro 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 via API: bloqueio e permissões
Adicione uma entrada (rosto, documento, IP, carteira, e-mail, telefone) a uma lista de bloqueio, de permissões ou personalizada da Didit via API.
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 no formato E.164 (por exemplo,
+14155552671) - ip_address: um endereço IP ou intervalo CIDR válido (por exemplo,
192.168.1.1ou10.0.0.0/8) - device_fingerprint: pelo menos 8 caracteres entre letras, dígitos,
-,_,:e.. Uma lista de bloqueio recusa um fingerprint que vários dispositivos distintos tenham informado, porque bloqueá-lo recusaria pessoas sem relação entre si. - country: um código de país ISO 3166-1 alpha-3 válido (por exemplo,
USA,GBR,ESP). Códigos alpha-2 (por exemplo,US) são aceitos e convertidos automaticamente para alpha-3. - user, business: o
vendor_datado usuário ou da empresa - face, document, wallet_address, bank_account, key: qualquer string não vazia
User@Example.COM também bloqueará user@example.com. Uma lista contém cada valor uma única vez: adicionar um valor que já está na lista retorna 400.reference_session_id para usar o rosto de uma sessão existente. Uma entrada de rosto precisa de um rosto armazenado para comparação, o que um value digitado não fornece.
Adicionar a partir de uma sessão
Quando você informa umreference_session_id, a Didit:
- Busca a sessão (ela deve pertencer à mesma aplicação)
- Lê o valor do registro mais recente da sessão com o 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 são armazenados em
metadata, edisplay_labelassume por padrã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: um fingerprint que identifica um único dispositivo, dando preferência a um dispositivo que concluiu uma etapa de verificação. Em uma lista de bloqueio, a Didit recusa uma sessão que tenha apenas um fingerprint de classe de dispositivo, ou que tenha sido concluída em mais de um dispositivo: nesse caso, envie o fingerprint exato como
value.
- face: o rosto da selfie de prova de vida;
- Vincula a entrada à sessão (
reference_session_id) e ao registro (reference_object_uuid) para fins de rastreabilidade
value.
Retorna 400 se a sessão não for encontrada ou não contiver dados do tipo de entrada solicitado.
Rostos da selfie da captura do documento
Enquanto o usuário fotografa o documento, a câmera frontal pode tirar uma selfie dele (as imagensfront_image_camera_front e back_image_camera_front do relatório de verificação de identidade). Esse rosto pode ser adicionado à lista de bloqueio de rostos, assim como o rosto da prova de vida: passe face_image_source com a imagem desejada.
{
"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
valuedeve ficar vazio: a Didit obtém o rosto da selfie da sessão. - A selfie deve conter um único rosto nítido. Caso contrário, a requisição retorna
400e nada é adicionado. - Cada selfie pode ser adicionada uma única vez. Os campos
metadata.face_image_sourceemetadata.reference_node_idda entrada indicam de qual selfie ela veio. - Em um fluxo de verificação (workflow) com mais de uma etapa de verificação de identidade,
reference_node_idescolhe a etapa cuja selfie será usada. Por padrã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 bloqueado: contra a selfie de prova de vida de cada nova sessão e contra cada nova selfie da captura do documento (veja
FRONT_CAMERA_FACE_IN_BLOCKLIST). - Excluir a entrada remove o rosto da lista de bloqueio, e ele deixa de corresponder a novas sessões.
Sessões com vários registros do mesmo tipo
Uma sessão pode conter mais de um registro de um tipo, por exemplo, dois números de telefone de um fluxo com várias etapas. A Didit sempre lê o mais recente. Se você enviarvalue junto com reference_session_id, a entrada armazena o seu value, mas continua vinculada a esse registro mais recente, e, em uma lista de bloqueio do sistema, é esse registro que é marcado.
Para incluir na lista um valor de um registro anterior, adicione-o apenas por value, sem reference_session_id:
{
"value": "+34612345678",
"comment": "First phone number of session 42"
}
Referenciar transações, usuários e empresas
Ao bloquear dados de uma transação ou de um usuário/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, exceto reference_image_url e front_image_url, que somente a Didit define. Para uma entrada obtida de uma sessão, a Didit adiciona as próprias chaves às suas, e as chaves dela prevalecem.
| Entidade de origem | reference_object_uuid | metadata.reference_type |
|---|---|---|
| Sessão de verificação | Definido pela Didit (o registro de rosto, documento, telefone ou e-mail) | Não é necessário: use reference_session_id |
| Transação | UUID da transação | "transaction" |
| Usuário do fornecedor | didit_internal_id | "vendor_user" |
| Empresa do fornecedor | didit_internal_id | "vendor_business" |
BLOCKED: aqueles cujo vendor_data é igual a value ou cujo didit_internal_id é igual a reference_object_uuid. Veja Lista de bloqueio de usuários e Lista de bloqueio de empresas.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 lista à qual adicionar. Para um rosto que você tem apenas como imagem, use Enviar 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 ser incluído na lista, validado conforme o entry_type da lista: email, um endereço de e-mail válido; phone, um número internacional válido, armazenado em E.164; ip_address, um endereço IP ou intervalo CIDR (por exemplo, 10.0.0.0/8); device_fingerprint, pelo menos 8 caracteres entre letras, dígitos, -, _, : e . (uma lista de bloqueio recusa uma impressão digital que vários dispositivos distintos informaram); country, um código ISO 3166-1 alfa-2 ou alfa-3, armazenado como alfa-3; user e business, o vendor_data; qualquer outro tipo, uma string não vazia. Armazenado em letras minúsculas, exceto números de telefone e códigos de país, e uma lista contém cada valor uma única vez (sem diferenciar maiúsculas de minúsculas). Obrigatório, a menos que reference_session_id seja enviado; deve ficar vazio com um face_image_source de captura de documento.
Uma sessão de verificação de pessoa ou de empresa da sua aplicação da qual o valor será obtido. A Didit lê o registro mais recente da sessão do tipo de entrada da lista (face, document, phone, email, ip_address ou device_fingerprint), vincula a entrada à sessão e a esse registro e preenche display_label e metadata para documentos. Para uma lista de bloqueio device_fingerprint, uma sessão que tenha apenas 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 esse registro, envie também value; nesse caso, o seu value é armazenado e a entrada continua vinculada à sessão.
UUID do registro que a entrada representa quando ela não vem de uma sessão: um UUID de transação, ou o didit_internal_id de um usuário ou de uma empresa. Use-o junto com metadata.reference_type. É substituído pelo registro da sessão quando reference_session_id fornece um.
Em listas de rostos com reference_session_id: de qual imagem da sessão o rosto é extraído. liveness (padrão) é a selfie de prova de vida. front_image_camera_front e back_image_camera_front são as selfies que a câmera frontal tirou enquanto o usuário fotografava a frente ou o verso do documento: aceitas apenas na lista de bloqueio facial do sistema, com reference_session_id e um value vazio. Cada selfie pode ser adicionada uma única 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 usada, para fluxos com mais de um. O 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, quando 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 livre armazenado com a entrada e retornado como foi armazenado. Use reference_type e reference_id para que o console faça o link de volta à origem. reference_image_url e front_image_url são definidos apenas pela Didit e descartados se você os enviar. Para uma entrada lida de uma sessão, as chaves da Didit são mescladas com as suas.
Show child attributes
Show child attributes
Resposta
A entrada foi criada.
Um valor em uma lista.
Identificador da entrada. Use-o como entry_uuid em Excluir 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 de dispositivo, um endereço de carteira, uma conta bancária, um código de país ISO 3166-1 alpha-3, um vendor_data, qualquer string em uma lista key ou o UUID do rosto armazenado em uma lista de rostos. Os valores que você envia são armazenados em letras 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 o preenche para entradas obtidas de uma sessão (por exemplo, o nome do titular e o número do documento) quando você não envia nenhum.
512Nota em texto livre. String vazia quando não definida.
Quem adicionou a entrada: api (uma chave de API), o e-mail de um usuário do console ou console, system ou migration (entradas criadas pela Didit), ou rule (uma ação de regra de transação ou de monitoramento).
Sessão de verificação da qual a entrada foi obtida. null quando a entrada foi adicionada por valor.
Número dessa sessão no escopo da aplicação, como exibido no console.
kyc para uma sessão de verificação de pessoa, kyb para uma sessão de verificação de empresa, null quando não há sessão.
kyc, kyb, null O registro que a entrada representa: o registro de rosto, documento, telefone ou e-mail lido de uma sessão, o rosto criado por Enviar um rosto para uma lista ou o UUID que você enviou (por exemplo, um UUID de transação ou o didit_internal_id de um usuário).
Contexto adicional. Contém as chaves definidas pela Didit (listadas aqui) mescladas com qualquer metadata que você enviou ao criar a entrada, retornadas como foram armazenadas. null quando não há nenhum.
Show child attributes
Show child attributes
Quando a entrada foi adicionada.