Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo de alteraçõescurl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.update_status(
"user-123",
status="ACTIVE",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.updateStatus("user-123", {
status: "ACTIVE",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
Status: "ACTIVE",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
.status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->updateStatus('user-123', [
'status' => 'ACTIVE',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.update_status(
"user-123",
status: "ACTIVE"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));Atualizar estado do utilizador: bloquear ou sinalizar
Bloqueie, sinalize ou ative um utilizador na Didit. O estado aplica-se às futuras sessões KYC e à triagem de transações. Pagamento por chamada.
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.update_status(
"user-123",
status="ACTIVE",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.updateStatus("user-123", {
status: "ACTIVE",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
Status: "ACTIVE",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
.status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->updateStatus('user-123', [
'status' => 'ACTIVE',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.update_status(
"user-123",
status: "ACTIVE"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));Visão geral
Altera o estado de uma entidade de utilizador entreACTIVE, FLAGGED e BLOCKED. Consulte o ciclo de vida da entidade para ver a máquina de estados completa.
Quando utilizar
- Bloquear um utilizador depois de confirmar fraude ou uma violação de conformidade.
- Sinalizar um utilizador à espera de revisão manual, sem o bloquear totalmente.
- Desbloquear um utilizador depois de uma remediação bem-sucedida.
- Propagar sinais externos, por exemplo, quando o seu próprio motor de fraude atribui a um utilizador uma pontuação acima de um limiar, altere-o para
FLAGGEDatravés deste endpoint.
Notas
- Valores válidos:
ACTIVE,FLAGGEDeBLOCKED. Valores inválidos devolvem 400. - Pode indicar um
reasonopcional (até 1000 caracteres) para registar o motivo da alteração de estado. A Didit guarda-o como comentário da entrada de alteração de estado na atividade da pessoa:comments[].commentno utilizador e Atividade na Business Console. É registado apenas quando o estado muda efetivamente. - Os utilizadores
BLOCKEDtêm todas as novas sessões recusadas automaticamente e todas as novas transações recusadas automaticamente. - Emite um webhook
user.status.updatedcomprevious_statusestatus. O webhook não incluireason.
Aplicação
| Estado | Efeito nas novas sessões | Efeito nas novas transações |
|---|---|---|
ACTIVE | Fluxo normal | Fluxo normal |
FLAGGED | Permitidas, mas encaminhadas para IN_REVIEW | Permitidas; podem ser escaladas automaticamente consoante as regras |
BLOCKED | Recusadas automaticamente | Recusadas automaticamente |
Permissões
O segredo principal e as chaves de API de acesso total podem sempre chamar este endpoint. Uma chave com acesso personalizado precisa de permissão de escrita em Pessoas (users).
Uma chave limitada a alguns fluxos ou a sessões aprovadas não consegue aceder a este endpoint.
As funções e permissões da Consola determinam o que um membro da equipa pode fazer na Consola.
Não são avaliadas para pedidos feitos com 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
O seu identificador exclusivo para o utilizador.
Corpo
Novo estado do ciclo de vida. BLOCKED também adiciona o vendor_data à lista de bloqueio do sistema.
ACTIVE, FLAGGED, BLOCKED O motivo da alteração de estado. Registado na entrada de alteração de estado da atividade do utilizador (comments[].comment e Activity na Business Console), apenas quando o estado realmente muda. Os webhooks não o transmitem.
1000Resposta
Estado do utilizador atualizado. Registo completo do utilizador devolvido.
Detalhe completo do utilizador. Estende UserListItem com metadados, comentários e updated_at.
UUID interno estável da Didit para este utilizador.
O seu identificador exclusivo para este utilizador (transmitido ao criar sessões). Pode ser nulo quando não tiver sido fornecido nenhum identificador de fornecedor.
Nome de apresentação personalizado definido por si
Nome completo extraído de documentos verificados
Melhor nome disponível: display_name se definido, caso contrário full_name
Estado do ciclo de vida do registo do utilizador (NÃO é um estado da sessão). ACTIVE é o padrão, FLAGGED marca o utilizador para atenção manual, BLOCKED impede novas sessões para este vendor_data.
ACTIVE, FLAGGED, BLOCKED URL pré-assinado da fotografia de retrato do utilizador (expira após algumas horas)
Número total de sessões de verificação para este utilizador
Número de sessões aprovadas
Número de sessões recusadas
Número de sessões em análise
Códigos ISO 3166-1 alfa-3 dos países emissores observados nos documentos de identificação aprovados deste utilizador, por exemplo, ["USA", "ESP"]. Array vazio quando não houver nenhum.
Endereços de e-mail verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, ["john@example.com"].
Números de telefone verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, ["+14155551234"].
Estado agregado por funcionalidade em todas as sessões deste utilizador. Chaves possíveis: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valores possíveis: Approved, Declined, In Review, Not Finished, Resub Requested.
Os mesmos dados que features, como um array ordenado de objetos {feature, status}.
Show child attributes
Show child attributes
Carimbo de data/hora da sessão mais recente
Carimbo de data/hora da primeira sessão
Carimbo de data/hora da atividade mais recente neste utilizador (sessão, transação, mudança de estado, edição de dados, etc.).
Atribuições de etiquetas. NOTA: nas respostas detalhadas, cada entrada é um objeto de ligação de etiqueta ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), ao contrário do formato simples {uuid, name, color} utilizado nas respostas de listagem.
Show child attributes
Show child attributes
JSON de metadados personalizados que associou a este utilizador. O valor predefinido é {}.
Registo de atividade e comentários para este utilizador (alterações de estado, edições de perfil, notas manuais).
Show child attributes
Show child attributes