Lancer rapidement une enveloppe

Nom du paramètre

Type

Obligatoire

Description

subject

string

true

Objet de l'enveloppe

Exemple : « Offer Letter »

remark

string

false

Remarques sur l'enveloppe，Limite de longueur : 1 000 caractères

object

false

Opérations autorisées pour le signataire

boolean

false

Indique si le signataire est autorisé à transférer cette enveloppe à une autre personne pour signature, false par défaut

true - Autorise le signataire de l'enveloppe à avoir le pouvoir de transférer l'enveloppe à d'autres ;

false - N'autorise pas le signataire de l'enveloppe à avoir le pouvoir de transférer l'enveloppe à d'autres ;

boolean

false

Indique si le signataire est autorisé à modifier le nom, uniquement valable pour la signature de modèle, false par défaut

true - Autorise le signataire à modifier le nom

false - N'autorise pas le signataire à modifier le nom

expireAfterSeconds

long

false

Délai d'expiration de l'enveloppe, après combien de secondes l'enveloppe expire

Plage d'expiration : 86 400 secondes (1 jour) à 7 776 000 secondes (90 jours)

redirectUrl

string

false

Doit être une adresse https valide

callBackUrl

string

false

Adresse de rappel (longueur 500), doit être une adresse de protocole https.

sendLaterAfterSeconds

long

false

Prise en charge de l'envoi différé par l'utilisateur, en secondes

Plage de temps prise en charge : 3 600 secondes (1 heure) à 259 200 secondes (30 jours)

CCInfos

array

false

Ensemble d'informations sur les personnes en copie

userEmail

string

false

Adresse e-mail de la personne en copie

userName

string

false

Nom du destinataire en copie, utilisé pour afficher le nom du destinataire en copie sur la page de signature et l'enveloppe.

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

customizeSettings

object

false

Configuration personnalisée

notificationSettings

object

false

Configuration personnalisée de notification

notificationLanguage

string

false

Langue de notification, la configuration « Langue de notification par défaut » est utilisée 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

signFiles

array

true

Ensemble d'informations sur les documents à signer, l'ordre d'affichage est l'ordre dans lequel les documents sont ajoutés.

fileKey 

string

true

Clé de fichier du document à signer, seul le format PDF est pris en charge

attachments

array

false

Ensemble de pièces jointes à l'enveloppe, l'ordre d'affichage est l'ordre dans lequel les documents sont ajoutés.

fileKey 

string

false

Clé de fichier du document

signerInfos

array

true

Ensemble d'informations sur le signataire

businessId

string

false

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

string

false

userEmail

string

false

Adresse e-mail du signataire

userName

string

true

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

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

phoneNumber

object

false

Numéro de téléphone, vide par défaut

Paramètre obligatoire lorsque la notification par SMS est requise, countryCode et number doivent être transmis

countryCode

string

false

Indicatif international du pays/de la région, pas besoin de saisir « + »

number

string

false

Aucune vérification de format, uniquement une limite de longueur maximale de 13 chiffres

customizeSettings

object

false

Configuration personnalisée

notificationSettings

object

false

Configuration personnalisée de la classe de notification

customizeMessage

string

false

Notification de message exclusive, limite de 200 caractères

notificationLanguage

string

false

Langue de notification, la configuration « Langue de notification par défaut » est utilisée 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

signOrder

int

true

Ordre de signature des signataires, le minimum est 1. Une signature non ordonnée peut spécifier la même valeur d'ordre.

anySigner

boolean

false

Indique si la signature d'une seule personne est prise en charge, 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 de vérification, noAuth par défaut

authConfig

object

false

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

accessCode

object

false

Paramètres du mot de passe de signature, lorsque authModes=accessCodeest requis

accessCode

string

false

Contenu du mot de passe, insensible à la casse, peut contenir des lettres et des chiffres, longueur limitée à 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 SMS OTP, lorsque authModes=smsest obligatoire

countryCode

string

false

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

number

string

false

Aucune vérification de format n'est effectuée, seule la longueur maximale est limitée à 13 chiffres

idVerification

object

false

Paramètres de vérification des pièces d'identité, lorsque authModes=idVerificationest obligatoire

name

string

false

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

emailAuth

object

false

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

authEmail

string

false

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

digitalId

array

false

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

authApp

string

false

L'application utilisée pour la vérification d'identité électronique

singpass- Authentification avec Singpass

iamsmart- Authentification avec i AM Smart

idNumber

string

false

Numéro de pièce d'identité du signataire en attente de vérification

Quand authApp=singpassla règle de transmission est la suivante : lettre majuscule + 7 ou 8 chiffres + lettre majuscule

Quand authApp=iamsmartla règle de transmission est la suivante :

1. Une lettre majuscule (A-Z) ou deux lettres majuscules (AA-ZZ) comme début de la séquence ;

2. Suivi de 6 chiffres ;

3. Enfin, 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 WhatsApp, obligatoire lorsque authModes=whatsappAuth

countryCode

string

false

Indicatif international du pays/de la région, pas besoin de transmettre le « + »

number

string

false

Aucune vérification de format n'est effectuée, seule la longueur maximale est limitée à 13 chiffres

digitalSignature

boolean

false

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

true-activé, false-désactivé

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, freeFormSign a la priorité sur sealInfos et les paramètres sous sealInfos ne prendront pas effet.

【Attention】La signature libre signifie qu'il n'y a pas de limite au 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 l'emplacement du contrôle. Les informations sur l'emplacement du contrôle doivent être spécifiées pour pouvoir effectuer une signature électronique.

fieldType

string

false

Type de contrôle, par défaut signature

signature- Contrôle de signature

stamp- Contrôle de tampon

sizeRule

string

false

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

originalSize- Appliquer 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/sceau est appliqué à la taille réelle ;

Lorsque sizeRule est vide et que height et width ne sont pas vides, le tampon/sceau est appliqué à la taille spécifiée ;

Lorsque sizeRule n’est pas vide, le tampon/sceau 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, seuls les entiers positifs sont pris en charge, auto par défaut (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, seuls les entiers positifs sont pris en charge, auto par défaut (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. Applicable uniquement lorsque fieldType est signature

Paramètres possibles :

template : signature de modèle

handDrawn : signature dessinée à la main

upload : télécharger une image de signature locale

Plusieurs options peuvent être sélectionnées, séparées par « , », toutes les options sont sélectionnées par défaut

movable

boolean

false

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

false - N'autorise pas le signataire à ajuster la position de ses propres contrôles de signature

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

allowedOptions

array

false

Options d'approbation autorisées pour le signataire, applicables lorsque fieldType est approval. La valeur par défaut est ["approve", "decline"]

approve- Accepter

decline- Refuser

pageNo

string

false

Numéro 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 « , »

Exemple : 1-3,6-10

posX

float

false

Coordonnée de l'axe des x

【注意】若fieldType为signature，则坐标位置指签名区Coin inférieur gauche；

Si fieldType est stamp, la position des coordonnées fait référence à la zone de cachetPoint 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 cachet.

posY

float

false

Coordonnée de l'axe des y

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

1-Réduire automatiquement la taille de la police

2-Limiter la saisie

minFontSize

float

false

S'applique uniquement au texte, uniquement à overflowType=1, 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, par défaut 160px

font

int

false

S'applique uniquement au texte, police, par défaut 宋体

1-宋体

2-新宋体

4-黑体

5-楷体

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋

11-Georgia

12-Monospace

fontSize

float

false

S'applique uniquement au texte, taille de la 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, police en gras ou non, par défaut false

true - Gras

false - Non gras

italic

boolean

false

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

true - Italique

false - Non italique

underline

boolean

false

S'applique uniquement au texte, si le texte doit être souligné, par défaut false

true - Souligné

false - Non souligné

lineThrough

boolean

false

S'applique uniquement au texte, si une barre de suppression doit être ajoutée, par défaut false

true - Barré

false - Non barré

horizontalAlignment

string

false

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

LEFT - Aligné à gauche

CENTER - Centré

RIGHT - Aligné à droite

tickBoxField

object

false

Attribut de la case à cocher

tickOptions

array

false

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

1-Coche

2-Croix

posX

float

false

Abscisse X de la position du contrôle

posY

float

false

Ordonné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 - 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

pageNo

string

false

Numéro 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 ","，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 est 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 aaaa-MM-jj

Formats pris en charge :

aaaa年MM月jj日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy

Nom du paramètre

Type

Description

envelopeId

string

ID de l'enveloppe

CCInfos

array

Ensemble d'informations sur les personnes en copie

userEmail

string

Adresse e-mail de la personne en copie

userName

string

Nom de la personne en copie

signFiles

array

Ensemble d'informations sur les documents de signature

fileKey

string

Clé de fichier du document de signature

attachments

array

Collection de pièces jointes d'enveloppe

fileKey

string

Fichier fileKey

signerInfos

array

Informations de signature

businessId

string

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

userEmail

string

Adresse e-mail du signataire

userName

string

Nom du signataire

signOrder

int

Ordre de signature du signataire, le minimum est 1

accessCode

string

Mot de passe d'accès à la page de signature