Adicionar documento ao envelope

Sandbox

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

POST

/v4/api/envelopes/{envelopeId}/documents

Registra um documento no envelope e retorna os dados necessários para enviar o arquivo.

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Criado

Headers

Bodyapplication/json

🟠401Não Autorizado

🟠404Registo Não Encontrado

🟠413

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.sandbox.supersign.com.br/v4/api/envelopes//documents' \
--header 'Idempotency-Key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "documents": [
        {
            "filename": "string",
            "contentType": "application/pdf",
            "fileSize": 9007199254740991,
            "isAttachment": false
        }
    ]
}'

Response Example

201 - Exemplo 1

[
    {
        "documentId": "string",
        "uploadUrl": "string",
        "uploadFields": {
            "property1": "string",
            "property2": "string"
        }
    }
]

Modificado em 2026-09-08 21:34:21

Página anterior

Listar campos do documento

Próxima página

Gerar URL de download do documento