v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB

Informação

Informações sobre todos os assinantes

Obtém informações sobre os assinantes, e os status de suas assinaturas para cada documento listado no envio.

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

Response

Retorno das informações relacionadas a todos os assinantes

signerNoncestring

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

signerUuidstring

Valor UUID do assinante, gerado pelo backend

namestring

Nome do assinante

emailstring

E-mail do assinante dentro do envio a ser gerado.

phonestring

Telefone do assinante dentro do envio a ser gerado.

personal_identifierstring

Identificador pessoal único do assinante.

personal_identifier_typestring

Tipo da identificação enviada em 'personal_identifier'.

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

Linguagem que será utilizada como padrão na comunicação com signatário para página de assinatura, e-mail e/ou sms. Caso não informada, utiliza a linguagem do envelope.

positioningMode'CREATOR' | 'PRESET' | 'SIGNEE'

Modo de aposição da rúbrica visível. CREATOR - Posição e imagem definidas apenas pelo criador das assinaturas. PRESET - Posição e imagem iniciais definidas pelo criador das assinaturas com possibilidade da definição da imagem de assinaura pelo assinante. SIGNEE - Posição e imagem iniciais definidas pelo criador das assinaturas com possibilidade da definição da posição e imagem de assinatura pelo assinante.

signInBatchboolean

Permite que este envelope seja assinado em lote pelo signatário, caso haja outros envelopes pendentes

canSignboolean

Se assinante pode assinar o envio

status'PENDING' | 'SIGNED' | 'REFUSED'

Status da assinatura deste assinante. PENDING - Assinatura ainda não foi realizada; SIGNED - Assinatura realizada; REFUSED - Assinatura recusada.

groupNoncestring

Grupo ao qual este signatário pertence. Valor não é retornado caso signatário não pertença a nehum grupo.

evidenceDatestring

Unix timestamp da assinatura do assinante, caso assinatura tenha sido realizada

purposestring

Papel do signatário dentro do envelope

authenticationsstring[]

Objeto JSON Array, com todos os tipos de evidências que devem ser coletadas na tela de assinatura pelo signatário. GEOLOCATION - Define se utilizará as coordenadas geográficas do signatário. IP - Define se utilizará endereço ip do signatário. OTP_PHONE - Define se a confirmação OTP será enviada ao telefone do signatário por SMS. Caso verdadeiro, o número de telefone do signatário deve ser informado. OTP_EMAIL - Define se a confirmação OTP será enviada ao email do signatário. Caso verdadeiro, o email do signatário deve ser informado. OTP_WHATSAPP - Define se a confirmação OTP será enviada ao telefone do signatário por WhatsApp. Caso verdadeiro, o número de telefone do signatário deve ser informado. SELFIE - Define se será tirada Foto do usuário no momento da assinatura. DRIVER_LICENSE - Define se será solicitado foto ou PDF da carteira de motorista do usuário no momento da assinatura. Se definido também o parâmetro SELFIE, será realizada a verificação de similaridade entre a foto do usuário e do documento. Caso formato PDF e definição do parâmtro SELFIE, será aceito exclusivamente o documento emitido pelo aplicativo Carteira Digital de Trânsito. DATAVALID - Define se a Foto do usuário será validada na base do governo. Caso verdadeiro, o CPF do signatário deve ser informado pelo parâmetro 'personal_identifier', utilizando CPF como personal_identifier_type. Adiciona nível de segurança SELFIE. É possível definir o nível mínimo de similaridade aceito utilizando o parâmetro biometricOptions de cada signatário. LIVENESS - Define se será verificado vivacidade do signatário. Adiciona nível de segurança SELFIE. É possível definir os valores mínimos de vivacidade aceitos utilizando o parâmetro biometricOptions de cada signatário. PERSONAL_IDENTIFIER - Define se será solicitado a confirmação do 'personal_identifier' do signatário na tela de assinaturas. A confirmação será realizada utilizando apenas os caracteres alpha-numéricos do campo (ex: os valores 12345632151 e 123.456.321-51 serão considerados iguais). VIEW_DOCUMENTS - Define se o signatário deverá visualizar todas as páginas dos documentos antes de seguir com a assinatura

typeMessagingstring[]

Canal de retorno do link de acesso a tela de assinaturas para cada assinante. LINK - Retorno das informações na(s) resposta(s) da API. EMAIL - Envia o link de acesso para o email do signatário. WHATSAPP - Envia o link de acesso para o whatsapp do signatário.

typeReportstring[]

Tipo de mensagem de finalização que será enviada para o signatário. REPORT - Envia o(s) relatório(s) de validação dos documentos. DOCUMENT - Envia o(s) documento(s) assinados. REPORT_UNIFIED - Envia o(s) relatório(s) unificado(s) do processo de assinatura.

typeReportNotifystring[]

Modo de como a mensagem de finalização será enviada para o signatário. Caso não definido na requisição, será utilizado o tipo EMAIL. EMAIL - Envia a(s) mensagem(ns) para o email do signatário. Caso os documentos sejam muito grandes, envia um link para download. SMS - Envia um link de acesso a(s) mensagem(ns) para o telefone do signatário através de um SMS

metadataobject

Metadados do assinante que serão adicionados aos documentos assinados.

Example response

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