> ## 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.

# Substituições de funcionalidades: histórico de passos

> Liste todas as substituições do estado de um passo numa sessão, da mais recente para a mais antiga: aplicadas, à espera de conclusão ou canceladas. Didit.



Prompt para listar substituições de funcionalidades
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`List the check (feature) status overrides of a Didit session: the ones that applied, the ones still waiting for the person to finish the flow, and the cancelled ones.

Endpoint:
GET https://verification.didit.me/v3/session/{session_id}/features/overrides/

Authentication:
x-api-key (client API key) or a user-auth token. Privilege: read:sessions. A scoped API key needs read access to decisions.

Path parameter:
\- session_id (UUID): KYC or KYB; Didit resolves it against both session types.

Response (200, not paginated):
\- session_id (UUID).
\- person_in_flow (boolean): true while the person is still in the flow, so a new override with defer_until_flow_finishes=true would wait.
\- flow_finished_at (date-time or null): when the person last finished the flow. null while they are still in it (a resubmission included) and when the session closed before they finished.
\- overrides (array, newest first). Each override:
\- id (UUID): pass it to the cancel endpoint.
\- node_id, feature_type ("" when the request passed none), feature_model (for example "KYC", "Face", "AML").
\- previous_status, new_status.
\- state: "applied", "pending_until_flow_finishes" or "cancelled".
\- forced (boolean): true when it applied at once while the person was still in the flow.
\- reason: the comment sent with the request, or null.
\- requested_by: { email, name, type } with type "CONSOLE_USER", "API_KEY" or "SYSTEM"; or null.
\- requested_at, applied_at (null while waiting or once cancelled), cancelled_at.
\- cancel_reason: null, "cancelled_by_reviewer", "replaced", "check_changed" or "session_closed".

curl example:
curl https://verification.didit.me/v3/session/<SESSION_ID>/features/overrides/ \
-H "x-api-key: <API_KEY>"

Failure modes:
\- 401: the scoped API key has expired.
\- 403: missing credentials (a wrong, revoked or expired key gets 401), the caller lacks read:sessions, a scoped key lacks decisions read, or the session belongs to another application ({ "detail": "You do not have permission to perform this action." }).
\- 404: { "detail": "Not found." } when no session with this session_id exists.

Related: create overrides with PATCH /v3/session/{session_id}/features/{node_id}/update-status/ (see /sessions-api/update-feature-status); cancel a waiting one with POST /v3/session/{session_id}/features/overrides/{override_id}/cancel/ (see /sessions-api/cancel-feature-override).

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

\</pre>



      
      

Colar em

Cada chamada a [Atualizar estado da funcionalidade](https://docs.didit.me/pt/sessions-api/update-feature-status.md) regista uma substituição do estado de uma verificação.
Este endpoint lista todas as substituições de uma sessão, da mais recente para a mais antiga, sem paginação.## Estados da substituição| `state` | O que significa |
| - | - |
| `applied` | A verificação tem o novo estado. `applied_at` indica quando. |
| `pending_until_flow_finishes` | A substituição aguarda e é aplicada quando a pessoa concluir o fluxo. |
| `cancelled` | A substituição aguardou e nunca foi aplicada. `cancel_reason` indica o motivo. |Uma substituição com `forced: true` foi aplicada de imediato, enquanto a pessoa ainda estava no fluxo.## Motivo do cancelamento de uma substituição em espera| `cancel_reason` | O que aconteceu |
| - | - |
| `cancelled_by_reviewer` | Alguém a cancelou com [Cancelar substituição de funcionalidade](https://docs.didit.me/pt/sessions-api/cancel-feature-override.md). |
| `replaced` | Uma substituição mais recente da mesma verificação substituiu esta. |
| `check_changed` | A pessoa refez a verificação antes de concluir o fluxo, pelo que o resultado ao qual aplicou a substituição deixou de existir. |
| `session_closed` | A sessão saiu do fluxo antes de a pessoa o concluir: abandonada, expirada ou decidida a meio do fluxo. |## Posição da pessoa no fluxo`person_in_flow` é `true` enquanto a sessão estiver em `Not Started`, `In Progress` ou `Resubmitted` e a pessoa não tiver concluído o fluxo.
Enquanto for `true`, uma nova substituição com `defer_until_flow_finishes: true` fica em espera.
`flow_finished_at` indica quando a pessoa concluiu o fluxo pela última vez.
Fica a `null` enquanto ela ainda estiver no fluxo, incluindo um reenvio, e quando a sessão foi encerrada antes de ela o concluir.## Consulte também- [Atualizar estado da funcionalidade](https://docs.didit.me/pt/sessions-api/update-feature-status.md): substituir o estado de um passo, agora ou quando o fluxo terminar.
- [Cancelar substituição de funcionalidade](https://docs.didit.me/pt/sessions-api/cancel-feature-override.md): impedir que uma substituição em espera seja aplicada.
- [Obter sessão](https://docs.didit.me/pt/sessions-api/retrieve-session.md): o `node_id` de cada funcionalidade e o respetivo estado atual.


## OpenAPI

````yaml pt/openapi-25.json GET /v3/session/{sessionId}/features/overrides/
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}/features/overrides/:
    get:
      tags:
        - Sessions
      summary: Listar substituições das verificações de uma sessão
      description: >-
        Cada anulação do estado de uma funcionalidade individual (passo) numa
        sessão de Verificação de utilizadores (KYC) ou Verificação de empresas
        (KYB), da mais recente para a mais antiga e não paginada: as aplicadas,
        as que aguardam que a pessoa termine o fluxo
        (`pending_until_flow_finishes`) e as canceladas, cada uma com quem a
        solicitou, o respetivo motivo e se foi aplicada enquanto a pessoa ainda
        estava no fluxo (`forced`).


        `person_in_flow` indica se uma nova anulação com
        `defer_until_flow_finishes: true` ficaria em espera. `flow_finished_at`
        é a data e hora em que a pessoa terminou o fluxo pela última vez; é
        `null` enquanto ainda estiver no fluxo (incluindo um novo envio) e
        quando a sessão tiver sido encerrada antes de terminar.


        Requer o privilégio `read:sessions`; uma chave de API com escopo
        necessita de acesso de leitura a decisões.
      operationId: get_v3_session_feature_overrides
      parameters:
        - in: path
          name: sessionId
          required: true
          description: >-
            UUID da sessão de verificação. Aceita IDs de sessão de utilizador
            (KYC) e de empresa (KYB).
          schema:
            type: string
            format: uuid
            example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: >-
            As substituições da verificação da sessão, da mais recente para a
            mais antiga.
          content:
            application/json:
              schema:
                type: object
                required:
                  - session_id
                  - person_in_flow
                  - flow_finished_at
                  - overrides
                properties:
                  session_id:
                    type: string
                    format: uuid
                    example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  person_in_flow:
                    type: boolean
                    description: >-
                      Se a pessoa ainda está no fluxo, pelo que uma nova
                      substituição com `defer_until_flow_finishes: true`
                      aguardaria.
                    example: true
                  flow_finished_at:
                    type: string
                    format: date-time
                    nullable: true
                    description: >-
                      Quando a pessoa concluiu o fluxo pela última vez. `null`
                      enquanto ainda estiver no mesmo (incluindo uma
                      ressubmissão) e quando a sessão foi encerrada antes de
                      terminar (abandonada, expirada ou quando foi tomada uma
                      decisão a meio do fluxo).
                    example: null
                  overrides:
                    type: array
                    description: >-
                      Cada anulação da sessão, da mais recente para a mais
                      antiga.
                    items:
                      $ref: '#/components/schemas/FeatureStatusOverride'
              examples:
                Overrides:
                  summary: Uma sobreposição pendente, uma aplicada
                  value:
                    session_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    person_in_flow: true
                    flow_finished_at: null
                    overrides:
                      - id: 9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3
                        node_id: feature_liveness_1
                        feature_type: ''
                        feature_model: Face
                        previous_status: Declined
                        new_status: Approved
                        state: pending_until_flow_finishes
                        forced: false
                        reason: Liveness retried with a reviewer present.
                        requested_by:
                          email: reviewer@example.com
                          name: Alex Reviewer
                          type: CONSOLE_USER
                        requested_at: '2026-10-13T09:15:00Z'
                        applied_at: null
                        cancelled_at: null
                        cancel_reason: null
                      - id: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                        node_id: feature_ocr_1
                        feature_type: ''
                        feature_model: KYC
                        previous_status: In Review
                        new_status: Approved
                        state: applied
                        forced: true
                        reason: Document manually verified by compliance.
                        requested_by:
                          email: reviewer@example.com
                          name: Alex Reviewer
                          type: CONSOLE_USER
                        requested_at: '2026-10-13T09:15:00Z'
                        applied_at: '2026-10-13T09:15:00Z'
                        cancelled_at: null
                        cancel_reason: null
        '401':
          description: A chave de API com âmbito expirou.
          content:
            application/json:
              examples:
                Expired API Key:
                  summary: Chave de API com âmbito cuja data de validade já passou
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Credenciais em falta, um chamador sem o privilégio `read:sessions`,
            uma chave de API com âmbito sem o acesso de que este endpoint
            necessita, ou um `session_id` que pertence a outra aplicação.
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: x-api-key em falta ou inválido
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Missing Privilege:
                  summary: O autor da chamada não tem read:sessions
                  value:
                    detail: You do not have permission to perform this action.
                Scoped Key Without Access:
                  summary: Chave de API com âmbito sem este acesso
                  value:
                    detail: This API key has no read access to decisions.
        '404':
          description: Não existe nenhuma sessão de KYC ou KYB com este `session_id`.
          content:
            application/json:
              examples:
                Not Found:
                  summary: session_id desconhecido
                  value:
                    detail: Not found.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X GET \
              https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/features/overrides/ \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.sessions.list_feature_overrides(
                "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.sessions.listFeatureOverrides("3fa85f64-5717-4562-b3fc-2c963f66afa6");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListFeatureOverrides(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.sessions().listFeatureOverrides("3fa85f64-5717-4562-b3fc-2c963f66afa6");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->sessions->listFeatureOverrides('3fa85f64-5717-4562-b3fc-2c963f66afa6');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.sessions.list_feature_overrides("3fa85f64-5717-4562-b3fc-2c963f66afa6")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Sessions.ListFeatureOverridesAsync("3fa85f64-5717-4562-b3fc-2c963f66afa6");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    FeatureStatusOverride:
      type: object
      description: >-
        Uma sobreposição do estado de uma verificação (funcionalidade) efetuada
        com `PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/`: o
        que altera, se foi aplicada ou se ainda aguarda que a pessoa conclua o
        fluxo, quem solicitou e porquê.
      required:
        - id
        - node_id
        - feature_type
        - feature_model
        - previous_status
        - new_status
        - state
        - forced
        - reason
        - requested_by
        - requested_at
        - applied_at
        - cancelled_at
        - cancel_reason
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Identificador da substituição. Transmita-o para o endpoint de
            cancelamento.
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        node_id:
          type: string
          description: O nó do fluxo indicado pelo pedido (`default` para um passo sem nó).
          example: feature_ocr_1
        feature_type:
          type: string
          description: >-
            O `feature_type` transmitido pelo pedido, ou uma string vazia se
            nenhum tiver sido transmitido.
          example: ''
        feature_model:
          type: string
          description: >-
            O tipo de verificação que foi substituído, por exemplo `KYC`,
            `Face`, `AML` ou `GeolocationCheck`.
          example: KYC
        previous_status:
          type: string
          enum:
            - Not Finished
            - Approved
            - Declined
            - In Review
            - Resub Requested
          description: O estado da verificação quando a substituição foi solicitada.
          example: In Review
        new_status:
          type: string
          enum:
            - Approved
            - Declined
            - In Review
          description: O estado definido pela sobreposição.
          example: Approved
        state:
          type: string
          enum:
            - applied
            - pending_until_flow_finishes
            - cancelled
          description: >-
            `applied`: a verificação tem o novo estado.
            `pending_until_flow_finishes`: a substituição aguarda e é aplicada
            quando a pessoa terminar o fluxo. `cancelled`: aguardou e nunca foi
            aplicada (consulte `cancel_reason`).
          example: applied
        forced:
          type: boolean
          description: >-
            `true` quando a substituição foi aplicada de imediato enquanto a
            pessoa ainda estava no fluxo.
          example: false
        reason:
          type: string
          nullable: true
          description: O `comment` enviado com o pedido, ou `null`.
          example: Document manually verified by compliance.
        requested_by:
          type: object
          nullable: true
          description: Quem solicitou a substituição, ou `null` quando não for conhecido.
          properties:
            email:
              type: string
              format: email
              nullable: true
              description: >-
                E-mail do utilizador da consola, ou `null` para chaves de API e
                para o sistema.
              example: reviewer@example.com
            name:
              type: string
              nullable: true
              description: Nome de apresentação do requerente, ou `null`.
              example: Alex Reviewer
            type:
              type: string
              enum:
                - CONSOLE_USER
                - API_KEY
                - SYSTEM
              description: >-
                Quem fez o pedido: um utilizador da consola, uma chave de API ou
                a própria Didit.
              example: CONSOLE_USER
        requested_at:
          type: string
          format: date-time
          description: Quando a substituição foi solicitada.
          example: '2026-10-13T09:15:00Z'
        applied_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quando a verificação assumiu o novo estado, ou `null` enquanto
            aguarda ou assim que for cancelada.
          example: '2026-10-13T09:15:00Z'
        cancelled_at:
          type: string
          format: date-time
          nullable: true
          description: Quando uma substituição em espera foi cancelada, ou `null`.
          example: null
        cancel_reason:
          type: string
          nullable: true
          enum:
            - cancelled_by_reviewer
            - replaced
            - check_changed
            - session_closed
            - null
          description: >-
            O motivo pelo qual uma sobreposição pendente nunca foi aplicada, ou
            `null`. `cancelled_by_reviewer`: cancelada com o endpoint de
            cancelamento. `replaced`: uma sobreposição mais recente na mesma
            verificação substituiu-a. `check_changed`: a pessoa repetiu a
            verificação antes de concluir o fluxo. `session_closed`: a sessão
            saiu do fluxo antes de a pessoa o concluir (abandonada, expirada ou
            decidida a meio do fluxo).
          example: null
  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.