Modificação de assinante

Modifica informações sobre o assinante do envio, exceto se o envio de assinaturas já foi iniciado.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
string
required
Body Params
string

Valor nonce único para identificação do assinante. Caso não seja enviado, seu valor será igual ao identificador único gerado para o assinante.

string
required

Nome do assinante dentro do envio a ser gerado.

string

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

string

Telefone do assinante dentro do envio a ser gerado. Deve estar no formato E.164.

string

Identificador pessoal único do assinante.

string

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

string
enum

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.

Allowed:
string
enum
Defaults to CREATOR

Modo de aposição da rúbrica visível. CREATOR - A definição da imagem e posição de assinatura são configuradas pelo criador do envelope, no momento de criação, não sendo possível sua alteração por parte do assinante. PRESET - A definição da imagem de assinatura fica a cargo do assinante. A posição em que cada imagem é inserida deve ser configurada no momento de criação do envelope. SIGNEE - A definição da imagem de assinatura e sua posição fica a cargo do assinante.

Allowed:
boolean
Defaults to false

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

string

Grupo ao qual este signatário pertence. Caso esteja vazio, o signatário não será adicionado a nenhum grupo.

string

Papel do signatário dentro do envelope. Caso esteja vazio, não será adicionado nenhum papel ao signatário.

authenticationOptions
array of strings

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)

authenticationOptions
signatureConfig
object

Configurações de assinatura para determinado assinante. Define o modo de assinatura (SIMPLE, ADVANCED, QUALIFIED) e as propriedades deste modo.

typeMessaging
array of strings

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.

typeMessaging
typeReport
array of strings

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.

typeReport
typeReportNotify
array of strings

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

typeReportNotify
biometricOptions
object

Configurações de biometria para assinatura.

metadata
object

Metadados do assinante que serão adicionados aos documentos assinados. Disponível somente para assinaturas em modos ADVANCED e QUALIFIED. Deve ser informado no formato JSON, contendo os metadados no formato chave-valor.

Responses
204

Sucesso na operação. Retorna apenas o código 204.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json