> ## 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 sessão da API > Consulte na Didit a cronologia de eventos de uma sessão: passos do dispositivo, alterações de estado e fluxo, do mais recente, com paginação. Prompt da API para listar eventos da sessão Copiar o prompt para a área de transferência 
  \`Read the event timeline of one Didit verification session through the API.

  Endpoint:
  GET [https://verification.didit.me/v3/session/\{session\_id}/events/](https://verification.didit.me/v3/session/\{session_id}/events/)

  Authentication:
  Send my Didit API key in the x-api-key header. A scoped key needs sessions: read and decisions: read.

  Goal:

  * See what happened during a session, step by step: which screens the user saw, where they stopped, which attempts failed, when the status changed and how the workflow routed the session.

  Behavior:

  * Works for user (KYC) and business (KYB) session IDs.
  * Ordered by sent\_at, newest first. sent\_at is a Unix timestamp in milliseconds.
  * Paginated with limit (default 50) and offset. The response is { count, next, previous, results }. Follow next until it is null.
  * Device-reported event types: LINK\_OPENED, STEP\_RENDERED, BUTTON\_CLICKED, FORM\_SUBMITTED, FILE\_UPLOADED, ATTEMPT\_FAILED, LOG. Server-recorded types include SESSION\_CREATED, SESSION\_STATUS\_CHANGED (details.old\_status, details.current\_status), FEATURE\_STEP\_CHANGED, WORKFLOW\_BRANCH\_EVALUATED and WORKFLOW\_STATUS\_NODE\_REACHED.
  * Events are stored asynchronously, so a new event can take a few seconds to appear.
  * file\_url is a short-lived presigned link; a scoped key without media: read receives it as null.

  Example call:
  curl -X GET "[https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50](https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50)" \
  -H "x-api-key: YOUR\_API\_KEY"

  What to read from the response:

  * results\[].event\_type, feature\_step (OCR, LIVENESS, FACE\_MATCH, ...) and step (the screen, for example DOCUMENT\_CAPTURE\_FRONT).
  * results\[].details: event-specific data; the keys vary by event\_type.
  * results\[].ip\_address, user\_agent and device\_info for device-reported events.
  * count, next and previous for pagination.

  Failure modes:

  * 400: limit or offset above 1,000,000.
  * 401: the API key has expired.
  * 403: missing key (a wrong, revoked or expired key gets 401), a key of another application, a scoped key without the permissions above, or a request from outside the key's IP allowlist.
  * 404: the session does not exist, was deleted, or is outside a scoped key's workflow or status limits.

  Side effects: none. This is a pure read.

  For the full integration shape, see /integration/integration-prompt.\`
Colar em Os eventos de encaminhamento do fluxo (`WORKFLOW_BRANCH_EVALUATED`, `WORKFLOW_STATUS_NODE_REACHED`) e os respetivos `details` são descritos em [Obter sessão](https://docs.didit.me/pt/sessions-api/retrieve-session.md), que também pode devolver a cronologia de uma sessão de Verificação de utilizadores (KYC) na respetiva decisão com `?include=events`. ## OpenAPI ````yaml pt/openapi-25.json GET /v3/session/{sessionId}/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/session/{sessionId}/events/: get: tags: - Sessions summary: Listar eventos da sessão description: >- Consulte a cronologia de eventos de uma sessão de verificação, dos mais recentes para os mais antigos por `sent_at`: os ecrãs que o utilizador viu, botões e carregamentos de ficheiros, tentativas falhadas, alterações de estado e de passos de funcionalidades, e o rastreio de encaminhamento do fluxo. Funciona para IDs de sessões de Verificação de utilizadores (KYC) e Verificação de empresas (KYB). Os eventos são armazenados assincronamente, pelo que um novo evento pode demorar alguns segundos a surgir. Os resultados são paginados com `limit` e `offset`; siga `next` até que seja `null`. Uma chave de API com âmbito precisa de `sessions: read` e `decisions: read` e, sem `media: read`, recebe `file_url` como `null`. Os eventos de encaminhamento estão descritos em [Consultar sessão](https://docs.didit.me/pt/sessions-api/retrieve-session). operationId: get_v3_session_events parameters: - name: sessionId in: path required: true description: >- UUID da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão de Verificação de utilizadores (KYC) e de Verificação de empresas (KYB): o servidor resolve o ID em ambos os tipos de sessão. Deve ser um UUID bem formatado; um valor mal formatado não corresponde à rota e retorna um `404` em HTML. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 - name: limit in: query required: false description: >- Número máximo de eventos por página. O valor predefinido é 50. Um valor inferior a 1 ou um valor não numérico reverte para 50; um valor acima de 1,000,000 devolve `400`. schema: type: integer default: 50 minimum: 1 maximum: 1000000 example: 50 - name: offset in: query required: false description: >- Número de resultados a ignorar antes do primeiro devolvido. O valor predefinido é 0; um valor negativo ou não numérico reverte para 0, um valor acima de 1,000,000 devolve `400`. Prefira seguir os URLs `next` e `previous`. schema: type: integer default: 0 minimum: 0 maximum: 1000000 example: 0 - name: ordering in: query required: false description: >- Substituição opcional da ordenação. A ordem predefinida é `-sent_at`. Indique o nome de um campo de resultado (por exemplo `sent_at`, `created_at`, `event_type`, `feature_step` ou `step`) para ordenar ascendentemente, use o prefixo `-` para ordenar descendentemente e separe múltiplos campos com vírgulas. Campos desconhecidos são ignorados. schema: type: string example: sent_at responses: '200': description: Uma página de eventos da sessão, os mais recentes primeiro. content: application/json: schema: type: object required: - count - next - previous - results properties: count: type: integer description: Número total de eventos da sessão. 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/SessionEvent' examples: Completed session: value: count: 3 next: null previous: null results: - uuid: aaaaaaaa-1111-2222-3333-444444444444 event_type: SESSION_STATUS_CHANGED created_at: '2026-09-14T10:02:13.904512Z' component: null feature_step: null step: null details: old_status: In Progress current_status: Approved ip_address: null user_agent: null device_info: null file_url: null sent_at: 1789380131482 - uuid: bbbbbbbb-1111-2222-3333-444444444444 event_type: FEATURE_STEP_CHANGED created_at: '2026-09-14T10:01:49.210377Z' component: null feature_step: null step: null details: old_feature_step: OCR current_feature_step: LIVENESS ip_address: null user_agent: null device_info: null file_url: null sent_at: 1789380107103 - uuid: cccccccc-1111-2222-3333-444444444444 event_type: STEP_RENDERED created_at: '2026-09-14T10:01:00.581930Z' component: DocumentCapture feature_step: OCR step: DOCUMENT_CAPTURE_FRONT details: {} ip_address: 203.0.113.24 user_agent: >- Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1 device_info: device_model: iPhone file_url: null sent_at: 1789380058776 '400': description: >- `limit` ou `offset` é superior a 1,000,000. O corpo é um array JSON com uma mensagem. content: application/json: examples: Limit too large: summary: limit=2000000 value: - limit must not exceed 1000000. Offset too large: summary: offset=2000000 value: - offset must not exceed 1000000. schema: type: array items: type: string '401': description: >- A chave de API com âmbito expirou. Este é o único caso que devolve `401`: uma chave em falta, inválida ou revogada devolve `403`. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Expired key: summary: A data de validade da chave já passou value: detail: This API key has expired. '403': description: >- Falha de autenticação ou autorização. Uma chave em falta devolve `403`, assim como uma chave de outra aplicação, uma chave com âmbito restrito sem a permissão que este endpoint requer e um pedido proveniente de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada devolve `401`. Distinga-as através de `detail`. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Missing or invalid credentials: summary: Sem cabeçalho x-api-key ou a chave falhou a validação value: detail: >- Authentication credentials were not provided or are invalid. Other application: summary: >- Uma chave válida que pertence a uma aplicação diferente da sessão value: detail: You do not have permission to perform this action. Scoped key without sessions read: summary: 'Chave com âmbito não tem sessions: read' value: detail: This API key has no read access to sessions. Scoped key without decisions read: summary: 'Chave com âmbito não tem decisions: read' value: detail: This API key has no read access to decisions. IP not allowed: summary: >- Pedido proveniente de fora da lista de permissões de IP da chave value: detail: This API key can't be used from this IP address. '404': description: >- A sessão não existe, foi eliminada ou está fora dos limites de fluxo ou limites que permitem apenas sessões aprovadas de uma chave com âmbito restrito. A pesquisa da sessão é executada antes da verificação de credenciais, pelo que um `sessionId` desconhecido devolve `404` mesmo sem uma chave válida. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Unknown session: summary: Não existe nenhuma sessão com este ID ou foi eliminada value: detail: Not found. Outside key limits: summary: >- A sessão está fora dos limites de fluxo ou dos limites que permitem apenas sessões aprovadas de uma chave com âmbito restrito value: detail: Session not found. '429': description: >- Limite de pedidos excedido: 600 pedidos GET por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram o orçamento disponível. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Rate limited: summary: Orçamento esgotado para o minuto atual value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. headers: Retry-After: description: Segundos a aguardar antes de tentar novamente. schema: type: integer minimum: 1 example: 30 security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?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.sessions.list_events( "11111111-2222-3333-4444-555555555555", ): 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.sessions.listEvents("11111111-2222-3333-4444-555555555555")) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListEventsAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsListEventsParams{})\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.sessions().listEvents("11111111-2222-3333-4444-555555555555")) { System.out.println(item); } - lang: php label: PHP source: >- sessions->listEvents('11111111-2222-3333-4444-555555555555') as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.sessions.list_events("11111111-2222-3333-4444-555555555555").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.Sessions.ListEventsAsync("11111111-2222-3333-4444-555555555555")) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: SessionEvent: type: object description: Uma entrada da cronologia de eventos de uma sessão de verificação. required: - uuid - event_type - created_at - component - feature_step - step - details - ip_address - user_agent - device_info - file_url - sent_at properties: uuid: type: string format: uuid description: Identificador do evento. event_type: type: string enum: - SESSION_CREATED - SESSION_COMPLETED - SESSION_STATUS_CHANGED - LINK_OPENED - FORM_SUBMITTED - BUTTON_CLICKED - FILE_UPLOADED - ATTEMPT_FAILED - FEATURE_STEP_CHANGED - STEP_RENDERED - NOTE_ADDED - MANUAL_REVIEW_STARTED - WORKFLOW_BRANCH_EVALUATED - WORKFLOW_STATUS_NODE_REACHED - LOG description: >- O que aconteceu. Comunicado pelo dispositivo durante o fluxo alojado ou SDK: `LINK_OPENED`, `STEP_RENDERED`, `BUTTON_CLICKED`, `FORM_SUBMITTED`, `FILE_UPLOADED`, `ATTEMPT_FAILED` e `LOG` (depuração). Registado pelo servidor: `SESSION_CREATED`, `SESSION_STATUS_CHANGED` (`details.old_status`, `details.current_status`), `FEATURE_STEP_CHANGED` (`details.old_feature_step`, `details.current_feature_step`), `WORKFLOW_BRANCH_EVALUATED` e `WORKFLOW_STATUS_NODE_REACHED` (o rastreio de encaminhamento do fluxo). `SESSION_COMPLETED`, `NOTE_ADDED` e `MANUAL_REVIEW_STARTED` podem aparecer em sessões mais antigas. created_at: type: string format: date-time description: >- Quando a Didit armazenou o evento. Os eventos são armazenados de forma assíncrona, alguns segundos após `sent_at`. component: type: string nullable: true description: >- Componente de UI que reportou o evento (apenas eventos de dispositivo). feature_step: type: string nullable: true enum: - OCR - OCR_BACK - NFC - AML - FACE - LIVENESS - FACE_MATCH - IP_ANALYSIS - AGE_ESTIMATION - PROOF_OF_ADDRESS - PHONE_VERIFICATION - EMAIL_VERIFICATION - FACE_SEARCH - DATABASE_VALIDATION - QUESTIONNAIRE - KYB_REGISTRY - KYB_DOCUMENTS - KYB_KEY_PEOPLE - DOCUMENT_AI - GEOLOCATION - null description: >- Funcionalidade de verificação em que a sessão se encontrava quando o evento ocorreu. step: type: string nullable: true description: >- Ecrã dentro da funcionalidade, por exemplo `DOCUMENT_CAPTURE_FRONT` ou `FACE_PASSIVE_LIVENESS`. details: type: object nullable: true additionalProperties: true description: Dados específicos do evento. As chaves dependem de `event_type`. ip_address: type: string nullable: true description: >- Endereço IP a partir do qual o dispositivo reportou o evento. `null` para eventos registados no servidor. user_agent: type: string nullable: true description: >- Agente do utilizador do dispositivo. `null` para eventos registados pelo servidor. device_info: type: object nullable: true additionalProperties: true description: Detalhes do dispositivo que o SDK ou navegador comunicou. file_url: type: string format: uri nullable: true description: >- Ligação pré-assinada de curta duração para um ficheiro anexado ao evento (por exemplo, uma imagem capturada). `null` quando não existir nenhum, e sempre `null` para uma chave de API com âmbito restrito sem `media: read`. sent_at: type: integer format: int64 description: >- Quando o evento aconteceu, como um carimbo de data/hora Unix em milissegundos. Os resultados são ordenados por este campo. 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.