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

# Consultar entrega de webhook da sessão: API

> Consulte uma entrega de webhook de uma sessão na Didit: a URL, a resposta HTTP do seu endpoint e os cabeçalhos de assinatura e o corpo JSON enviados.



Prompt da API para obter a entrega do webhook da sessão
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Retrieve one webhook delivery of a Didit verification session through the API.

Endpoint:
GET https://verification.didit.me/v3/session/{session_id}/webhook/{webhook_uuid}
(no trailing slash)

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

Goal:
\- Read exactly what Didit sent to my webhook endpoint for one delivery and what my endpoint answered, to debug a rejected or missing event.

Behavior:
\- {webhook_uuid} is the uuid of an entry from GET /v3/session/{session_id}/webhooks/. It must belong to the session in the path; a delivery of another session returns 404.
\- request_header and request_body are JSON-encoded strings. Parse them with a JSON parser.
\- To check my signature code, recompute X-Signature-V2 from the parsed request_body with my destination's secret (the application-level secret for a delivery sent to the legacy webhook_url) and compare it with the header. A scoped key without media: read or sessions: write receives a redacted body, which no longer matches the signatures.

Example call:
curl -X GET "https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/webhook/9f8e7d6c-5b4a-4321-8fed-cba987654321" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- response_status: the HTTP status my endpoint returned (null while queued, 504 timeout, 503 connection failure, 400 URL refused as unsafe).
\- request_url: where it was sent.
\- request_header: the X-Signature, X-Signature-V2, X-Signature-Simple and X-Timestamp values sent.
\- request_body: the webhook payload (event_id, webhook_type, session_id, status, decision when present).
\- status, webhook_type, created_at.

Failure modes:
\- 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 limits, or the delivery does not belong to this session ({ "detail": "No WebhookLog matches the given query." }).
\- 429: more than 600 reads per minute for this API key; honor Retry-After.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Colar em

O payload dentro de `request_body` é o descrito em [Webhooks](https://docs.didit.me/pt-br/integration/webhooks.md#formato-do-payload), e os cabeçalhos são os abordados em [verificação de assinatura](https://docs.didit.me/pt-br/integration/webhooks.md#verificação-de-assinatura). Para enviar a entrega novamente, use [Reenviar a entrega do webhook da sessão](https://docs.didit.me/pt-br/management-api/sessions/resend-webhook.md).


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/session/{sessionId}/webhook/{webhook_uuid}
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}/webhook/{webhook_uuid}:
    get:
      tags:
        - Sessions
      summary: Obter entrega de webhook da sessão
      description: >-
        Obtenha uma entrega de webhook de uma sessão de verificação: a URL para
        a qual foi enviada, o status HTTP que o seu endpoint retornou e os
        cabeçalhos exatos e o corpo JSON que a Didit enviou. `request_header` e
        `request_body` são texto JSON; para conferir a sua [verificação de
        assinatura](https://docs.didit.me/pt-br/integration/webhooks#verificação-de-assinatura),
        recalcule `X-Signature-V2` a partir do corpo após o parse com o segredo
        do destino para o qual foi enviada (ou o segredo da aplicação, no caso
        de uma entrega para a URL de webhook legada). O caminho não tem barra
        final: com ela, retorna `404`. Uma chave de API com escopo precisa de
        `sessions: read` e `decisions: read`.
      operationId: get_v3_session_webhook
      parameters:
        - name: sessionId
          in: path
          required: true
          description: >-
            UUID da sessão de verificação, de usuário (KYC) ou de empresa (KYB):
            o `session_id` retornado por `POST /v3/session/`. O servidor o
            resolve entre os dois tipos de sessão.


            **Deve ser um UUID válido.** A rota só corresponde a UUIDs bem
            formados, então um valor malformado é rejeitado pelo roteador de
            URLs antes que qualquer código da aplicação seja executado, e a
            resposta é uma página **HTML** `404` em vez do envelope JSON
            `{"detail": ...}` mostrado abaixo.
          schema:
            type: string
            format: uuid
          example: 22222222-3333-4444-5555-666666666666
        - name: webhook_uuid
          in: path
          required: true
          description: >-
            UUID da entrega: o `uuid` de um item retornado por `GET
            /v3/session/{sessionId}/webhooks/`. Ela deve pertencer à sessão
            indicada no caminho.
          schema:
            type: string
            format: uuid
          example: 66666666-7777-8888-9999-000000000001
      responses:
        '200':
          description: A entrega, com os cabeçalhos e o corpo da requisição.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionWebhookDelivery'
              examples:
                Connection failure:
                  value:
                    uuid: 66666666-7777-8888-9999-000000000001
                    session_id: 22222222-3333-4444-5555-666666666666
                    request_url: https://yourapp.com/webhooks/didit
                    response_status: 503
                    status: In Progress
                    webhook_type: status.updated
                    request_header: >-
                      {"Content-Type": "application/json", "X-Signature":
                      "a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b",
                      "X-Signature-V2":
                      "927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5",
                      "X-Signature-Simple":
                      "e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302",
                      "X-Timestamp": "1792056078", "User-Agent":
                      "DiditWebhook/2.0 +https://didit.me"}
                    request_body: >-
                      {"application_id":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","created_at":1792056057,"environment":"live","event_id":"33333333-4444-5555-6666-777777777777","sandbox_scenario":null,"session_id":"22222222-3333-4444-5555-666666666666","status":"In
                      Progress","timestamp":1792056078,"vendor_data":"user-123","webhook_type":"status.updated","workflow_id":"44444444-5555-6666-7777-888888888888","workflow_version":3}
                    created_at: '2026-10-15T09:21:18.412345Z'
        '401':
          description: >-
            A chave de API expirou: ela foi criada com uma data de validade que
            já passou. Uma chave incorreta ou revogada também recebe `401`; uma
            chave ausente recebe `403`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            A requisição não é permitida. Sem `x-api-key`, ou com uma chave
            inválida ou revogada, a resposta é `Authentication credentials were
            not provided or are invalid.` Uma chave de outra aplicação recebe
            `You do not have permission to perform this action.` Uma chave com
            escopo sem o acesso exigido por este endpoint recebe uma mensagem
            que indica o acesso ausente, e uma chave usada fora da sua lista de
            IPs permitidos recebe `This API key can't be used from this IP
            address.` Um `sessionId` desconhecido retorna `404` antes de a
            credencial ser verificada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Missing or invalid key:
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Key of another application:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without sessions read:
                  value:
                    detail: This API key has no read access to sessions.
                Scoped key without decisions read:
                  value:
                    detail: This API key has no read access to decisions.
                Outside the IP allowlist:
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            A sessão não existe ou foi excluída (`Not found.`, retornado antes
            de a credencial ser verificada), ou está fora dos limites de fluxo
            ou de status de uma chave com escopo (`Session not found.`). Uma
            entrega que não existe, pertence a outra sessão ou não está mais
            disponível retorna `No WebhookLog matches the given query.`
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Unknown session:
                  value:
                    detail: Not found.
                Outside the key's limits:
                  value:
                    detail: Session not found.
                Delivery not in this session:
                  value:
                    detail: No WebhookLog matches the given query.
        '429':
          description: >-
            Limite de requisições excedido: mais de 600 requisições GET na
            janela atual de um minuto para esta chave de API. Aguarde
            `Retry-After` segundos antes de tentar novamente.
          headers:
            Retry-After:
              description: Segundos de espera antes de tentar novamente.
              schema:
                type: integer
                minimum: 1
                example: 30
            X-RateLimit-Limit:
              description: Requisições permitidas na janela de um minuto (600).
              schema:
                type: integer
                example: 600
            X-RateLimit-Remaining:
              description: Requisições restantes na janela atual.
              schema:
                type: integer
                example: 0
            X-RateLimit-Reset:
              description: Horário Unix (segundos) em que a janela atual é reiniciada.
              schema:
                type: integer
                example: 1792056120
            X-RateLimit-Scope:
              description: Nome do orçamento que foi excedido.
              schema:
                type: string
                example: generic-get
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Throttled:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhook/66666666-7777-8888-9999-000000000001'
            \
              -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.webhooks.retrieve(
                "22222222-3333-4444-5555-666666666666",
                "66666666-7777-8888-9999-000000000001",
            )
            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.webhooks.retrieve(
              "22222222-3333-4444-5555-666666666666",
              "66666666-7777-8888-9999-000000000001",
            );
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.Retrieve(ctx, \"22222222-3333-4444-5555-666666666666\", \"66666666-7777-8888-9999-000000000001\")\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().webhooks().retrieve("22222222-3333-4444-5555-666666666666",
            "66666666-7777-8888-9999-000000000001");

            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->webhooks->retrieve('22222222-3333-4444-5555-666666666666',
            '66666666-7777-8888-9999-000000000001');

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

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.sessions.webhooks.retrieve(
              "22222222-3333-4444-5555-666666666666",
              "66666666-7777-8888-9999-000000000001"
            )
            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.Webhooks.RetrieveAsync("22222222-3333-4444-5555-666666666666",
            "66666666-7777-8888-9999-000000000001");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    SessionWebhookDelivery:
      type: object
      description: >-
        Uma tentativa de entrega de webhook registrada para uma sessão de
        verificação, com os cabeçalhos e o corpo exatos da requisição que a
        Didit enviou.
      required:
        - uuid
        - session_id
        - request_url
        - response_status
        - status
        - webhook_type
        - request_header
        - request_body
        - created_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            ID da entrega. Use-o como `{webhook_uuid}` para obter ou reenviar
            esta entrega.
        session_id:
          type: string
          format: uuid
          description: A sessão à qual a entrega pertence (a sessão no caminho).
        request_url:
          type: string
          format: uri
          nullable: true
          description: URL para a qual a entrega foi enviada.
        response_status:
          type: integer
          nullable: true
          description: >-
            Status HTTP que seu endpoint retornou. `null` enquanto a entrega
            está na fila e ainda não foi tentada. Quando nenhuma resposta HTTP é
            recebida, a Didit registra um status próprio: `504` quando seu
            endpoint não respondeu em 5 segundos, `503` para falha de conexão,
            `400` quando a URL foi recusada como insegura (por exemplo, um
            endereço privado ou interno) e `404` para qualquer outro erro de
            requisição. `400` ou acima conta como entrega com falha.
        status:
          type: string
          nullable: true
          description: >-
            Status da sessão quando o evento foi gerado, por exemplo `In
            Progress`, `Approved` ou `Declined`.
        webhook_type:
          $ref: '#/components/schemas/WebhookEvent'
        request_header:
          type: string
          description: >-
            Texto JSON (uma string) dos cabeçalhos da requisição que a Didit
            enviou: `Content-Type`, `X-Signature`, `X-Signature-V2`,
            `X-Signature-Simple`, `X-Timestamp` e `User-Agent`. Analise-o com um
            parser JSON. Ele contém assinaturas, nunca o segredo de assinatura.
        request_body:
          type: string
          description: >-
            Texto JSON (uma string) do payload exato que a Didit enviou, com as
            chaves ordenadas, incluindo `event_id` e `timestamp`. Analise-o com
            um parser JSON; consulte [Formato do
            payload](https://docs.didit.me/pt-br/integration/webhooks#formato-do-payload).
            Para uma chave com escopo sem `media: read`, as URLs de mídia dentro
            dele são `null`; sem `sessions: write`, os tokens de sessão e os
            links de verificação hospedados são `null`. Um corpo alterado dessa
            forma não corresponde mais às suas assinaturas. A Didit não registra
            o corpo da resposta que o seu endpoint retornou.
        created_at:
          type: string
          format: date-time
          description: Quando a entrega foi criada.
    WebhookEvent:
      type: string
      description: >-
        Nome de evento de webhook compatível. Use exatamente estas strings em
        `subscribed_events`; valores não compatíveis são rejeitados.
      enum:
        - status.updated
        - data.updated
        - user.status.updated
        - user.data.updated
        - business.status.updated
        - business.data.updated
        - activity.created
        - transaction.created
        - transaction.status.updated
        - travel_rule.status.updated
        - workflow.compliance_changed
        - transaction_rule_suggestions.created
        - auth.signup
        - auth.login
        - auth.login_failed
        - auth.password_reset_requested
        - auth.password_reset_completed
        - auth.mfa_changed
        - auth.new_device
        - auth.account_locked
        - investigator.report.ready
        - investigator.decision.automated
        - investigator.decision.overridden
        - investigator.decision.contested
        - investigator.question.raised
        - investigator.automation.paused
        - investigator.rfi.answered
        - investigator.rfi.overdue
        - investigator.drift.detected
        - investigator.sla.breached
        - investigator.qa.failed
        - investigator.external.report.ready
  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.