Envelopes

Consultar detalhes do envelope

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

Requer scope transactions:read.

get/v1/envelopes/{envelopeId}

Request

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

Path parameters

envelopeIdstring required

Identificador único do envelope.

Response

Detalhes do envelope retornados com sucesso.

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

totalSignersinteger required

Número total de signatários esperados.

addedSessionsinteger required

Número de sessões adicionadas ao envelope.

signerConfidentialityboolean required

Envelope com confidencialidade entre signatários. Não afeta esta resposta: o criador sempre vê todos os signatários.

completedSessionsinteger required

Número de sessões concluídas.

documentHashstring required

Hash SHA-256 do documento.

createdAtstring date-time required

Data/hora de criação (ISO 8601 UTC).

updatedAtstring date-time required

Data/hora da última atualização (ISO 8601 UTC).

expiresAtstring date-time required

Data/hora de expiração do envelope (ISO 8601 UTC).

combinedSignedPdfUrlstring uri

URL pré-assinada do documento com carimbo combinado (presente quando todas as sessões foram concluídas).

Example response

{
  "envelopeId": "env_01JXYZ...",
  "signingMode": "PARALLEL",
  "totalSigners": 3,
  "addedSessions": 2,
  "completedSessions": 1,
  "documentHash": "sha256:a1b2c3d4e5f6...",
  "sessions": [
    {
      "sessionId": "01JXYZ...",
      "transactionId": "01JXYZ...",
      "signerIndex": 1,
      "signerName": "Maria Oliveira"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.