Ajouter un signataire

Nom du paramètre

Type

Obligatoire

Description

envelopeId

string

true

ID de l'enveloppe

signerInfos

array

true

Ensemble des informations du signataire

businessId

string

false

Numéro de业务 personnalisé par le développeur, longueur 500

roleTypes

array

false

Mode d'action du signataire, valeur par défaut ["sign", "fill"]

fill-remplir

sign-signer

string

false

userEmail

string

false

Adresse e-mail du signataire

documentVisibility

object

false

Configuration de la visibilité des fichiers, par défaut tous les fichiers sont visibles.

documentViewType

string

false

Stratégie de visibilité, par défaut all ; all signifie que tous les documents signés dans l'enveloppe peuvent être consultés, limited signifie que seuls les documents signés par l'utilisateur et les documents supplémentaires autorisés à la consultation peuvent être consultés.

viewableFileKeys

array

false

Liste des fileKey supplémentaires autorisés à être consultés par la partie signataire ; uniquement transmis et appliqué lorsque documentViewType=limited.

phoneNumber

object

false

Obligatoire lors de l'envoi d'une notification par SMS ; countryCode et number doivent tous deux être fournis, la valeur par défaut est vide.

countryCode

string

false

Code international du pays ou de la région, le « + » n'est pas nécessaire.

number

string

false

Aucune validation de format n'est effectuée, longueur maximale de 13 caractères.

customizeSettings

object

false

Configuration personnalisée

notificationSettings

object

false

Configuration personnalisée pour les notifications

customizeMessage

string

false

Notification de message dédié, limite de 200 caractères

notificationLanguage

string

false

Langue de notification, par défaut utilise la configuration « Langue de notification par défaut »

en-US Anglais

zh-CN Chinois simplifié

zh-Hant Chinois traditionnel

ja-JP Japonais

es-MX espagnol

pt-PT portugais
th-TH thaï
id-ID indonésien
vi-VN vietnamien
ms-MY malais
fil-PH philippin
de-DE allemand
fr-FR français
ru-RU russe
it-IT italien
ko-KR coréen

userName

string

true

Nom du signataire, affiché sur la page de signature et dans le processus pour identifier le signataire.

[Attention] Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > | ? ainsi que tous les emojis

signOrder

int

true

Ordre de signature du signataire, minimum 1. Pour les signatures simultanées, une même valeur d'ordre peut être spécifiée.

signTaskSuspend

boolean

false

S'il faut définir un nœud de blocage du processus avant ce point de signature, la valeur par défaut est false. true : définit un nœud de blocage ; false : ne définit pas de nœud de blocage. La configuration de blocage au sein d'un groupe de signatures en mode « ou » avec le même signOrder doit être cohérente.

suspensionKey

string

false

Identifiant du nœud de blocage, maximum 500 caractères, unique dans le même envelope. Obligatoire lorsque signTaskSuspend=true ; interdit de transmettre cette valeur lorsque signTaskSuspend=false ou lorsqu'elle n'est pas transmise.

suspendReason

string

false

Raison du blocage, obligatoire lors de sa transmission, maximum 50 caractères. Transmissible uniquement lorsque signTaskSuspend=true ; si non transmise, cela signifie par défaut qu'il faut attendre le traitement du système externe. Interdit de transmettre cette valeur lorsque signTaskSuspend=false ou lorsqu'elle n'est pas transmise.

anySigner

boolean

false

Indique si la signature par toute personne est autorisée, la valeur par défaut est false

true : une seule personne parmi celles du même signOrder doit signer

false : toutes les personnes du même signOrder doivent signer

authModes

string

false

Mode de vérification d'identité, la valeur par défaut est noAuth

Type énuméré :

authConfig

object

false

Paramètres du mode de vérification

accessCode

object

false

Paramètres du mot de passe de signature, obligatoire lorsque authModes=accessCode

accessCode

string

false

Contenu du mot de passe, insensible à la casse, peut contenir des lettres et des chiffres, longueur maximale de 45 caractères

promptInfo

string

false

Message d'invite pour le mot de passe d'accès, ne doit pas contenir le mot de passe d'accès, longueur maximale de 30 caractères, obligatoire lorsque authModes=accessCode.

sms

object

false

Vérification OTP par SMS, obligatoire lorsque authModes=sms

countryCode

string

false

Code international du pays/région, sans le « + »

number

string

false

Aucune validation de format, longueur maximale de 13 caractères

idVerification

object

false

Paramètres de vérification par pièce d'identité, obligatoire lorsque authModes=idVerification

name

string

false

Nom complet figurant sur la pièce d'identité du signataire, longueur maximale de 100 caractères

emailAuth

object

false

Vérification OTP par e-mail, obligatoire lorsque authModes=emailAuth

authEmail

string

false

Adresse e-mail de vérification de l'identité du signataire

digitalId

array

false

Vérification d'identité électronique, obligatoire lorsque authModes=digitalId

authApp

string

false

Application utilisée pour la vérification d'identité électronique

singpass- Authentification via Singpass

iamsmart- Authentification via MyInfo

idNumber

string

false

Numéro de pièce d'identité du signataire à vérifier

Lorsque authApp=singpass, le format attendu est : une lettre majuscule + 7 ou 8 chiffres + une lettre majuscule

Lorsque authApp=iamsmart, le format attendu est :

1. Une lettre majuscule (A-Z) ou deux lettres majuscules (AA-ZZ) en tant que préfixe ;

2. Suivi de six chiffres ;

3. Terminé par un code de contrôle, qui peut être un chiffre (0-9) ou une lettre (A-Z). Exemple : A888888(A)

whatsappAuth

object

false

Vérification OTP par WhatsApp, obligatoire lorsque authModes=whatsappAuth

countryCode

string

false

Indicatif international du pays/region, sans inclure le « + »

number

string

false

Aucune validation de format, longueur maximale limitée à 13 caractères

digitalSignature

boolean

false

Activer la signature numérique, par défaut false

true- Activé

false- Désactivé

tsp

string

false

Sélectionner le TSP utilisé par le signataire, par défaut false.

Non défini, le signataire choisit librement le TSP à utiliser. Les valeurs possibles sont :

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

Le signataire peut-il apposer son sceau librement, valeur par défaut false

Remarques complémentaires :

Lorsque freeFormSign est défini sur true, les autres paramètres sous sealInfos ne doivent pas être transmis. S'ils sont tous deux fournis, freeFormSign a priorité sur sealInfos et les paramètres de sealInfos ne seront pas pris en compte.

[Attention] La signature libre signifie qu'il n'y a aucune restriction sur le nombre et la position des sceaux/signatures que le signataire peut faire glisser.

sealInfos

array

false

Informations sur la tâche de signature

fileKey

string

true

fileKey du document signé

signConfigs

array

false

Informations de position du contrôle : il est obligatoire de spécifier la position du contrôle pour procéder à la signature électronique.

fieldType

string

false

Type de contrôle, paramètres acceptés :

signature- Contrôle de signature

stamp-Contrôle de sceau

Valeur par défaut : signature

Champ obligatoire ou non, obligatoire par défaut

true-Obligatoire

false-Non obligatoire

signFieldStyle

string

false

Mode d'apposition du contrôle de signature, valeur par défaut : normalSeal.

normalSeal-Sceau ordinaire

pagingSeal-Sceau de reliure

Seuls les contrôles de signature et de sceau prennent en charge la configuration du sceau de reliure.

pagingSealMode

string

false

Plage de pages pour l'apposition du sceau de reliure, valeur par défaut : all.

all-Toutes les pages

assignedPages-Pages spécifiées

even-Pages paires

odd-Pages impaires

Spécifiable uniquement lorsque signFieldStyle=pagingSeal.

sizeRule

string

false

Mode d'affichage des dimensions de la zone de signature

originalSize- Application du sceau selon les dimensions réelles de la signature/du sceau

targetSize- Dimensions personnalisées (largeur et hauteur) de la zone de signature/du sceau

Lorsque sizeRule, height et width sont tous vides, le sceau est appliqué selon les dimensions réelles de la signature/du sceau ;

Lorsque sizeRule est vide mais que height et width ne le sont pas, le sceau est appliqué selon les dimensions spécifiées ;

Lorsque sizeRule n'est pas vide, le sceau est appliqué selon le mode d'affichage spécifié ;

Le sceau de recouvrement n'a pas besoin de ce paramètre ; il est appliqué uniquement selon les dimensions réelles.

height

int

false

Hauteur du widget de signature, applicable lorsque fieldType est signature/stamp, exprimée en pixels. Seuls les entiers positifs sont acceptés. La valeur par défaut est auto (taille automatique déterminée par le système) ;

Lorsque fieldType=signature, la plage autorisée est de 20 à 250 px ;

Lorsque fieldType=stamp, la plage autorisée est de 30 à 280 px ;

Le sceau de recouvrement n'a pas besoin de ce paramètre.

width

int

false

Largeur du widget de signature, applicable lorsque fieldType est signature/stamp, exprimée en pixels. Seuls les entiers positifs sont acceptés. La valeur par défaut est auto (taille automatique déterminée par le système) ;

Lorsque fieldType=signature, la plage autorisée est de 20 à 250 px ;

Lorsque fieldType=stamp, la plage autorisée est de 30 à 280 px ;

Le cachet de reliure n'a pas besoin de spécifier ce paramètre.

signatureOptions

string

false

Options du contrôle de signature. Applicables uniquement lorsque fieldType est signature.

Paramètres d'entrée possibles :

template

handDrawn

upload

aiHandDrawn

Sélection multiple possible, séparés par ",", tous sélectionnés par défaut

movable

boolean

false

Autoriser le déplacement de la position lors de la signature, false par défaut

false- Le signataire ne peut pas ajuster la position de son propre contrôle de signature

true- Le signataire peut ajuster la position de son propre contrôle de signature

allowedOptions

array

false

Options autorisant l'approbation par le signataire, applicables lorsque fieldType est approval. Par défaut : ["approve", "decline"]

approve- Accepter

decline- Refuser

pageNo

string

false

Numéros de page de signature ; les pages consécutives sont reliées par "-", les pages individuelles par ",", par exemple : 1-3, 6-10

Lorsque pagingSealMode=assignedPages, transmettez la plage de pages où le cachet de reliure sera apposé. Le cachet de reliure ne peut être utilisé que sur des fichiers de plus d'une page.

posX

string

false

Coordonnée de l'axe X

Remarques complémentaires :

Si fieldType est signature, la position des coordonnées fait référence à la zone de signatureCoin inférieur gauche；

Si fieldType est stamp, la position des coordonnées désigne la zone de cachet.Point centralPosition

À partir du 3 février 2026, si fieldType est signature ou stamp, la position des coordonnées désigne le point central de la zone de cachet.

Pour le cachet de jointure, la valeur peut être 0, mais pas null ; le contrôle est fixé sur le bord droit du document.

posY

string

false

Coordonnée Y

Remarques complémentaires :

Si fieldType est signature, la position des coordonnées désigne la zone de signature.Coin inférieur gauche；

Si fieldType est stamp, la position des coordonnées désigne la zone de cachet.Point centralPosition

À partir du 3 février 2026, si fieldType est signature ou stamp, la position des coordonnées désigne le point central de la zone de cachet.

fillConfigs

array

false

Renseignez les informations du contrôle

fieldName

string

false

Nom du contrôle, limite de caractères : 128

required

boolean

false

Champ obligatoire ou non, par défaut obligatoire

true-obligatoire

false-non obligatoire

fieldType

string

false

Type de contrôle :

1-texte sur une seule ligne

15-case à cocher

textField

object

false

Propriétés du contrôle texte

overflowType

int

false

S'applique uniquement au type text, valeur par défaut : 1

1-réduction automatique de la taille de police

2-limitation de l'entrée

minFontSize

float

false

S'applique uniquement au type text et seulement lorsque overflowType=1, valeur par défaut : 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

Largeur du contrôle, valeur par défaut : 160px

font

int

false

S'applique uniquement au type text, police, valeur par défaut : SimSun.

1-SimSun

2-Songti Xin

4-Heiti

5-Kaiti

6-Arial

7-Helvetica

9-Times New Roman

10-Fangsong

11-Georgia

12-Monospace

fontSize

float

false

S'applique uniquement au texte, taille de police, par défaut 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

S'applique uniquement au texte, couleur hexadécimale, par défaut noir #000

bold

boolean

false

S'applique uniquement au texte, graisse de la police, par défaut false

true-gras

false-non gras

italic

boolean

false

S'applique uniquement au texte, italique ou non, par défaut false

true-italique

false-non italique

underline

boolean

false

S'applique uniquement au texte, soulignement ou non, par défaut false

true-souligné

false-non souligné

lineThrough

boolean

false

S'applique uniquement au texte, indique s'il faut ajouter une barre oblique, par défaut false

true-ajouter une barre oblique

false-ne pas ajouter de barre oblique

horizontalAlignment

string

false

S'applique uniquement au texte, format centré horizontalement, par défaut left

LEFT-aligné à gauche

CENTER-centré

RIGHT-aligné à droite

tickBoxField

object

false

Propriétés de la case à cocher

tickOptions

array

false

S'applique uniquement à Check, par défaut 1

1-coche

2-croix

posX

float

false

Coordonnée X de la position du contrôle

posY

float

false

Coordonnée Y de la position du contrôle

pageNo

string

false

Numéro de page où se trouve le contrôle

signDateConfigs

array

false

Informations sur la position de la date de signature

movable

boolean

false

Autoriser le déplacement lors de la signature, par défaut false

false- L'annotateur n'est pas autorisé à ajuster la position de ses propres widgets de signature

true- L'annotateur est autorisé à ajuster la position de ses propres widgets de signature

pageNo

string

false

Numéros de page de signature ; les pages consécutives sont reliées par « - », les pages individuelles par « , », par exemple : 1-3, 6-10

S'il ne s'agit pas de pages consécutives, utiliser « , » pour la séparation

posX

float

false

Décalage selon l'axe x, l'origine des coordonnées étant le coin inférieur gauche de la page

posY

float

false

Décalage selon l'axe y, l'origine des coordonnées étant le coin inférieur gauche de la page

signDateFormat

string

false

Format de la date de signature, le format par défaut est yyyy-MM-dd

Formats spécifiés pris en charge :

yyyy MM jj

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy