Modificação de assinante

Altera os dados de um signatário pendente de envelope não finalizado. Só os campos enviados são alterados; As notificações para o signatário não são enviadas automaticamente.

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

Campo enviado vazio apaga o valor atual ou volta ao padrão da criação do signatário.

string
^([A-Za-zÀ-Úà-ú0-9ç/\\\-_\.& ()@:;,]){1,100}$

Nome do signatário. Não pode ser vazio.

string
length ≤ 128

E-mail do signatário.

string

Telefone do signatário, no formato E.164.

string
^([A-Za-zÀ-Úà-ú0-9ç/\\\-_\.& ()@:;,]){0,50}$

Identificador pessoal único do signatário. Enviado junto com 'personal_identifier_type'.

string
length ≤ 50

Tipo da identificação enviada em 'personal_identifier'. Enviado junto com 'personal_identifier'.

string
enum

Idioma utilizado na comunicação com o signatário. Vazio volta ao idioma do envelope.

Allowed:
string
enum

Modo de aposição da rubrica visível. Vazio volta ao modo padrão.

Allowed:
string
^([A-Za-zÀ-Úà-ú0-9ç/\\\-_\.& ()@:;,]){0,40}$

Papel do signatário dentro do envelope.

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). VIEW_DOCUMENTS - Define se o signatário deverá visualizar todas as páginas dos documentos antes de seguir com a assinatura

authenticationOptions
signatureConfig
object

Configuração de assinatura do signatário.

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
Allowed:
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_SIGNED - Envia o(s) documento(s) assinado(s). DOCUMENT - Deprecated: utilize DOCUMENT_SIGNED. Envia o(s) documento(s) assinado(s). REPORT_UNIFIED - Envia o(s) relatório(s) unificado(s) do processo de assinatura. DOCUMENT_PRINTED - Envia o(s) documento(s) para impressão, com a representação visual das assinaturas e rubricas.

typeReport
Allowed:
typeReportNotify
array of strings

Modo de envio da mensagem de finalização. Enviado sem 'typeReport', vale para os relatórios atuais.

typeReportNotify
Allowed:
biometricOptions
object

Configurações de biometria para assinatura.

metadata
object

Metadados do signatário que serão adicionados aos documentos assinados. Disponível somente para assinaturas em modos ADVANCED e QUALIFIED. Vazio mantém os metadados atuais.

signaturePositions
array of objects

Posições de assinatura do signatário, uma por documento, na ordem dos documentos do envelope. Substitui todas as posições atuais; vazio volta às posições padrão.

signaturePositions
rubricConfig
object

Objeto JSON com a configuração e posições das rubricas de um signatário.

markerConfig
object

Objeto JSON com as posições dos marcadores de assinatura de um signatário. O marcador repete a imagem de assinatura do signatário em pontos adicionais do documento, sem alterar a posição de assinatura.

signatureDesignConfig
object

Configuração do desenho da assinatura do signatário. Substitui a configuração atual; 'personalIdentifier' ausente volta a NONE.

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