Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Gestão

Inclusão de novos documentos para assinatura

Efetua o upload e a inclusão de novos documentos para assinatura em um determinado envio de assinaturas que ainda não foi inicializada.

post/api/service/sign/v1/signatures/{request_id}/documents

Request body

type'PDF' | 'CMS' | 'XML'

Formato detectado do documento.

namestring

Nome do documento.

sizeinteger

Tamanho do documento em bytes.

Example request

[
  {
    "type": "PDF",
    "name": "contrato.pdf",
    "size": 524288,
    "hash": {
      "value": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
      "algorithm": "SHA-256"
    }
  }
]

Response

Retorno das informações relacionadas aos novos documentos adicionados ao envio

documentNoncestring

Valor nonce do documento, definido pelo usuário ou gerado pelo backend

documentUuidstring

Valor UUID do documento, gerado pelo backend

namestring

Nome do documento

status'AVAILABLE' | 'DELETED'

Status atual do documento. AVAILABLE - Documento está disponível; DELETED - Documento foi removido e não está mais disponível.

deletionstring

Unix timestamp de deleção do documento, caso ele tenha sido removido.

currentDocumentSizenumber

Tamanho (em bytes) do documento contendo as assinaturas já realizadas.

Example response

[
  {
    "documentNonce": "Document Nonce",
    "documentUuid": "d23ef88b-d749-49c4-a8ac-58ca397a9927",
    "name": "Documento_1",
    "status": "AVAILABLE",
    "deletion": "1699052385",
    "currentDocumentSize": 64297,
    "currentDocumentLink": {
      "href": "https://easysign.bry.com.br/api/service/sign/v1/signatures/{request_id}/documents/{documentNonce}/signed"
    },
    "originalDocumentLink": {
      "href": "https://easysign.bry.com.br/api/service/sign/v1/signatures/{request_id}/documents/{documentNonce}/file"
    }
  }
]