Documents

Upload de documento (base64)

Envia o documento codificado em base64 diretamente no corpo da requisição. Suporta PDF, DOCX, XLSX, PPTX, ODT, imagens e outros formatos. Para documentos maiores, utilize o fluxo de upload pré-assinado (presign → upload direto ao S3 → confirm).

Validação de qualidade do PDF

O documento é validado quanto à qualidade e integridade. Caso o PDF seja inválido, corrompido, protegido por senha ou não atenda aos critérios mínimos de qualidade, a API retorna 422 Unprocessable Entity com detalhes do problema.

Requer scope transactions:write.

post/v1/transactions/{transactionId}/document

Request

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

Path parameters

transactionIdstring required

Identificador único da transação.

Request body

contentstring byte required

Conteúdo do documento codificado em base64.

filenamestring

Nome do arquivo com extensão. Obrigatório para documentos não-PDF. Extensões permitidas: .docx, .doc, .xlsx, .xls, .pptx, .ppt, .odt, .ods, .odp, .rtf, .txt, .csv, .jpg, .jpeg, .png, .tiff, .tif, .bmp, .svg, .xml, .json, .html, .pdf

Example request

{
  "filename": "contrato.docx"
}

Response

Documento enviado com sucesso.

transactionIdstring required
documentHashstring required

Hash SHA-256 do documento.

documentFormat'pdf' | 'generic' required

Formato detectado do documento.

status'DOCUMENT_UPLOADED' required
uploadedAtstring date-time required

Changes

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