v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB

Informação

Informações sobre documento específico

Obtém o status e o link do documento específico cujo nonce deve ser enviado na URL.

get/api/service/sign/v1/signatures/{request_id}/documents/{documentNonce}

Response

Retorno de Sucesso para detalhes do documento dentro da requisição de envio - Documento original, assinado atual, e status de cada assinatura de cada assinante no documento

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"
  },
  "signers": [
    {
      "signerNonce": "Signer Nonce",
      "signerUuid": "d23ef88b-d749-49c4-a8ac-58ca397a9927",
      "name": "João Qualificada",
      "email": "joao.qualifidada@bry.com.br",
      "phone": "+48123456789",
      "personal_identifier": "123.456.321-51",
      "personal_identifier_type": "CPF",
      "status": "Pending",
      "evidenceDate": "1699052385",
      "purpose": "Testemunha",
      "signatureConfig": {
        "mode": "QUALIFIED",
        "hashAlgorithm": "SHA256",
        "profile": "BASIC"
      },
      "link": {
        "href": "https://easysign.bry.com.br/{request_id}/sign/{signerNonce}"
      },
      "iframe": {
        "href": "https://easysign.bry.com.br/{request_id}/sign/{signerNonce}/iframe"
      },
      "typeMessaging": [
        "LINK"
      ],
      "typeReport": [
        "REPORT",
        "DOCUMENT",
        "REPORT_UNIFIED"
      ],
      "typeReportNotify": [
        "EMAIL",
        "SMS"
      ],
      "biometricOptions": {
        "similarity": 0.9,
        "datavalid": 0.9,
        "livenessCaptureProbability": 1,
        "livenessCaptureScore": 0.5,
        "livenessFaceProbability": 0.5
      }
    }
  ]
}