Detalhar Documento

Retorna os detalhes completos de um envelope, incluindo documentos, signatarios, campos de assinatura e trilha de auditoria.

Requisicao

GET /v1/envelopes/{id}

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer token de autenticacao

Parametros de URL

Parametro	Tipo	Obrigatorio	Descricao
id	string	Sim	Identificador unico do envelope

Exemplo de requisicao

curl -X GET \
  https://api.tapsign.com.br/v1/envelopes/env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a \
  -H "Authorization: Bearer {token}"

Resposta

200 - Sucesso

{
  "id": "env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
  "name": "Contrato de Prestacao de Servicos - Carlos Mendes",
  "status": "IN_PROGRESS",
  "documents": [
    {
      "id": "doc_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "name": "Contrato de Prestacao de Servicos",
      "originalFilename": "contrato.pdf",
      "contentType": "application/pdf",
      "fileSize": 245780,
      "pageCount": 4,
      "createdAt": "2026-03-25T10:15:30Z"
    }
  ],
  "signers": [
    {
      "id": "sgn_aaa111bbb",
      "name": "Carlos Eduardo Mendes",
      "email": "carlos@email.com",
      "role": "SIGNER",
      "status": "SIGNED",
      "signedAt": "2026-03-26T15:42:00Z",
      "ipAddress": "189.100.50.25",
      "viewedAt": "2026-03-26T15:40:12Z"
    },
    {
      "id": "sgn_ccc333ddd",
      "name": "Ana Paula Costa",
      "email": "ana@empresa.com.br",
      "role": "SIGNER",
      "status": "PENDING",
      "signedAt": null,
      "ipAddress": null,
      "viewedAt": null
    },
    {
      "id": "sgn_eee555fff",
      "name": "Roberto Lima",
      "email": "roberto@empresa.com.br",
      "role": "WITNESS",
      "status": "PENDING",
      "signedAt": null,
      "ipAddress": null,
      "viewedAt": null
    }
  ],
  "fields": [
    {
      "id": "fld_001",
      "signerId": "sgn_aaa111bbb",
      "type": "SIGNATURE",
      "page": 4,
      "x": 72.0,
      "y": 650.0,
      "width": 200.0,
      "height": 50.0,
      "required": true
    },
    {
      "id": "fld_002",
      "signerId": "sgn_ccc333ddd",
      "type": "SIGNATURE",
      "page": 4,
      "x": 350.0,
      "y": 650.0,
      "width": 200.0,
      "height": 50.0,
      "required": true
    }
  ],
  "auditTrail": [
    {
      "type": "CREATED",
      "description": "Envelope criado",
      "performedBy": "Maria Silva",
      "timestamp": "2026-03-25T10:15:30Z",
      "ipAddress": "200.150.100.50"
    },
    {
      "type": "SENT",
      "description": "Envelope enviado para assinatura",
      "performedBy": "Maria Silva",
      "timestamp": "2026-03-25T10:20:00Z",
      "ipAddress": "200.150.100.50"
    },
    {
      "type": "VIEWED",
      "description": "Documento visualizado por Carlos Eduardo Mendes",
      "performedBy": "Carlos Eduardo Mendes",
      "timestamp": "2026-03-26T15:40:12Z",
      "ipAddress": "189.100.50.25"
    },
    {
      "type": "SIGNED",
      "description": "Documento assinado por Carlos Eduardo Mendes",
      "performedBy": "Carlos Eduardo Mendes",
      "timestamp": "2026-03-26T15:42:00Z",
      "ipAddress": "189.100.50.25"
    }
  ],
  "createdAt": "2026-03-25T10:15:30Z",
  "updatedAt": "2026-03-26T15:42:00Z",
  "expiresAt": "2026-04-24T10:15:30Z"
}

Campos da resposta

Campo	Tipo	Descricao
id	string	Identificador unico do envelope
name	string	Nome do envelope
status	string	Status atual (DRAFT, SENT, IN_PROGRESS, COMPLETED, CANCELED, EXPIRED)
documents	array	Lista de documentos do envelope
documents[].id	string	Identificador do documento
documents[].name	string	Nome do documento
documents[].originalFilename	string	Nome original do arquivo
documents[].contentType	string	Tipo MIME do arquivo
documents[].fileSize	number	Tamanho do arquivo em bytes
documents[].pageCount	number	Numero de paginas do documento
signers	array	Lista de signatarios
signers[].id	string	Identificador do signatario
signers[].name	string	Nome do signatario
signers[].email	string	Email do signatario
signers[].role	string	Papel (SIGNER, WITNESS, APPROVER)
signers[].status	string	Status (PENDING, VIEWED, SIGNED, DECLINED)
signers[].signedAt	string	Data da assinatura (ISO 8601, null se pendente)
signers[].ipAddress	string	IP utilizado na assinatura
signers[].viewedAt	string	Data da primeira visualizacao (ISO 8601)
fields	array	Campos de assinatura posicionados no documento
auditTrail	array	Trilha de auditoria com eventos do envelope
createdAt	string	Data de criacao do envelope (ISO 8601)
updatedAt	string	Data da ultima atualizacao (ISO 8601)
expiresAt	string	Data de expiracao do envelope (ISO 8601)

Status do envelope

• DRAFT: Rascunho, ainda nao enviado para assinatura.
• SENT: Enviado, aguardando primeira interacao dos signatarios.
• IN_PROGRESS: Pelo menos um signatario ja assinou, mas ainda faltam assinaturas.
• COMPLETED: Todos os signatarios assinaram com sucesso.
• CANCELED: Cancelado pelo remetente antes da conclusao.
• EXPIRED: Prazo de assinatura expirado.

401 - Nao autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token de autenticacao invalido ou expirado."
}

404 - Nao encontrado

{
  "error": "NOT_FOUND",
  "message": "Envelope nao encontrado ou nao pertence a sua organizacao."
}