> ## 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. # Listar Eventos de Monitorização API > Liste eventos de monitorização da Didit com filtros de categoria, estado, dispositivo, IP e período, do mais recente ao mais antigo. Prompt da API para listar eventos de monitorização Copiar o prompt para a área de transferência 
  \`List and filter the monitoring events (logins, sessions, gameplay, bonuses, payments, disputes, security changes) stored for my Didit application.

  Endpoint:
  GET [https://verification.didit.me/v3/events/](https://verification.didit.me/v3/events/)

  Authentication:
  Use the x-api-key header with my Didit API key. A scoped key needs transactions: read.

  Goal:

  * Search events for a back-office screen, an export job or an investigation: for example every payment and dispute event a rule matched last week, or every event from one device fingerprint or IP address.

  Behavior:

  * Newest occurred\_at first. Paginated with limit (default 50) and offset; follow next until it is null.
  * count is exact up to 100 and capped at 100 above that, so never use it to compute the number of pages.
  * Every filter is optional and filters combine with AND. Multi-value filters repeat the parameter (?event\_category=payment\&event\_category=dispute) and match any of the values.
  * Filters: event\_category, action\_type, status, retention\_class (multi-value); subject\_vendor\_data, subject\_entity\_type (company for a company, any other value for an individual), business\_vendor\_data, session\_id, device\_fingerprint, ip\_address, game\_id, round\_id, affiliate\_code, payment\_reference\_id, counterparty\_vendor\_data (exact match); matched\_only=true; occurred\_from and occurred\_to (inclusive; ISO 8601 with Z or an offset whose + is sent as %2B, for example 2026-10-17T09:00:00Z, or a date alone, which means 00:00 UTC of that day); search (case-insensitive substring of event\_id, action\_type, subject\_vendor\_data or counterparty\_vendor\_data).
  * Each result is a summary. Call GET /v3/events/{event_uuid}/ for the payload, device context, IP enrichment and rule evidence.
  * For one subject, prefer GET /v3/events/subjects/{vendor_data}/, which keeps an individual and a company with the same vendor\_data apart.
  * Reads work whether or not event ingestion is switched on.

  Example call:
  curl -X GET "[https://verification.didit.me/v3/events/?event\_category=payment\&event\_category=dispute\&matched\_only=true\&limit=50](https://verification.didit.me/v3/events/?event_category=payment\&event_category=dispute\&matched_only=true\&limit=50)" \
  -H "x-api-key: YOUR\_API\_KEY"

  What to read from the response:

  * results\[].event\_uuid - Didit id of the event; use it as {event_uuid} in the detail and delete calls.
  * results\[].event\_id - your own id (the idempotency key you sent).
  * results\[].event\_category, action\_type, occurred\_at, received\_at.
  * results\[].status (ACCEPTED, APPROVED, IN\_REVIEW, DECLINED) and score.
  * results\[].rules\_matched\_count and correlation\_pending (true while an asynchronous rule still has to run).
  * results\[].ip\_country, device\_fingerprint, session\_id, amount, currency, payment\_reference\_id.
  * results\[].is\_droppable - whether an SDK under backpressure may drop events of this kind.
  * next - URL of the next page, or null.

  Failure modes:

  * 400 - limit or offset larger than 1000000.
  * 401 - the API key has expired.
  * 403 - missing API key (a wrong, revoked or expired key gets 401), a scoped key without transactions: read, or a request from outside the key's IP list.
  * 429 - more than 600 reads per minute for this API key; honor Retry-After.

  Side effects: none. This is a pure read.

  For the full integration shape, see /integration/integration-prompt.\`
Colar em Os eventos são organizados em [classes de conservação](https://docs.didit.me/pt/transaction-monitoring/events.md#retenção), pelo que um evento que ultrapasse o fim da sua classe deixa de aparecer aqui. Consulte [Ingestão de eventos](https://docs.didit.me/pt/transaction-monitoring/events.md#consultar-eventos) para a referência dos filtros e [Regras sobre eventos](https://docs.didit.me/pt/transaction-monitoring/event-rules.md) para saber o que faz variar `rules_matched_count`. ## OpenAPI ````yaml pt/openapi-25.json GET /v3/events/ 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/: get: tags: - Monitoring Events summary: Listar eventos de monitorização description: >- Listar os eventos de monitorização armazenados para a sua aplicação, do `occurred_at` mais recente para o mais antigo, com filtros opcionais que são combinados com AND. Os filtros multivalor (`event_category`, `action_type`, `status`, `retention_class`) repetem o parâmetro e correspondem a qualquer um dos valores; os restantes filtros são correspondências exatas, e valores desconhecidos simplesmente não devolvem eventos. Cada resultado é um resumo: chame `GET /v3/events/{event_uuid}/` para obter o payload, o contexto do dispositivo, o enriquecimento de IP e a evidência da regra, e dê preferência a `GET /v3/events/subjects/{vendor_data}/` para o histórico de um sujeito. As leituras funcionam quer a ingestão de eventos esteja ativada quer não. Uma chave de API com âmbito restrito necessita de `transactions: read`. Consulte [Ingestão de eventos](https://docs.didit.me/pt/transaction-monitoring/events). operationId: list_monitoring_events parameters: - name: limit in: query required: false description: >- Número máximo de eventos por página. O valor predefinido é 50. Valores acima de 1000000 devolvem `400`; um valor não numérico, zero ou negativo reverte para 50. schema: type: integer default: 50 minimum: 1 maximum: 1000000 example: 50 - name: offset in: query required: false description: >- Número de eventos a ignorar. A predefinição é 0. É preferível seguir o URL `next` da resposta. schema: type: integer maximum: 1000000 minimum: 0 default: 0 example: 0 - name: event_category in: query required: false description: >- Apenas eventos nestas categorias. Repita o parâmetro para vários valores (`?event_category=payment&event_category=dispute`); é devolvido qualquer evento que corresponda a qualquer um deles. style: form explode: true schema: type: array items: type: string enum: - auth - session - gameplay - bonus - affiliate - payment - dispute - security - responsible_gambling - custom example: - payment - dispute - name: action_type in: query required: false description: >- Apenas eventos com estes tipos de ação (exatos, sensíveis a maiúsculas e minúsculas). Repita para vários valores. style: form explode: true schema: type: array items: type: string example: - deposit_completed - chargeback_opened - name: status in: query required: false description: Apenas eventos com estes estados. Repita para vários valores. style: form explode: true schema: type: array items: type: string enum: - ACCEPTED - APPROVED - IN_REVIEW - DECLINED example: - IN_REVIEW - DECLINED - name: retention_class in: query required: false description: >- Apenas eventos nestas classes de conservação. Repita para vários valores. style: form explode: true schema: type: array items: type: string enum: - low_value - standard - risk_relevant - monetary_or_compliance example: - risk_relevant - name: subject_vendor_data in: query required: false description: >- Correspondência exata no `vendor_data` do sujeito. O mesmo ID pode nomear um indivíduo e uma empresa; adicione `subject_entity_type` para escolher um, ou utilize `GET /v3/events/subjects/{vendor_data}/`. schema: type: string example: user-42 - name: subject_entity_type in: query required: false description: >- `company` devolve apenas eventos de sujeitos do tipo empresa; qualquer outro valor não vazio (por exemplo `individual`) devolve apenas eventos de indivíduos. Omita-o para devolver ambos. schema: type: string enum: - individual - company example: individual - name: business_vendor_data in: query required: false description: >- Correspondência exata no `business.vendor_data` enviado com o evento. schema: type: string example: merchant-7 - name: session_id in: query required: false description: Correspondência exata em `session.session_id`. schema: type: string example: web-session-abc - name: device_fingerprint in: query required: false description: Correspondência exata em `device_context.fingerprint`. schema: type: string example: fp-a8c1 - name: ip_address in: query required: false description: Correspondência exata no endereço IP do evento. schema: type: string example: 203.0.113.42 - name: game_id in: query required: false description: Correspondência exata no `game_id` promovido. schema: type: string example: poker-holdem-01 - name: round_id in: query required: false description: Correspondência exata no `round_id` promovido. schema: type: string example: round-88231 - name: affiliate_code in: query required: false description: Correspondência exata no `affiliate_code` promovido. schema: type: string example: aff-summer - name: payment_reference_id in: query required: false description: >- Correspondência exata na referência de pagamento (de `transaction_context.payment_reference_id` ou `payload.payment_reference_id`). schema: type: string example: dep_735 - name: counterparty_vendor_data in: query required: false description: Correspondência exata no `counterparty_vendor_data` promovido. schema: type: string example: user-77 - name: matched_only in: query required: false description: >- `true` (também `1` ou `yes`, não sensível a maiúsculas/minúsculas) devolve apenas eventos correspondidos por pelo menos uma regra (`rules_matched_count` superior a 0). Qualquer outro valor é ignorado. schema: type: boolean default: false example: true - name: occurred_from in: query required: false description: >- Apenas eventos com `occurred_at` neste instante ou após o mesmo (inclusive). Envie um valor ISO 8601: `2026-10-01T00:00:00Z`, um deslocamento explícito com o `+` codificado por percentagem (`2026-10-01T02:00:00%2B02:00`; um `+` não codificado é descodificado como um espaço e o valor deixa de ser analisado), ou apenas uma data (`2026-10-01`), o que significa 00:00:00 UTC desse dia. Um valor sem deslocamento é lido como UTC. Valores em qualquer outro formato não são aceites. schema: type: string format: date-time example: '2026-10-01T00:00:00Z' - name: occurred_to in: query required: false description: >- Apenas eventos com `occurred_at` neste instante ou antes do mesmo (inclusive). Uma data por si só significa o início desse dia, pelo que `occurred_to=2026-10-15` exclui o resto de 15 de outubro; envie `2026-10-15T23:59:59Z` para o incluir. Envie um valor ISO 8601: `2026-10-01T00:00:00Z`, um deslocamento explícito com o `+` codificado por percentagem (`2026-10-01T02:00:00%2B02:00`; um `+` não codificado é descodificado como um espaço e o valor deixa de ser analisado), ou apenas uma data (`2026-10-01`), o que significa 00:00:00 UTC desse dia. Um valor sem deslocamento é lido como UTC. Valores em qualquer outro formato não são aceites. schema: type: string format: date-time example: '2026-10-17T23:59:59Z' - name: search in: query required: false description: >- Correspondência de subcadeia sem distinção entre maiúsculas e minúsculas em `event_id`, `action_type`, `subject_vendor_data` ou `counterparty_vendor_data`. schema: type: string example: chargeback responses: '200': description: Uma página de resumos de eventos. content: application/json: schema: $ref: '#/components/schemas/MonitoringEventPage' examples: Payment and dispute events: value: count: 2 next: null previous: null results: - event_uuid: 11111111-2222-3333-4444-555555555555 event_id: chargeback-2026-10-16-000318 event_category: dispute action_type: chargeback_opened occurred_at: '2026-10-16T14:02:11Z' received_at: '2026-10-16T14:02:12.418230Z' status: IN_REVIEW score: 60 subject_vendor_data: user-42 subject_entity_type: individual subject_uuid: 66666666-7777-8888-9999-000000000000 counterparty_vendor_data: null session_id: null device_fingerprint: null ip_address: null ip_country: null amount: '250.000000000000000000' currency: EUR game_id: null round_id: null bonus_id: null affiliate_code: null payment_reference_id: dep_735 retention_class: monetary_or_compliance rules_matched_count: 1 correlation_pending: false is_droppable: false - event_uuid: 22222222-3333-4444-5555-666666666666 event_id: login-2026-10-15-000912 event_category: auth action_type: login occurred_at: '2026-10-15T08:30:00.120000Z' received_at: '2026-10-15T08:30:00.734512Z' status: ACCEPTED score: 0 subject_vendor_data: user-42 subject_entity_type: individual subject_uuid: 66666666-7777-8888-9999-000000000000 counterparty_vendor_data: null session_id: web-session-abc device_fingerprint: fp-a8c1 ip_address: 203.0.113.42 ip_country: ES amount: null currency: null game_id: null round_id: null bonus_id: null affiliate_code: null payment_reference_id: null retention_class: standard rules_matched_count: 0 correlation_pending: false is_droppable: true '400': description: >- `limit` ou `offset` é superior a 1000000. O corpo é um array JSON com uma mensagem. Um `limit` não numérico ou não positivo reverte para o valor padrão de 50 em vez de falhar. content: application/json: examples: limit too large: summary: limit superior a 1000000 value: - limit must not exceed 1000000. offset too large: summary: offset superior a 1000000 value: - offset must not exceed 1000000. '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: read`, 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. content: application/json: examples: 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 read 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: os pedidos `GET` partilham um orçamento de 600 pedidos por minuto por chave de API. Aguarde `Retry-After` segundos e, em seguida, tente novamente. headers: Retry-After: description: Segundos a aguardar antes de tentar novamente. schema: type: integer minimum: 1 example: 30 content: application/json: examples: Throttled: value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/events/?event_category=payment&event_category=dispute&matched_only=true&occurred_from=2026-10-01T00:00:00Z&limit=50' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.monitoring_events.list(): print(item) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.monitoringEvents.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.MonitoringEvents.ListAutoPaging(ctx, didit.MonitoringEventsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.monitoringEvents().list()) { System.out.println(item); } - lang: php label: PHP source: |- monitoringEvents->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.monitoring_events.list.auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.MonitoringEvents.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: MonitoringEventPage: type: object description: >- Uma página de eventos de monitorização, os eventos com o `occurred_at` mais recente primeiro. required: - count - next - previous - results properties: count: type: integer description: >- Número de eventos correspondentes, exato até 100 e limitado a 100 acima disso. Não calcule contagens de páginas a partir dele; siga `next` até ser null. next: type: string format: uri nullable: true description: URL da página seguinte, ou null na última página. previous: type: string format: uri nullable: true description: URL da página anterior, ou null na primeira página. results: type: array items: $ref: '#/components/schemas/MonitoringEvent' MonitoringEvent: type: object description: >- Um evento de monitorização armazenado, conforme devolvido pelos endpoints de lista e de linha temporal do titular. As evidências restritas (payload, contexto do dispositivo, evidências de regras) só são devolvidas por `GET /v3/events/{event_uuid}/`. required: - event_uuid - event_id - event_category - action_type - occurred_at - received_at - status - score - subject_vendor_data - subject_entity_type - subject_uuid - counterparty_vendor_data - session_id - device_fingerprint - ip_address - ip_country - amount - currency - game_id - round_id - bonus_id - affiliate_code - payment_reference_id - retention_class - rules_matched_count - correlation_pending - is_droppable properties: event_uuid: type: string format: uuid description: >- Identificador Didit do evento. Utilize-o como `{event_uuid}` nas chamadas de obtenção e eliminação. event_id: type: string maxLength: 128 description: O seu próprio identificador, a chave de idempotência que enviou. event_category: type: string enum: - auth - session - gameplay - bonus - affiliate - payment - dispute - security - responsible_gambling - custom description: Categoria do evento. action_type: type: string maxLength: 128 description: O que aconteceu dentro da categoria, tal como enviou. occurred_at: type: string format: date-time description: Quando o evento aconteceu do seu lado. received_at: type: string format: date-time description: Quando a Didit aceitou o evento. status: type: string enum: - ACCEPTED - APPROVED - IN_REVIEW - DECLINED description: >- `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. score: type: integer description: >- 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: type: string maxLength: 255 description: >- `subject.vendor_data` do evento: o seu ID para o utilizador ou empresa. subject_entity_type: type: string description: >- `individual` ou `company`: que tipo de sujeito é indicado por `subject_vendor_data`. example: individual subject_uuid: type: string format: uuid nullable: true description: >- 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: type: string nullable: true description: >- O outro interveniente de um evento P2P (promovido a partir de `payload.counterparty_vendor_data`). maxLength: 255 session_id: type: string nullable: true description: '`session.session_id` enviado com o evento.' maxLength: 255 device_fingerprint: type: string nullable: true description: '`device_context.fingerprint` enviado com o evento.' maxLength: 255 ip_address: type: string nullable: true description: >- 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. maxLength: 64 ip_country: type: string nullable: true description: >- 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). example: ES amount: type: string nullable: true description: >- Montante como uma string decimal com 18 casas decimais, a partir de `transaction_context.amount`, `payload.amount` ou `payload.stake_amount`, por essa ordem. example: '250.000000000000000000' currency: type: string nullable: true description: Moeda de `transaction_context.currency` ou `payload.currency`. maxLength: 10 game_id: type: string nullable: true description: Promovido a partir de `payload.game_id`. maxLength: 128 round_id: type: string nullable: true description: Promovido a partir de `payload.round_id`. maxLength: 128 bonus_id: type: string nullable: true description: Promovido a partir de `payload.bonus_id`. maxLength: 128 affiliate_code: type: string nullable: true description: Promovido a partir de `payload.affiliate_code`. maxLength: 128 payment_reference_id: type: string nullable: true description: >- Referência de pagamento de `transaction_context.payment_reference_id` ou `payload.payment_reference_id`. maxLength: 255 retention_class: type: string enum: - low_value - standard - risk_relevant - monetary_or_compliance description: >- 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). rules_matched_count: type: integer minimum: 0 description: >- Número de regras que corresponderam ao evento, incluindo regras em modo `TEST` (que registam provas mas não aplicam ações). correlation_pending: type: boolean description: >- `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: type: boolean description: >- 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`. 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.