Criar e enviar envelope numa chamada

Sandbox

https://api.sandbox.supersign.com.br

POST

/v4/api/envelopes/send-now

Cria o envelope com documentos, participantes e campos numa só chamada e devolve as URLs para enviar os arquivos. O envio aos participantes acontece sozinho quando todos os documentos terminam de processar. Consulte o andamento por webhook ou por GET /v4/api/envelopes/{envelopeId}. Equivale ao POST /v3/envelopes da API legada. Campos aceitam anchor (texto âncora) no lugar de pageNumber + position, com size obrigatório. A busca é assíncrona: roda depois do processamento dos documentos e antes do envio. Se não conseguir posicionar (texto não achado, PDF sem texto, PDF grande demais, campo fora da página), nada é enviado: ele é anulado e o motivo chega em cancellationReason no webhook ENVELOPE_VOIDED. Com a busca desligada no ambiente, responde 503 ANCHOR_SEARCH_UNAVAILABLE sem registrar nada. Veja o guia Posicionar campos por texto âncora.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Criado

Headers

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠409

🟠413

🟠422Erro de Parâmetro

🟠429

🔴503Serviço Indisponível

Request Example

Shell

JavaScript

Java

Swift

cURL

Cria e envia: um PDF, um signatário e um campo de assinaturaCria e envia com o signatário recebendo página e e-mails em espanhol (locale)

curl --location 'https://api.sandbox.supersign.com.br/v4/api/envelopes/send-now' \
--header 'Idempotency-Key: 7d3f1c52-9a4b-4e6d-8f20-5b1c9e3a7d41' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "Contrato de prestação de serviços",
    "message": "Olá! Segue o contrato para assinatura.",
    "documents": [
        {
            "ref": "contrato",
            "filename": "contrato.pdf",
            "contentType": "application/pdf",
            "fileSize": 245760
        }
    ],
    "signatories": [
        {
            "ref": "maria",
            "deliveryMethod": "EMAIL",
            "name": "Maria Souza",
            "email": "maria.souza@exemplo.com.br",
            "qualification": "Contratante"
        }
    ],
    "fields": [
        {
            "documentRef": "contrato",
            "signatoryRef": "maria",
            "pageNumber": 1,
            "type": "SIGNATURE",
            "position": {
                "x": 80,
                "y": 640
            },
            "size": {
                "width": 180,
                "height": 60
            }
        }
    ]
}'

Response Example

201 - Exemplo 1

{
    "envelopeId": "string",
    "uploadDetails": [
        {
            "documentId": "string",
            "documentRef": "string",
            "filename": "string",
            "uploadUrl": "string",
            "uploadHeaders": {
                "property1": "string",
                "property2": "string"
            }
        }
    ]
}

Modificado em 2026-10-10 22:15:12

Página anterior

Consultar histórico do envelope

Próxima página

Gerar URL de download do envelope em ZIP