Adicionar signatário

Nome do Parâmetro

Tipo

Obrigatório

Descrição

envelopeId

string

true

ID do Envelope

signerInfos

array

true

Conjunto de informações do signatário

businessId

string

false

Número de negócio personalizado pelo desenvolvedor, comprimento 500

userEmail

string

true

Endereço de e-mail do signatário

phoneNumber

object

false

O preenchimento é obrigatório quando é necessário enviar notificações por SMS, countryCode e number precisam ser inseridos como parâmetros, o padrão é vazio

countryCode

string

false

Código internacional do país/região, não é necessário inserir “+”

number

string

false

Não faz verificação de formato, o comprimento máximo é de 13 dígitos

customizeSettings

object

false

Configuração personalizada

notificationSettings

object

false

Configuração personalizada de notificações

customizeMessage

string

false

Notificação de mensagem exclusiva, limite de 200 caracteres

notificationLanguage

string

false

Idioma da notificação, o padrão é inglês

en-US Inglês

zh-CN Chinês Simplificado

zh-Hant Chinês Tradicional

ja-JP Japonês

ES-MX Espanhol

userName

string

true

Nome do signatário, usado para exibir o nome do signatário externamente na página e no processo de assinatura.

【Atenção】Não pode conter os seguintes 9 caracteres especiais: / \ : * " < > | ？e todos os emojis

signOrder

int

true

Ordem de assinatura do signatário, o mínimo é 1. Para assinaturas não ordenadas, pode especificar o mesmo valor de ordem.

anySigner

boolean

false

Se suporta que qualquer pessoa assine, por defeito é falso

true - Apenas uma pessoa precisa assinar na mesma signOrder

false - Todas as pessoas precisam assinar na mesma signOrder

authModes

string

false

Método de autenticação, por defeito é noAuth

Tipo de enumeração:

authConfig

object

false

Definições do método de verificação

accessCode

object

false

Definições da palavra-passe de assinatura, obrigatório quando authModes=accessCode

accessCode

string

false

Conteúdo da palavra-passe, não sensível a maiúsculas e minúsculas, pode conter letras e números, comprimento 45

promptInfo

string

false

Mensagem de sugestão da palavra-passe de acesso, não pode conter a palavra-passe de acesso, limite de comprimento de 30, quando authModes=accessCodeé obrigatório.

sms

object

false

Verificação de SMS OTP, quando authModes=smsé obrigatório

countryCode

string

false

Código internacional do país/região, não é necessário incluir o “+”

number

string

false

Não efetua verificação de formato, o comprimento máximo é de 13 dígitos

idVerification

object

false

Definições de verificação de documento de identificação, obrigatório quando authModes=idVerification

name

string

false

Nome completo do signatário no documento de identificação, comprimento máximo de 100 caracteres

emailAuth

object

false

Validação OTP por e-mail, obrigatório quando authModes=emailAuth

authEmail

string

false

Endereço de e-mail de verificação de identidade do signatário

digitalId

array

false

Autenticação de identidade eletrónica, obrigatório quando authModes=digitalId

authApp

string

false

APP usada para autenticação de identidade eletrónica

singpass - Use o Singpass para autenticação

idNumber

string

false

Número do documento de identificação do signatário a ser verificado

digitalSignature

boolean

false

Se a assinatura digital está ativada, o padrão é false

true-Ativar

false- Não ativado

freeFormSign

boolean

false

Se o signatário tem liberdade para assinar, o valor padrão é falso

Observações adicionais:

Quando a opção freeFormSign é definida como verdadeira, não é necessário transmitir outros parâmetros em sealInfos. Se forem transmitidos em simultâneo, a prioridade de freeFormSign é superior a sealInfos e os parâmetros em sealInfos não terão efeito.

[Atenção] A assinatura livre significa que não há restrições quanto ao número e posição de selos/assinaturas que o signatário pode inserir.

sealInfos

array

false

Informações da tarefa de assinatura

fileKey

string

true

fileKey do ficheiro de assinatura

signConfigs

array

false

Informações de localização do controlo. É necessário especificar as informações de localização do controlo para realizar a assinatura eletrónica.

fieldType

string

false

Tipo de controlo, pode ser um parâmetro de entrada:

signature- Controlo de assinatura

stamp- Controlo de selo

O padrão é signature

sizeRule

string

false

Método de exibição do tamanho da área de assinatura

originalSize- Colocar o selo de acordo com o tamanho real da assinatura/selo

targetSize- Personalizar a largura e altura da área de assinatura/selo

Quando sizeRule, height e width estão todos vazios, o selo é colocado de acordo com o tamanho real da assinatura/selo;

Quando sizeRule está vazio e height e width não estão vazios, o carimbo é colocado de acordo com o tamanho especificado;

Quando sizeRule não está vazio, o carimbo é colocado de acordo com o método de exibição especificado.

height

int

false

Altura do controlo de assinatura, aplicável quando fieldType é signature/stamp, em px, suporta apenas a introdução de inteiros positivos, por defeito auto (ou seja, tamanho automático do sistema);

Quando fieldType=signature, o intervalo configurável é 20-250px;

Quando fieldType=stamp, o intervalo configurável é 30-280px

width

int

false

Largura do controlo de assinatura, aplicável quando fieldType é signature/stamp, em px, suporta apenas a introdução de inteiros positivos, por defeito auto (ou seja, tamanho automático do sistema);

Quando fieldType=signature, o intervalo configurável é 20-250px;

Quando fieldType=stamp, o intervalo configurável é 30-280px

signatureOptions

string

false

Opções do controlo de assinatura. Aplica-se apenas quando fieldType é signature.

Pode receber os seguintes parâmetros:

template

handDrawn

upload

Pode selecionar várias opções, separadas por ",", por defeito, todas as opções são selecionadas

movable

boolean

false

Permitir mover a localização ao assinar, por defeito é falso

false- Não permitir que o signatário ajuste a posição do seu próprio controlo de assinatura

true- Permitir que o signatário ajuste a posição do seu próprio controlo de assinatura

allowedOptions

array

false

Opções que permitem ao signatário aprovar, aplicável quando o fieldType é approval. O padrão é ["approve", "decline"]

approve- Aprovar

decline- Rejeitar

pageNo

string

false

Número da página de assinatura; números de página consecutivos são conectados com "-", números de página individuais são conectados com ",", por exemplo: 1-3, 6-10

posX

string

false

Coordenada do eixo X

Observações adicionais:

Se fieldType for signature, a posição das coordenadas refere-se à área de assinaturaCanto inferior esquerdo；

Se fieldType for stamp, a posição das coordenadas refere-se à área de carimboPonto centralPosição

A partir de 3 de fevereiro de 2026, se fieldType for signature ou stamp, a posição das coordenadas refere-se à posição do ponto central da área de carimbo.

posY

string

false

Coordenada do eixo Y

Nota adicional:

Se fieldType for signature, a posição das coordenadas refere-se à área de assinaturaCanto inferior esquerdo；

Se fieldType for stamp, a posição das coordenadas refere-se à área de carimboPonto centralPosição

A partir de 3 de fevereiro de 2026, para fieldType signature ou stamp, a posição das coordenadas refere-se à posição do ponto central da área de carimbo.

fillConfigs

array

false

Preencher informações do controlo

fieldName

string

false

Nome do controlo, limite de 128 caracteres

required

boolean

false

Obrigatório ou não, obrigatório por padrão

true-Obrigatório

false-Não obrigatório

fieldType

string

false

Tipo de controlo:

1-Texto de linha única

15-Caixa de verificação

textField

object

false

Propriedades do controlo de texto

overflowType

int

false

Aplica-se apenas ao texto, predefinição 1

1 - Reduzir automaticamente o tamanho da fonte

2 - Limitar a entrada

minFontSize

float

false

Aplica-se apenas ao texto, apenas se aplica a overflowType=1, predefinição 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

Largura do controlo, predefinição 160px

font

int

false

Aplica-se apenas ao texto, tipo de letra, por defeito 宋体.

1-宋体

2-新宋体

4-黑体

5-楷体

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋

11-Georgia

12-Monospace

fontSize

float

false

Aplica-se apenas ao texto, tamanho da fonte, predefinição 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

Aplica-se apenas ao texto, cor hexadecimal, predefinição preto #000

bold

boolean

false

Aplica-se apenas ao texto, se a fonte está em negrito, predefinição false

true - Negrito

false - Não negrito

italic

boolean

false

Aplica-se apenas ao texto, se deve ser itálico, predefinição é falso

true - itálico

false - não itálico

underline

boolean

false

Aplica-se apenas ao texto, se a fonte deve ser sublinhada, predefinição é falso

true - adicionar sublinhado

false - não adicionar sublinhado

lineThrough

boolean

false

Aplica-se apenas ao texto, indica se deve adicionar um traço de eliminação, predefinição é falso

true - Adicionar traço de eliminação

false - Não adicionar traço de eliminação

horizontalAlignment

string

false

Aplica-se apenas ao texto, formato de alinhamento horizontal, predefinição é left

LEFT - Alinhado à esquerda

CENTER - Centrado

RIGHT - Alinhado à direita

tickBoxField

object

false

Propriedades da caixa de verificação

tickOptions

array

false

Apenas se aplica ao Check, predefinição 1

1-Visto

2-Cruz

posX

float

false

Coordenada X da posição do controlo

posY

float

false

Coordenada Y da posição do controlo

pageNo

string

false

Número da página onde o controlo se encontra

signDateConfigs

array

false

Informação da posição da data de assinatura

movable

boolean

false

Permitir mover a posição ao assinar, por defeito falso

false- Não permitir que o signatário ajuste a posição do seu próprio controlo de assinatura

true- Permitir que o signatário ajuste a posição dos seus próprios controlos de assinatura

pageNo

string

false

Número da página de assinatura; números de página consecutivos são ligados com "-", números de página individuais são ligados com ",", por exemplo: 1-3, 6-10

Se não for contínuo, introduza "," para separar

posX

float

false

Desvio do eixo x, o canto inferior esquerdo da página é a origem das coordenadas

posY

float

false

Desvio do eixo y, o canto inferior esquerdo da página é a origem das coordenadas

signDateFormat

string

false

Formato da data de assinatura, o formato predefinido é aaaa-MM-dd

Formatos suportados:

aaaa年MM月dd日

aaaa-MM-dd

aaaa/MM/dd

dd.MM.aaaa

MM dd aaaa

dd MM aaaa