> ## 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 revisões de sessão: registro de auditoria KYC

> Liste as notas de revisão manual e mudanças de status de uma sessão de verificação Didit. Registro de auditoria, pague por chamada, sem contrato.



Prompt para listar as 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-br/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 e registro de atividades da sessão
      description: >-
        Retorna a trilha de auditoria / feed de atividades de uma sessão de
        Verificação de usuários (KYC), da mais recente para a mais antiga, em um
        envelope paginado (`count` / `next` / `previous` / `results`, 50
        entradas por página por padrão).


        As entradas do feed são registradas por todos os agentes que interagem
        com a sessão: decisões manuais tomadas por meio de `PATCH
        /v3/session/{session_id}/update-status/` (que registra `previous_status`
        → `new_status`), atividades de revisores no Console (comentários com
        menções `@email`, edições de dados de KYC/comprovante de endereço,
        envios e remoções de arquivos, alterações de tags, visualizações da
        página de detalhes), correspondências do monitoramento AML contínuo e
        notas adicionadas via `POST` neste mesmo caminho. Ler este feed
        equivale, pela API, ao painel **Activity** na visualização da sessão no
        Didit Console.


        Apenas sessões de Verificação de usuários (KYC) podem ser consultadas
        aqui; IDs de sessões 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 usuários (KYC). Deve pertencer à
            mesma aplicação da chave de API: UUIDs de outras aplicações, sessões
            excluídas e IDs de sessões de Verificação de empresas (KYB) retornam
            `404`.
          schema:
            type: string
            format: uuid
            example: 8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d
        - name: limit
          in: query
          required: false
          description: Tamanho da página. O padrão é `50`.
          schema:
            type: integer
            default: 50
            example: 50
        - name: offset
          in: query
          required: false
          description: >-
            Número de entradas a pular a partir do início do feed (ordenado). O
            padrão é `0`. As URLs `next` / `previous` da resposta trazem os
            valores corretos para percorrer o feed.
          schema:
            type: integer
            default: 0
            example: 0
        - name: ordering
          in: query
          required: false
          description: >-
            Ordem de classificação. Por padrão, o feed mostra os mais recentes
            primeiro (`-created_at`); passe `created_at` para lê-lo dos mais
            antigos para os mais recentes. Valores desconhecidos são ignorados
            silenciosamente (a ordem padrão é usada); outros nomes de campo do
            serializer também são aceitos.
          schema:
            type: string
            default: '-created_at'
            example: created_at
      responses:
        '200':
          description: >-
            Feed de atividades paginado, das mais recentes para as mais antigas
            por padrão. `count` é o número total de entradas; `next` /
            `previous` são URLs de página prontas (`null` nas extremidades). Um
            `count` igual a `0` com `results` vazio significa que nenhuma
            atividade foi registrada ainda.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Número total de entradas do feed desta sessão (em todas as
                      páginas).
                    example: 3
                  next:
                    type: string
                    nullable: true
                    description: URL da próxima página, 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 do feed desta página.
              examples:
                DecisionTrail:
                  summary: Aprovação manual com notas adicionadas via 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: next contém a URL da página
                    seguinte
                  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 registrada
                  value:
                    count: 0
                    next: null
                    previous: null
                    results: []
        '403':
          description: >-
            `x-api-key` ausente, malformada, expirada ou revogada. A
            autenticação é verificada antes da busca da sessão, então uma chave
            ausente retorna `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 ausente ou inválido
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Nenhuma sessão de Verificação de usuários (KYC) com este UUID está
            visível para sua aplicação: o UUID não existe, a sessão foi excluída
            ou pertence a outra aplicação. IDs de sessão de Verificação de
            empresas (KYB) também retornam `404` aqui, pois o feed de revisões
            só pode ser acessado 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, excluído ou de outra aplicação
                  value:
                    detail: Session not found.
        '429':
          description: >-
            Limite de requisições excedido. Verifique os cabeçalhos de resposta
            `Retry-After` e `X-RateLimit-*`. Consulte [Limite de
            requisições](/pt-br/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 do feed de revisão / atividade de uma sessão. As mudanças de
        status trazem `previous_status`, `new_status`, `previous_value`,
        `new_value` e `changed_fields`; os comentários trazem `comment` e (para
        comentários do Console) `mentioned_emails`; os demais 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 do 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: >-
            O tipo de atividade que este registro documenta. Linhas
            `STATUS_UPDATED` vêm de decisões manuais (`PATCH
            /v3/session/{session_id}/update-status/`) e de registros adicionados
            via `POST …/reviews/` (que usam esse tipo por padrão mesmo quando
            nenhum status é registrado). Linhas `COMMENT` vêm de revisores no
            Console; visualizações da página de detalhes no Console também são
            armazenadas como linhas `COMMENT` marcadas com
            `metadata.system_event = "DETAIL_VIEWED"`. Os demais tipos
            acompanham edições de dados, alterações de arquivos, tags e
            atividade de monitoramento AML. Linhas STATUS_UPDATED também são
            gravadas por atores do sistema (por exemplo, o monitoramento AML
            contínuo com actor_type SYSTEM e atualizações automáticas de status
            de recursos), não apenas pelo endpoint update-status e por envios de
            revisão manual. `FEATURE_OVERRIDE_PENDING`,
            `FEATURE_OVERRIDE_APPLIED` e `FEATURE_OVERRIDE_CANCELLED` registram
            uma substituição do status 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. Elas trazem o status da verificação em `previous_value` /
            `new_value` (`{"status": ...}`), deixam `previous_status` e
            `new_status` como `null` e identificam a substituição em `metadata`
            (`feature_override_id`, `node_id`, `feature_model`, `forced`,
            `state`, `cancel_reason`). O registro da requisição traz o `comment`
            do revisor; uma substituição aplicada quando o fluxo termina é
            registrada com `actor_type` `SYSTEM`.
          example: STATUS_UPDATED
        actor_display:
          type: string
          description: >-
            Rótulo legível do autor, resolvido nesta ordem: nome completo do
            ator → identificador da conta do Console → parte local de
            `actor_email` → `"API Client"` (para atores `API_KEY`) → `"System"`
            (para atores `SYSTEM`) → `"Unknown"`. Entradas criadas via `POST
            …/reviews/` sempre exibem `"Unknown"`, porque esse endpoint não
            registra a atribuição de ator.
          example: API Client
        actor_email:
          type: string
          nullable: true
          description: >-
            E-mail do usuário do Console que executou a ação. `null` para chaves
            de API e atores do sistema.
          example: null
        actor_type:
          type: string
          enum:
            - API_KEY
            - CONSOLE_USER
            - SYSTEM
          description: >-
            Quem executou a ação: uma chave de API, um usuário do Console ou a
            própria Didit (`SYSTEM`, por exemplo, o monitoramento contínuo AML).
            Entradas criadas via `POST …/reviews/` recebem o padrão
            `CONSOLE_USER`, independentemente de quem fez a chamada.
          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: >-
            Status da sessão registrado por esta entrada (para atualizações de
            status). `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: >-
            Status que a sessão tinha antes da alteração. Preenchido nas
            entradas `STATUS_UPDATED` gravadas pelo endpoint de atualização de
            status; `null` nas entradas adicionadas via `POST …/reviews/`.
            Também preenchido nas linhas STATUS_UPDATED gravadas pelo sistema.
          example: In Review
        comment:
          type: string
          nullable: true
          description: Nota em texto livre anexada à entrada, ou `null`.
          example: Document re-checked manually; address matches.
        mentioned_emails:
          type: array
          items:
            type: string
            format: email
          description: >-
            Usuários do console mencionados com `@email` no comentário. Sempre
            vazio para entradas criadas por esta API: o processamento de menções
            é um recurso exclusivo do console.
          example: []
        previous_value:
          type: object
          nullable: true
          description: >-
            Snapshot dos dados alterados antes da ação, por exemplo `{"status":
            "In Review"}` em uma mudança de status. `null` quando nada foi
            alterado.
          example:
            status: In Review
        new_value:
          type: object
          nullable: true
          description: >-
            Snapshot 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
            via `POST …/reviews/`.
          example:
            - status
        metadata:
          type: object
          nullable: true
          description: >-
            Contexto adicional para entradas geradas pelo sistema. Visualizações
            de páginas de detalhes no console trazem `{"system_event":
            "DETAIL_VIEWED", "detail_type": "verification"}` para que possam ser
            excluídas da lógica de notificações por filtro. `null` para entradas
            comuns.
          example: null
        created_at:
          type: string
          format: date-time
          description: Quando a entrada foi gravada, em ISO 8601 UTC.
          example: '2026-06-12T00:19:31.918735Z'
  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.