Iniciar firma con plantilla de sobre

Nombre del parámetro

Tipo

Obligatorio

Descripción

envelopeTemplateId

string

true

ID de la plantilla de sobre

envelopeConfig

object

true

Configuración del proceso de firma

contractConfig

boolean

false

Configuración de firma del contrato

envelopeRemark

array

false

Notas del contrato

envelopeSubject

string

true

Tema del proceso de firma actual

expireAfterSeconds

int

false

Fecha límite de firma del proceso de firma actual. Una vez superado este tiempo, no se podrán realizar más firmas. Marca de tiempo Unix en milisegundos. Validez predeterminada y máxima de 90 días.

callbackUrl

string

false

Dirección Web para recibir notificaciones de devolución de llamada

redirectUrl

string

false

Debe ser una dirección https válida

signConfig

object

false

Configuración de firma

allowTransfer

boolean

false

Indica si se permite al firmante transferir este sobre a otra persona para su firma, valor predeterminado false

true-Permite que el firmante del sobre tenga la facultad de transferirlo a otra persona;

false-No permite que el firmante del sobre tenga la facultad de transferirlo a otra persona;

participants

array

false

Configuración de participantes

participantId

string

true

ID del participante

authConfig

object

false

Configuración de autenticación

willingnessAuthModes

array

false

Método opcional de intención del firmante, predeterminado noAuth

noAuth-Sin verificación

accessCode-Verificación mediante contraseña de firma

sms-Verificación OTP por SMS

idVerification-Verificación de documento de identidad

emailAuth-Verificación OTP por correo electrónico

digitalId-Verificación de identidad digital

whatsappAuth-Verificación OTP por WhatsApp

accessCode

object

false

Configuración de la contraseña de firma, obligatoria cuando authModes=accessCode

accessCode

string

false

Contenido de la contraseña, sin distinción de mayúsculas y minúsculas, puede contener letras y números, límite de longitud 45

promptInfo

string

false

Mensaje de indicación de la contraseña de acceso, no debe contener la contraseña de acceso, límite de longitud 30, obligatorio cuando authModes=1.

sms

object

false

Validación OTP por SMS, obligatoria cuando authModes=sms

countryCode

string

false

Código internacional del país o región, no es necesario incluir el símbolo "+"

number

string

false

No se realiza validación de formato, solo se limita la longitud máxima a 13 caracteres

idVerification

object

false

Configuración de verificación de documento de identidad, obligatoria cuando authModes=idVerification

name

string

false

Nombre completo que figura en el documento de identidad del firmante, longitud máxima de 100 caracteres

emailAuth

object

false

Validación OTP por correo electrónico, obligatoria cuando authModes=emailAuth

authEmail

string

false

Dirección de correo electrónico para la verificación de identidad del firmante

digitalId

array

false

Verificación de identidad electrónica, obligatoria cuando authModes=digitalId

authApp

string

false

Aplicación utilizada para la verificación de identidad electrónica

singpass - autenticación de identidad mediante Singpass

iamsmart - autenticación de identidad mediante IAM Smart

idNumber

string

false

Número de documento de identidad del firmante pendiente de verificación

whatsappAuth

object

false

Validación OTP de WhatsApp, obligatorio cuando authModes=whatsappAuth

countryCode

string

false

Código internacional del país o región, no es necesario incluir el símbolo '+'

number

string

false

Sin validación de formato, solo se limita la longitud máxima a 13 caracteres

participantInfos

object

false

Parte individual

userEmail

string

false

Correo electrónico del firmante

phoneNumber

object

false

Número de teléfono, vacío por defecto

Parámetro obligatorio para notificaciones por SMS; deben proporcionarse tanto countryCode como number

countryCode

string

false

Código internacional del país o región, no es necesario incluir el símbolo '+'

number

string

false

Sin validación de formato, solo se limita la longitud máxima a 13 caracteres

userName

string

false

Nombre de la persona

deliveryMethod

string

false

Método de notificación

none-no enviar notificación de mensaje

email-enviar notificación por correo electrónico

sms-enviar notificación por SMS

WhatsApp-enviar notificación por WhatsApp

customizeSettings

object

false

Configuración personalizada

customizeMessage

object

false

Configuración personalizada de notificaciones

notificationLanguage

string

false

Idioma de notificación, inglés predeterminado

en-US Inglés

zh-CN Chino simplificado

zh-Hant Chino tradicional

ja Japonés

ES-MX Español

copiers

array

false

Agregar copia

copierId

string

true

ID del participante

CCInfos

object

false

Información de copia

userEmail

string

false

Correo electrónico

userName

string

false

Nombre personal

customizeSettings

object

false

Configuración personalizada

customizeMessage

object

false

Configuración personalizada de notificaciones

notificationLanguage

string

false

Idioma de notificación, el predeterminado es inglés

en-US inglés

zh-CN chino simplificado

zh-Hant chino tradicional

ja japonés

ES-MX español

attchments

array

false

Información para agregar archivos adjuntos (archivos que no requieren firma)

documentId

string

false

ID del archivo adjunto

fileName

string

false

Nombre del archivo adjunto

components

array

false

Lista de controles

documentId

string

false

ID del archivo al que pertenece el control

componentId

string

false

ID del control

componentKey

string

false

Clave del control (seleccione entre ID del control o clave del control)

componentValue

string

false

Valor de relleno del control

Nombre del parámetro

Tipo

Descripción

envelopeId

string

ID del sobre