> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# API de Eventos de Monitorização em Lote
> Envie até 500 eventos de monitorização num só pedido da Didit, com resultado por item, para que um evento mal formatado não bloqueie o lote.
Prompt para criar eventos de monitorização na API de lotes
Copiar o prompt para a área de transferência
\
\`Send up to 500 monitoring events to Didit in one request from my backend, and handle the per-item outcomes.
Endpoint:
POST https://verification.didit.me/v3/events/batch/
Authentication:
Use the x-api-key header with my Didit API key, from my backend only. A scoped key needs transactions: write.
Goal:
\- Flush a queue of events (logins, gameplay rounds, payment steps, chargebacks) in as few requests as possible, without one bad event blocking the others.
Request body (application/json):
\{
"events": [ { ...one event, same envelope as POST /v3/events/... }, ... ] // 1 to 500 events
}
A bare JSON array of events is also accepted.
Behavior:
\- Each item is validated, stored and evaluated on its own, exactly like POST /v3/events/. A rejected item never rolls back the others.
\- HTTP 201 when no item was rejected, 207 when at least one was. Treat both as success and read results[].
\- results[] has one entry per item in request order, with index pointing into my events array and outcome accepted, replayed or rejected.
\- accepted and replayed items carry the same fields as the single-event response (event_uuid, status, score, rule_matches, correlation_pending, retention_class, expires_at, idempotent_replay).
\- rejected items carry errors keyed by field, in the same shape as the 400 of POST /v3/events/. A reused event_id with different content is reported as a string under errors.event_id. Send event_id in snake_case so a rejected item's results[].event_id is filled.
\- Retry only the rejected items after fixing them. Resending an accepted item is safe: it comes back as replayed.
\- occurred_at must still be within 7 days in the past and 5 minutes in the future for every item.
Example call:
curl -X POST "https://verification.didit.me/v3/events/batch/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"events":[{"event_id":"login-2026-10-17-000001","event_category":"auth","action_type":"login","occurred_at":"2026-10-17T09:15:02.481Z","subject":{"vendor_data":"user-42"}}]}'
What to read from the response:
\- accepted_count, replayed_count, rejected_count.
\- results[].index and results[].outcome.
\- results[].errors for rejected items.
\- results[].event_uuid and results[].status for stored items.
Failure modes:
\- 400 - events missing, not an array, empty, or longer than 500 items ({ "events": "" }). Nothing is stored; split the batch.
\- 429 - more than 600 ingestion requests per minute for this API key (event and transaction ingestion share this budget, apart from the 300 of every other write); honor Retry-After.
\- 401 - the API key has expired.
\- 403 - missing API key (a wrong, revoked or expired key gets 401), a scoped key without transactions: write, or code event_monitoring_disabled (event ingestion is not switched on; nothing is stored).
Side effects: stores every valid item, may create subjects, and applies the actions of matched active rules.
For the full integration shape, see /integration/integration-prompt.`
\
Colar em
Consulte [Lotes](https://docs.didit.me/pt/transaction-monitoring/events.md#lotes) no guia de ingestão de eventos. O canal de dispositivo tem os mesmos resultados por item para as operações de esvaziamento do SDK: consulte [Envio de eventos pelo SDK](https://docs.didit.me/pt/transaction-monitoring/sdk-event-submission.md#envio-em-lote).
## OpenAPI
````yaml pt/openapi-25.json POST /v3/events/batch/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/events/batch/:
post:
tags:
- Monitoring Events
summary: Criar eventos de monitorização em lote
description: >-
Submeta 1 a 500 eventos num único pedido, cada um no mesmo envelope que
`POST /v3/events/`. Cada item é validado, armazenado e avaliado
individualmente e obtém o seu próprio resultado (`accepted`, `replayed`
ou `rejected`), pelo que um evento malformado nunca reverte os
restantes: a resposta é `201` quando nenhum item foi rejeitado e `207`
quando pelo menos um o foi, sendo que ambas significam que o pedido foi
processado. Envie `{"events": [...]}`; uma matriz JSON simples de
eventos também é aceite. A ingestão de eventos tem de estar ativada para
a aplicação; caso contrário, todo o pedido devolve `403` com `code:
event_monitoring_disabled` e nada é armazenado. Uma chave de API com
âmbito necessita de `transactions: write`. Consulte
[Batches](https://docs.didit.me/pt/transaction-monitoring/events#lotes).
operationId: create_monitoring_events_batch
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- events
properties:
events:
type: array
minItems: 1
maxItems: 500
description: >-
1 a 500 eventos. Cada item segue
`MonitoringEventCreateRequest`, incluindo a janela de 7 dias
no passado e 5 minutos no futuro em `occurred_at`.
items:
$ref: '#/components/schemas/MonitoringEventCreateRequest'
example:
events:
- event_id: login-2026-10-17-000001
event_category: auth
action_type: login
occurred_at: '2026-10-17T09:15:02.481Z'
subject:
vendor_data: user-42
- event_id: deposit-2026-10-17-000002
event_category: payment
action_type: deposit_completed
occurred_at: '2026-10-17T09:16:40Z'
subject:
vendor_data: user-42
transaction_context:
amount: '100.00'
currency: EUR
payment_reference_id: dep_736
payload:
payment_method: card
status: completed
responses:
'201':
description: >-
Nenhum item foi rejeitado: todos os itens foram `accepted` ou
`replayed`.
content:
application/json:
schema:
type: object
required:
- accepted_count
- replayed_count
- rejected_count
- results
properties:
accepted_count:
type: integer
minimum: 0
description: Itens guardados e avaliados.
replayed_count:
type: integer
minimum: 0
description: Itens já guardados com o mesmo conteúdo.
rejected_count:
type: integer
minimum: 0
description: Itens não guardados.
results:
type: array
description: Uma entrada por item, na ordem do pedido.
items:
type: object
description: >-
Resultado de um item. Itens aceites e repetidos também
incluem todos os campos de
`MonitoringEventIngestResult`; itens rejeitados incluem
`event_id` e `errors` em vez disso.
required:
- index
- outcome
properties:
index:
type: integer
minimum: 0
description: Posição do item no seu array `events`.
outcome:
type: string
enum:
- accepted
- replayed
- rejected
description: >-
`accepted`: armazenado e avaliado. `replayed`: já
armazenado com o mesmo conteúdo. `rejected`: não
armazenado; consulte `errors`.
event_id:
type: string
nullable: true
description: >-
O seu `event_id`. Nos itens rejeitados pela
validação, é lido a partir da chave snake_case
`event_id` do item, pelo que é nulo quando o item o
omitiu ou enviou o alias `eventId`.
errors:
type: object
additionalProperties: true
description: >-
Apenas itens rejeitados. Erros de validação
indexados por campo, na mesma estrutura do `400` de
`POST /v3/events/`; um `event_id` reutilizado com
conteúdo diferente é reportado como uma string sob
`errors.event_id`.
event_uuid:
type: string
format: uuid
description: Apenas itens aceites e reproduzidos.
status:
type: string
enum:
- ACCEPTED
- APPROVED
- IN_REVIEW
- DECLINED
description: Apenas itens aceites e reproduzidos.
score:
type: integer
description: Apenas itens aceites e reproduzidos.
rules_evaluated_count:
type: integer
description: Apenas itens aceites e reproduzidos.
rules_matched_count:
type: integer
description: Apenas itens aceites e reproduzidos.
correlation_pending:
type: boolean
description: Apenas itens aceites e reproduzidos.
retention_class:
type: string
enum:
- low_value
- standard
- risk_relevant
- monetary_or_compliance
description: Apenas itens aceites e reproduzidos.
expires_at:
type: string
format: date-time
nullable: true
description: Apenas itens aceites e reproduzidos.
idempotent_replay:
type: boolean
description: Apenas itens aceites e reproduzidos.
rule_matches:
type: array
description: Apenas itens aceites e reproduzidos.
items:
type: object
required:
- rule_id
- library_key
- mode
- is_async
properties:
rule_id:
type: string
format: uuid
description: UUID da regra.
library_key:
type: string
nullable: true
description: >-
Chave da biblioteca quando a regra foi
instalada a partir da biblioteca de regras;
caso contrário, null.
mode:
type: string
enum:
- ACTIVE
- TEST
description: >-
As regras `TEST` registam a correspondência,
mas não aplicam ações.
is_async:
type: boolean
description: >-
`true` quando a correspondência resultou da
passagem assíncrona.
examples:
All landed:
value:
accepted_count: 1
replayed_count: 1
rejected_count: 0
results:
- index: 0
outcome: accepted
event_uuid: 33333333-4444-5555-6666-777777777777
event_id: login-2026-10-17-000001
status: ACCEPTED
score: 0
rules_evaluated_count: 6
rules_matched_count: 0
correlation_pending: false
retention_class: standard
expires_at: '2026-11-16T09:15:02.481000Z'
idempotent_replay: false
rule_matches: []
- index: 1
outcome: replayed
event_uuid: 11111111-2222-3333-4444-555555555555
event_id: deposit-2026-10-17-000002
status: ACCEPTED
score: 0
rules_evaluated_count: 6
rules_matched_count: 0
correlation_pending: false
retention_class: monetary_or_compliance
expires_at: null
idempotent_replay: true
rule_matches: []
'207':
description: >-
Pelo menos um item foi rejeitado. Os restantes itens foram
guardados; corrija e reenvie apenas os rejeitados (reenviar um item
aceite é seguro, é devolvido como `replayed`).
content:
application/json:
schema:
type: object
required:
- accepted_count
- replayed_count
- rejected_count
- results
properties:
accepted_count:
type: integer
minimum: 0
description: Itens guardados e avaliados.
replayed_count:
type: integer
minimum: 0
description: Itens já guardados com o mesmo conteúdo.
rejected_count:
type: integer
minimum: 0
description: Itens não guardados.
results:
type: array
description: Uma entrada por item, na ordem do pedido.
items:
type: object
description: >-
Resultado de um item. Itens aceites e repetidos também
incluem todos os campos de
`MonitoringEventIngestResult`; itens rejeitados incluem
`event_id` e `errors` em vez disso.
required:
- index
- outcome
properties:
index:
type: integer
minimum: 0
description: Posição do item no seu array `events`.
outcome:
type: string
enum:
- accepted
- replayed
- rejected
description: >-
`accepted`: armazenado e avaliado. `replayed`: já
armazenado com o mesmo conteúdo. `rejected`: não
armazenado; consulte `errors`.
event_id:
type: string
nullable: true
description: >-
O seu `event_id`. Nos itens rejeitados pela
validação, é lido a partir da chave snake_case
`event_id` do item, pelo que é nulo quando o item o
omitiu ou enviou o alias `eventId`.
errors:
type: object
additionalProperties: true
description: >-
Apenas itens rejeitados. Erros de validação
indexados por campo, na mesma estrutura do `400` de
`POST /v3/events/`; um `event_id` reutilizado com
conteúdo diferente é reportado como uma string sob
`errors.event_id`.
event_uuid:
type: string
format: uuid
description: Apenas itens aceites e reproduzidos.
status:
type: string
enum:
- ACCEPTED
- APPROVED
- IN_REVIEW
- DECLINED
description: Apenas itens aceites e reproduzidos.
score:
type: integer
description: Apenas itens aceites e reproduzidos.
rules_evaluated_count:
type: integer
description: Apenas itens aceites e reproduzidos.
rules_matched_count:
type: integer
description: Apenas itens aceites e reproduzidos.
correlation_pending:
type: boolean
description: Apenas itens aceites e reproduzidos.
retention_class:
type: string
enum:
- low_value
- standard
- risk_relevant
- monetary_or_compliance
description: Apenas itens aceites e reproduzidos.
expires_at:
type: string
format: date-time
nullable: true
description: Apenas itens aceites e reproduzidos.
idempotent_replay:
type: boolean
description: Apenas itens aceites e reproduzidos.
rule_matches:
type: array
description: Apenas itens aceites e reproduzidos.
items:
type: object
required:
- rule_id
- library_key
- mode
- is_async
properties:
rule_id:
type: string
format: uuid
description: UUID da regra.
library_key:
type: string
nullable: true
description: >-
Chave da biblioteca quando a regra foi
instalada a partir da biblioteca de regras;
caso contrário, null.
mode:
type: string
enum:
- ACTIVE
- TEST
description: >-
As regras `TEST` registam a correspondência,
mas não aplicam ações.
is_async:
type: boolean
description: >-
`true` quando a correspondência resultou da
passagem assíncrona.
examples:
Partial success:
value:
accepted_count: 1
replayed_count: 0
rejected_count: 2
results:
- index: 0
outcome: accepted
event_uuid: 33333333-4444-5555-6666-777777777777
event_id: login-2026-10-17-000001
status: ACCEPTED
score: 0
rules_evaluated_count: 6
rules_matched_count: 0
correlation_pending: false
retention_class: standard
expires_at: '2026-11-16T09:15:02.481000Z'
idempotent_replay: false
rule_matches: []
- index: 1
event_id: deposit-2026-10-17-000002
outcome: rejected
errors:
payload:
- >-
payment.deposit_completed requires:
payment_method, status.
- index: 2
event_id: login-2026-10-16-000777
outcome: rejected
errors:
event_id: >-
event_id 'login-2026-10-16-000777' already exists
with a different payload.
'400':
description: >-
O próprio lote está malformado: `events` está em falta ou não é um
array, está vazio ou contém mais de 500 itens. Nada é armazenado;
divida lotes grandes.
content:
application/json:
examples:
Not a list:
value:
events: Expected a list of events.
Empty:
value:
events: At least one event is required.
Too many:
value:
events: A batch accepts at most 500 events; received 612.
'401':
description: >-
A chave de API com âmbito expirou. Apenas uma chave expirada recebe
`401`; uma chave em falta ou inválida recebe `403`.
content:
application/json:
examples:
Expired key:
value:
detail: This API key has expired.
'403':
description: >-
Um `x-api-key` em falta (uma chave incorreta, revogada ou expirada
obtém `401`), uma chave com âmbito restrito sem `transactions:
write`, uma chave limitada a alguns fluxos ou a sessões aprovadas
(tal chave nunca acede a dados de monitorização de transações), ou
um pedido fora da lista de permissões de IP da chave. Também
devolvido com `code: event_monitoring_disabled` enquanto a ingestão
de eventos estiver desativada para a aplicação; nada é armazenado
nesse caso, e a verificação é executada antes da validação do corpo.
content:
application/json:
examples:
Event monitoring disabled:
value:
detail: >-
Event monitoring is not enabled for this application. Turn
on event ingestion in the transaction monitoring settings
before submitting events.
code: event_monitoring_disabled
Missing or invalid API key:
value:
detail: You do not have permission to perform this action.
Scoped key without access:
value:
detail: This API key has no write access to transactions.
Key limited to workflows or approved sessions:
value:
detail: >-
This API key only reaches sessions inside its workflow or
status limits, so it can't use this endpoint.
IP not allowed:
value:
detail: This API key can't be used from this IP address.
'429':
description: >-
Limite de pedidos excedido: a criação de transações e a ingestão de
eventos (`POST /v3/transactions/`, `POST /v3/events/`, `POST
/v3/events/batch/`) partilham um orçamento de 600 pedidos por minuto
por chave de API, separado dos 300 partilhados por todos os outros
pedidos de escrita. Aguarde `Retry-After` segundos e, em seguida,
tente novamente.
headers:
Retry-After:
description: >-
Segundos a aguardar antes de tentar novamente, arredondados para
cima para que a nova tentativa ocorra na janela seguinte.
schema:
type: integer
minimum: 1
example: 30
content:
application/json:
examples:
Throttled:
value:
detail: >-
Ingestion rate limit exceeded. You can make up to 600
requests per minute.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: |-
curl -X POST 'https://verification.didit.me/v3/events/batch/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"events": [
{"event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login",
"occurred_at": "2026-10-17T09:15:02.481Z", "subject": {"vendor_data": "user-42"}},
{"event_id": "deposit-2026-10-17-000002", "event_category": "payment", "action_type": "deposit_completed",
"occurred_at": "2026-10-17T09:16:40.000Z", "subject": {"vendor_data": "user-42"},
"transaction_context": {"amount": "100.00", "currency": "EUR", "payment_reference_id": "dep_736"},
"payload": {"payment_method": "card", "status": "completed"}}
]
}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.monitoring_events.create_batch(
events=[{
"event_id": "login-2026-10-17-000001",
"event_category": "auth",
"action_type": "login",
"occurred_at": "2026-10-17T09:15:02.481Z",
"subject": {
"vendor_data": "user-42",
},
}, {
"event_id": "deposit-2026-10-17-000002",
"event_category": "payment",
"action_type": "deposit_completed",
"occurred_at": "2026-10-17T09:16:40Z",
"subject": {
"vendor_data": "user-42",
},
"transaction_context": {
"amount": "100.00",
"currency": "EUR",
"payment_reference_id": "dep_736",
},
"payload": {"payment_method": "card", "status": "completed"},
}],
)
print(result)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.monitoringEvents.createBatch({
events: [{
event_id: "login-2026-10-17-000001",
event_category: "auth",
action_type: "login",
occurred_at: "2026-10-17T09:15:02.481Z",
subject: {
vendor_data: "user-42",
},
}, {
event_id: "deposit-2026-10-17-000002",
event_category: "payment",
action_type: "deposit_completed",
occurred_at: "2026-10-17T09:16:40Z",
subject: {
vendor_data: "user-42",
},
transaction_context: {
amount: "100.00",
currency: "EUR",
payment_reference_id: "dep_736",
},
payload: { payment_method: "card", status: "completed" },
}],
});
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.CreateBatch(ctx, didit.MonitoringEventsCreateBatchParams{\n\tEvents: []didit.MonitoringEventCreateRequest{{\n\t\tEventID: \"login-2026-10-17-000001\",\n\t\tEventCategory: \"auth\",\n\t\tActionType: \"login\",\n\t\tOccurredAt: time.Date(2026, 10, 17, 9, 15, 2, 0, time.UTC),\n\t\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\t\tVendorData: \"user-42\",\n\t\t},\n\t}, {\n\t\tEventID: \"deposit-2026-10-17-000002\",\n\t\tEventCategory: \"payment\",\n\t\tActionType: \"deposit_completed\",\n\t\tOccurredAt: time.Date(2026, 10, 17, 9, 16, 40, 0, time.UTC),\n\t\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\t\tVendorData: \"user-42\",\n\t\t},\n\t\tTransactionContext: didit.Some(didit.MonitoringEventCreateRequestTransactionContext{\n\t\t\tAmount: didit.String(\"100.00\"),\n\t\t\tCurrency: didit.String(\"EUR\"),\n\t\t\tPaymentReferenceID: didit.String(\"dep_736\"),\n\t\t}),\n\t\tPayload: didit.Some(map[string]any{\"payment_method\": \"card\", \"status\": \"completed\"}),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.MonitoringEventCreateRequest;
import me.didit.types.MonitoringEventsCreateBatchParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.monitoringEvents().createBatch(MonitoringEventsCreateBatchParams.builder()
.events(List.of(
MonitoringEventCreateRequest.builder()
.eventId("login-2026-10-17-000001")
.eventCategory(MonitoringEventCreateRequest.EventCategory.of("auth"))
.actionType("login")
.occurredAt(OffsetDateTime.parse("2026-10-17T09:15:02.481Z"))
.subject(MonitoringEventCreateRequest.Subject.builder()
.vendorData("user-42")
.build())
.build(),
MonitoringEventCreateRequest.builder()
.eventId("deposit-2026-10-17-000002")
.eventCategory(MonitoringEventCreateRequest.EventCategory.of("payment"))
.actionType("deposit_completed")
.occurredAt(OffsetDateTime.parse("2026-10-17T09:16:40Z"))
.subject(MonitoringEventCreateRequest.Subject.builder()
.vendorData("user-42")
.build())
.transactionContext(MonitoringEventCreateRequest.TransactionContext.builder()
.amount("100.00")
.currency("EUR")
.paymentReferenceId("dep_736")
.build())
.payload(Map.of("payment_method", "card", "status", "completed"))
.build()))
.build());
System.out.println(result);
- lang: php
label: PHP
source: |-
monitoringEvents->createBatch([
'events' => [[
'event_id' => 'login-2026-10-17-000001',
'event_category' => 'auth',
'action_type' => 'login',
'occurred_at' => '2026-10-17T09:15:02.481Z',
'subject' => [
'vendor_data' => 'user-42',
],
], [
'event_id' => 'deposit-2026-10-17-000002',
'event_category' => 'payment',
'action_type' => 'deposit_completed',
'occurred_at' => '2026-10-17T09:16:40Z',
'subject' => [
'vendor_data' => 'user-42',
],
'transaction_context' => [
'amount' => '100.00',
'currency' => 'EUR',
'payment_reference_id' => 'dep_736',
],
'payload' => ['payment_method' => 'card', 'status' => 'completed'],
]],
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.monitoring_events.create_batch(
events: [{
event_id: "login-2026-10-17-000001",
event_category: "auth",
action_type: "login",
occurred_at: "2026-10-17T09:15:02.481Z",
subject: {
vendor_data: "user-42",
},
}, {
event_id: "deposit-2026-10-17-000002",
event_category: "payment",
action_type: "deposit_completed",
occurred_at: "2026-10-17T09:16:40Z",
subject: {
vendor_data: "user-42",
},
transaction_context: {
amount: "100.00",
currency: "EUR",
payment_reference_id: "dep_736",
},
payload: { payment_method: "card", status: "completed" },
}]
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.MonitoringEvents.CreateBatchAsync(new
MonitoringEventsCreateBatchParams
{
Events = new MonitoringEventCreateRequest[]
{
new()
{
EventId = "login-2026-10-17-000001",
EventCategory = "auth",
ActionType = "login",
OccurredAt = DateTimeOffset.Parse("2026-10-17T09:15:02.481Z"),
Subject = new()
{
VendorData = "user-42",
},
},
new()
{
EventId = "deposit-2026-10-17-000002",
EventCategory = "payment",
ActionType = "deposit_completed",
OccurredAt = DateTimeOffset.Parse("2026-10-17T09:16:40Z"),
Subject = new()
{
VendorData = "user-42",
},
TransactionContext = new MonitoringEventCreateRequestTransactionContext
{
Amount = "100.00",
Currency = "EUR",
PaymentReferenceId = "dep_736",
},
Payload = new Dictionary { ["payment_method"] = "card", ["status"] = "completed" },
},
},
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
MonitoringEventCreateRequest:
type: object
description: >-
O envelope do evento, igual para todas as categorias. São aceites
aliases em camelCase: `eventId`, `eventCategory` (ou `category`),
`actionType`, `occurredAt`, `timeZone` (ou `zoneId`), `deviceContext`
(ou `device`), `transactionContext`, `customValues` (ou `props`); dentro
de `subject`: `vendorData`, `entityType`, `fullName`; dentro de
`session`: `sessionId`, `pageUrl`; dentro de `transaction_context`:
`paymentReferenceId`.
required:
- event_id
- event_category
- action_type
- occurred_at
- subject
properties:
event_id:
type: string
maxLength: 128
description: >-
O seu identificador para o evento, único por aplicação. É a chave de
idempotência: reenviar os mesmos `event_category`, `action_type`,
`occurred_at`, `subject.vendor_data` e `payload` sob este
identificador é uma repetição; qualquer alteração constitui um
conflito.
example: login-2026-10-17-000001
event_category:
type: string
enum:
- auth
- session
- gameplay
- bonus
- affiliate
- payment
- dispute
- security
- responsible_gambling
- custom
description: Categoria do evento.
example: auth
action_type:
type: string
minLength: 1
maxLength: 128
description: >-
O que aconteceu dentro da categoria. Vocabulário aberto; as ações
geridas listadas em [Ingestão de
eventos](https://docs.didit.me/pt/transaction-monitoring/events)
(por exemplo `login`, `deposit_completed`, `chargeback_opened`)
desbloqueiam a validação tipada e campos de regras geridos. Os
espaços em branco no início e no final são removidos.
example: login
occurred_at:
type: string
format: date-time
description: >-
Quando o evento aconteceu do seu lado, ISO 8601 (um valor sem fuso
horário é interpretado como UTC). Não deve ter mais de 7 dias no
passado nem mais de 5 minutos no futuro.
example: '2026-10-17T09:15:02.481Z'
time_zone:
type: string
nullable: true
maxLength: 64
description: >-
Fuso horário da ocorrência do seu lado, por exemplo `Europe/Madrid`.
Armazenado com o evento; não é devolvido pelos endpoints de leitura.
subject:
type: object
description: >-
O utilizador ou empresa a quem o evento pertence. É resolvido para o
utilizador (ou empresa) com este `vendor_data` na sua aplicação; é
criado um novo registo se não existir nenhum.
required:
- vendor_data
properties:
vendor_data:
type: string
minLength: 1
maxLength: 255
description: O seu id para o sujeito.
example: user-42
entity_type:
type: string
maxLength: 32
default: individual
description: >-
`company` associa o sujeito a uma empresa; qualquer outro valor
(por predefinição `individual`) associa-o a um indivíduo. O
mesmo `vendor_data` pode indicar um de cada.
example: individual
full_name:
type: string
nullable: true
maxLength: 512
description: >-
Nome de apresentação, utilizado apenas quando este evento cria o
utilizador ou a empresa.
email:
type: string
format: email
nullable: true
description: Validado como um endereço de e-mail; não armazenado no evento.
phone:
type: string
nullable: true
maxLength: 32
description: Validado; não armazenado no evento.
country:
type: string
nullable: true
maxLength: 3
description: Validado; não armazenado no evento.
business:
type: object
description: >-
A empresa à qual o evento pertence, quando difere do sujeito. Apenas
`vendor_data` é lido.
additionalProperties: true
properties:
vendor_data:
type: string
maxLength: 255
description: O seu id para a empresa. Filtrável como `business_vendor_data`.
example: merchant-7
session:
type: object
description: O seu contexto de sessão para o evento.
properties:
session_id:
type: string
nullable: true
maxLength: 255
description: >-
O seu identificador de sessão. Filtrável e devolvido como
`session_id`.
sequence:
type: integer
nullable: true
description: >-
Posição do evento dentro da sessão. Devolvida como
`session_sequence`.
page_url:
type: string
nullable: true
maxLength: 2048
description: Validado; não armazenado no evento.
referrer:
type: string
nullable: true
maxLength: 2048
description: Validado; não armazenado no evento.
device_context:
type: object
additionalProperties: true
description: >-
Contexto de dispositivo e rede, armazenado tal como enviado e
devolvido por `GET /v3/events/{event_uuid}/`. Nesta camada do
servidor, a Didit não vê a ligação do utilizador final, pelo que o
IP enriquecido e utilizado pelas regras é
`network_context.ip_address` tal como o enviar.
properties:
fingerprint:
type: string
maxLength: 255
description: >-
Impressão digital do dispositivo. Filtrável como
`device_fingerprint`.
persistent_device_id:
type: string
maxLength: 255
description: O seu identificador persistente de dispositivo.
bot_score:
type: integer
description: Pontuação de bot da sua própria deteção, como um número inteiro.
network_context:
type: object
additionalProperties: true
properties:
ip_address:
type: string
maxLength: 64
description: >-
Endereço IP do utilizador final. Os endereços públicos são
enriquecidos uma vez por endereço exclusivo.
example: 203.0.113.42
transaction_context:
type: object
description: >-
Contexto monetário. Valores não vazios aqui também satisfazem as
chaves de payload obrigatórias da ação.
properties:
amount:
type: string
nullable: true
description: Montante como uma string decimal (também é aceite um número).
example: '1000.00'
currency:
type: string
nullable: true
maxLength: 10
description: Código de moeda.
direction:
type: string
nullable: true
maxLength: 16
description: >-
Direção do movimento de dinheiro, por exemplo `inbound` ou
`outbound`.
payment_reference_id:
type: string
nullable: true
maxLength: 255
description: >-
A sua referência de pagamento. Filtrável como
`payment_reference_id`.
payload:
type: object
additionalProperties: true
description: >-
Os campos de domínio da categoria, no máximo 16384 bytes após
codificação JSON. Algumas ações exigem chaves (em `payload` ou
`transaction_context`): `gameplay.p2p_settlement` requer `game_id`,
`counterparty_vendor_data`, `stake_amount`, `net_result_amount`,
`role` e um de `hand_id`, `round_id`, `match_id`;
`gameplay.bet_placed` e `gameplay.bet_settled` requerem `game_id`;
`payment.deposit_initiated`, `payment.deposit_completed`,
`payment.withdrawal_requested` e `payment.withdrawal_completed`
requerem `payment_reference_id`, `amount`, `currency`,
`payment_method`, `status`; `payment.withdrawal_address_changed`
requer `withdrawal_address_hash`; `dispute.chargeback_opened`,
`dispute.chargeback_won` e `dispute.chargeback_lost` requerem
`payment_reference_id` e um de `dispute_id`, `chargeback_id`;
`session.bot_signal_observed` requer `telemetry_schema_version` e um
de `bot_score`, `actions_per_minute`, `timing_variance_ms`,
`pointer_entropy`, `keystroke_entropy`, `reaction_time_ms_p50`;
`responsible_gambling.self_exclusion_match` requer
`registry_source`, `exclusion_status`, `identity_match_ref`. Todas
as ações de `security` que terminam em `_changed` requerem
`changed_field`, além de `previous_reference_hash` ou
`new_reference_hash` quando o campo for `password`, `mfa_method`,
`mfa`, `email`, `phone`, `withdrawal_address`, `payout_method` ou
`api_key`. Envie hashes e referências, nunca um número de cartão, um
endereço de levantamento completo, um hash de palavra-passe ou um
segredo MFA.
custom_values:
type: object
description: >-
Até 100 chaves suas, acessíveis a partir de regras como
`custom_values.`. Os valores têm de ser escalares (string,
número, booleano ou null); objetos e arrays aninhados são
rejeitados.
additionalProperties:
nullable: true
oneOf:
- type: string
- type: number
- type: boolean
example:
event_id: login-2026-10-17-000001
event_category: auth
action_type: login
occurred_at: '2026-10-17T09:15:02.481Z'
time_zone: Europe/Madrid
subject:
vendor_data: user-42
entity_type: individual
session:
session_id: web-session-abc
sequence: 142
device_context:
fingerprint: fp-a8c1
network_context:
ip_address: 203.0.113.42
payload:
method: password
custom_values:
vip_tier: gold
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
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.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.