Documents

Obter URL pré-assinada para upload

Gera uma URL pré-assinada do S3 para upload direto do documento. Após o upload, confirme com POST /v1/transactions/{id}/document/confirm.

Recomendado para documentos maiores que 5 MB.

Requer scope transactions:write.

post/v1/transactions/{transactionId}/document/presign

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/v1/transactions/{transactionId}/document/presign
  • Auth: HTTP bearer

Path parameters

transactionIdstring required

Identificador único da transação.

Request body

contentTypestring required

Tipo MIME do arquivo.

filenamestring required

Nome do arquivo.

Example request

{
  "contentType": "application/pdf",
  "filename": "contrato.pdf"
}

Response

URL pré-assinada gerada com sucesso.

uploadUrlstring uri required

URL pré-assinada do S3 para upload via PUT.

uploadTokenstring required

Token para confirmar o upload via /document/confirm.

s3Keystring required

Chave do objeto no S3.

expiresIninteger required

Tempo de expiração da URL em segundos.

contentTypestring required

Content-Type esperado no upload.

instructionsstring required

Instruções para o integrador realizar o upload.

Example response

{
  "expiresIn": 600,
  "contentType": "application/pdf"
}

Changes

No recorded changes to this operation across all 1 revision of this API.