> ## 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 revisões de sessões API: registo de auditoria KYC

> Obtenha todas as notas de revisão manual e alterações de estado de uma sessão Didit. Registo de auditoria KYC, pago por chamada, sem contratos.



Prompt para listar revisões da sessão
        Copiar o prompt para a área de transferência



      
      

\<pre>

\``Goal: Fetch the full review/activity feed for a Didit verification session — manual comments, status changes, KYC/KYB edits, file uploads, AML events, tags. Mirrors the timeline shown on the Console session-detail page.

Endpoint: GET https://verification.didit.me/v3/sessions/{session_id}/reviews/
Auth header: x-api-key: YOUR_API_KEY

Path param:
\- session_id (UUID, REQUIRED) — verification session UUID. Cross-application reads return 404.

curl:
curl -s 'https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/' \
-H "x-api-key: $DIDIT_API_KEY"

Response 200: JSON ARRAY (no envelope, no pagination — feed is bounded). Newest first. Each entry (ReviewItem) has:
\- uuid (UUID)
\- activity_type: "COMMENT" | "STATUS_UPDATED" | "KYC_DATA_UPDATED" | "POA_DATA_UPDATED" | "FILE_ADDED" | "FILE_REMOVED" | "AML_ONGOING_MATCH" | "AML_STATUS_UPDATED" | "AML_HIT_STATUS_UPDATED" | "KYB_DATA_UPDATED" | "KYB_DOCUMENT_UPLOADED" | "TAG_ADDED" | "TAG_REMOVED"
\- actor_email, actor_display, actor_type: "API_KEY" | "CONSOLE_USER" | "SYSTEM"
\- new_status, previous_status — only populated for STATUS_UPDATED/AML_STATUS_UPDATED. Values from the SESSION status enum: "Not Started" | "In Progress" | "Awaiting User" | "In Review" | "Approved" | "Declined" | "Resubmitted" | "Expired" | "Kyc Expired" | "Abandoned".
\- comment (string | null)
\- mentioned_emails (string[]) — extracted @mentions, only for COMMENT activities
\- previous_value, new_value, changed_fields — diff payload for *_DATA_UPDATED, FILE_*, TAG_* (opaque JSON, shape varies per activity_type)
\- metadata (object | null)
\- created_at (ISO 8601 UTC)
Empty array means the session has had no recorded activity yet.

When to use:
\- Render an audit trail mirror on your own dashboard.
\- Export the feed for compliance archives.
\- Poll for manual-review decisions when you can't consume webhooks (filter activity_type === "STATUS_UPDATED"; inspect new_status). Webhooks are still preferred — see /integration/webhooks.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing/invalid `x-api-key` header. Re-fetch your application API key from the Auth API if needed.
\- 403 — API key valid but the application is not allowed (revoked, expired, or wrong app).
\- 404 — session UUID does not exist, has been deleted, or belongs to a different application.
\- 429 — rate-limited. Inspect Retry-After.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.``

\</pre>



      
      

Colar em



## OpenAPI

````yaml pt/openapi-25.json GET /v3/sessions/{session_id}/reviews/
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/sessions/{session_id}/reviews/:
    get:
      tags:
        - Sessions
      summary: Listar revisões da sessão e registo de atividade
      description: >-
        Retorna o registo de auditoria / feed de atividade de uma sessão de
        Verificação de utilizadores (KYC), da mais recente para a mais antiga,
        num invólucro paginado (`count` / `next` / `previous` / `results`, 50
        entradas por página por predefinição).


        As entradas do feed são registadas por todos os intervenientes que
        interagem com a sessão: decisões manuais tomadas através de `PATCH
        /v3/session/{session_id}/update-status/` (que regista `previous_status`
        → `new_status`), atividade do revisor na Console (comentários com
        menções `@email`, edições de dados de KYC/POA, carregamentos/remoções de
        ficheiros, alterações de etiquetas, visualizações da página de
        detalhes), correspondências de monitorização contínua de AML e notas
        adicionadas via `POST` neste mesmo caminho. A leitura deste feed é o
        equivalente do lado da API ao painel **Activity** na vista de sessão da
        Didit Console.


        Apenas sessões de Verificação de utilizadores (KYC) podem ser
        consultadas aqui; os IDs de sessão de Verificação de empresas (KYB)
        retornam `404`.
      operationId: list_session_reviews
      parameters:
        - name: session_id
          in: path
          required: true
          description: >-
            UUID da sessão de Verificação de utilizadores (KYC). Tem de
            pertencer à mesma aplicação da chave de API — UUIDs entre
            aplicações, sessões eliminadas e IDs de sessões de Verificação de
            empresas (KYB) devolvem todos `404`.
          schema:
            type: string
            format: uuid
            example: 8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d
        - name: limit
          in: query
          required: false
          description: Tamanho da página. A predefinição é `50`.
          schema:
            type: integer
            default: 50
            example: 50
        - name: offset
          in: query
          required: false
          description: >-
            Número de entradas a ignorar desde o início do feed (ordenado). O
            valor predefinido é `0`. Os URLs `next` / `previous` na resposta
            contêm os valores corretos para percorrer o feed.
          schema:
            type: integer
            default: 0
            example: 0
        - name: ordering
          in: query
          required: false
          description: >-
            Ordem de ordenação. O feed tem como predefinição os mais recentes
            primeiro (`-created_at`); passe `created_at` para o ler do mais
            antigo para o mais recente. Os valores desconhecidos são ignorados
            silenciosamente (a ordem predefinida é utilizada); outros nomes de
            campos do serializador também são aceites.
          schema:
            type: string
            default: '-created_at'
            example: created_at
      responses:
        '200':
          description: >-
            Fluxo de atividade paginado, o mais recente primeiro por
            predefinição. `count` é o número total de entradas; `next` /
            `previous` são URLs de página prontos a usar (`null` nas
            extremidades). Um `count` de `0` com `results` vazio significa que
            ainda não foi registada qualquer atividade.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Número total de entradas de feed para esta sessão (em
                      todas as páginas).
                    example: 3
                  next:
                    type: string
                    nullable: true
                    description: URL da página seguinte, ou `null` na última página.
                    example: null
                  previous:
                    type: string
                    nullable: true
                    description: URL da página anterior, ou `null` na primeira página.
                    example: null
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReviewItem'
                    description: Entradas de feed para esta página.
              examples:
                DecisionTrail:
                  summary: Aprovação manual e notas adicionadas pela API
                  value:
                    count: 3
                    next: null
                    previous: null
                    results:
                      - uuid: de0561bc-5583-4409-9171-1a31a4c8a5f4
                        activity_type: STATUS_UPDATED
                        actor_display: API Client
                        actor_email: null
                        actor_type: API_KEY
                        new_status: Approved
                        previous_status: In Review
                        comment: Document re-checked manually; address matches.
                        mentioned_emails: []
                        previous_value:
                          status: In Review
                        new_value:
                          status: Approved
                        changed_fields:
                          - status
                        metadata: null
                        created_at: '2026-06-12T00:19:31.918735Z'
                      - uuid: 35370f58-5098-44ee-8a06-8c9af80b2455
                        activity_type: STATUS_UPDATED
                        actor_display: Unknown
                        actor_email: null
                        actor_type: CONSOLE_USER
                        new_status: null
                        previous_status: null
                        comment: Note without status.
                        mentioned_emails: []
                        previous_value: null
                        new_value: null
                        changed_fields: []
                        metadata: null
                        created_at: '2026-06-12T00:18:44.504157Z'
                      - uuid: 00338f82-f1c5-4f57-8614-c49bb258af1a
                        activity_type: STATUS_UPDATED
                        actor_display: Unknown
                        actor_email: null
                        actor_type: CONSOLE_USER
                        new_status: In Review
                        previous_status: null
                        comment: Flagging for manual document re-check.
                        mentioned_emails: []
                        previous_value: null
                        new_value: null
                        changed_fields: []
                        metadata: null
                        created_at: '2026-06-12T00:18:44.466537Z'
                PaginatedFirstPage:
                  summary: >-
                    Primeira página com limit=2 — a seguinte contém o URL de
                    seguimento
                  value:
                    count: 4
                    next: >-
                      https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/?limit=2&offset=2
                    previous: null
                    results:
                      - uuid: de0561bc-5583-4409-9171-1a31a4c8a5f4
                        activity_type: STATUS_UPDATED
                        actor_display: API Client
                        actor_email: null
                        actor_type: API_KEY
                        new_status: Approved
                        previous_status: In Review
                        comment: Document re-checked manually; address matches.
                        mentioned_emails: []
                        previous_value:
                          status: In Review
                        new_value:
                          status: Approved
                        changed_fields:
                          - status
                        metadata: null
                        created_at: '2026-06-12T00:19:31.918735Z'
                      - uuid: bd4e6227-bdd2-42b2-a726-1d12f785a457
                        activity_type: STATUS_UPDATED
                        actor_display: Unknown
                        actor_email: null
                        actor_type: CONSOLE_USER
                        new_status: null
                        previous_status: null
                        comment: null
                        mentioned_emails: []
                        previous_value: null
                        new_value: null
                        changed_fields: []
                        metadata: null
                        created_at: '2026-06-12T00:18:44.540238Z'
                Empty:
                  summary: Sessão ainda sem atividade registada
                  value:
                    count: 0
                    next: null
                    previous: null
                    results: []
        '403':
          description: >-
            `x-api-key` em falta, malformado, expirado ou revogado. A
            autenticação é verificada antes da pesquisa da sessão, pelo que uma
            chave em falta devolve `403` mesmo quando o UUID da sessão não
            existe.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: You do not have permission to perform this action.
              examples:
                InvalidKey:
                  summary: Cabeçalho x-api-key em falta ou inválido
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Nenhuma sessão de Verificação de utilizadores (KYC) com este UUID
            está visível para a sua aplicação: o UUID não existe, a sessão foi
            eliminada ou pertence a uma aplicação diferente. Os IDs de sessão de
            Verificação de empresas (KYB) também devolvem `404` aqui — o feed de
            revisões só pode ser acedido para sessões de KYC.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Session not found.
              examples:
                NotFound:
                  summary: UUID de sessão desconhecido, eliminado ou de outra aplicação
                  value:
                    detail: Session not found.
        '429':
          description: >-
            Limite de pedidos excedido. Inspecione os cabeçalhos de resposta
            `Retry-After` e `X-RateLimit-*`. Consulte [Limite de
            pedidos](/pt/integration/rate-limiting).
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -s
            'https://verification.didit.me/v3/sessions/8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d/reviews/?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.reviews.list(
                "8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d",
            ):
                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.reviews.list("8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d"))
            {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.Reviews.ListAutoPaging(ctx, \"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d\", didit.SessionsReviewsListParams{})\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().reviews().list("8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d"))
            {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            foreach
            ($didit->sessions->reviews->list('8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d')
            as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.sessions.reviews.list("8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d").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.Reviews.ListAsync("8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d"))

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    ReviewItem:
      type: object
      description: >-
        Uma entrada no feed de atividade/revisão de uma sessão. As alterações de
        estado incluem `previous_status`, `new_status`, `previous_value`,
        `new_value` e `changed_fields`; os comentários incluem `comment` e (para
        comentários da consola) `mentioned_emails`; os restantes campos são
        `null` ou vazios quando não se aplicam ao tipo de atividade.
      properties:
        uuid:
          type: string
          format: uuid
          description: Identificador único desta entrada de feed.
          example: de0561bc-5583-4409-9171-1a31a4c8a5f4
        activity_type:
          type: string
          enum:
            - COMMENT
            - STATUS_UPDATED
            - KYC_DATA_UPDATED
            - POA_DATA_UPDATED
            - FILE_ADDED
            - FILE_REMOVED
            - AML_ONGOING_MATCH
            - AML_STATUS_UPDATED
            - AML_HIT_STATUS_UPDATED
            - KYB_DATA_UPDATED
            - KYB_DOCUMENT_UPLOADED
            - TAG_ADDED
            - TAG_REMOVED
            - FEATURE_OVERRIDE_PENDING
            - FEATURE_OVERRIDE_APPLIED
            - FEATURE_OVERRIDE_CANCELLED
          description: >-
            Que tipo de atividade este registo guarda. As linhas
            `STATUS_UPDATED` provêm de decisões manuais (`PATCH
            /v3/session/{session_id}/update-status/`) e de registos adicionados
            via `POST …/reviews/` (cujo padrão é este tipo, mesmo quando nenhum
            estado é registado). As linhas `COMMENT` provêm de revisores da
            Console; as visualizações da página de detalhes na Console também
            são armazenadas como linhas `COMMENT` sinalizadas com
            `metadata.system_event = "DETAIL_VIEWED"`. Os restantes tipos
            acompanham edições de dados, alterações de ficheiros, etiquetas e
            atividade de monitorização AML. As linhas STATUS_UPDATED também são
            escritas por agentes do sistema (por exemplo, monitorização AML
            contínua com actor_type SYSTEM e atualizações automáticas de estado
            de funcionalidades), não apenas pelo endpoint update-status e
            publicações de revisão manual. `FEATURE_OVERRIDE_PENDING`,
            `FEATURE_OVERRIDE_APPLIED` e `FEATURE_OVERRIDE_CANCELLED` registam a
            sobreposição do estado de uma verificação (`PATCH
            /v3/session/{session_id}/features/{node_id}/update-status/`):
            solicitada para aguardar a conclusão do fluxo, aplicada ou
            cancelada. Estas transmitem o estado da verificação em
            `previous_value` / `new_value` (`{"status": ...}`), mantêm
            `previous_status` e `new_status` como `null`, e indicam a
            sobreposição em `metadata` (`feature_override_id`, `node_id`,
            `feature_model`, `forced`, `state`, `cancel_reason`). O registo do
            pedido inclui o `comment` do revisor; uma sobreposição aplicada
            quando o fluxo termina é registada com `actor_type` `SYSTEM`.
          example: STATUS_UPDATED
        actor_display:
          type: string
          description: >-
            Rótulo de autor legível, resolvido pela seguinte ordem: nome
            completo do interveniente → identificador de conta da Console →
            parte local de `actor_email` → `"API Client"` (para intervenientes
            `API_KEY`) → `"System"` (para intervenientes `SYSTEM`) →
            `"Unknown"`. As entradas criadas através de `POST …/reviews/`
            apresentam sempre `"Unknown"` porque esse endpoint não regista a
            atribuição de interveniente.
          example: API Client
        actor_email:
          type: string
          nullable: true
          description: >-
            E-mail do utilizador da Consola que realizou a ação. `null` para
            atores do sistema e de chave de API.
          example: null
        actor_type:
          type: string
          enum:
            - API_KEY
            - CONSOLE_USER
            - SYSTEM
          description: >-
            Quem executou a ação: uma chave de API, um utilizador da consola ou
            a própria Didit (`SYSTEM`, p. ex., monitorização AML contínua). As
            entradas criadas através de `POST …/reviews/` assumem o valor
            predefinido `CONSOLE_USER`, independentemente de quem chamou.
          example: API_KEY
        new_status:
          type: string
          nullable: true
          enum:
            - Not Started
            - In Progress
            - Approved
            - Declined
            - In Review
            - Expired
            - Abandoned
            - Kyc Expired
            - Resubmitted
            - Awaiting User
          description: >-
            Estado da sessão registado por esta entrada (para atualizações de
            estado). `null` para comentários e entradas de alteração de dados.
          example: Approved
        previous_status:
          type: string
          nullable: true
          enum:
            - Not Started
            - In Progress
            - Approved
            - Declined
            - In Review
            - Expired
            - Abandoned
            - Kyc Expired
            - Resubmitted
            - Awaiting User
          description: >-
            Estado que a sessão tinha antes da alteração. Preenchido nas
            entradas `STATUS_UPDATED` gravadas pelo endpoint de atualização de
            estado; `null` nas entradas adicionadas via `POST …/reviews/`.
            Também preenchido nas linhas STATUS_UPDATED geradas pelo sistema.
          example: In Review
        comment:
          type: string
          nullable: true
          description: Nota em texto livre associada à entrada, ou `null`.
          example: Document re-checked manually; address matches.
        mentioned_emails:
          type: array
          items:
            type: string
            format: email
          description: >-
            Utilizadores da consola mencionados com `@email` no comentário.
            Sempre vazio para entradas criadas através desta API — o
            processamento de menções é uma funcionalidade exclusiva da consola.
          example: []
        previous_value:
          type: object
          nullable: true
          description: >-
            Instantâneo dos dados alterados antes da ação, por exemplo,
            `{"status": "In Review"}` numa alteração de estado. `null` quando
            nada foi alterado.
          example:
            status: In Review
        new_value:
          type: object
          nullable: true
          description: >-
            Instantâneo dos dados alterados após a ação, por exemplo,
            `{"status": "Approved"}`. `null` quando nada foi alterado.
          example:
            status: Approved
        changed_fields:
          type: array
          items:
            type: string
          description: >-
            Nomes dos campos modificados por esta atividade (por exemplo,
            `["status"]`). Vazio para comentários e para entradas adicionadas
            através de `POST …/reviews/`.
          example:
            - status
        metadata:
          type: object
          nullable: true
          description: >-
            Contexto adicional para entradas geradas pelo sistema. As
            visualizações da página de detalhes na Console incluem
            `{"system_event": "DETAIL_VIEWED", "detail_type": "verification"}`
            para que possam ser filtradas da lógica de notificações. Um
            `COMMENT` editado pelo seu autor na Console inclui `edited_at`, a
            data e hora ISO 8601 da última edição (`comment` e
            `mentioned_emails` contêm então o texto editado e as suas menções).
            `null` para entradas normais.
          example: null
        created_at:
          type: string
          format: date-time
          description: Quando a entrada foi gravada, ISO 8601 UTC.
          example: '2026-06-12T00:19:31.918735Z'
  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.