---
title: "Consultar detalhes do envelope"
method: GET
path: "/v1/envelopes/{envelopeId}"
tags: ["Envelopes"]
---

# Consultar detalhes do envelope

`GET /v1/envelopes/{envelopeId}`

## Request

- Base URL: `https://api.signdocs.com.br`
- URL: `https://api.signdocs.com.br/v1/envelopes/{envelopeId}`
- Auth: HTTP bearer

Retorna os detalhes completos do envelope, incluindo resumo de cada sessão.

Requer scope `transactions:read`.

## Path parameters

- `envelopeId` string, required

## Response `200`

Detalhes do envelope retornados com sucesso.

- GetEnvelopeResponse: Resposta com detalhes completos do envelope.
  - `envelopeId` string, required: Identificador único do envelope.
  - `status` 'CREATED' | 'ACTIVE' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED', required: Status possíveis de um envelope.
  - `signingMode` 'PARALLEL' | 'SEQUENTIAL', required: Modo de assinatura configurado.
  - `totalSigners` integer, required: Número total de signatários esperados.
  - `addedSessions` integer, required: Número de sessões adicionadas ao envelope.
  - `signerConfidentiality` boolean, required: Envelope com confidencialidade entre signatários. Não afeta esta resposta: o criador sempre vê todos os signatários.
  - `completedSessions` integer, required: Número de sessões concluídas.
  - `documentHash` string, required: Hash SHA-256 do documento.
  - `sessions` EnvelopeSessionSummary[], required: Lista de sessões de signatários do envelope.
    - `sessionId` string, required: Identificador único da sessão.
    - `transactionId` string, required: Identificador da transação subjacente.
    - `signerIndex` integer, required: Índice do signatário no envelope.
    - `signerName` string, required: Nome do signatário.
    - `status` 'ACTIVE' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED' | 'FAILED', required: Status da sessão de assinatura.
    - `completedAt` string, date-time: Data/hora de conclusão (presente quando status é COMPLETED).
    - `evidenceId` string: ID da evidência (presente quando status é COMPLETED).
  - `createdAt` string, date-time, required: Data/hora de criação (ISO 8601 UTC).
  - `updatedAt` string, date-time, required: Data/hora da última atualização (ISO 8601 UTC).
  - `expiresAt` string, date-time, required: Data/hora de expiração do envelope (ISO 8601 UTC).
  - `combinedSignedPdfUrl` string, uri: URL pré-assinada do documento com carimbo combinado (presente quando todas as sessões foram concluídas).

## Other responses

- `400`: Requisição inválida — parâmetros ausentes ou malformados.
- `401`: Autenticação ausente ou inválida.
- `403`: Permissões insuficientes para a operação solicitada. Inclui `purpose: "ACTION_AUTHENTICATION"` sem `featureFlags.trustSessionsEnabled`. A verificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`. O remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.
- `404`: Recurso não encontrado.
- `500`: Erro interno do servidor.

---

[API](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api.md) · [All operations](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/revisions/2d3805aed161?raw)