Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Envelope

Iniciar uma requisição de assinatura

Realiza uma requisição de envio de um ou mais documentos para assinatura, conforme parâmetros e gera links de acesso a página de assinatura para cada assinante listado.

post/api/service/sign/v1/signatures

Request body

namestring required

Determina o nome que será atribuído ao envio e exibido para o assinante no momento da assinatura.

clientNamestring required

Determina o nome que será atribuído ao criador do envio e exibido para o assinante no momento da assinatura.

expirationnumber

Determina a duração da requisição de envio de assinaturas gerada em segundos. Mínimo: 86400 (1 dia). Default: 604800 (7 dias)

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

Determina se existirá uma ordem pré-definida para os assinantes. ORDERED - criador do envelope define a ordem das assinaturas; UNORDERED - sem ordem pré-definida entre as assinaturas; GROUPED - criador do envelope define a ordem dos grupos que podem realizar as assinaturas;

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

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

sendNotificationsboolean

Define se as mensagens de notificação definidas para os signatários serão enviadas na criação do envelope. Deprecated: para não enviar as notificações configuradas na inicialização deve ser utilizado o parâmetro 'startAsDraft' e iniciar o envelope pela página de configuração

startAsDraftboolean

Define se o envelope será iniciado no estado de 'DRAFT'. Caso esteja verdadeiro, as notificações dos signatários não serão enviadas, sendo necessário iniciar o envelope após finalizar as alterações. Para inicializar o envelope, acesse a página de configuração do envelope.

keepDocumentboolean

Define se os documentos assinados serão mantidos após a expiração do envelope. Caso esteja verdadeiro, os documentos não serão removidos automaticamente após a expiração do envelope

Example request

{
  "name": "Envio de assinaturas Bry Tecnologia",
  "clientName": "Bry Tecnologia",
  "expiration": 604800,
  "signatureOrder": "UNORDERED",
  "signersData": [
    {
      "signerNonce": "Signer Nonce",
      "name": "João Qualificada",
      "email": "joao.qualificada@bry.com.br",
      "phone": "+48123456789",
      "personal_identifier": "123.456.321-51",
      "personal_identifier_type": "CPF",
      "purpose": "Testemunha",
      "signatureConfig": {
        "mode": "ADVANCED",
        "hashAlgorithm": "SHA256",
        "profile": "BASIC"
      },
      "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": [
    {
      "type": "PDF",
      "name": "contrato.pdf",
      "size": 524288,
      "hash": {
        "value": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
        "algorithm": "SHA-256"
      }
    }
  ],
  "images": [
    {
      "image": "iVBORw0KGgoAAAANSUhEUgAAAB4AAAAPCAYAAADzun+cAAAACXBIWXMAAAsSAAALEgHS3X78AAABmElEQVQ4ja1V3W3CMBD+ijoAGzRPfqYbhAmgE5BKHgAmIExA+x6JZIKyQegGPPsp3YARqrPvkotJBKj9JMv25ez77seXJxRuCmDGg9aCE4AzrLm0ksIlAGikSq9hvTMeABmmS+qRI2R0A2tKNpwD2I7okuH3ewlMon3Dnja8pwgc2NNboIh93evzc7SvYE3O3u0BrFmeKDKCOaw5MamadRIUjgismAhgzbw9UTiJ7Dn2WBSmfJHgMqgXLpYoCaROUj9CKsGEUqmP2OMtChfnsBzJ2wyFo3kBIFNyIvKtorVgYrogq2GP+1gy2xh7DvFayT98BKw5qtQseV61xKy5CnXpcxfGToVurJI1yOhG7Y88JxzumZbHhn98wYSRK/kU1xCCgiyq/k+1Pqh1NWT4xbML4/bTIILkaUfuoL41Pa8D2kYTG844b7XKTcw+xk5VfVfFw+fa/YQPjT0XYvfGxTLmdehuHbbqm25Gl7YD+pap0fXtfo9+FMFruUuI7HTd9A3/F0KHin8kr9qZe97xX0FpovbaRRDALxnAhd1SgHC5AAAAAElFTkSuQmCC",
      "imageNonce": "Imagem1"
    }
  ]
}

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"
      }
    }
  ]
}