> ## 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 para obter entrega de webhook

> Consulte uma tentativa de entrega de webhook da Didit: cabeçalhos de assinatura exatos, payload JSON e código de estado devolvido pelo endpoint.



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



      
      

\<pre>

\`Read one delivery attempt made to a Didit webhook destination through the Management API.

Endpoint:
GET https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs webhooks: read and decisions: read. A key limited to some workflows or to approved sessions cannot use this endpoint.

Goal:
\- See exactly what Didit sent to my endpoint, to debug signature verification or payload handling.

Path parameters:
\- destination_uuid: the destination uuid from GET /v3/webhook/destinations/.
\- delivery_uuid: the uuid of an entry from GET /v3/webhook/destinations/{destination_uuid}/deliveries/.

Behavior:
\- Returns the delivery fields of the list (uuid, session_id, request_url, response_status, response_time_ms, status, webhook_type, created_at) plus request_header and request_body.
\- request_header and request_body are JSON text (strings). Parse them: request_header holds Content-Type, X-Signature, X-Signature-V2, X-Signature-Simple, X-Timestamp and User-Agent; request_body holds the event payload, including event_id.
\- A scoped key without media: read receives media URLs inside request_body as null; without sessions: write it receives session tokens and hosted verification links as null. A body changed that way is re-encoded and no longer matches the signatures.

Example call:
curl -X GET "https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/" \
-H "x-api-key: YOUR_API_KEY"

Failure modes:
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." }, { "detail": "This API key has no read access to webhooks." }, { "detail": "This API key has no read access to decisions." }, or the limited-key message.
\- 404: { "detail": "Webhook destination not found." } or { "detail": "Webhook delivery not found." } (the delivery does not belong to this destination).
\- 429: more than 600 GET requests per minute with this key; wait for Retry-After.

Side effects: none. This is a pure read.

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

\</pre>



      
      

Colar em

Para verificar o seu código de assinatura com uma entrega real, recalcule `X-Signature-V2` a partir de `request_body` com o `secret_shared_key` do destino, tal como descrito em [Verificação da assinatura](https://docs.didit.me/pt/integration/webhooks.md#verificação-da-assinatura). Para isto, use uma chave com acesso total: um corpo com valores ocultados deixa de corresponder às respetivas assinaturas.Para enviar a entrega novamente, chame [Reenviar entrega do destino do webhook](https://docs.didit.me/pt/management-api/webhook/resend-delivery.md).


## OpenAPI

````yaml pt/openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_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/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/:
    get:
      tags:
        - Webhook
      summary: Obter entrega do destino do webhook
      description: >-
        Obtenha uma tentativa de entrega para um destino do webhook com os
        cabeçalhos de pedido e o corpo JSON exatos que a Didit enviou, o estado
        HTTP retornado pelo seu endpoint e o tempo de resposta. `request_header`
        e `request_body` são texto em JSON: analise-os para ler os cabeçalhos de
        assinatura e o payload, por exemplo, para verificar a sua [verificação
        da
        assinatura](https://docs.didit.me/pt/integration/webhooks#verificação-da-assinatura)
        em relação ao `secret_shared_key` do destino. Uma entrega nunca contém o
        segredo de assinatura e a Didit não regista o corpo da resposta do seu
        endpoint. Uma chave de API com âmbito restrito necessita de `webhooks:
        read` e `decisions: read`; uma chave limitada a determinados fluxos ou a
        sessões aprovadas não pode utilizar este endpoint.
      operationId: get_webhook_destination_delivery
      parameters:
        - name: destination_uuid
          in: path
          required: true
          description: UUID do destino para o qual a entrega foi enviada.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
        - name: delivery_uuid
          in: path
          required: true
          description: >-
            UUID da entrega: o `uuid` de uma entrada retornada por `GET
            /v3/webhook/destinations/{destination_uuid}/deliveries/`.
          schema:
            type: string
            format: uuid
          example: 66666666-7777-8888-9999-000000000001
      responses:
        '200':
          description: A entrega, com os respetivos cabeçalhos e corpo do pedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDestinationDeliveryDetail'
              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
                    response_time_ms: 412
                    status: In Progress
                    webhook_type: status.updated
                    created_at: '2026-10-15T09:21:18.412345Z'
                    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}
        '401':
          description: >-
            A chave de API expirou: foi criada com uma data de validade que já
            passou. Uma chave incorreta ou revogada também recebe `401`; uma
            chave em falta 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: >-
            O pedido não é permitido. Um `x-api-key` em falta, inválido ou
            revogado recebe `You do not have permission to perform this action.`
            Uma chave com âmbito sem o acesso de que este endpoint necessita
            recebe uma mensagem a indicar o acesso em falta, e uma chave
            utilizada fora da sua lista de permissões de IP recebe `This API key
            can't be used from this IP address.` Uma chave limitada a alguns
            fluxos ou a sessões aprovadas recebe `This API key only reaches
            sessions inside its workflow or status limits, so it can't use this
            endpoint.`
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Missing or invalid key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without webhooks read:
                  value:
                    detail: This API key has no read access to webhooks.
                Scoped key without decisions read:
                  value:
                    detail: This API key has no read access to decisions.
                Key limited to workflows or approved sessions:
                  value:
                    detail: >-
                      This API key only reaches sessions inside its workflow or
                      status limits, so it can't use this endpoint.
                Outside the IP allowlist:
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            O destino não existe para a aplicação ou foi eliminado, ou a entrega
            não existe, pertence a outro destino ou já não está disponível.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Destination not found:
                  value:
                    detail: Webhook destination not found.
                Delivery not found:
                  value:
                    detail: Webhook delivery not found.
        '429':
          description: >-
            Limite de pedidos excedido: mais de 600 pedidos 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 a aguardar antes de tentar novamente.
              schema:
                type: integer
                minimum: 1
                example: 30
            X-RateLimit-Limit:
              description: Pedidos permitidos na janela de um minuto (600).
              schema:
                type: integer
                example: 600
            X-RateLimit-Remaining:
              description: Pedidos restantes na janela atual.
              schema:
                type: integer
                example: 0
            X-RateLimit-Reset:
              description: Hora Unix (segundos) em que a janela atual é reposta.
              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/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/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.webhooks.destinations.retrieve_delivery(
                "11111111-2222-3333-4444-555555555555",
                "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.webhooks.destinations.retrieveDelivery(
              "11111111-2222-3333-4444-555555555555",
              "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.Webhooks.Destinations.RetrieveDelivery(ctx, \"11111111-2222-3333-4444-555555555555\", \"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.webhooks().destinations().retrieveDelivery("11111111-2222-3333-4444-555555555555",
            "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->webhooks->destinations->retrieveDelivery('11111111-2222-3333-4444-555555555555',
            '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.webhooks.destinations.retrieve_delivery(
              "11111111-2222-3333-4444-555555555555",
              "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.Webhooks.Destinations.RetrieveDeliveryAsync("11111111-2222-3333-4444-555555555555",
            "66666666-7777-8888-9999-000000000001");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    WebhookDestinationDeliveryDetail:
      type: object
      description: >-
        Uma tentativa de entrega para um destino do webhook, com os cabeçalhos e
        corpo do pedido exatos enviados pela Didit.
      required:
        - uuid
        - session_id
        - request_url
        - response_status
        - response_time_ms
        - status
        - webhook_type
        - created_at
        - request_header
        - request_body
      properties:
        uuid:
          type: string
          format: uuid
          description: ID de entrega, para as chamadas de detalhe e reenvio.
        session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Sessão de verificação de utilizadores a que o evento se refere.
            `null` para eventos de sessão de empresa, utilizador, empresa,
            transação, Travel Rule e fluxo.
        request_url:
          type: string
          format: uri
          nullable: true
          description: >-
            URL para onde a entrega foi enviada: o URL do destino quando o
            evento foi gerado.
        response_status:
          type: integer
          nullable: true
          description: >-
            Código de estado HTTP devolvido pelo seu endpoint. `null` enquanto a
            entrega está na fila e ainda não foi tentada. Quando não foi
            recebida nenhuma resposta HTTP, a Didit regista um código de estado
            próprio: `504` quando o seu endpoint não respondeu no prazo de 5
            segundos, `503` para uma falha de ligação, `400` quando o URL foi
            recusado por não ser seguro (por exemplo, um endereço privado ou
            interno) e `404` para qualquer outro erro no pedido. Valores iguais
            ou superiores a `400` contam como uma entrega com falha.
        response_time_ms:
          type: integer
          nullable: true
          minimum: 0
          description: >-
            Tempo que a tentativa demorou, em milissegundos. `null` enquanto a
            entrega estiver na fila.
        status:
          type: string
          nullable: true
          description: >-
            Estado comunicado pelo evento quando foi gerado: o estado da sessão
            para eventos de sessão (por exemplo, `Approved` ou `In Review`), o
            estado da pessoa ou da empresa para eventos de utilizador e de
            empresa, e o estado da transação para eventos de transação. `null`
            para eventos que não possuem estado.
        webhook_type:
          $ref: '#/components/schemas/WebhookEvent'
        created_at:
          type: string
          format: date-time
          description: Quando a entrega foi criada.
        request_header:
          type: string
          description: >-
            Texto JSON (uma string) dos cabeçalhos do pedido que a Didit enviou:
            `Content-Type`, `X-Signature`, `X-Signature-V2`,
            `X-Signature-Simple`, `X-Timestamp` e `User-Agent`. Efetue o parse
            com um analisador de JSON. 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
            chaves ordenadas, incluindo `event_id` e `timestamp`. Efetue o parse
            com um analisador de JSON; consulte [Formato do
            payload](https://docs.didit.me/pt/integration/webhooks#estrutura-do-payload).
            Para uma chave com âmbito sem `media: read`, os URLs de multimédia
            no seu interior são `null`; sem `sessions: write`, os tokens de
            sessão e as ligações de verificação alojadas são `null`. Um corpo
            alterado dessa forma já não coincide com as suas assinaturas. A
            Didit não regista o corpo da resposta que o seu endpoint devolveu.
    WebhookEvent:
      type: string
      description: >-
        Nome de evento de webhook suportado. Utilize estas strings exatas em
        `subscribed_events`; valores não suportados 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: >-
        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.