Skip to main content
Este endpoint permite enviar envelopes enviando o PDF diretamente codificado em base64.
cURL
curl -X POST "https://api.formsign.com.br/api/envelopes/send/base64" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Contrato para Assinatura",
    "message": "Por favor, revise e assine o documento anexo.",
    "submissionType": "document",
    "base64Document": "JVBERi0xLjQKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFsgMyAwIFIgXQovQ291bnQgMQo+PgplbmRvYmoK...",
    "documentName": "contrato.pdf",
    "fields": [
      {
        "type": "signature",
        "identifier": "assinatura_cliente",
        "required": true,
        "x": 70,
        "y": 90,
        "w": 20,
        "h": 8,
        "pageNumber": 1
      },
      {
        "type": "date",
        "identifier": "data_assinatura",
        "required": true,
        "x": 70,
        "y": 80,
        "w": 20,
        "h": 6,
        "pageNumber": 1
      }
    ],
    "recipients": [
      {
        "email": "[email protected]",
        "name": "João Silva",
        "signatureType": "draw",
        "role": "signer"
      }
    ],
    "advancedOptions": {
      "autoReminders": true,
      "reminderDelay": 2,
      "reminderFrequency": 3,
      "expirationDays": 30,
      "expirationWarning": 5
    }
  }'

Parâmetros (Body)

subject
string
required
Assunto do envelope.
message
string
Mensagem personalizada para os destinatários.
submissionType
string
required
Deve ser “document”.
base64Document
string
required
Documento PDF codificado em base64.
documentName
string
required
Nome do arquivo (deve terminar com .pdf).
fields
array
required
Campos do documento.
recipients
array
required
Destinatários do envelope.
advancedOptions
object
Opções avançadas de entrega.

Validações

  • PDF válido: O documento deve ser um PDF válido (magic bytes: %PDF)
  • Tamanho máximo: 10MB
  • Nome do arquivo: Deve terminar com .pdf
  • Base64: Deve estar no formato correto
  • Destinatários: Pelo menos um destinatário é obrigatório
  • Campos: Pelo menos um campo é obrigatório

Respostas

{ 
  "message": "Success",
  "envelopeId": "env_abc123456789"
}