Iniciar assinatura com modelo de envelope

Nome do parâmetro

Tipo

Obrigatório

Descrição

envelopeTemplateId

string

true

ID do modelo de envelope

envelopeConfig

object

true

Configuração do fluxo de assinatura

contractConfig

boolean

false

Configuração de assinatura do contrato

envelopeRemark

array

false

Observações do contrato

envelopeSubject

string

true

Assunto deste fluxo de assinatura

expireAfterSeconds

int

false

Prazo final para assinatura deste fluxo. Após esse período, não será mais possível realizar assinaturas. Timestamp Unix em milissegundos, com validade padrão e máxima de 90 dias.

callbackUrl

string

false

Endereço Web para receber notificações de callback

redirectUrl

string

false

Deve ser um endereço HTTPS válido

signConfig

object

false

Item de configuração de assinatura

allowTransfer

boolean

false

Se permite que o signatário transfira este envelope para outra pessoa assinar, padrão false

true - Permite que o signatário do envelope tenha o direito de transferir o envelope para outra pessoa;

false - Não permite que o signatário do envelope tenha o direito de transferir o envelope para outra pessoa;

participants

array

false

Configuração de participantes

participantId

string

true

ID do participante

authConfig

object

false

Item de configuração de autenticação

willingnessAuthModes

array

false

Método de intenção opcional para o signatário, padrão noAuth

noAuth - Sem verificação

accessCode - Verificação por senha de assinatura

sms - Verificação OTP por SMS

idVerification - Verificação por documento de identidade

emailAuth - Verificação OTP por e-mail

digitalId - Verificação de identidade digital

whatsappAuth - Verificação OTP por WhatsApp

accessCode

object

false

Configuração da senha de assinatura, obrigatório quando authModes=accessCode

accessCode

string

false

Conteúdo da senha, sem distinção entre maiúsculas e minúsculas, pode conter letras e números, limite de tamanho 45

promptInfo

string

false

Mensagem de dica da senha de acesso, não pode conter a senha de acesso, limite de tamanho 30, obrigatório quando authModes=1.

sms

object

false

Validação OTP por SMS, obrigatório quando authModes=sms

countryCode

string

false

Código internacional do país/região, não é necessário inserir o "+"

number

string

false

Sem validação de formato, apenas limite máximo de tamanho de 13 caracteres

idVerification

object

false

Configuração de verificação de documento de identidade, obrigatório quando authModes=idVerification

name

string

false

Nome completo conforme consta no documento de identidade do signatário, tamanho máximo de 100 caracteres

emailAuth

object

false

Validação OTP por e-mail, obrigatório quando authModes=emailAuth

authEmail

string

false

Endereço de e-mail para verificação de identidade do signatário

digitalId

array

false

Verificação de identidade digital, obrigatório quando authModes=digitalId

authApp

string

false

Aplicativo utilizado para verificação de identidade digital

singpass - Autenticação de identidade usando Singpass

iamsmart - Autenticação de identidade usando iAM Smart

idNumber

string

false

Número do documento de identidade do signatário a ser verificado

whatsappAuth

object

false

Validação OTP do WhatsApp, obrigatório quando authModes=whatsappAuth

countryCode

string

false

Código internacional do país/região, não é necessário informar o “+”

number

string

false

Sem validação de formato, apenas limite máximo de 13 caracteres

participantInfos

object

false

Parte individual

userEmail

string

false

E-mail do signatário

phoneNumber

object

false

Número de telefone, vazio por padrão

Parâmetro obrigatório para notificação por SMS, countryCode e number devem ser informados

countryCode

string

false

Código internacional do país/região, não é necessário informar o “+”

number

string

false

Sem validação de formato, apenas limite máximo de 13 caracteres

userName

string

false

Nome individual

deliveryMethod

string

false

Método de notificação

none - não enviar notificação de mensagem

email - enviar notificação por e-mail

sms - enviar notificação por SMS

WhatsApp - enviar notificação via WhatsApp

customizeSettings

object

false

Configuração personalizada

customizeMessage

object

false

Configuração personalizada de notificações

notificationLanguage

string

false

Idioma da notificação, padrão em inglês

en-US Inglês

zh-CN Chinês Simplificado

zh-Hant Chinês Tradicional

ja Japonês

ES-MX Espanhol

copiers

array

false

Adicionar cópia

copierId

string

true

ID do participante

CCInfos

object

false

Informações da cópia

userEmail

string

false

E-mail

userName

string

false

Nome pessoal

customizeSettings

object

false

Configuração personalizada

customizeMessage

object

false

Configuração personalizada de notificações

notificationLanguage

string

false

Idioma da notificação, padrão é inglês

en-US Inglês

zh-CN Chinês Simplificado

zh-Hant Chinês Tradicional

ja Japonês

ES-MX Espanhol

attchments

array

false

Informações do anexo (arquivo sem assinatura)

documentId

string

false

ID do arquivo do anexo

fileName

string

false

Nome do arquivo do anexo

components

array

false

Lista de controles

documentId

string

false

ID do arquivo do controle

componentId

string

false

ID do controle

componentKey

string

false

Chave do controle (selecione entre ID do controle ou chave do controle)

componentValue

string

false

Valor de preenchimento do controle

Nome do parâmetro

Tipo

Descrição

envelopeId

string

ID do envelope