Saltar para o conteúdo principal
POST
Python
Envie o mesmo corpo que pretende utilizar para Fraud Check. A planificação não cria nenhuma verificação nem sessão, não chama nenhum fornecedor de enriquecimento, não lê o histórico de rede e não cobra nada. Cada módulo separa available de will_run. availability_reason explica se os dados fornecidos permitem suportar o módulo, enquanto selection_reason explica por que razão ele é ou não selecionado. Mantenha visíveis os módulos indisponíveis e mostre os requisitos de dados de cada um. networks_cross_org requer o plano Enterprise e que o modo de partilha da sua organização esteja definido como global. Sem estes requisitos, ou quando a Networks não está ativada para a sua organização, o plano indica-o com available: false e availability_reason: "entitlement_required". Uma verificação que selecione este módulo ignora-o com o mesmo motivo. As aplicações sandbox não estão sujeitas ao plano nem ao modo de partilha: com um identificador suportado, o módulo é executado e devolve um resultado de amostra vazio. estimated_price é uma string decimal, expressa na moeda devolvida em currency. Um preço nulo significa indisponível ou sem preço, não gratuito. A estimativa de nível superior totaliza os módulos executáveis selecionados; can_afford verifica também o regime de faturação aplicável. Volte a planificar depois de alterar identificadores, contexto ou seleções. A execução volta a verificar a elegibilidade e os preços, pelo que um plano não é uma reserva nem uma garantia de que uma fonte externa irá responder.

Autorizações

x-api-key
string
header
obrigatório

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.

Corpo

subject
object
obrigatório
client_reference
string

A sua própria referência para esta verificação. Funciona também como a chave de idempotência: reutilizá-la com o mesmo corpo devolve a verificação original sem executar ou faturar os módulos novamente; reutilizá-la com um corpo diferente devolve 409.

Required string length: 1 - 255
profile
string
padrão:standard

ID do perfil de orquestração. O valor predefinido é o perfil standard da Didit.

Required string length: 1 - 64
profile_version
string

Fixar uma versão congelada do perfil. Assume por predefinição a versão atual do perfil.

Required string length: 1 - 32
context
object
checks
object
vendor_data
string
Maximum string length: 1000
metadata
any

Resposta

profile_id
string
obrigatório
profile_version
string
obrigatório
modules
object[]
obrigatório
estimated_price
string | null
obrigatório
currency
string | null
obrigatório
is_sandbox
boolean
obrigatório
can_afford
boolean
obrigatório
Última modificação em 7 de novembro de 2026