Nome del parametro | Tipo | Obbligatorio | Descrizione |
subject | string | true | Oggetto del plico Esempio: "Lettera di offerta" |
remark | string | false | Note del plico, limite di lunghezza 1000 caratteri |
signerSettings | object | false | Operazioni consentite ai firmatari |
| | allowTransfer | boolean | false | Se è consentito al firmatario di trasferire questa busta a un'altra persona per la firma, il valore predefinito è false true - Consente ai firmatari nella busta di avere il potere di trasferire la busta ad altri; false - Non consente ai firmatari nella busta di avere il potere di trasferire la busta ad altri; |
| | allowModifyName | boolean | false | Se è consentito al firmatario di modificare il nome, valido solo per le firme dei modelli, il valore predefinito è false true - Consente al firmatario di modificare il nome false - Non consente al firmatario di modificare il nome |
expireAfterSeconds | long | false | Scadenza della busta, dopo quanti secondi scade la busta Intervallo di scadenza: da 86.400 secondi (1 giorno) a 7.776.000 secondi (90 giorni) |
redirectUrl | string | false | Deve essere un indirizzo https valido |
callBackUrl | string | false | Indirizzo di callback (lunghezza massima 500), deve essere conforme all'indirizzo del protocollo https. |
sendLaterAfterSeconds | long | false | Supporta l'invio ritardato da parte dell'utente, in secondi Intervallo di tempo supportato: da 3.600 secondi (1 ora) a 259.200 secondi (30 giorni) |
autoFinish | boolean | false | Controlla se la busta termina automaticamente, il valore predefinito è true true- Terminazione automatica della busta false- Terminazione manuale della busta |
CCInfos | array | false | Collezione delle informazioni dei destinatari in copia |
| userEmail | string | false | Indirizzo email del destinatario in copia |
| userName | string | false | Nome del destinatario in copia, utilizzato per visualizzare il nome del destinatario in copia sulla pagina di firma e sul pacco. [Attenzione]: non deve contenere i seguenti 9 caratteri speciali: / \ : * " < > | ? nonché tutte le emoji |
| ccOrder | int | false | Posizione ordinale del destinatario in copia nel processo di firma, che condivide l'ordine con signOrder dei firmatari. Se non specificato, viene mantenuta la logica originale di notifica ai destinatari in copia. |
| | customizeSettings | object | false | Configurazione personalizzata |
| | | notificationSettings | object | false | Configurazione personalizzata per le notifiche |
| | | | notificationLanguage | string | false | Lingua della notifica, per impostazione predefinita utilizza la configurazione 'lingua di notifica predefinita' en-US inglese zh-CN cinese semplificato zh-Hant cinese tradizionale ja-JP giapponese es-MX spagnolo pt-PT portoghese th-TH thailandese id-ID Bahasa Indonesia vi-VN Bahasa Vietnam ms-MY Bahasa Melayu fil-PH Bahasa Filipina de-DE Bahasa Jerman fr-FR Bahasa Prancis ru-RU Bahasa Rusia it-IT Bahasa Italia ko-KR Bahasa Korea |
signFiles | array | true | Insieme di informazioni sui documenti firmati, visualizzati nell'ordine in cui sono stati aggiunti. |
| fileKey | string | true | fileKey del documento firmato, supporta solo il formato PDF |
| | documentFields | array | false | Elenco dei controlli delle dimensioni del documento. Utilizzato per aggiungere controlli delle dimensioni del documento non associati a firmatari su un documento specifico. |
| | fieldType | string | false | Tipo di controllo. Inserire eMeterai per indicare il controllo dell'imposta di bollo indonesiana. |
| | pageNo | string | false | Numero della pagina in cui si trova il controllo. Il controllo dell'imposta di bollo indonesiana supporta solo una singola pagina; è necessario inserire un numero di pagina singolo, non sono supportati formati multipli continui o discontinui come 1-3, 1,3, ecc. |
| | | posX | float | false | Offset sull'asse x, con l'angolo in basso a sinistra della pagina come origine delle coordinate. L'intervallo delle coordinate è coerente con quello degli altri controlli. |
| | | posY | float | false | Spostamento sull'asse y, con l'origine delle coordinate nell'angolo in basso a sinistra della pagina. L'intervallo delle coordinate è coerente con quello degli altri controlli. |
attachments | array | false | Collezione di allegati sotto forma di busta, ordinata secondo la sequenza di aggiunta dei file. |
| fileKey | string | false | fileKey del documento |
signerInfos | array | true | Collezione di informazioni sui firmatari |
| businessId | string | false | Numero di riferimento aziendale personalizzato dallo sviluppatore, limite di lunghezza 500 |
| | roleTypes | array | false | Modalità di operazione del firmatario, valore predefinito ["sign", "fill"] fill-compilazione sign-firma |
| | deliveryMethods | string | false | Modalità di notifica, valore predefinito auto auto- quando viene passato userEmail, invia una notifica via email; quando viene passato phoneNumber, invia una notifica SMS none- non invia notifiche tramite messaggio email- invia notifica via email sms- invia notifica SMS WhatsApp- invia notifica WhatsApp |
| userEmail | string | false | Indirizzo email del firmatario |
| userName | string | true | Nome del firmatario, utilizzato per visualizzare il nome del firmatario nella pagina di firma e nell'anteprima dell'involucro. [Nota] Non deve contenere i seguenti 9 caratteri speciali: / \ : * " < > | ? nonché tutte le emoji |
| | minimumReadingDuration | int | false | Imposta il tempo di countdown obbligatorio per la lettura nella pagina di configurazione; il valore predefinito è 0 (unità: secondi, massimo 999) 0 o l'omissione indica che non è attivato alcun countdown per la lettura |
| | readToEndRequired | boolean | false | Indica se è necessario leggere fino alla fine. Valore predefinito: false; true indica attivazione; false o l'omissione indicano disattivazione. |
| phoneNumber | object | false | Numero di telefono, vuoto per impostazione predefinita Parametro obbligatorio quando sono necessarie notifiche SMS; devono essere forniti sia countryCode che number |
| | countryCode | string | false | Codice internazionale del paese/regione; non includere il simbolo '+' |
| | number | string | false | Nessuna convalida del formato, lunghezza massima consentita di 13 caratteri |
| | customizeSettings | object | false | Configurazione personalizzata |
| | | notificationSettings | object | false | Configurazione personalizzata per le notifiche |
| | | | customizeMessage | string | false | Notifica messaggio dedicato, limite di 200 caratteri |
| | | | notificationLanguage | string | false | Lingua della notifica; per impostazione predefinita utilizza la configurazione 'lingua di notifica predefinita' en-US inglese zh-CN Cinese semplificato zh-Hant Cinese tradizionale ja-JP Giapponese es-MX Spagnolo pt-PT Portoghese th-TH Thai id-ID Indonesiano vi-VN Vietnamita ms-MY Malese fil-PH Filippino de-DE Tedesco fr-FR Francese ru-RU Russo it-IT Italiano ko-KR Coreano |
| signOrder | int | true | Ordine di firma del firmatario, minimo 1. Per la firma non ordinata è possibile assegnare lo stesso valore di ordine. |
| signTaskSuspend | boolean | false | Se impostare un nodo di blocco del flusso prima di questa posizione di firma, predefinito false. true: imposta il nodo di blocco; false: non imposta il nodo di blocco. La configurazione di blocco all'interno di un gruppo OR con lo stesso signOrder deve essere coerente. |
| suspensionKey | string | false | Identificatore del nodo di blocco, massimo 500 caratteri, unico all'interno dello stesso plico. Obbligatorio quando signTaskSuspend=true; non deve essere fornito quando signTaskSuspend=false o non viene passato. |
| suspendReason | string | false | Motivo del blocco, non può essere vuoto se fornito, massimo 50 caratteri. Può essere fornito solo quando signTaskSuspend=true; se non fornito, per default indica che è necessario attendere l'elaborazione da parte di un sistema esterno. Non deve essere fornito quando signTaskSuspend=false o non viene passato. |
| anySigner | boolean | false | Se supporta la firma da parte di una sola persona, predefinito false true- Solo una persona tra quelle dello stesso signOrder deve firmare false- Tutte le persone dello stesso signOrder devono firmare |
| authModes | string | false | Metodo di verifica, predefinito noAuth noAuth- Nessuna verifica accessCode- Verifica tramite password di firma sms- Verifica OTP via SMS idVerification- Verifica dell'identità documentale emailAuth- Verifica OTP via email digitalId- Verifica dell'identità elettronica whatsappAuth- Verifica OTP via WhatsApp |
| authConfig | object | false | Impostazioni del metodo di verifica |
| | accessCode | object | false | Impostazione della password di firma, obbligatoria quando authModes=accessCode |
| | | accessCode | string | false | Contenuto della password, non distingue tra maiuscole e minuscole, può contenere lettere e numeri, lunghezza massima 45 caratteri |
| | | | promptInfo | string | false | Messaggio informativo per la password di accesso, non deve contenere la password di accesso, lunghezza massima 30 caratteri, obbligatoria quando authModes=accessCode |
| | sms | object | false | Verifica OTP SMS, obbligatoria quando authModes=sms |
| | | countryCode | string | false | Codice internazionale del paese/regione, senza il simbolo '+' |
| | | number | string | false | Nessuna validazione del formato, solo limite massimo di lunghezza a 13 caratteri |
| | idVerification | object | false | Impostazioni di verifica dell'identità tramite documento, obbligatorie quando authModes=idVerification |
| | | name | string | false | Nome completo riportato sul documento d'identità del firmatario, lunghezza massima 100 caratteri |
| | | emailAuth | object | false | Verifica OTP email, obbligatoria quando authModes=emailAuth |
| | | | authEmail | string | false | Indirizzo e-mail per la verifica dell'identità del firmatario |
| | digitalId | array | false | Verifica dell'identità elettronica, obbligatoria quando authModes=digitalId |
| | | authApp | string | false | App utilizzata per la verifica dell'identità elettronica singpass- Utilizzo di Singpass per l'autenticazione dell'identità iamsmart- Utilizzo di i AM Smart per l'autenticazione dell'identità |
| | | idNumber | string | false | Numero del documento d'identità del firmatario da verificare Quando authApp=singpass, le regole di inserimento sono: una lettera maiuscola + 7 o 8 cifre numeriche + una lettera maiuscola Quando authApp=iamsmart, le regole di inserimento sono: 1. Una lettera maiuscola (A-Z) o due lettere maiuscole (AA-ZZ) come inizio della sequenza; 2. Seguite da 6 cifre numeriche; 3. Infine un codice di controllo, che può essere una cifra (0-9) o una lettera (A-Z). Esempio: A888888(A) |
| | whatsappAuth | object | false | Verifica OTP tramite WhatsApp, obbligatoria quando authModes=whatsappAuth |
| | | countryCode | string | false | Codice internazionale del paese/regione, senza inserire il simbolo '+' |
| | | number | string | false | Non eseguire la convalida del formato, limitare solo la lunghezza massima a 13 caratteri |
| digitalSignature | boolean | false | Se abilitare la firma digitale, valore predefinito false true-Abilitato, false-Disabilitato |
| tsp | string | false | Selezionare il TSP utilizzato dal firmatario, valore predefinito false. Se non impostato, il firmatario sceglie autonomamente il TSP da utilizzare. L'elenco delle opzioni include: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha |
| freeFormSign | boolean | false | Se il firmatario può applicare liberamente il sigillo, valore predefinito false Note aggiuntive: Quando freeFormSign è impostato su true, non è necessario trasmettere gli altri parametri sotto sealInfos. Se vengono trasmessi contemporaneamente, freeFormSign ha priorità su sealInfos e i parametri sotto sealInfos non avranno effetto [Nota]La firma libera significa che non vi sono limiti al numero di timbri/firme che il firmatario può trascinare e alla loro posizione |
| documentVisibility | object | false | Configurazione della visibilità dei documenti, tutti visibili per impostazione predefinita. |
| | documentViewType | string | false | Strategia di visibilità, valore predefinito all; all indica che è possibile visualizzare tutti i documenti di firma nell'involucro, limited indica che è possibile visualizzare solo i propri documenti di firma e i documenti di visibilità supplementare. |
| | viewableFileKeys | array | false | Elenco dei fileKey aggiuntivi consentiti per la visualizzazione dalla parte firmataria; può essere trasmesso ed è efficace solo quando documentViewType=limited. |
| sealInfos | array | false | Informazioni sull'attività di firma |
| | fileKey | string | true | fileKey del documento firmato |
| | signConfigs | array | false | Informazioni sulla posizione del controllo. È necessario specificare le informazioni sulla posizione del controllo per poter eseguire la firma elettronica. |
| | | fieldType | string | false | Tipo di controllo, il valore predefinito è signature signature-Controllo di firma stamp-Controllo timbro approval-Controllo approvazione |
| | | | required | boolean | false | Campo obbligatorio o meno, il valore predefinito è obbligatorio true-Obbligatorio false-Non obbligatorio |
| | | | signFieldStyle | string | false | Metodo di applicazione del timbro per i controlli di firma, il valore predefinito è normalSeal. normalSeal-Timbro normale pagingSeal-Timbro a cavallo delle pagine Solo i controlli di firma e i controlli timbro supportano l'impostazione del timbro a cavallo delle pagine. |
| | | | pagingSealMode | string | false | Intervallo di pagine per il timbro a cavallo delle pagine, il valore predefinito è all. all-Tutte le pagine assignedPages-Pagine specifiche even-Pagine pari odd-Pagine dispari Specificabile solo quando signFieldStyle=pagingSeal. |
| | | | sizeRule | string | false | Modalità di visualizzazione delle dimensioni dell'area di firma originalSize-Applicazione del timbro in base alle dimensioni effettive della firma/timbro targetSize-Larghezza e altezza personalizzate dell'area di firma/timbro Quando sizeRule, height e width sono tutti vuoti, il timbro viene applicato in base alle dimensioni effettive della firma/timbro; Quando sizeRule è vuoto ma height e width non lo sono, il timbro viene applicato in base alle dimensioni specificate; Quando sizeRule non è vuoto, il timbro viene applicato in base alla modalità di visualizzazione specificata; Per i timbri a cavallo delle pagine non è necessario specificare questo parametro; si applica solo in base alle dimensioni effettive. |
| | | height | int | false | Altezza del controllo di firma, applicabile quando fieldType è signature/stamp, unità in px, accetta solo numeri interi positivi, valore predefinito auto (dimensioni automatiche del sistema); Quando fieldType=signature, l'intervallo impostabile è 20-250px; Quando fieldType=stamp, l'intervallo impostabile è 30-280px; Non è necessario specificare questo parametro per i timbri a cavallo delle pagine. |
| | | width | int | false | Larghezza del controllo di firma, applicabile quando fieldType è signature/stamp, unità in px, accetta solo numeri interi positivi, valore predefinito auto (dimensioni automatiche del sistema); Quando fieldType=signature, l'intervallo impostabile è 20-250px; Quando fieldType=stamp, l'intervallo impostabile è 30-280px; Il timbro di sovrapposizione non richiede la specifica di questo parametro. |
| | | signatureOptions | string | false | Opzioni del widget di firma. Applicabile solo quando fieldType è signature Parametri di input: template: firma da modello handDrawn: firma disegnata a mano upload: caricamento locale dell'immagine della firma aiHandDrawn: firma manoscritta AI Selezionabili in più opzioni, separate da ","; selezione predefinita di tutte le opzioni |
| | | movable | boolean | false | Consente lo spostamento della posizione durante la firma, valore predefinito false false - non consente al firmatario di regolare la posizione del proprio widget di firma true - consente al firmatario di regolare la posizione del proprio widget di firma |
| | | allowedOptions | array | false | Opzioni che consentono all'utente di approvare o meno, applicabile quando fieldType è approval. Valore predefinito: ["approve", "decline"] approve- Approva decline-Rifiuta |
| | | pageNo | string | false | Numero di pagina della firma; per pagine consecutive usa "-" come separatore, per pagine singole usa "," Esempio: 1-3,6-10 Quando pagingSealMode=assignedPages, inserisci l'intervallo di pagine in cui verrà applicato il sigillo di continuità. Il sigillo di continuità può essere utilizzato solo su documenti con più di una pagina. |
| | | posX | float | false | Coordinata asse x [Nota] Se fieldType è signature, la posizione delle coordinate indica l'area di firmaAngolo in basso a sinistra; Se fieldType è stamp, la posizione delle coordinate indica l'area del timbroPunto centralePosizione A partire dal 3 febbraio 2026, quando fieldType è signature o stamp, la posizione delle coordinate indica il punto centrale dell'area del timbro. Per il sigillo di continuità è possibile inserire 0, ma non null; il controllo è fissato sul bordo destro del documento. |
| | | posY | float | false | Coordinata asse y [Nota] Se fieldType è signature, la posizione delle coordinate indica l'area di firmaAngolo in basso a sinistra; Se fieldType è stamp, la posizione delle coordinate indica l'area del timbroPunto centralePosizione A partire dal 3 febbraio 2026, se fieldType è signature o stamp, la posizione delle coordinate indica il punto centrale dell'area del timbro. |
| | fillConfigs | array | false | Compilare le informazioni del controllo |
| | | fieldName | string | false | Nome del controllo, limite di caratteri: 128 |
| | | required | boolean | false | Obbligatorio o meno, obbligatorio per impostazione predefinita true-obbligatorio false-non obbligatorio |
| | | fieldType | string | false | Tipo di controllo: 1-testo su una riga 15-casella di controllo |
| | | textField | object | false | Proprietà del controllo testo |
| | | | overflowType | int | false | Si applica solo a text, valore predefinito 1 1-riduzione automatica della dimensione del carattere 2-Limita input |
| | | | minFontSize | float | false | Si applica solo a text, si applica solo quando overflowType=1, valore predefinito 8 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | width | int | false | Larghezza del controllo, valore predefinito 160px |
| | | | font | int | false | Si applica solo a text, carattere, valore predefinito SimSun 1-SimSun 2-New SimSun 4-HeiTi 5-KaiTi 6-Arial 7-Helvetica 9-Times New Roman 10-FangSong 11-Georgia 12-Monospace |
| | | | fontSize | float | false | Si applica solo a text, dimensione del carattere, valore predefinito 12 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | textColor | string | false | Si applica solo a text, colore in esadecimale, valore predefinito nero #000 |
| | | | bold | boolean | false | Si applica solo a text, se il carattere è in grassetto, valore predefinito false true-Grassetto false-Niente grassetto |
| | | | italic | boolean | false | Si applica solo a text, se il carattere è in corsivo, valore predefinito false true-corsivo false-non corsivo |
| | | | underline | boolean | false | Si applica solo al testo; indica se aggiungere la sottolineatura al carattere, valore predefinito false true-aggiungi sottolineatura false-non aggiungere sottolineatura |
| | | | lineThrough | boolean | false | Si applica solo al testo; indica se aggiungere il testo barrato, valore predefinito false true-aggiungi testo barrato false-non aggiungere testo barrato |
| | | | horizontalAlignment | string | false | Si applica solo al testo; formato di allineamento orizzontale, valore predefinito left LEFT-allineato a sinistra CENTER-centrato RIGHT-allineato a destra |
| | | tickBoxField | object | false | Proprietà della casella di controllo |
| | | | tickOptions | array | false | Si applica solo a tickBox, valore predefinito 1 1-spuntata 2-ramo |
| | | posX | float | false | Coordinate X della posizione del controllo |
| | | posY | float | false | Coordinate Y della posizione del controllo |
| | | pageNo | string | false | Numero di pagina in cui si trova il controllo |
| | signDateConfigs | array | false | Informazioni sulla posizione della data di firma |
| | | movable | boolean | false | Consente lo spostamento della posizione durante la firma, valore predefinito false false: non è consentito al firmatario di regolare la posizione dei propri controlli di firma true: è consentito al firmatario di regolare la posizione dei propri controlli di firma |
| | | pageNo | string | false | Numeri di pagina da firmare; le pagine consecutive sono unite con "-", quelle singole con ",". Esempio: 1-3, 6-10; Se non consecutive, utilizzare "," come separatore. |
| | | posX | float | false | Spostamento sull'asse x, l'origine delle coordinate è l'angolo in basso a sinistra della pagina |
| | | posY | float | false | Spostamento sull'asse y, l'origine delle coordinate è l'angolo in basso a sinistra della pagina |
| | | signDateFormat | string | false | Formato della data di firma, formato predefinito yyyy-MM-dd Supporta i seguenti formati: anno yyyy, mese MM, giorno dd yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |