Ajouter un signataire

Nom du paramètre

Type

Obligatoire

Description

envelopeId

string

true

ID de l'enveloppe

signerInfos

array

true

Ensemble d'informations sur le signataire

businessId

string

false

Numéro d'entreprise personnalisé par le développeur, longueur 500

userEmail

string

true

Adresse e-mail du signataire

phoneNumber

object

false

Obligatoire pour les notifications par SMS, countryCode et number doivent être inclus en paramètres, vide par défaut

countryCode

string

false

Indicatif international du pays/de la région, pas besoin d'inclure le signe « + »

number

string

false

Aucune vérification de format, longueur maximale de 13 chiffres

customizeSettings

object

false

Configuration personnalisée

notificationSettings

object

false

Configuration personnalisée de type notification

customizeMessage

string

false

Notification de message exclusive, limite de 200 caractères

notificationLanguage

string

false

Langue de la notification, anglais par défaut

en-US Anglais

zh-CN Chinois simplifié

zh-Hant Chinois traditionnel

ja-JP Japonais

ES-MX Espagnol

userName

string

true

Nom du signataire, utilisé pour afficher le nom du signataire sur la page de signature et dans le processus.

【Attention】Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > | ？ ni aucune émoticône emoji

signOrder

int

true

Ordre de signature du signataire, le minimum est 1. Pour une signature non ordonnée, vous pouvez spécifier la même valeur d'ordre.

anySigner

boolean

false

Indique si la signature d'une seule personne est suffisante, false par défaut

true - Une seule personne du même signOrder doit signer

false - Toutes les personnes du même signOrder doivent signer

authModes

string

false

Méthode d'authentification, par défaut noAuth

Type d'énumération :

authConfig

object

false

Paramètres de la méthode de vérification

accessCode

object

false

Définir le mot de passe de signature, lorsque authModes=accessCodeest obligatoire

accessCode

string

false

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

promptInfo

string

false

Message d'invite du mot de passe d'accès, ne peut pas contenir le mot de passe d'accès, longueur limitée à 30, lorsque authModes=accessCodeest obligatoire.

sms

object

false

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

countryCode

string

false

Indicatif international du pays/de la région, pas besoin d'inclure le signe « + »

number

string

false

Aucune vérification de format, la longueur maximale est de 13 chiffres

idVerification

object

false

Paramètres de vérification de la pièce d'identité, requis lorsque authModes=idVerificationest défini

name

string

false

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

emailAuth

object

false

Vérification OTP par e-mail, requis lorsque authModes=emailAuthest défini

authEmail

string

false

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

digitalId

array

false

Authentification d'identité électronique, obligatoire lorsque authModes=digitalId

authApp

string

false

Application utilisée pour l'authentification d'identité électronique

singpass - Utiliser Singpass pour l'authentification

idNumber

string

false

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

digitalSignature

boolean

false

Indique si la signature numérique est activée, false par défaut

true- Activé

false- Ne pas activer

freeFormSign

boolean

false

L'auteur de la signature est-il libre de signer, la valeur par défaut est false

Remarques supplémentaires :

Lorsque freeFormSign est défini sur true, il n'est pas nécessaire de transmettre d'autres paramètres sous sealInfos. Si les deux sont transmis simultanément, la priorité de freeFormSign est supérieure à celle de sealInfos, et les paramètres sous sealInfos ne prendront pas effet.

【Attention】La signature libre ne limite pas le nombre et la position des tampons/signatures que le signataire peut faire glisser.

sealInfos

array

false

Informations sur la tâche de signature

fileKey

string

true

Clé de fichier du document à signer

signConfigs

array

false

Informations sur la position du contrôle, vous devez spécifier les informations de position du contrôle pour effectuer une signature électronique.

fieldType

string

false

Type de contrôle, peut être un paramètre :

signature- Contrôle de signature

stamp- Contrôle de tampon

Par défaut, signature

sizeRule

string

false

Méthode d’affichage de la taille de la zone de signature

originalSize- Apposer le tampon en fonction de la taille réelle de la signature/du tampon

targetSize- Largeur et hauteur personnalisées de la zone de signature/tampon

Lorsque sizeRule, height et width sont tous vides, le tampon est apposé en fonction de la taille réelle de la signature/du tampon ;

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

Lorsque sizeRule n'est pas vide, le tampon est appliqué selon la méthode d'affichage spécifiée.

height

int

false

Hauteur du contrôle de signature, applicable lorsque fieldType est signature/stamp, en px, prend uniquement en charge les entiers positifs, par défaut auto (c'est-à-dire la taille automatique du système) ;

Lorsque fieldType=signature, la plage de valeurs peut être définie entre 20 et 250 px ;

Lorsque fieldType=stamp, la plage de valeurs peut être définie entre 30 et 280 px

width

int

false

Largeur du contrôle de signature, applicable lorsque fieldType est signature/stamp, en px, prend uniquement en charge les entiers positifs, par défaut auto (c'est-à-dire la taille automatique du système) ;

Lorsque fieldType=signature, la plage de valeurs peut être définie entre 20 et 250 px ;

Lorsque fieldType=stamp, la plage de valeurs peut être définie entre 30 et 280 px

signatureOptions

string

false

Options du contrôle de signature. S'applique uniquement si fieldType est signature.

Paramètres possibles :

template

handDrawn

upload

Choix 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- N'autorise pas le signataire à ajuster la position de son propre contrôle de signature

true- Autorise le signataire à ajuster la position de son propre contrôle de signature

allowedOptions

array

false

Options permettant au signataire d'approuver, applicables lorsque fieldType est « approval ». Par défaut : ["approve", "decline"]

approve-Accepter

decline-Refuser

pageNo

string

false

Pages à signer ; les pages consécutives sont reliées par un « - », les pages individuelles sont reliées par une « , », par exemple : 1-3, 6-10

posX

string

false

Coordonnée sur l'axe X

Remarques :

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 fait référence à la zone de tamponPoint centralPosition

À partir du 3 février 2026, si fieldType est signature ou stamp, la position des coordonnées fait référence à la position du point central de la zone de tampon.

posY

string

false

Coordonnée de l'axe Y

Remarques supplé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 fait référence à la zone de tamponPoint centralPosition

À partir du 3 février 2026, si fieldType est signature ou stamp, la position des coordonnées fait référence à la position du point central de la zone de tampon.

fillConfigs

array

false

Remplir les informations du contrôle

fieldName

string

false

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

required

boolean

false

Obligatoire ou non, obligatoire par défaut

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 de texte

overflowType

int

false

S'applique uniquement au texte, 1 par défaut

1-Réduire automatiquement la taille de la police

2-Limiter la saisie

minFontSize

float

false

S'applique uniquement au texte, uniquement si overflowType=1, 8 par défaut.

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, 160px par défaut

font

int

false

S'applique uniquement au texte, police par défaut : SimSun.

1-SimSun

2-NSimSun

4-Heiti

5-Kaiti

6-Arial

7-Helvetica

9-Times New Roman

10-Fangsong

11-Georgia

12-Monospace

fontSize

float

false

Ne s'applique qu'au texte, taille de la police, 12 par défaut

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

Ne s'applique qu'au texte, couleur hexadécimale, noir par défaut #000

bold

boolean

false

Ne s'applique qu'au texte, indique si la police est en gras, false par défaut

true - Gras

false - Non gras

italic

boolean

false

S'applique uniquement au texte, indique si le texte est en italique, false par défaut

true - Italique

false - Non italique

underline

boolean

false

S'applique uniquement au texte, indique si le texte est souligné, false par défaut

true - Ajouter un soulignement

false - Ne pas ajouter de soulignement

lineThrough

boolean

false

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

true - Ajouter une barre de suppression

false - Ne pas ajouter de barre de suppression

horizontalAlignment

string

false

S'applique uniquement au texte, format de centrage horizontal, left par défaut

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, 1 par défaut

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 de position de la date de signature

movable

boolean

false

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

false- Ne pas autoriser le signataire à ajuster la position de son propre contrôle de signature

true- Autoriser le signataire à ajuster la position de ses propres contrôles de signature

pageNo

string

false

Numéros de page de signature ; les numéros de page consécutifs sont reliés par « - », les numéros de page individuels sont reliés par « , », par exemple : 1-3, 6-10

Si non consécutifs, entrez « , » pour séparer

posX

float

false

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

posY

float

false

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

signDateFormat

string

false

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

Formats pris en charge :

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy