Nome do parâmetro | Tipo | Obrigatório | Descrição |
subject | string | true | Assunto do envelope Exemplo: "Carta de Oferta" |
remark | string | false | Observações do envelope, limite de 1000 caracteres |
signerSettings | object | false | Operações permitidas para o signatário |
| | allowTransfer | boolean | false | Se é permitido ao signatário transferir este envelope para outra pessoa assinar, padrão false true - permite que o signatário no envelope tenha o poder de transferir o envelope a terceiros; false - não permite que o signatário no envelope tenha o poder de transferir o envelope a terceiros; |
| | allowModifyName | boolean | false | Se é permitido ao signatário modificar o nome, aplica-se apenas à assinatura de modelo, padrão false 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 retorno (comprimento 500), deve estar em conformidade com o protocolo https. |
sendLaterAfterSeconds | long | false | Suporta envio atrasado pelo usuário, em segundos Intervalo de tempo suportado: 3.600 segundos (1 hora) ~ 259.200 segundos (30 dias) |
autoFinish | boolean | false | Controla se o envelope termina automaticamente, padrão true true- Encerramento automático do envelope false- Encerramento manual do envelope |
CCInfos | array | false | Conjunto de informações dos destinatários em cópia |
| userEmail | string | false | Endereço de e-mail do destinatário em cópia |
| userName | string | false | Nome do destinatário em cópia, exibido na página de assinatura e no envelope. [Atenção]: Não deve conter os seguintes 9 caracteres especiais: / \ : * " < > | ? nem emojis |
| ccOrder | int | false | Posição na sequência do processo de assinatura para o destinatário em cópia, compartilhando a ordem com signOrder dos signatários. Se não informado, será mantida a lógica original de notificação por cópia. |
| | customizeSettings | object | false | Configurações personalizadas |
| | | notificationSettings | object | false | Configurações personalizadas para notificações |
| | | | notificationLanguage | string | false | Idioma da notificação; padrão definido pela configuração 'idioma padrão de notificação' en-US Inglês (EUA) zh-CN Chinês Simplificado zh-Hant Chinês Tradicional ja-JP Japonês es-MX Espanhol (México) pt-PT Português (Portugal) 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 | Conjunto de informações dos documentos a assinar, exibidos na ordem em que foram adicionados. |
| fileKey | string | true | fileKey do documento a assinar; apenas o formato PDF é suportado |
| | documentFields | array | false | Lista de controles dimensionais do documento. Utilizada para adicionar controles dimensionais ao documento especificado sem vincular a um signatário. |
| | fieldType | string | false | Tipo de controle. Use eMeterai para indicar o controle de imposto de carimbo da Indonésia. |
| | pageNo | string | false | Número da página onde o controle está localizado. O controle de imposto de carimbo da Indonésia suporta apenas uma única página específica; deve ser fornecido um único número de página, não sendo aceitos formatos de múltiplas páginas contínuas ou não contínuas como 1-3 ou 1,3. |
| | | posX | float | false | Deslocamento no eixo x, com a origem das coordenadas no canto inferior esquerdo da página. A faixa de coordenadas é consistente com a faixa de coordenadas de outros controles. |
| | | posY | float | false | Deslocamento no eixo Y, com a origem das coordenadas no canto inferior esquerdo da página. O intervalo de coordenadas é consistente com o intervalo de coordenadas dos outros controles. |
attachments | array | false | Conjunto de anexos do envelope, exibidos na ordem em que os arquivos foram adicionados. |
| fileKey | string | false | fileKey do arquivo |
signerInfos | array | true | Conjunto de informações do signatário |
| businessId | string | false | Número de negócio personalizado pelo desenvolvedor, limite de comprimento: 500 caracteres |
| | roleTypes | array | false | Método de operação do signatário, valor padrão: ["sign", "fill"] fill-preenchimento sign-assinatura |
| | deliveryMethods | string | false | Método de notificação, padrão: auto auto- Ao enviar userEmail, envia notificação por e-mail; ao enviar phoneNumber, envia notificação por SMS none- Não envia notificação por mensagem email- Envia notificação por e-mail sms- Envia notificação por SMS WhatsApp- Envia notificação via WhatsApp |
| userEmail | string | false | Endereço de e-mail do signatário |
| userName | string | true | Nome do signatário, utilizado 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: / \ : * " < > | ? nem nenhum emoji |
| | minimumReadingDuration | int | false | Define o tempo de contagem regressiva obrigatório para leitura na página de configuração. O valor padrão é 0 (unidade: segundos, valor máximo: 999) 0 ou não informar indica que a contagem regressiva de leitura não será ativada |
| | readToEndRequired | boolean | false | Indica se é necessário ler até o final. Valor padrão: false; true indica que está ativado; false ou não informar indica que está desativado. |
| phoneNumber | object | false | Número de telefone, vazio por padrão Parâmetro obrigatório quando for necessária notificação por SMS; tanto countryCode quanto number devem ser fornecidos |
| | countryCode | string | false | Código internacional do país/região, sem necessidade de incluir o “+” |
| | number | string | false | Sem validação de formato, apenas limite máximo de comprimento de 13 dígitos |
| | customizeSettings | object | false | Configuração personalizada |
| | | notificationSettings | object | false | Configurações personalizadas para notificações |
| | | | customizeMessage | string | false | Notificação de mensagem exclusiva, limite de caracteres: 200 |
| | | | notificationLanguage | string | false | Idioma da notificação, utiliza por padrão a configuração “idioma padrão de notificaçã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 | Ordem de assinatura do signatário, valor mínimo é 1. Para assinaturas sem ordem, pode-se atribuir o mesmo valor de ordem. |
| signTaskSuspend | boolean | false | Se deve configurar um nó de bloqueio de fluxo antes deste local de assinatura, padrão false. true - configura nó de bloqueio; false - não configura nó de bloqueio. A configuração de bloqueio dentro de um grupo de assinatura OR com o mesmo signOrder deve ser consistente. |
| suspensionKey | string | false | Identificador do nó de bloqueio, máximo de 500 caracteres, único dentro do mesmo envelope. Obrigatório quando signTaskSuspend=true; não deve ser transmitido quando signTaskSuspend=false ou não for fornecido. |
| suspendReason | string | false | Motivo do bloqueio, não pode estar vazio ao ser transmitido, máximo de 50 caracteres. Só pode ser transmitido quando signTaskSuspend=true; se não for transmitido, o padrão indica que é necessário aguardar o processamento por um sistema externo. Não deve ser transmitido quando signTaskSuspend=false ou não for fornecido. |
| anySigner | boolean | false | Se suporta assinatura por qualquer pessoa, padrão false true- Apenas uma pessoa entre as mesmas signOrder precisa assinar false- Todas as pessoas da mesma signOrder precisam assinar |
| authModes | string | false | Método de validação, padrão noAuth noAuth- Sem verificação accessCode- Verificação por senha de assinatura sms- Verificação OTP via SMS idVerification- Verificação por documento de identidade emailAuth- Verificação OTP por e-mail digitalId- Verificação de identidade eletrônica whatsappAuth- Verificação OTP via WhatsApp |
| authConfig | object | false | Configurações do método de verificação |
| | accessCode | object | false | Configurações da senha de assinatura, quando authModes=accessCodeobrigatório no horário |
| | | accessCode | string | false | Conteúdo da senha, sem distinção de maiúsculas e minúsculas, pode conter letras e números, limite de 45 caracteres. |
| | | | promptInfo | string | false | Mensagem de solicitação da senha de acesso, não deve conter a senha de acesso, limite de comprimento 30, quando authModes=accessCodeobrigatório. |
| | sms | object | false | Verificação de OTP por SMS, quando authModes=smsObrigatório |
| | | countryCode | string | false | Código internacional do país/região, não é necessário inserir o "+" |
| | | number | string | false | Sem validação de formato, apenas o tamanho máximo é limitado a 13 caracteres. |
| | idVerification | object | false | Configurações de verificação de documento de identidade, quando authModes=idVerificationHora obrigatória |
| | | name | string | false | Nome completo conforme consta no documento de identificação do signatário, comprimento máximo de 100 caracteres. |
| | | emailAuth | object | false | Validação OTP do e-mail, quando authModes=emailAuthObrigatório |
| | | | authEmail | string | false | Endereço de e-mail para verificação da identidade do signatário |
| | digitalId | array | false | Verificação de identidade eletrônica, obrigatório quando authModes=digitalId |
| | | authApp | string | false | Aplicativo utilizado para verificação de identidade eletrônica singpass- Usar Singpass para autenticação de identidade iamsmart- Usar i AM Smart para autenticação de identidade |
| | | idNumber | string | false | Número do documento de identificação do signatário a ser verificado Quando authApp=singpass, a regra de entrada é: letra maiúscula + 7 ou 8 dígitos + letra maiúscula Quando authApp=iamsmart, a regra 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 seis dígitos; 3. Por fim, um dígito de verificação, que pode ser um número (0-9) ou uma letra (A-Z). Exemplo: A888888(A) |
| | whatsappAuth | object | false | Verificação OTP via WhatsApp, obrigatório quando authModes=whatsappAuth |
| | | countryCode | string | false | Código internacional do país/região, sem incluir o símbolo '+' |
| | | number | string | false | Sem validação de formato, apenas limitar o comprimento máximo a 13 dígitos |
| digitalSignature | boolean | false | Se ativa a assinatura digital, padrão false true-ativar, false-desativar |
| tsp | string | false | Selecionar o TSP usado pelo signatário, padrão false. Ao não definir, o signatário escolhe livremente o TSP a ser utilizado. Enumeração inclui: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha |
| freeFormSign | boolean | false | Se o signatário pode usar carimbo livremente, valor padrão false Comentários adicionais: Quando freeFormSign estiver definido como true, os outros parâmetros sob sealInfos não precisam ser fornecidos. Se fornecidos simultaneamente, freeFormSign tem prioridade sobre sealInfos, e os parâmetros em sealInfos não terão efeito [Atenção]Assinatura livre significa que não há restrição no número e na posição dos carimbos/assinaturas que o signatário pode arrastar |
| documentVisibility | object | false | Configuração de visibilidade do documento, padrão: todos visíveis. |
| | documentViewType | string | false | Estratégia de visibilidade, padrão all; all indica que é possível visualizar todos os documentos de assinatura dentro do envelope, limited indica que é possível visualizar apenas os próprios documentos assinados e os documentos com visibilidade adicional. |
| | viewableFileKeys | array | false | Lista de fileKey adicional permitida para visualização pela parte signatária; só pode ser fornecida e terá efeito quando documentViewType=limited. |
| sealInfos | array | false | Informações da tarefa de assinatura |
| | fileKey | string | true | fileKey do documento assinado |
| | signConfigs | array | false | Informações de posição do controle. É necessário especificar as informações de posição do controle para realizar a assinatura eletrônica. |
| | | fieldType | string | false | Tipo de controle, padrão é signature signature-Controle de assinatura stamp-Controle de carimbo approval-Controle de aprovação |
| | | | required | boolean | false | Se é obrigatório, padrão é obrigatório true-Obrigatório false-Não obrigatório |
| | | | signFieldStyle | string | false | Método de aplicação do carimbo no controle de assinatura, padrão é normalSeal. normalSeal-Carimbo normal pagingSeal-Carimbo de página contínua Apenas controles de assinatura e controles de carimbo suportam a configuração do carimbo de página contínua. |
| | | | pagingSealMode | string | false | Intervalo de páginas para o carimbo de página contínua, padrão é all. all-Todas as páginas assignedPages-Páginas específicas even-Páginas pares odd-Páginas ímpares Suporta especificação apenas quando signFieldStyle=pagingSeal. |
| | | | sizeRule | string | false | Modo de exibição do tamanho da área de assinatura originalSize-Aplicar carimbo com base no tamanho real da assinatura/carimbo targetSize-Largura e altura personalizadas para a área de assinatura/carimbo Quando sizeRule, height e width estão todos vazios, o carimbo é aplicado com base no tamanho real da assinatura/carimbo; Quando sizeRule está vazio, mas height e width não estão vazios, o carimbo é aplicado com as dimensões especificadas; Quando sizeRule não está vazio, o carimbo é aplicado conforme o modo de exibição especificado; O carimbo de paginação não requer a especificação deste parâmetro; aplica-se apenas com base no tamanho real. |
| | | height | int | false | Altura do controle de assinatura, aplicável quando fieldType é signature/stamp, em px. Suporta apenas números inteiros positivos. O padrão é auto (tamanho automático do sistema); Quando fieldType=signature, o intervalo configurável é de 20 a 250px; Quando fieldType=stamp, o intervalo configurável é de 30 a 280px; O carimbo de paginação não requer a especificação deste parâmetro. |
| | | width | int | false | Largura do controle de assinatura, aplicável quando fieldType é signature/stamp, em px. Suporta apenas números inteiros positivos. O padrão é auto (tamanho automático do sistema); Quando fieldType=signature, o intervalo pode ser definido como 20-250px; Quando fieldType=stamp, o intervalo pode ser definido como 30-280px; O carimbo de sobreposição não requer a especificação deste parâmetro. |
| | | signatureOptions | string | false | Opções do controle de assinatura. Apenas aplicável quando fieldType for signature Parâmetros de entrada possíveis: template: assinatura por modelo handDrawn: assinatura desenhada à mão upload: upload de imagem de assinatura local aiHandDrawn: assinatura manuscrita por IA Pode selecionar múltiplas opções, separadas por ","; padrão é selecionar todas |
| | | movable | boolean | false | Permite mover a posição durante a assinatura; padrão false false - não permite que o signatário ajuste a posição do seu controle de assinatura true - permite que o signatário ajuste a posição do seu controle de assinatura |
| | | allowedOptions | array | false | Opções que permitem ao signatário aprovar, aplicáveis quando fieldType for approval. Padrão é ["approve", "decline"] approve- Aprovar decline-Recusar |
| | | pageNo | string | false | Número da página de assinatura; páginas contínuas são conectadas com "-" e páginas individuais com "," Exemplo: 1-3,6-10 Ao usar pagingSealMode=assignedPages, insira o intervalo de páginas para o carimbo de selo nas margens. O carimbo de selo nas margens só pode ser usado em documentos com mais de uma página. |
| | | posX | float | false | Coordenada do eixo x [Atenção] 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, quando fieldType for signature ou stamp, a posição das coordenadas refere-se ao ponto central da área de carimbo. Para o carimbo de selo nas margens, pode-se passar 0, mas não null; o controle é fixado na borda direita do documento. |
| | | posY | float | false | Coordenada do eixo y [Atenção] 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 do carimboPonto centralPosição A partir de 3 de fevereiro de 2026, quando fieldType for signature ou stamp, a posição das coordenadas refere-se ao ponto central da área do carimbo. |
| | fillConfigs | array | false | Preencher informações do controle |
| | | fieldName | string | false | Nome do controle, limite de caracteres: 128 |
| | | required | boolean | false | Obrigatório? Padrão: obrigatório true - obrigatório false - não obrigatório |
| | | fieldType | string | false | Tipo de controle: 1 - texto de uma linha 15 - caixa de seleção |
| | | textField | object | false | Propriedades do controle de texto |
| | | | overflowType | int | false | Aplica-se apenas a text, padrão: 1 1 - reduzir automaticamente o tamanho da fonte 2-Limitar entrada |
| | | | minFontSize | float | false | Apenas válido para text, apenas válido quando overflowType=1, padrã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 controle, padrão 160px |
| | | | font | int | false | Apenas válido para text, fonte, padrão SimSun 1-SimSun 2-New SimSun 4-Heiti 5-Kaiti 6-Arial 7-Helvetica 9-Times New Roman 10-FangSong 11-Georgia 12-Monospace |
| | | | fontSize | float | false | Apenas válido para text, tamanho da fonte, padrã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 | Apenas válido para text, cor hexadecimal, padrão preto #000 |
| | | | bold | boolean | false | Apenas válido para text, se a fonte deve ser negrito, padrão false true-Negrito false-Não negrito |
| | | | italic | boolean | false | Apenas válido para text, se a fonte deve ser itálico, padrão false true-Itálico false-Não itálico |
| | | | underline | boolean | false | Aplica-se apenas ao texto; indica se o sublinhado deve ser adicionado à fonte; padrão: false true-Adicionar sublinhado false-Não adicionar sublinhado |
| | | | lineThrough | boolean | false | Aplica-se apenas ao texto; indica se o risco no texto deve ser adicionado; padrão: false true-Adicionar risco no texto false-Não adicionar risco no texto |
| | | | horizontalAlignment | string | false | Aplica-se apenas ao texto; alinhamento horizontal centralizado; padrão: left LEFT-Alinhar à esquerda CENTER-Centralizar RIGHT-Alinhar à direita |
| | | tickBoxField | object | false | Propriedades da caixa de seleção |
| | | | tickOptions | array | false | Aplica-se apenas ao tickBox; padrão: 1 1-Marcado 2-árvore |
| | | posX | float | false | Coordenada X da posição do controle |
| | | posY | float | false | Coordenada Y da posição do controle |
| | | pageNo | string | false | Número da página onde o controle está localizado |
| | signDateConfigs | array | false | Informações de localização da data de assinatura |
| | | movable | boolean | false | Permite mover a posição durante a assinatura, padrão false false - Não permite que o signatário ajuste a posição dos seus controles de assinatura true - Permite que o signatário ajuste a posição dos seus controles de assinatura |
| | | pageNo | string | false | Número da página de assinatura; páginas consecutivas são conectadas com "-", páginas individuais são separadas por ",", exemplo: 1-3, 6-10; Se não contínuo, use "," para dividir. |
| | | posX | float | false | Deslocamento no eixo x, a origem das coordenadas é o canto inferior esquerdo da página |
| | | posY | float | false | Deslocamento no eixo y, a origem das coordenadas é o canto inferior esquerdo da página |
| | | signDateFormat | string | false | Formato da data de assinatura, formato padrão yyyy-MM-dd Suporta formatos especificados: Ano yyyy, mês MM, dia dd yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |