Avviare la firma utilizzando un modello di busta

Nome del parametro

Tipo

Obbligatorio

Descrizione

envelopeTemplateId

string

true

ID del modello di busta

envelopeConfig

object

true

Configurazione del flusso di firma

contractConfig

boolean

false

Configurazione della firma del contratto

envelopeRemark

array

false

Note del contratto

envelopeSubject

string

true

Oggetto del presente flusso di firma

expireAfterSeconds

int

false

Scadenza per la firma del presente flusso; oltre tale data non sarà più possibile procedere alla firma. Timestamp Unix al millisecondo, durata predefinita e massima di 90 giorni.

callbackUrl

string

false

Indirizzo Web per ricevere le notifiche di callback

redirectUrl

string

false

Deve essere un indirizzo https valido

signConfig

object

false

Elemento di configurazione della firma

allowTransfer

boolean

false

Se è consentito al firmatario trasferire questa busta ad altri per la firma, predefinito false

true-consente ai firmatari nella busta di avere il diritto di trasferirla ad altri;

false-non consente ai firmatari nella busta di avere il diritto di trasferirla ad altri;

participants

array

false

Configurazione partecipanti

participantId

string

true

ID partecipante

authConfig

object

false

Elemento di configurazione dell'autenticazione

willingnessAuthModes

array

false

Modalità di verifica opzionale per il firmatario, predefinita noAuth

noAuth-nessuna verifica

accessCode-verifica tramite codice di accesso

sms-verifica OTP via SMS

idVerification-verifica documento d'identità

emailAuth-verifica OTP via email

digitalId-verifica identità digitale

whatsappAuth-verifica OTP via WhatsApp

accessCode

object

false

Impostazioni del codice di firma, obbligatorio quando authModes=accessCode

accessCode

string

false

Contenuto del codice, non distingue tra maiuscole e minuscole, può contenere lettere e numeri, lunghezza massima 45

promptInfo

string

false

Testo informativo per il codice di accesso, non deve contenere il codice di accesso, lunghezza massima 30, obbligatorio quando authModes=1.

sms

object

false

Validazione OTP SMS, obbligatorio quando authModes=sms

countryCode

string

false

Codice internazionale del Paese o della regione, non è necessario inserire il simbolo “+”

number

string

false

Nessuna verifica del formato, la lunghezza massima è limitata a 13 caratteri

idVerification

object

false

Impostazioni di verifica del documento d'identità, obbligatorio quando authModes=idVerification

name

string

false

Nome completo riportato sul documento d'identità del firmatario, lunghezza massima 100 caratteri

emailAuth

object

false

Validazione OTP email, obbligatorio quando authModes=emailAuth

authEmail

string

false

Indirizzo email per la verifica dell'identità del firmatario

digitalId

array

false

Verifica dell'identità digitale, obbligatorio quando authModes=digitalId

authApp

string

false

App utilizzata per la verifica dell'identità digitale

singpass: autenticazione dell'identità tramite Singpass

iamsmart: autenticazione dell'identità tramite iAM Smart

idNumber

string

false

Numero del documento d'identità del firmatario da verificare

whatsappAuth

object

false

Validazione OTP WhatsApp, obbligatoria quando authModes=whatsappAuth

countryCode

string

false

Codice internazionale del paese/regione, non è necessario inserire il simbolo "+"

number

string

false

Nessuna verifica del formato, lunghezza massima limitata a 13 caratteri

participantInfos

object

false

Parte fisica

userEmail

string

false

Indirizzo email del firmatario

phoneNumber

object

false

Numero di telefono, vuoto per impostazione predefinita

Parametro obbligatorio quando è richiesta una notifica SMS, devono essere forniti sia countryCode che number

countryCode

string

false

Codice internazionale del paese/regione, non è necessario inserire il simbolo "+"

number

string

false

Nessuna verifica del formato, lunghezza massima limitata a 13 caratteri

userName

string

false

Nome della persona

deliveryMethod

string

false

Modalità di notifica

none - nessuna notifica tramite messaggio

email - invio notifica via email

sms - invio notifica via SMS

WhatsApp - invio notifica tramite WhatsApp

customizeSettings

object

false

Configurazione personalizzata

customizeMessage

object

false

Configurazione personalizzata per notifiche

notificationLanguage

string

false

Lingua delle notifiche, predefinita in inglese

en-US Inglese

zh-CN Cinese semplificato

zh-Hant Cinese tradizionale

ja Giapponese

ES-MX Spagnolo

copiers

array

false

Aggiungi destinatario in copia

copierId

string

true

ID partecipante

CCInfos

object

false

Informazioni destinatario in copia

userEmail

string

false

Indirizzo email

userName

string

false

Nome personale

customizeSettings

object

false

Configurazione personalizzata

customizeMessage

object

false

Configurazione personalizzata per notifiche

notificationLanguage

string

false

Lingua della notifica, predefinito inglese

en-US Inglese

zh-CN Cinese semplificato

zh-Hant Cinese tradizionale

ja Giapponese

ES-MX Spagnolo

attchments

array

false

Informazioni per l'aggiunta di allegati (file non firmati)

documentId

string

false

ID del file allegato

fileName

string

false

Nome del file allegato

components

array

false

Elenco dei controlli

documentId

string

false

ID del file di appartenenza del controllo

componentId

string

false

ID del controllo

componentKey

string

false

Chiave del controllo, (scegliere tra ID del controllo e chiave del controllo)

componentValue

string

false

Valore di compilazione del controllo

Nome del parametro

Tipo

Descrizione

envelopeId

string

ID busta