Iniciar Envelope Rapidamente

Nome do Parâmetro

Tipo

Obrigatório

Descrição

subject

string

true

Assunto do Envelope

Exemplo: “Offer Letter”

remark

string

false

Observações do Envelope，Limite de comprimento de 1000 caracteres

object

false

Operações permitidas para o signatário

boolean

false

Se o signatário está autorizado a transferir este envelope para outra pessoa assinar, o padrão é falso

true - Permite que o signatário no envelope tenha o poder de transferir o envelope para outra pessoa;

false - Não permite que o signatário no envelope tenha o poder de transferir o envelope para outra pessoa;

boolean

false

Se a parte signatária está autorizada a modificar o nome, válido apenas para assinaturas de modelo, o padrão é falso

true - Permite que o signatário modifique o nome

false - Não permite que o signatário modifique o nome

expireAfterSeconds

long

false

Tempo de expiração do envelope, após quantos segundos o envelope expira

Intervalo de expiração: 86.400 segundos (1 dia) ~ 7.776.000 segundos (90 dias)

redirectUrl

string

false

Deve ser um endereço https válido

callBackUrl

string

false

Endereço de callback (comprimento 500), deve estar em conformidade com o endereço do protocolo https.

sendLaterAfterSeconds

long

false

Suporta o envio atrasado do utilizador, em segundos

Intervalo de tempo suportado: 3600 segundos (1 hora) ~ 259200 segundos (30 dias)

CCInfos

array

false

Conjunto de informações do destinatário em cópia

userEmail

string

false

Endereço de e-mail do destinatário em cópia

userName

string

false

Nome do CC, usado para exibir externamente o nome do CC na página de assinatura e no envelope.

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

customizeSettings

object

false

Configuração personalizada

notificationSettings

object

false

Configuração personalizada de notificações

notificationLanguage

string

false

Idioma da notificação, por defeito utiliza a configuração de “Idioma de notificação predefinido”

en-US Inglês

zh-CN Chinês Simplificado

zh-Hant Chinês Tradicional

ja-JP Japonês

es-MX Espanhol

pt-PT Português
th-TH Tailandês
id-ID Indonésio
vi-VN Vietnamita
ms-MY Malaio
fil-PH Filipino
de-DE Alemão
fr-FR Francês
ru-RU Russo
it-IT Italiano
ko-KR Coreano

signFiles

array

true

Coleção de informações de documentos assinados, a ordem de exibição é a ordem em que os documentos são adicionados.

fileKey 

string

true

fileKey do documento assinado, apenas suporta o formato PDF

attachments

array

false

Coleção de anexos do envelope, a ordem de exibição é a ordem em que os documentos são adicionados.

fileKey 

string

false

fileKey do ficheiro

signerInfos

array

true

Coleção de informações do signatário

businessId

string

false

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

string

false

userEmail

string

false

Endereço de e-mail do signatário

userName

string

true

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

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

phoneNumber

object

false

Número de telefone, o padrão é vazio

Quando for necessário enviar uma notificação por SMS, este é um parâmetro obrigatório, tanto countryCode como number precisam ser passados

countryCode

string

false

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

number

string

false

Sem verificação de formato, apenas limita o comprimento máximo a 13 dígitos

customizeSettings

object

false

Configuração personalizada

notificationSettings

object

false

Configuração personalizada da classe de notificação

customizeMessage

string

false

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

notificationLanguage

string

false

Idioma da notificação, o padrão é a configuração de “Idioma de notificação padrão”

en-US Inglês

zh-CN Chinês Simplificado

zh-Hant Chinês Tradicional

ja-JP Japonês

es-MX Espanhol

pt-PT Português
th-TH Tailandês
id-ID Indonésio
vi-VN Vietnamita
ms-MY Malaio
fil-PH Filipino
de-DE Alemão
fr-FR Francês
ru-RU Russo
it-IT Italiano
ko-KR Coreano

signOrder

int

true

A ordem de assinatura do signatário, sendo 1 o valor mínimo. Assinaturas não ordenadas podem especificar o mesmo valor de ordem.

anySigner

boolean

false

Se suporta a assinatura de qualquer pessoa, por defeito é falso

true-Apenas uma pessoa com o mesmo signOrder precisa assinar

false-Todas as pessoas com o mesmo signOrder precisam assinar

authModes

string

false

Método de verificação, o padrão é noAuth

authConfig

object

false

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

accessCode

object

false

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

accessCode

string

false

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

promptInfo

string

false

Informação 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 SMS OTP, quando authModes=smsé obrigatório

countryCode

string

false

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

number

string

false

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

idVerification

object

false

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

name

string

false

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

emailAuth

object

false

Verificação de e-mail OTP, quando authModes=emailAuthé obrigatório

authEmail

string

false

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

digitalId

array

false

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

authApp

string

false

APP utilizada para verificação de identidade eletrónica

singpass- Autenticação com Singpass

iamsmart- Autenticação com i AM Smart

idNumber

string

false

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

Quando authApp=singpasso formato de entrada é: letra maiúscula + 7 ou 8 dígitos + letra maiúscula

Quando authApp=iamsmarto formato de entrada é:

1. Uma letra maiúscula (A-Z) ou duas letras maiúsculas (AA-ZZ) como início da sequência;

2. Seguido por 6 dígitos;

3. Finalmente, um código de verificação, que pode ser um dígito (0-9) ou uma letra (A-Z). Exemplo: A888888(A)

whatsappAuth

object

false

Verificação OTP do WhatsApp, obrigatório quando authModes=whatsappAuth

countryCode

string

false

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

number

string

false

Não há validação de formato, apenas um limite máximo de 13 dígitos

digitalSignature

boolean

false

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

true - ativado, false - não ativado

freeFormSign

boolean

false

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 simultaneamente, a prioridade de freeFormSign é maior que a de 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 da localização do controlo. É necessário especificar as informações da localização do controlo para realizar a assinatura eletrónica.

fieldType

string

false

Tipo de controlo, o padrão é signature

signature- Controlo de assinatura

stamp- Controlo de selo

sizeRule

string

false

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

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

targetSize- Largura e altura personalizadas da área de assinatura/selo

Quando sizeRule, height e width estão todos vazios, o carimbo é 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 a fieldType como signature/stamp, em px, suporta apenas a entrada de inteiros positivos, padrão é 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 a fieldType como signature/stamp, em px, suporta apenas a entrada de inteiros positivos, padrão é 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 de controlo de assinatura. Aplicável apenas a fieldType como signature

Parâmetros de entrada:

template: Assinatura de modelo

handDrawn: Assinatura desenhada à mão

upload: Carregar imagem de assinatura local

Pode selecionar várias opções, separadas por ",", padrão é selecionar tudo

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 dos seus próprios controlos de assinatura

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

allowedOptions

array

false

Opções permitidas para aprovação pelo signatário, aplicável quando 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 ","

Exemplo: 1-3,6-10

posX

float

false

Coordenada do eixo x

【Atenção】Se fieldType for signature, a posição da coordenada refere-se à área de assinaturaCanto inferior esquerdo；

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

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

posY

float

false

Coordenada do eixo y

【Atenção】Se fieldType for signature, a posição da coordenada refere-se à área de assinaturaCanto inferior esquerdo；

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

A partir de 3 de fevereiro de 2026, se fieldType for signature ou stamp, a posição da coordenada 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 defeito

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, aplica-se apenas 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, predefinição 宋体

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á a negrito, predefinição false

true - Negrito

false - Sem negrito

italic

boolean

false

Aplica-se apenas ao texto, se deve ser itálico, por defeito é false

true - Itálico

false - Não itálico

underline

boolean

false

Aplica-se apenas ao texto, se a fonte deve ser sublinhada, por defeito é false

true - Adicionar sublinhado

false - Não adicionar sublinhado

lineThrough

boolean

false

Aplica-se apenas ao texto, se deve adicionar um traço, por defeito é false

true - Adicionar traço

false - Não adicionar traço

horizontalAlignment

string

false

Aplica-se apenas ao texto, formato de alinhamento horizontal, por defeito é left

LEFT - Alinhado à esquerda

CENTER - Centrado

RIGHT - Alinhado à direita

tickBoxField

object

false

Atributos da caixa de verificação

tickOptions

array

false

Apenas eficaz para tickBox, padrã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 está localizado

signDateConfigs

array

false

Informações de localização da data de assinatura

movable

boolean

false

Permitir mover a posição ao assinar, padrão false

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

pageNo

string

false

Número da página de assinatura; páginas consecutivas são conectadas com "-", páginas individuais são conectadas com ","，Exemplo: 1-3, 6-10;

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

posX

float

false

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

posY

float

false

Deslocamento do eixo y, com o canto inferior esquerdo da página como origem das coordenadas

signDateFormat

string

false

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

Formatos suportados:

aaaa年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy

Nome do parâmetro

Tipo

Descrição

envelopeId

string

ID do envelope

CCInfos

array

Coleção de informações do destinatário em cópia

userEmail

string

Endereço de e-mail do destinatário em cópia

userName

string

Nome do destinatário em cópia

signFiles

array

Coleção de informações do ficheiro de assinatura

fileKey

string

fileKey do ficheiro de assinatura

attachments

array

Coleção de anexos de envelope

fileKey

string

Ficheiro fileKey

signerInfos

array

Informação de assinatura

businessId

string

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

userEmail

string

Endereço de email do signatário

userName

string

Nome do signatário

signOrder

int

Ordem de assinatura do signatário, mínimo é 1

accessCode

string

Palavra-passe de acesso à página de assinatura