Saltar para o conteúdo principal
GET
curl
Consulte Evidência para saber como as execuções de regras registam cada valor correspondente e a respetiva origem, e Enriquecimento de IP para os campos de endereço enriquecidos.

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.

Parâmetros de caminho

event_uuid
string<uuid>
obrigatório

Identificador Didit do evento (event_uuid da resposta de criação, de processamento em lote, de listagem ou de cronologia), e não o seu próprio event_id.

Resposta

O evento com as suas provas.

Um evento de monitorização com o respetivo envelope completo, enriquecimento e evidência de regras. Todos os campos de MonitoringEvent mais os campos abaixo.

event_uuid
string<uuid>
obrigatório

Identificador Didit do evento. Utilize-o como {event_uuid} nas chamadas de obtenção e eliminação.

event_id
string
obrigatório

O seu próprio identificador, a chave de idempotência que enviou.

Maximum string length: 128
event_category
enum<string>
obrigatório

Categoria do evento.

Opções disponíveis:
auth,
session,
gameplay,
bonus,
affiliate,
payment,
dispute,
security,
responsible_gambling,
custom
action_type
string
obrigatório

O que aconteceu dentro da categoria, tal como enviou.

Maximum string length: 128
occurred_at
string<date-time>
obrigatório

Quando o evento aconteceu do seu lado.

received_at
string<date-time>
obrigatório

Quando a Didit aceitou o evento.

status
enum<string>
obrigatório

ACCEPTED: armazenado, nenhuma regra correspondida alterou o seu estado (a resposta normal para a maioria dos eventos, e sempre a resposta numa aplicação sandbox, onde não são executadas regras). APPROVED: uma regra correspondeu e a pontuação permaneceu abaixo do seu limiar de revisão. IN_REVIEW: uma regra elevou a pontuação acima do limiar de revisão ou definiu o estado. DECLINED: uma regra recusou-o ou a pontuação ultrapassou o seu limiar de recusa.

Opções disponíveis:
ACCEPTED,
APPROVED,
IN_REVIEW,
DECLINED
score
integer
obrigatório

Pontuação acumulada da regra. Começa em 0; as ações add_score da regra alteram-na (são permitidos deltas negativos).

subject_vendor_data
string
obrigatório

subject.vendor_data do evento: o seu ID para o utilizador ou empresa.

Maximum string length: 255
subject_entity_type
string
obrigatório

individual ou company: que tipo de sujeito é indicado por subject_vendor_data.

Exemplo:

"individual"

subject_uuid
string<uuid> | null
obrigatório

UUID do utilizador (indivíduo) ou empresa a que o evento foi associado, ou null quando esse registo já não existir.

counterparty_vendor_data
string | null
obrigatório

O outro interveniente de um evento P2P (promovido a partir de payload.counterparty_vendor_data).

Maximum string length: 255
session_id
string | null
obrigatório

session.session_id enviado com o evento.

Maximum string length: 255
device_fingerprint
string | null
obrigatório

device_context.fingerprint enviado com o evento.

Maximum string length: 255
ip_address
string | null
obrigatório

Endereço IP do evento. Na via de servidor, este é o device_context.network_context.ip_address tal como o enviou; na via de dispositivo, é o IP do pedido.

Maximum string length: 64
ip_country
string | null
obrigatório

Código do país de ip_address a partir do enriquecimento de IP, ou null quando o endereço não foi enriquecido (em falta, privado ou telemetria de baixo valor cujo endereço ainda não era conhecido).

Exemplo:

"ES"

amount
string | null
obrigatório

Montante como uma string decimal com 18 casas decimais, a partir de transaction_context.amount, payload.amount ou payload.stake_amount, por essa ordem.

Exemplo:

"250.000000000000000000"

currency
string | null
obrigatório

Moeda de transaction_context.currency ou payload.currency.

Maximum string length: 10
game_id
string | null
obrigatório

Promovido a partir de payload.game_id.

Maximum string length: 128
round_id
string | null
obrigatório

Promovido a partir de payload.round_id.

Maximum string length: 128
bonus_id
string | null
obrigatório

Promovido a partir de payload.bonus_id.

Maximum string length: 128
affiliate_code
string | null
obrigatório

Promovido a partir de payload.affiliate_code.

Maximum string length: 128
payment_reference_id
string | null
obrigatório

Referência de pagamento de transaction_context.payment_reference_id ou payload.payment_reference_id.

Maximum string length: 255
retention_class
enum<string>
obrigatório

Classe de conservação. Os eventos de pagamento e de disputa são monetary_or_compliance; os eventos de segurança e de jogo responsável são risk_relevant; session.page_view, session.sdk_heartbeat, session.sdk_loaded, session.device_seen, session.bot_signal_observed, bonus.promotion_viewed e affiliate.referral_clicked são low_value; todos os outros são standard. Um evento ao qual correspondeu uma regra ativa é promovido a risk_relevant (nunca despromovido).

Opções disponíveis:
low_value,
standard,
risk_relevant,
monetary_or_compliance
rules_matched_count
integer
obrigatório

Número de regras que corresponderam ao evento, incluindo regras em modo TEST (que registam provas mas não aplicam ações).

Intervalo necessário: x >= 0
correlation_pending
boolean
obrigatório

true enquanto uma regra assíncrona (correlação entre sujeitos ou uma sequência superior a 24 horas) ainda tem de ser executada para este evento. É resolvida em minutos e status, score e rules_matched_count são atualizados diretamente.

is_droppable
boolean
obrigatório

Se um SDK sob contrapressão pode descartar eventos deste tipo. false para todos os eventos de security, payment, dispute e responsible_gambling e para gameplay.bet_placed, gameplay.bet_settled e gameplay.p2p_settlement.

payload
object
obrigatório

Os campos de categoria que enviou em payload.

custom_values
object
obrigatório

Os custom_values escalares que enviou. A Didit adiciona vpn_or_proxy_detected: true ou is_data_center: true quando o enriquecimento de IP sinaliza o endereço e você não os definiu.

device_context
object
obrigatório

O contexto do dispositivo conforme armazenado: o seu device_context (incluindo fingerprint, persistent_device_id e bot_score quando enviados) com network_context completado por enriquecimento de IP (ip_country, ip_country_code, ip_city, asn_number, asn_organization, is_vpn_or_tor, is_data_center, proxy_type, connection_type) para chaves que tenha deixado vazias.

field_sources
object
obrigatório

Caminho do campo até à proveniência: customer (enviado pelo seu backend), sdk (enviado através do canal do dispositivo) ou server (derivado pela Didit, como received_at e campos de rede enriquecidos). Verifique-o antes de agir sobre uma correspondência.

session_sequence
integer<int64> | null
obrigatório

session.sequence enviado com o evento.

table_id
string | null
obrigatório

Promovido a partir de payload.table_id.

Maximum string length: 128
hand_id
string | null
obrigatório

Promovido a partir de payload.hand_id.

Maximum string length: 128
match_id
string | null
obrigatório

Promovido a partir de payload.match_id.

Maximum string length: 128
market_id
string | null
obrigatório

Promovido a partir de payload.market_id.

Maximum string length: 128
side
string | null
obrigatório

Promovido a partir de payload.side.

Maximum string length: 64
role
string | null
obrigatório

Promovido a partir de payload.role.

Maximum string length: 64
net_result_amount
string | null
obrigatório

Promovido a partir de payload.net_result_amount, como uma string decimal com 18 casas decimais.

Exemplo:

"-120.000000000000000000"

payment_fingerprint
string | null
obrigatório

Promovido a partir de payload.payment_fingerprint.

Maximum string length: 255
instrument_reference_hash
string | null
obrigatório

Promovido a partir de payload.instrument_reference_hash.

Maximum string length: 255
withdrawal_address_hash
string | null
obrigatório

Promovido a partir de payload.withdrawal_address_hash (ou payload.destination_reference_hash).

Maximum string length: 255
dispute_id
string | null
obrigatório

Promovido a partir de payload.dispute_id.

Maximum string length: 255
chargeback_id
string | null
obrigatório

Promovido a partir de payload.chargeback_id.

Maximum string length: 255
changed_field
string | null
obrigatório

Promovido a partir de payload.changed_field (eventos de alteração de segurança).

Maximum string length: 128
identity_match_ref
string | null
obrigatório

Promovido a partir de payload.identity_match_ref (correspondências do registo de jogo responsável).

Maximum string length: 255
schema_version
integer
obrigatório

Versão do esquema do envelope do evento. Atualmente 1.

Exemplo:

1

expires_at
string<date-time> | null
obrigatório

Quando o evento expira de acordo com a sua classe de conservação e é eliminado: occurred_at mais o período da classe (14, 30 ou 90 dias por predefinição, ajustável por aplicação). Nulo para eventos monetary_or_compliance, que seguem a conservação de transações.

rules_evaluated_count
integer
obrigatório

Número de regras de evento avaliadas para este evento.

Intervalo necessário: x >= 0
rule_runs
object[]
obrigatório

Cada regra que correspondeu ao evento, da mais recente para a mais antiga.

ip_enrichment
object | null
obrigatório

Enriquecimento do endereço IP do evento, ou null quando o endereço não foi enriquecido. Consulte Enriquecimento de IP.

subject_profile
object | null
obrigatório

Sinais de risco em cache de e-mail e telefone do sujeito, ou null se não existir qualquer perfil para o sujeito.

tags
string[]
obrigatório

Nomes das etiquetas associadas ao evento (ações add_tags de regras).

Última modificação em 7 de novembro de 2026