> ## 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 monitoramento em lote
> Envie até 500 eventos de monitoramento por requisição na API do Didit, com resultado por item: um evento malformado não bloqueia o lote.
Prompt da API para criar eventos de monitoramento em lote
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 300 writes per minute for this API key; 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-br/transaction-monitoring/events.md#lotes) no guia de ingestão de eventos. O canal de dispositivos tem os mesmos resultados por item para os envios do SDK: consulte [Envio de eventos pelo SDK](https://docs.didit.me/pt-br/transaction-monitoring/sdk-event-submission.md#envio-em-lote).
## OpenAPI
````yaml pt-br/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 monitoramento em lote
description: >-
Envie de 1 a 500 eventos em uma única requisição, cada um no mesmo
envelope de `POST /v3/events/`. Cada item é validado, armazenado e
avaliado individualmente e recebe seu próprio resultado (`accepted`,
`replayed` ou `rejected`), de modo que um evento malformado nunca desfaz
os outros: a resposta é `201` quando nenhum item foi rejeitado e `207`
quando pelo menos um foi, e ambas significam que a requisição foi
processada. Envie `{"events": [...]}`; um array JSON simples de eventos
também é aceito. A ingestão de eventos precisa estar ativada para a
aplicação; caso contrário, a requisição inteira retorna `403` com `code:
event_monitoring_disabled` e nada é armazenado. Uma chave de API com
escopo precisa de `transactions: write`. Consulte
[Lotes](https://docs.didit.me/pt-br/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: >-
De 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 estão `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 armazenados e avaliados.
replayed_count:
type: integer
minimum: 0
description: Itens já armazenados com o mesmo conteúdo.
rejected_count:
type: integer
minimum: 0
description: Itens não armazenados.
results:
type: array
description: Uma entrada por item, na ordem da requisição.
items:
type: object
description: >-
Resultado de um item. Itens aceitos e repetidos também
trazem todos os campos de `MonitoringEventIngestResult`;
itens rejeitados trazem `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; veja `errors`.
event_id:
type: string
nullable: true
description: >-
Seu `event_id`. Nos itens rejeitados pela validação,
ele é lido da chave `event_id` em snake_case do
item, portanto é 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, no mesmo formato do `400` de
`POST /v3/events/`; um `event_id` reutilizado com
conteúdo diferente é informado como string em
`errors.event_id`.
event_uuid:
type: string
format: uuid
description: Somente itens aceitos e reprocessados.
status:
type: string
enum:
- ACCEPTED
- APPROVED
- IN_REVIEW
- DECLINED
description: Somente itens aceitos e reprocessados.
score:
type: integer
description: Somente itens aceitos e reprocessados.
rules_evaluated_count:
type: integer
description: Somente itens aceitos e reprocessados.
rules_matched_count:
type: integer
description: Somente itens aceitos e reprocessados.
correlation_pending:
type: boolean
description: Somente itens aceitos e reprocessados.
retention_class:
type: string
enum:
- low_value
- standard
- risk_relevant
- monetary_or_compliance
description: Somente itens aceitos e reprocessados.
expires_at:
type: string
format: date-time
nullable: true
description: Somente itens aceitos e reprocessados.
idempotent_replay:
type: boolean
description: Somente itens aceitos e reprocessados.
rule_matches:
type: array
description: Somente itens aceitos e reprocessados.
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: >-
Regras `TEST` registram a correspondência, mas
não aplicam nenhuma ação.
is_async:
type: boolean
description: >-
`true` quando a correspondência veio 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 demais itens foram armazenados;
corrija e reenvie apenas os rejeitados (reenviar um item aceito é
seguro, ele retorna 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 armazenados e avaliados.
replayed_count:
type: integer
minimum: 0
description: Itens já armazenados com o mesmo conteúdo.
rejected_count:
type: integer
minimum: 0
description: Itens não armazenados.
results:
type: array
description: Uma entrada por item, na ordem da requisição.
items:
type: object
description: >-
Resultado de um item. Itens aceitos e repetidos também
trazem todos os campos de `MonitoringEventIngestResult`;
itens rejeitados trazem `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; veja `errors`.
event_id:
type: string
nullable: true
description: >-
Seu `event_id`. Nos itens rejeitados pela validação,
ele é lido da chave `event_id` em snake_case do
item, portanto é 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, no mesmo formato do `400` de
`POST /v3/events/`; um `event_id` reutilizado com
conteúdo diferente é informado como string em
`errors.event_id`.
event_uuid:
type: string
format: uuid
description: Somente itens aceitos e reprocessados.
status:
type: string
enum:
- ACCEPTED
- APPROVED
- IN_REVIEW
- DECLINED
description: Somente itens aceitos e reprocessados.
score:
type: integer
description: Somente itens aceitos e reprocessados.
rules_evaluated_count:
type: integer
description: Somente itens aceitos e reprocessados.
rules_matched_count:
type: integer
description: Somente itens aceitos e reprocessados.
correlation_pending:
type: boolean
description: Somente itens aceitos e reprocessados.
retention_class:
type: string
enum:
- low_value
- standard
- risk_relevant
- monetary_or_compliance
description: Somente itens aceitos e reprocessados.
expires_at:
type: string
format: date-time
nullable: true
description: Somente itens aceitos e reprocessados.
idempotent_replay:
type: boolean
description: Somente itens aceitos e reprocessados.
rule_matches:
type: array
description: Somente itens aceitos e reprocessados.
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: >-
Regras `TEST` registram a correspondência, mas
não aplicam nenhuma ação.
is_async:
type: boolean
description: >-
`true` quando a correspondência veio 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á ausente ou não é um
array, está vazio ou tem 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 escopo expirou. Somente uma chave expirada recebe
`401`; uma chave ausente ou inválida recebe `403`.
content:
application/json:
examples:
Expired key:
value:
detail: This API key has expired.
'403':
description: >-
Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada
recebe `401`), uma chave com escopo sem `transactions: write`, uma
chave limitada a alguns fluxos ou a sessões aprovadas (essa chave
nunca acessa dados de monitoramento de transações) ou uma requisição
feita de fora da lista de IPs permitidos da chave. Também é
retornado com `code: event_monitoring_disabled` enquanto a ingestão
de eventos estiver desativada para a aplicação; nesse caso, nada é
armazenado, 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 requisições excedido: requisições de escrita (`POST`,
`PATCH`, `DELETE`) compartilham uma cota de 300 requisições por
minuto por chave de API. Aguarde `Retry-After` segundos e tente
novamente.
headers:
Retry-After:
description: Segundos de espera antes de tentar novamente.
schema:
type: integer
minimum: 1
example: 30
content:
application/json:
examples:
Throttled:
value:
detail: >-
Write request rate limit exceeded. You can make up to 300
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. Aliases em
camelCase são aceitos: `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: >-
Seu identificador do evento, único por aplicação. Ele é a chave de
idempotência: reenviar os mesmos `event_category`, `action_type`,
`occurred_at`, `subject.vendor_data` e `payload` com ele é uma
repetição; qualquer diferença é 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
gerenciadas listadas em [Ingestão de
eventos](https://docs.didit.me/pt-br/transaction-monitoring/events)
(por exemplo, `login`, `deposit_completed`, `chargeback_opened`)
habilitam validação tipada e campos de regra gerenciados. Os espaços
em branco no início e no fim são removidos.
example: login
occurred_at:
type: string
format: date-time
description: >-
Quando o evento ocorreu do seu lado, em ISO 8601 (um valor sem
deslocamento de fuso horário é interpretado como UTC). Deve estar no
máximo 7 dias no passado e no máximo 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 é retornado pelos endpoints de leitura.
subject:
type: object
description: >-
O usuário ou a empresa a que o evento pertence. Ele é associado ao
usuário (ou à empresa) com este `vendor_data` na sua aplicação; um
novo é criado quando não existe nenhum.
required:
- vendor_data
properties:
vendor_data:
type: string
minLength: 1
maxLength: 255
description: Seu ID do sujeito.
example: user-42
entity_type:
type: string
maxLength: 32
default: individual
description: >-
`company` resolve o titular como uma empresa; qualquer outro
valor (padrão `individual`) o resolve como uma pessoa física. O
mesmo `vendor_data` pode identificar um de cada.
example: individual
full_name:
type: string
nullable: true
maxLength: 512
description: >-
Nome de exibição, usado apenas quando este evento cria o usuário
ou a empresa.
email:
type: string
format: email
nullable: true
description: Validado como 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: Seu ID da empresa. Filtrável como `business_vendor_data`.
example: merchant-7
session:
type: object
description: O contexto da sua sessão para o evento.
properties:
session_id:
type: string
nullable: true
maxLength: 255
description: >-
Seu identificador de sessão. Filtrável e retornado como
`session_id`.
sequence:
type: integer
nullable: true
description: >-
Posição do evento dentro da sessão. Retornada 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 como enviado e retornado
por `GET /v3/events/{event_uuid}/`. Nesta via de servidor, a Didit
não vê a conexão do usuário final. Por isso, o IP enriquecido e
usado pelas regras é `network_context.ip_address`, exatamente como
você o envia.
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: Seu identificador persistente do dispositivo.
bot_score:
type: integer
description: Pontuação de bot da sua própria detecção, como número inteiro.
network_context:
type: object
additionalProperties: true
properties:
ip_address:
type: string
maxLength: 64
description: >-
Endereço IP do usuário final. Endereços públicos são
enriquecidos uma vez por endereço único.
example: 203.0.113.42
transaction_context:
type: object
description: >-
Contexto monetário. Valores não vazios aqui também atendem às chaves
obrigatórias do payload da ação.
properties:
amount:
type: string
nullable: true
description: Valor como string decimal (um número também é aceito).
example: '1000.00'
currency:
type: string
nullable: true
maxLength: 10
description: Código da moeda.
direction:
type: string
nullable: true
maxLength: 16
description: >-
Direção da movimentação de dinheiro, por exemplo `inbound` ou
`outbound`.
payment_reference_id:
type: string
nullable: true
maxLength: 255
description: >-
Sua referência de pagamento. Filtrável como
`payment_reference_id`.
payload:
type: object
additionalProperties: true
description: >-
Os campos de domínio da categoria, com no máximo 16384 bytes após a
codificação em JSON. Algumas ações exigem chaves (em `payload` ou
`transaction_context`): `gameplay.p2p_settlement` exige `game_id`,
`counterparty_vendor_data`, `stake_amount`, `net_result_amount`,
`role` e um entre `hand_id`, `round_id`, `match_id`;
`gameplay.bet_placed` e `gameplay.bet_settled` exigem `game_id`;
`payment.deposit_initiated`, `payment.deposit_completed`,
`payment.withdrawal_requested` e `payment.withdrawal_completed`
exigem `payment_reference_id`, `amount`, `currency`,
`payment_method`, `status`; `payment.withdrawal_address_changed`
exige `withdrawal_address_hash`; `dispute.chargeback_opened`,
`dispute.chargeback_won` e `dispute.chargeback_lost` exigem
`payment_reference_id` e um entre `dispute_id`, `chargeback_id`;
`session.bot_signal_observed` exige `telemetry_schema_version` e um
entre `bot_score`, `actions_per_minute`, `timing_variance_ms`,
`pointer_entropy`, `keystroke_entropy`, `reaction_time_ms_p50`;
`responsible_gambling.self_exclusion_match` exige `registry_source`,
`exclusion_status`, `identity_match_ref`. Toda ação `security`
terminada em `_changed` exige `changed_field`, além de
`previous_reference_hash` ou `new_reference_hash` quando o campo é
`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 saque
completo, um hash de senha ou um segredo de MFA.
custom_values:
type: object
description: >-
Até 100 chaves próprias, acessíveis nas regras como
`custom_values.`. Os valores devem ser escalares (string,
número, booleano ou null); objetos aninhados e arrays 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: >-
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.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.