Trung tâm nhà phát triển

Thêm người ký

POST/esignglobal/v1/envelope/recipients/addSigners

Mô tả giao diện

Thêm người ký vào phong bì, người ký là nhiệm vụ ký. Bao gồm thêm các điều khiển, phương thức xác thực, v.v. cho người ký.

Lưu ý:

  • Hỗ trợ thêm người ký mới sau khi phong bì được mở. Thứ tự ký của người ký mới được thêm vào không được nhỏ hơn hoặc bằng giá trị thứ tự ký của bất kỳ người ký nào đang ký.
  • Không cho phép thêm cùng một người ký (với email là định danh duy nhất của người dùng) nhiều lần. Nếu bạn cần cập nhật thông tin nhiệm vụ ký, vui lòng thêm lại người ký tương ứng.
  • Một phong bì chỉ có thể có tối đa 10 người ký.

 

Tham số yêu cầu

Tên tham số

Loại

Bắt buộc

Mô tả

envelopeId

string

true

ID phong bì

signerInfos

array

true

Tập hợp thông tin người ký

 

businessId

string

false

Số nghiệp vụ do nhà phát triển tùy chỉnh, độ dài 500

 

userEmail

string

true

Địa chỉ email của người ký

 

phoneNumber

object

false

Bắt buộc khi cần thông báo SMS, cần nhập tham số countryCode và number, mặc định là trống

 

 

countryCode

string

false

Mã quốc tế của quốc gia/khu vực, không cần nhập “+”

 

 

number

string

false

Không kiểm tra định dạng, độ dài tối đa là 13 chữ số

 

customizeSettings

object

false

Cấu hình tùy chỉnh

 

 

notificationSettings

object

false

Cấu hình tùy chỉnh loại thông báo

 

 

 

customizeMessage

string

false

Thông báo tin nhắn riêng, giới hạn 200 ký tự

  

 

notificationLanguage

string

false

Ngôn ngữ thông báo, mặc định là tiếng Anh

en-US Tiếng Anh

zh-CN Tiếng Trung giản thể

zh-Hant Tiếng Trung phồn thể

ja-JP Tiếng Nhật

ES-MX Tiếng Tây Ban Nha

 

userName

string

true

Tên người ký, dùng để hiển thị tên người ký trên trang ký và quy trình.

【Lưu ý】Không được chứa 9 ký tự đặc biệt sau: / \ : * " < > | ?và tất cả các biểu tượng cảm xúc emoji

 

signOrder

int

true

Thứ tự ký của người ký, nhỏ nhất là 1. Ký không theo thứ tự có thể chỉ định cùng một giá trị thứ tự.

 

anySigner

boolean

false

Có hỗ trợ bất kỳ ai ký không, mặc định là false

true-Chỉ cần một người ký trong cùng một signOrder

false-Tất cả mọi người trong cùng một signOrder đều phải ký

 

authModes

string

false

Phương thức xác thực danh tính, mặc định là noAuth

Kiểu liệt kê:

noAuth-Không xác thực

accessCode-Sử dụng mật khẩu ký để xác thực

sms-Xác thực OTP SMS

idVerification-Xác thực bằng giấy tờ tùy thân

emailAuth- Xác thực OTP qua email

digitalId- Xác thực danh tính điện tử

 

authConfig

object

false

Cài đặt phương thức xác thực

 

 

accessCode

object

false

Cài đặt mật khẩu ký, khi authModes=accessCodethì bắt buộc

 

 

 

accessCode

string

false

Nội dung mật khẩu, không phân biệt chữ hoa chữ thường, có thể chứa chữ và số, độ dài 45

   

promptInfo

string

false

Thông tin nhắc nhở mật khẩu truy cập, không được chứa mật khẩu truy cập, giới hạn độ dài 30, bắt buộc khi authModes=accessCode

 

 

sms

object

false

Xác minh SMS OTP, bắt buộc khi authModes=sms

 

 

 

countryCode

string

false

Mã quốc tế của quốc gia/khu vực, không cần dấu “+”

 

 

 

number

string

false

Không kiểm tra định dạng, độ dài tối đa là 13 chữ số

 

 

idVerification

object

false

Cài đặt xác minh giấy tờ tùy thân, bắt buộc khi authModes=idVerification

 

 

 

name

string

false

Họ và tên đầy đủ trên giấy tờ tùy thân của người ký, độ dài tối đa 100 ký tự

  

emailAuth

object

false

Xác minh OTP qua email, bắt buộc khi authModes=emailAuth

  

 

authEmail

string

false

Địa chỉ email xác minh danh tính của người ký

 

 

digitalId

array

false

Xác thực danh tính điện tử, bắt buộc khi authModes=digitalId

 

 

 

authApp

string

false

Ứng dụng được sử dụng để xác thực danh tính điện tử

singpass - Sử dụng Singpass để xác thực danh tính

 

 

 

idNumber

string

false

Số chứng minh thư/thẻ căn cước của người ký chờ xác minh

 

digitalSignature

boolean

false

Có bật chữ ký số hay không, mặc định là false

true-Bật

false- Không bật

 

freeFormSign

boolean

false

Người ký có được tự do ký không, giá trị mặc định là false

Giải thích bổ sung:

Khi chọn freeFormSign là true, không cần truyền các tham số khác trong sealInfos. Nếu đồng thời truyền, freeFormSign sẽ có độ ưu tiên cao hơn sealInfos, các tham số trong sealInfos sẽ không có hiệu lực.

[Lưu ý] Ký tự do là không giới hạn số lượng và vị trí con dấu/chữ ký mà người ký có thể kéo vào.

 

sealInfos

array

false

Thông tin nhiệm vụ ký

 

 

fileKey

string

true

FileKey của tài liệu ký

 

 

signConfigs

array

false

Thông tin vị trí của điều khiển, phải chỉ định thông tin vị trí của điều khiển thì mới có thể thực hiện chữ ký điện tử.

 

 

 

fieldType

 

string

false

Loại điều khiển, có thể nhập tham số:

signature- Điều khiển chữ ký

stamp- Điều khiển con dấu

approval- Điều khiển phê duyệt

Mặc định là signature

   

sizeRule

string

false

Phương thức hiển thị kích thước khu vực ký

originalSize- Đóng dấu theo kích thước thực tế của chữ ký/con dấu

targetSize- Tùy chỉnh chiều cao và chiều rộng của khu vực chữ ký/con dấu

Khi sizeRule, height, width đều trống, đóng dấu theo kích thước thực tế của chữ ký/con dấu;

Khi sizeRule trống, height, width không trống, đóng dấu theo kích thước được chỉ định;

Khi sizeRule không trống, đóng dấu theo phương thức hiển thị được chỉ định.

 

 

 

height

 

int

false

Chiều cao của điều khiển ký, áp dụng cho fieldType là signature/stamp, đơn vị là px, chỉ hỗ trợ truyền số nguyên dương, mặc định là auto (tức là kích thước tự động của hệ thống);

Khi fieldType=signature, phạm vi có thể đặt là 20-250px;

Khi fieldType=stamp, phạm vi có thể đặt là 30-280px

 

 

 

width

int

false

Chiều rộng của điều khiển ký, áp dụng cho fieldType là signature/stamp, đơn vị là px, chỉ hỗ trợ truyền số nguyên dương, mặc định là auto (tức là kích thước tự động của hệ thống);

Khi fieldType=signature, phạm vi có thể đặt là 20-250px;

Khi fieldType=stamp, phạm vi có thể đặt là 30-280px

 

 

 

signatureOptions

 

string

false

Tùy chọn điều khiển chữ ký. Chỉ áp dụng cho fieldType là signature.

Có thể nhập tham số:

template

handDrawn

upload

Có thể chọn nhiều, phân tách bằng ",", mặc định chọn tất cả

 

 

 

movable

boolean

false

Cho phép di chuyển vị trí khi ký, mặc định là false

false-Không cho phép người ký điều chỉnh vị trí điều khiển ký của riêng họ

true-Cho phép người ký điều chỉnh vị trí điều khiển ký của riêng họ

   

allowedOptions

array

false

Các tùy chọn cho phép người ký phê duyệt, áp dụng cho fieldType là approval. Mặc định là ["approve", "decline"]

approve- Đồng ý

decline- Từ chối

 

 

 

pageNo

 

string

false

Số trang ký; các trang liên tiếp được nối bằng "-", các trang riêng lẻ được nối bằng ",", ví dụ: 1-3, 6-10

 

 

 

posX

 

string

false

Tọa độ trục X

Giải thích thêm:

Nếu fieldType là signature, thì vị trí tọa độ đề cập đến khu vực chữ kýGóc dưới bên trái

Nếu fieldType là stamp, thì vị trí tọa độ đề cập đến khu vực đóng dấuĐiểm trung tâmVị trí

Kể từ ngày 3 tháng 2 năm 2026, fieldType là signature hoặc stamp, vị trí tọa độ của nó đề cập đến vị trí điểm trung tâm của khu vực đóng dấu.

 

 

 

posY

 

string

false

Tọa độ trục Y

Giải thích bổ sung:

Nếu fieldType là signature, thì vị trí tọa độ đề cập đến khu vực chữ kýGóc dưới bên trái

Nếu fieldType là stamp, thì vị trí tọa độ đề cập đến khu vực đóng dấuĐiểm trung tâmVị trí

Kể từ ngày 3 tháng 2 năm 2026, fieldType là signature hoặc stamp, vị trí tọa độ của nó đề cập đến vị trí điểm trung tâm của khu vực đóng dấu.

 

 

fillConfigs

array

false

Điền thông tin điều khiển

 

 

 

fieldName

string

false

Tên điều khiển, giới hạn 128 ký tự

 

 

 

required

boolean

false

Có bắt buộc hay không, mặc định là bắt buộc

true-Bắt buộc

false-Không bắt buộc

 

 

 

fieldType

string

false

Loại điều khiển:

1-Văn bản một dòng

15-Hộp kiểm

 

 

 

textField

object

false

Thuộc tính điều khiển văn bản

 

 

 

 

overflowType

int

false

Chỉ có hiệu lực với text, mặc định là 1

1-Tự động giảm cỡ chữ

2-Hạn chế nhập liệu

 

 

 

 

minFontSize

float

false

Chỉ có hiệu lực với text, chỉ có hiệu lực với overflowType=1, mặc định là 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

Độ rộng của điều khiển, mặc định là 160px

 

 

 

 

font

int

false

Chỉ có hiệu lực với text, phông chữ mặc định là 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

Chỉ có hiệu lực với text, kích thước phông chữ, mặc định là 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

Chỉ có hiệu lực với text, màu hệ thập lục phân, mặc định là màu đen #000

 

 

 

 

bold

boolean

false

Chỉ có hiệu lực với text, phông chữ có được in đậm hay không, mặc định là false

true-In đậm

false-Không in đậm

 

 

 

 

italic

boolean

false

Chỉ có hiệu lực với text, có in nghiêng hay không, mặc định là false

true-In nghiêng

false-Không in nghiêng

 

 

 

 

underline

boolean

false

Chỉ có hiệu lực với text, phông chữ có thêm gạch chân hay không, mặc định là false

true-Thêm gạch chân

false-Không thêm gạch chân

 

 

 

 

lineThrough

boolean

false

Chỉ có hiệu lực với text, có thêm gạch ngang hay không, mặc định là false

true-Thêm gạch ngang

false-Không thêm gạch ngang

 

 

 

 

horizontalAlignment

string

false

Chỉ có hiệu lực với text, định dạng căn giữa theo chiều ngang, mặc định là left

LEFT-Căn trái

CENTER-Căn giữa

RIGHT-Căn phải

 

 

 

tickBoxField

object

false

Thuộc tính hộp kiểm

 

 

 

 

tickOptions

array

false

Chỉ có hiệu lực với Check, mặc định là 1

1-Đánh dấu

2-Chữ thập

 

 

 

posX

float

false

Tọa độ X của vị trí điều khiển

 

 

 

posY

float

false

Tọa độ Y vị trí của điều khiển

 

 

 

pageNo

string

false

Số trang chứa điều khiển

 

 

signDateConfigs

array

false

Thông tin vị trí ngày ký

 

 

 

movable

boolean

false

Cho phép di chuyển vị trí khi ký, mặc định là false

false- Không cho phép người ký điều chỉnh vị trí điều khiển ký của họ

true-Cho phép người ký điều chỉnh vị trí các điều khiển ký của riêng họ

 

 

 

pageNo

string

false

Số trang ký; các số trang liên tiếp được nối bằng "-", các số trang riêng lẻ được nối bằng ",", ví dụ: 1-3, 6-10

Nếu không liên tục, hãy truyền vào "," để phân tách

 

 

 

posX

float

false

Độ lệch trục x, góc dưới bên trái của trang là gốc tọa độ

 

 

 

posY

float

false

Độ lệch trục y, góc dưới bên trái của trang là gốc tọa độ

 

 

 

signDateFormat

string

false

Định dạng ngày ký, định dạng mặc định là yyyy-MM-dd

Hỗ trợ định dạng được chỉ định:

yyyy năm MM tháng dd ngày

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy

Ví dụ yêu cầu

{
    "envelopeId": "{{envelope-id}}",
    "signerInfos": [
        {
    	   "userEmail": "sender_user@esignglobal.com",
    	   "userName": "sender_user_name",
    	   "signOrder": 1,
    	   "authModes": "sms",
           "authConfig": {
                "sms": {
                    "countryCode": "86",
                    "number": "158****9242"
                }
            },
            "sealInfos": [
                {
                    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
                    "signConfigs": [
                        {
                           "fieldType": "stamp",
                            "pageNo": "1",
                            "posX": 100.22,
                            "posY": 100
                        }
                    ],
                    "fillConfigs": [
                        {
                            "fieldId": "df0dd777bcc4d108de242d",
                            "fieldKey": "demo",
                            "pageNo": "1",
                            "posX": "88.70021",
                            "posY": 745.409,
                            "fieldType": "1",
                            "required": true,
                            "textField": {
                                "overflowType": "1",
                                "minFontSize": 8,
                                "font": "6",
                                "fontSize": "12",
                                "textColor": "#54ACD2",
                                "bold": false,
                                "italic": true,
                                "lineThrough": false,
                                "horizontalAlignment": "RIGHT"
                            }
                        },
                        {
                            "fieldId": "96e6c7d414f04e98938ea84013b",
                            "fieldKey": "红色加深斜体下划线删除线",
                            "pageNo": "1",
                            "posX": 94.516624,
                            "posY": 284.54953,
                            "fieldType": "1",
                            "required": false,
                            "textField": {
                                "overflowType": "1",
                                "minFontSize": 10.5,
                                "font": "1",
                                "fontSize": 12.0,
                                "textColor": "#E25041",
                                "bold": true,
                                "italic": true,
                                "lineThrough": true,
                                "horizontalAlignment": "LEFT"
                            }
                        },
                        {
                            "fieldId": "888b899853544c49bd819d9f6d1",
                            "fieldKey": "必填勾选控件选中样式不显示边框",
                            "pageNo": "3",
                            "posX": 451.77127,
                            "posY": 429.07626,
                            "fieldType": "15",
                            "required": true,
                            "tickBoxField": {
                                "tickOptions": [1,2],
                                "showBorder": false
                            }
                        }
                    ]
                    "signDateConfigs":[
                          "pageNo":"1",
                          "posX": 100.22,
                          "posY": 100,
                          "signDateFormat": "dd MMM yyyy"
                    ]
                }
            ]
        }
    ]
}

 

Tham số phản hồi

Tên tham số

Loại

Mô tả

envelopeId

string

ID phong bì

signFiles

array

Tập hợp tài liệu ký

 

fileKey 

string

fileKey của tài liệu ký

attachments

array

Tập hợp tệp đính kèm phong bì

 

fileKey 

string

fileKey của tệp

signerInfos

array

Tập hợp thông tin người ký

 

businessId

string

Số nghiệp vụ tùy chỉnh của nhà phát triển, độ dài 500

 

userEmail

string

Địa chỉ email của người ký

 

userName

string

Tên người ký

 

signOrder

int

Thứ tự nút của người ký, tối thiểu là 1

 

 

accessCode

string

Mật khẩu truy cập trang ký

Ví dụ phản hồi

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "organizationName": "Esign Global CO.",
                "userLastName": "",
                "accessCode": "",
                "userEmail": "sender_user@tsign.cn",
                "userFirstName": "",
                "signOrder": "1"
            }
        ],
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "attachments": [

        ],
        "envelopeId": "9fbe6c8190824227bde29136b0145c81"
    },
    "message": "success"
}

Mô tả giao diện
Tham số yêu cầu
Ví dụ yêu cầu
Tham số phản hồi
Ví dụ phản hồi