Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Informação

Informações completas das assinaturas

Devolve todas as informações sobre o processo de um determinado envio de assinaturas.

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

Response

Retorno das informações completas de um envio para Assinatura

uuidstring

Request_id criado para o envio

namestring

Nome atribuído ao envio e exibido para o assinante

clientNamestring

Nome atribuído ao criador do envio e exibido para o assinante

accessPasswordstring

Senha de acesso ao(s) relatório(s) de assinaturas, criada para o envio

language'pt-br' | 'en-us' | 'es-cl'

Linguagem padrão do envelope. Define a linguagem para os signatários que não a definirem.

status'DRAFT' | 'CREATED' | 'ONGOING' | 'FINISHED' | 'EXPIRED' | 'DELETED'

Status atual deste envio. CREATED - Envio de assinatura foi gerado; ONGOING - Assinaturas do envio foram inicializadas; FINISHED - Todas as assinaturas definidas no envio foram realizadas; EXPIRED - Tempo de expiração do envio chegou ao fim sem que todas as assinaturas tenham sido realizadas; DELETED - Envio foi deletado sem que todas as assinaturas tenham sido realizadas; DRAFT - Envelope está em estado de rascunho, signatários ainda não podem realizar assinaturas;

signatureOrder'UNORDERED' | 'ORDERED' | 'GROUPED'

Modo de ordenação das assinaturas deste envio

expirationstring

Unix timestamp de expiração do envio

creationstring

Unix timestamp de criação do envio

deletionstring

Unix timestamp de deleção do envio, caso envio tenha sido deletado

keepDocumentboolean

Define se os documentos assinados serão mantidos após a expiração do envelope

Example response

{
  "uuid": "a0089a7c-3f15-48d2-995a-6f59ed79f824",
  "name": "Envio de assinaturas Bry Tecnologia",
  "clientName": "Bry Tecnologia",
  "accessPassword": "123456",
  "status": "CREATED",
  "signatureOrder": "UNORDERED",
  "expiration": "1698912385",
  "creation": "1698912385",
  "deletion": "1699052385",
  "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
      }
    }
  ],
  "documents": [
    {
      "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"
      }
    }
  ]
}