Skip to main content
Este endpoint retorna todos os detalhes de um envelope específico, incluindo campos, destinatários, histórico e configurações.
cURL
curl -X GET "https://api.formsign.com.br/api/envelopes/env_abc123456789" \
  -H "Authorization: Bearer <TOKEN>"

​
Parâmetros (Path)

​
envelopeId
string
required
ID único do envelope.

​
Respostas

{
  "envelopeId": "env_abc123456789",
  "subject": "Contrato de Prestação de Serviços",
  "message": "Por favor, revise e assine o documento anexo.",
  "status": "sent",
  "submissionType": "document",
  "creationDate": "2024-08-15T10:30:00Z",
  "lastUpdateDate": "2024-08-15T10:35:00Z",
  "sentDate": "2024-08-15T10:35:00Z",
  "userId": "user_123",
  "templateId": "tpl_456",
  "fields": [
    {
      "type": "signature",
      "identifier": "assinatura_cliente",
      "name": "Assinatura do Cliente",
      "value": null,
      "required": true,
      "readonly": false,
      "x": 70.5,
      "y": 85.2,
      "w": 20.0,
      "h": 8.0,
      "pageNumber": 1,
      "recipientRole": "signer"
    },
    {
      "type": "date",
      "identifier": "data_assinatura",
      "name": "Data da Assinatura",
      "value": null,
      "required": true,
      "readonly": false,
      "x": 70.5,
      "y": 77.0,
      "w": 20.0,
      "h": 6.0,
      "pageNumber": 1,
      "recipientRole": "signer"
    }
  ],
  "recipients": [
    {
      "recipientId": "rec_789",
      "email": "[email protected]",
      "name": "João Silva",
      "signatureType": "draw",
      "order": 1,
      "cpf": "123.456.789-00",
      "status": "sent",
      "role": "signer",
      "color": "#FF6B6B",
      "completedDate": null
    }
  ],
  "observers": [],
  "sender": {
    "email": "[email protected]",
    "userName": "Maria Santos"
  },
  "documentSettings": {
    "documentName": "contrato.pdf",
    "documentSizeMB": "2.45",
    "fileHash": "d41d8cd98f00b204e9800998ecf8427e"
  },
  "advancedOptions": {
    "autoReminders": true,
    "reminderDelay": 2,
    "reminderFrequency": 3,
    "expirationDays": 30,
    "expirationWarning": 5
  },
  "validationKey": "val_xyz789",
  "s3Key": "documents/user_123/env_abc123456789.pdf",
  "documentSignedS3Key": null,
  "completedDate": null,
  "expirationDate": "2024-09-14T10:35:00Z"
}

​
Campos da Response

​
envelopeId
string
ID único do envelope.
​
subject
string
Assunto do envelope.
​
message
string
Mensagem personalizada.
​
status
string
Status: draft, sent, completed, voided, expired.
​
submissionType
string
Tipo: document ou form.
​
creationDate
string
Data de criação (ISO 8601).
​
lastUpdateDate
string
Última atualização (ISO 8601).
​
sentDate
string
Data de envio (ISO 8601).
​
userId
string
ID do proprietário.
​
templateId
string
ID do template usado (se aplicável).
​
fields
array
Lista de campos do documento.
​
recipients
array
Lista de destinatários.
​
observers
array
Lista de observadores.
​
sender
object
Dados do remetente.
​
documentSettings
object
Configurações do documento.
​
advancedOptions
object
Opções avançadas.
​
validationKey
string
Chave de validação única.
​
s3Key
string
Chave S3 do documento original.
​
documentSignedS3Key
string
Chave S3 do documento assinado.
​
completedDate
string
Data de conclusão.
​
expirationDate
string
Data de expiração.
Este endpoint retorna todos os detalhes do envelope, incluindo campos não preenchidos. Use este endpoint quando precisar de informações completas sobre o envelope.