Foxit eSign (versão prévia)

O Foxit eSign é uma solução de assinatura eletrônica que permite enviar, assinar e gerenciar documentos online, eliminando a necessidade de impressão, verificação ou endereçamento. Carregue seu documento, defina campos de assinatura e envie-o aos destinatários para eSignatures rápidas e legalmente vinculativas.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contact
Nome	Suporte ao Foxit eSign
URL	https://www.foxit.com
Email	api@foxit.com

Metadados do conector
Publicador	Foxit Software Inc.
Website	https://www.foxit.com/esign-pdf/
Política de privacidade	https://www.foxit.com/company/privacy-policy.html
Categories	Produtividade; Conteúdo e arquivos

Foxit eSign

O Foxit eSign é uma solução de assinatura eletrônica de nível empresarial que permite que as empresas enviem, assinem e gerenciem documentos de associação legal totalmente online, eliminando a necessidade de impressão, verificação ou endereçamento. Carregue seu documento, defina campos de assinatura e envie-o aos destinatários para eSignatures rápidas e seguras. O Foxit eSign está totalmente em conformidade com as principais leis de assinatura eletrônica, incluindo ESIGN e UETA, usa criptografia para proteger documentos em trânsito e em repouso e dá suporte à autenticação multifator para garantir que apenas os signatários autorizados possam acessar e assinar seus documentos.

O conector foxit eSign para Microsoft Power Automate permite automatizar seu fluxo de trabalho de assinatura de documento completo , desde a criação de envelopes e o envio deles para assinatura, até o acompanhamento do status, o download de documentos concluídos, o gerenciamento de modelos e o acionamento de ações downstream quando ocorrem eventos de envelope.

Publisher: Foxit Corporation

Pré-requisitos

Para usar esse conector, você precisará de:

Um plano Microsoft Power Apps ou Power Automate com acesso personalizado ao conector ou conector Premium
Uma conta do Foxit eSign – crie uma aqui
Acesso à API habilitado em sua conta do Foxit eSign (consulte Obter credenciais abaixo)

Obtendo credenciais

Crie uma conta do Foxit eSign se você ainda não tiver uma.
Entre em contato com a equipe de Vendas do Foxit para solicitar acesso à API para ser habilitado em sua conta. Depois de aprovado, o acesso à API será ativado em sua conta.
Em Power Automate, pesquise foxit eSign na lista de conectores e selecione Criar conexão.
Você será redirecionado para a página de entrada do Foxit eSign. Entre com suas credenciais do Foxit eSign para autorizar a conexão.
Depois de autorizada, a conexão estará pronta para ser usada em seus fluxos.

Introdução

Depois de criar uma conexão, você pode iniciar a criação de fluxos usando o conector Foxit eSign:

Use gatilhos para iniciar um fluxo automaticamente quando ocorrer um evento de envelope (por exemplo, quando todas as partes assinarem).
Use ações para criar envelopes, enviar lembretes de assinatura, baixar documentos concluídos, gerenciar modelos e muito mais.
Encadeie várias ações em conjunto , por exemplo, crie um envelope de um modelo, aguarde o gatilho totalmente executado e baixe o documento assinado e armazene-o no SharePoint.

Gatilhos com suporte

Gatilho	Description
Quando um envelope é enviado	É acionado quando um envelope é enviado aos destinatários. Requer o Nível do Webhook definido como Conta.
Quando um envelope é exibido	É acionado quando um destinatário é aberto e exibe o envelope.
Quando um envelope é assinado	É acionado quando um destinatário assina o envelope.
Quando um envelope é cancelado	É acionado quando um envelope é cancelado por um destinatário ou pelo remetente.
Quando um envelope é totalmente executado	Aciona quando todos os destinatários são assinados e o envelope está totalmente concluído.
Quando um envelope é excluído	É acionado quando um envelope é excluído.

Ações com Suporte

Envelopes

Ação	Description
Criar Envelope com base na URL	Cria e envia um envelope usando uma URL PDF acessível publicamente.
Criar envelope a partir de Base64	Cria e envia um envelope usando um documento PDF codificado em Base64.
Criar envelope com base no modelo	Cria e envia um envelope de um modelo foxit eSign existente.
Obter detalhes do envelope	Recupera os detalhes completos e o status atual de um envelope.
Obter IDs de envelope	Recupera uma lista de IDs de envelope com base em critérios de filtro.
Enviar lembrete de assinatura	Envia uma notificação de lembrete aos signatários pendentes de um envelope.
Baixar arquivos de envelope	Baixa todos os documentos assinados em um envelope como um arquivo zip.
Baixar PDF de documento único	Baixa um único documento de um envelope como PDF.
Mover envelopes para a lixeira	Move um ou mais envelopes para a lixeira.
Cancelar Envelope	Cancela um envelope e notifica os destinatários.
Excluir Envelopes	Exclui permanentemente um ou mais envelopes.
Obter histórico de atividades de envelope	Recupera o log de atividades completo de um envelope.
Obter histórico de envelope excluído	Recupera o histórico de envelopes excluídos na conta.

Modelos

Ação	Description
Criar modelo a partir da URL	Cria um modelo de assinatura reutilizável usando uma URL DE PDF acessível publicamente.
Criar modelo a partir de Base64	Cria um modelo de assinatura reutilizável usando um documento PDF codificado em Base64.
Obter detalhes do modelo	Recupera os detalhes completos de um modelo específico, incluindo definições de campo.
Obter modelos por IDs de modelo	Recupera detalhes de um ou mais modelos por suas IDs.
Obter uma lista de todos os modelos	Recupera todos os modelos disponíveis na conta.

Webhooks

Ação	Description
Listar todos os canais do Webhook	Retorna uma lista de todos os canais de webhook configurados na conta.
Obter detalhes do canal do Webhook	Recupera os detalhes de um canal de webhook específico.

Grupos de Email

Ação	Description
Criar grupo de email	Cria um novo grupo de email para uso como destinatários em envelopes.
Obter detalhes do grupo de email	Recupera os detalhes e os membros de um grupo de email.

Reports

Ação	Description
Baixar Relatório	Baixa um relatório de atividade de conta no formato Microsoft Excel.

Problemas e limitações conhecidos

Limite de taxa: a API foxit eSign permite até 4.000 solicitações por 5 minutos por conta. As solicitações que excedem esse limite recebem uma 429 Too Many Requests resposta. É recomendável implementar a lógica de repetição com retirada exponencial em seus fluxos para lidar com isso normalmente.
Limite de Tamanho do Arquivo: o tamanho máximo do arquivo por documento é de 25 MB. Esse limite se aplica a arquivos individuais, não ao tamanho total do envelope.
Cancelamento automático do webhook: devido a uma limitação na API de exclusão do webhook foxit eSign (que usa um método POST em vez de DELETE), Power Automate não pode limpar automaticamente as assinaturas de canal de webhook quando um fluxo baseado em gatilho é excluído ou modificado. Use a ação Listar Todos os Canais do Webhook para identificar canais ativos e o portal foxit eSign para remover assinaturas ao desativar um fluxo.
Quando um envelope é enviado — Somente Nível da Conta: o gatilho "Quando um envelope é enviado" é acionado somente quando o Nível do Webhook é definido como Conta. Ele não é acionado para envelopes criados no nível do aplicativo de API . Certifique-se de selecionar o nível da conta ao configurar esse gatilho.
Disponibilidade regional: o conector está disponível para contas da América do Norte (NA1) e da região da UE. Selecione a região do servidor apropriada ao configurar sua conexão. Conectar-se à região errada resultará em falhas de autenticação.
Tamanho do documento Base64: ao usar o create envelope de base64 ou criar modelo de ações base64, a cadeia de caracteres codificada em Base64 deve corresponder a um arquivo de origem não maior que 25 MB.

Support

Para obter suporte ao desenvolvedor, entre em contato com a equipe do Foxit eSign em devsupport@foxitsoftware.com.

Para enviar um caso de suporte, visite https://kb.foxit.com/s/submit-a-case.

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Baixar arquivos de envelope	Baixa os documentos concluídos de um envelope como um arquivo.
Baixar PDF de documento único	Baixa um único documento de um envelope como um arquivo PDF.
Baixar Relatório	Baixa um relatório de atividade de envelope como um arquivo de Microsoft Excel. Use os filtros para restringir os resultados por status, intervalo de datas, nome do envelope, autor ou signatário.
Cancelar assinatura do Gatilho do Webhook	Exclui uma assinatura de canal de webhook ativo por sua ID de canal. Use essa ação para limpar assinaturas de webhook que não são mais necessárias.
Cancelar Envelope	Cancela um envelope enviado. Os destinatários não poderão mais assinar os documentos.
Criar envelope a partir de Base64	Cria e envia um envelope usando um documento PDF codificado em Base64.
Criar Envelope com base na URL	Cria e envia um envelope usando URLs PDF publicamente acessíveis. Forneça as URLs do documento e os detalhes do destinatário para iniciar o processo de assinatura.
Criar envelope com base no modelo	Cria e envia um envelope usando um modelo existente. Os detalhes do destinatário podem ser personalizados.
Criar grupo de email	Cria um novo grupo de email que pode ser usado para enviar envelopes para vários destinatários ao mesmo tempo.
Criar modelo a partir da URL	Cria um novo modelo usando uma URL PDF acessível publicamente.
Criar modelo a partir de Base64	Cria um novo modelo usando uma cadeia de caracteres PDF codificada em Base64. Use isso quando o arquivo PDF já estiver disponível como uma cadeia de caracteres Base64 em seu fluxo, por exemplo, de um arquivo SharePoint ou OneDrive documento.
Enviar lembrete de assinatura	Envia uma notificação de lembrete para destinatários pendentes de um envelope, solicitando que eles concluam a assinatura.
Excluir Envelopes	Exclui permanentemente um ou mais envelopes.
Listar todos os canais do Webhook	Retorna uma lista de todos os canais de webhook configurados em sua conta.
Mover envelopes para a lixeira	Move um ou mais envelopes para a lixeira. Os envelopes na lixeira não são excluídos permanentemente.
Obter detalhes do canal do Webhook	Recupera os detalhes de um canal de webhook específico.
Obter detalhes do envelope	Recupera detalhes completos de um envelope, incluindo seu status, destinatários e documentos.
Obter detalhes do grupo de email	Recupera detalhes de um grupo de email existente.
Obter detalhes do modelo	Recupera todos os detalhes de um modelo específico, incluindo seus campos e destinatários.
Obter histórico de atividades de envelope	Recupera um log de atividades completo para um envelope, mostrando todas as ações executadas pelos destinatários e pelo remetente.
Obter histórico de envelope excluído	Recupera um histórico de envelopes que foram excluídos ou movidos para a lixeira.
Obter IDs de envelope	Retorna uma lista de IDs de envelope filtradas por status. Use isso para localizar envelopes em um estado específico.
Obter modelos por IDs de modelo	Recupera detalhes de um ou mais modelos por suas IDs.
Obter uma lista de todos os modelos	Retorna uma lista de todos os modelos disponíveis em sua conta.

Baixar arquivos de envelope

ID da operação:: DownloadEnvelopeFiles

Baixa os documentos concluídos de um envelope como um arquivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	folderId	True	string	O identificador exclusivo do envelope cujos documentos você deseja baixar.

Retornos

response: binary

Baixar PDF de documento único

ID da operação:: DownloadSingleDocumentPDF

Baixa um único documento de um envelope como um arquivo PDF.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	folderId	True	string	O identificador exclusivo do envelope que contém o documento a ser baixado.
Número do documento	docNumber	True	string	O índice do documento a ser baixado, a partir de 1.

Retornos

response: binary

Baixar Relatório

ID da operação:: DownloadReport

Baixa um relatório de atividade de envelope como um arquivo de Microsoft Excel. Use os filtros para restringir os resultados por status, intervalo de datas, nome do envelope, autor ou signatário.

Parâmetros

Nome	Chave	Tipo	Description
envelopeStatus	status	string	Os status da pasta pela qual filtraremos um relatório
Data de criação de	creationDateFrom	string	Início do intervalo de Datas de Criação. Formato aceito: YYYY-MM-DD.
Data de criação para	creationDateTo	string	Fim do intervalo de Datas de Criação. Formato aceito: YYYY-MM-DD.
Nome do envelope	folderName	string	Qualquer pasta que contenha essa cadeia de caracteres.
Incluir Campos	includeFields	string	Defina como 'true' para incluir valores de campo de envelope no relatório. O padrão é 'false'.
Autor Email	authorEmail	string	Filtre o relatório para incluir apenas envelopes criados por este endereço de email do autor.
Email do signatário	signerEmail	string	Filtre o relatório para incluir apenas envelopes em que esse endereço de email é um signatário.

Retornos

Arquivo de Relatório: binary

Cancelar assinatura do Gatilho do Webhook

ID da operação:: DeleteTriggerWebhookChannel

Exclui uma assinatura de canal de webhook ativo por sua ID de canal. Use essa ação para limpar assinaturas de webhook que não são mais necessárias.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Canal	channelId	True	integer	A ID do canal do webhook a ser excluído.

Cancelar Envelope

ID da operação:: CancelEnvelope

Cancela um envelope enviado. Os destinatários não poderão mais assinar os documentos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	folderId	True	integer	A ID do envelope a ser cancelada.
Motivo do cancelamento	reason_for_cancellation	True	string	O motivo para cancelar este envelope. Isso é registrado no histórico de atividades do envelope.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
IDs de envelope canceladas	folders cancelled	array of integer	A lista de IDs de envelope que foram canceladas com êxito.

Criar envelope a partir de Base64

ID da operação:: CreateEnvelopefromBase64

Cria e envia um envelope usando um documento PDF codificado em Base64.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do envelope	folderName	True	string	O nome deste envelope.
Tipo de entrada	inputType		string	Tipo de entrada para a origem do documento. Corrigido como base64 para essa ação.
Cadeias de caracteres de arquivo Base64	base64FileString	True	array of string	Uma matriz de documentos PDF codificados em Base64 a serem enviados.
Nomes de arquivo	fileNames	True	array of string	Uma matriz de nomes de exibição para cada documento, na mesma ordem que a matriz cadeia de caracteres de arquivo Base64.
Primeiro nome	firstName	True	string	O nome do destinatário.
Apelido	lastName	True	string	O sobrenome do destinatário.
Endereço de e-mail	emailId	True	string	O endereço de email do destinatário.
permissões	permission	True	string
Sequência	sequence	True	integer	Use esse campo para atribuir um número de sequência a um destinatário na lista de partes de destinatário. Use números de sequência exclusivos para cada parte começando com 1, como 1,2,3,4.... Se uma única pessoa aparecer várias vezes no fluxo de trabalho de assinatura, atribua uma sequência diferente sempre que o destinatário for repetido.
signerAuthLevels	signerAuthLevel		string	O nível de autenticação que um signatário aproveitará para fins de verificação
É Espaço Reservado	isPlaceholder		boolean	Use esse campo para iniciar a parte é um espaço reservado. Observação: 1. firstName, lastName, o valor do parâmetro emailId deve estar em branco dessa parte. 2. Para adicionar o espaço reservado, um destinatário deve ser requerado com a permissão 'PARTY_ASSIGNER'.
Função de destinatário	partyRole		string	Use este campo para atribuir uma função de espaço reservado.
Permitir alteração de nome	allowNameChange		string	O valor pode ser verdadeiro ou falso Use esse parâmetro para permitir que o signatário atualize o nome e o sobrenome antes de concluir o processo de assinatura.
Sequência de fluxo de trabalho	workflowSequence		integer	Atribua um número de sequência de fluxo de trabalho a esse destinatário. Quando a Sequência de Entrada está habilitada, os destinatários recebem o convite de assinatura em ordem de sequência crescente.
Host Email Id	hostEmailId		string	Endereço de email do Administrador do In-Person.
Código de acesso	userDefinedAccessCode		string	O parâmetro conterá o Código de Acesso quando o valor "signerAuthLevel" for definido como "Código de Acesso definido pelo usuário" para autenticação. Observação: 1. Os códigos não diferenciam maiúsculas de minúsculas. 2. O sistema não envia esse código, portanto, você deve compartilhar esse código diretamente com o signatário. 3. O código de acesso pode conter alfabetos, números e os seguintes caracteres especiais: @,&,{,},%,(,),~,\|,!,+,^.
Festa é Grupo de Email	partyIsEmailGroup		boolean	Use esse parâmetro ao criar uma parte como em massa. Nota: Se esse parâmetro for true, firstName, lastName e emailId dessa parte serão ignorados.
ID do Grupo de Email	emailGroupId		integer	Passe o email da ID do grupo que você deseja usar para criar em massa.
Logon Único em Massa	allowSingleSignerInBulk		boolean	Use esse parâmetro para permitir que apenas uma pessoa entre no grupo de email.
Código de discagem	dialingCode		string	Use esse campo para atribuir códigos de discagem de país são prefixos de número móvel a um destinatário na lista de partes de destinatários.
Número do Celular	mobileNumber		string	Use esse campo para atribuir um número de celular a um destinatário na lista de partes de destinatário.
Campos	Fields		object
Enviar agora	sendNow		boolean	Quando habilitado, o Foxit eSign envia imediatamente um link de assinatura exclusivo para o endereço de email de cada destinatário. Desabilite isso para salvar o envelope como um rascunho.
Criar sessão de assinatura inserida	createEmbeddedSigningSession	True	boolean	O token de sessão de assinatura será gerado sem enviar emails aos destinatários.
Criar sessão de assinatura inserida para todas as partes	createEmbeddedSigningSessionForAllParties		boolean	Se definido como true, uma URL de assinatura inserida será gerada para cada destinatário no envelope.
Processar marcas de texto	processTextTags	True	boolean	O valor pode ser verdadeiro ou falso. Esse campo é usado para determinar se o Foxit eSign deve analisar os documentos de Marcas de Texto para convertê-los em campos Foxit eSign.
Campos de Acro de Processo	processAcroFields	True	boolean	Este campo é usado para determinar se o Foxit eSign deve analisar os documentos de AcroFields para convertê-los em campos foxit eSign.
Sequência de entrada	signInSequence		boolean	Esse campo é usado para determinar se os destinatários assinarão os documentos do envelope em uma sequência. Se for falso, todos os destinatários receberão emails de convite simultaneamente. Quando verdadeiro, cada destinatário recebe o email de convite sucessivamente após o destinatário anterior concluir a tarefa necessária, como assinar os documentos ou preencher campos, etc.
Habilitar pessoalmente	inPersonEnable		boolean	Esse campo é usado para iniciar o processo de assinatura pessoal que pode ser facilmente concluído em qualquer dispositivo em questão de minutos e evita assinaturas baseadas em email quando necessário. Se for falso, todos os destinatários receberão o email de convite simultaneamente. Quando verdadeiro, o administrador pessoal recebe um email de convite para iniciar o processo de assinatura do signatário.
Corrigir partes de destinatário	fixRecipientParties		boolean	Se for true, no modo de exibição de envio inserido não será possível alterar as partes do envelope que já foram adicionadas como parte dessa solicitação.
Corrigir documentos	fixDocuments		boolean	Se for true, no envio inserido não será possível alterar os documentos do envelope que já foram adicionados como parte dessa solicitação.
Enviar URL de Êxito	sendSuccessUrl		string	Insira a URL absoluta para a página de aterrissagem para a qual o signatário será redirecionado depois de enviar com êxito a pasta no modo de exibição de envio inserido.
Enviar URL de Erro	sendErrorUrl		string	Insira a URL absoluta da página de aterrissagem para a qual o signatário será redirecionado se o erro vier durante o envio da pasta no modo de exibição de envio inserido.
Criar sessão de envio inserida	createEmbeddedSendingSession		boolean	Se definido como true, ele gerará um token inserido para abrir o modo de exibição de preparação do documento do Foxit eSign.
IDs de email de signatários inseridos	embeddedSignersEmailIds		array of string	Uma matriz de IDs de email de destinatários para os quais uma sessão de assinatura inserida precisa ser criada. As IDs de email das partes destinatários adicionadas na lista de partes.
Url de êxito do sinal	signSuccessUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados após a entrada com êxito no modo de exibição de assinatura inserido.
Url de Recusa de Sinal	signDeclineUrl		string	Insira a URL absoluta para os signatários que serão redirecionados se recusarem a entrar no modo de exibição de assinatura inserido.
Assinar url posterior	signLaterUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados se optarem por entrar posteriormente no modo de exibição de assinatura inserido.
Url de Erro de Sinal	signErrorUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados se o erro vier durante a assinatura do documento no modo de exibição de assinatura inserido.
Permitir enviar agora e sessão de assinatura inserida	allowSendNowAndEmbeddedSigningSession		boolean	Se definido como true, o Foxit eSign enviará um link de assinatura exclusivo para cada destinatário. Isso só é aplicável quando os parâmetros sendNow e createEmbeddedSigningSession são verdadeiros.
Validação avançada de email	allowAdvancedEmailValidation		boolean	Valide o endereço de email das partes quando definido como true.
Assinar url de êxito todas as partes	signSuccessUrlAllParties		boolean	Se definido como true, o signatário será redirecionado para a URL fornecida no signSuccessUrl após a assinatura com êxito. Isso só é aplicável quando o sendNow é verdadeiro.
ID do modelo de email	emailTemplateId		integer	Passe a ID do modelo de email para enviar os modelos de email diferentes dos modelos de email padrão.
ID de instrução do signatário	signerInstructionId		integer	Passe a ID de instrução para enviar instruções do signatário que não sejam as instruções padrão do signatário.
ID da Instrução de Confirmação	confirmationInstructionId		string	Passe a ID de instrução de confirmação para enviar instruções de confirmação diferentes das instruções de confirmação padrão.
Cor do Tema	themeColor		string	Insira o valor do CSS para definir a cor do tema.
Expiração da sessão	sessionExpire		boolean	Defina como true para iniciar a expiração da sessão de assinatura inserida.
Caducidade	expiry		integer	Obrigatório se sessionExpire for true. Insira a duração em milissegundos da expiração na sessão de assinatura inserida.
Nome do campo dependente	dependentFieldName	True	string	O nome do campo cuja visibilidade é controlada pelo campo pai.
Nome do campo pai	parentFieldName	True	string	O nome do campo pai cujo valor controla a visibilidade do campo dependente. Tipos de campo pai com suporte: campo de texto, caixa de texto, caixa de seleção, radiobutton, lista suspensa.
Valor do campo pai	parentFieldValue	True	string	O valor do campo pai que dispara o campo dependente para ficar visível. Para campos de caixa de seleção e botão de opção, use marcado ou desmarcado.
Opções	options	True	string	Opções de correspondência adicionais para campos pai baseados em texto. Valores aceitos: isblank, allowNull, contém.
Metadata	metadata		object	Isso deve estar no par de valores de chave. Máximo de 1.000 pares de valor de chave são permitidos.
Email do remetente	senderEmail		string	insira o email de outro usuário em sua conta que será usado para enviar esta pasta de documentos para as partes de destinatários.
Ocultar o botão Adicionar-me	hideAddMeButton		boolean	Se for true, ele ocultará o botão "Adicionar-me" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar Botão Adicionar Novo	hideAddNewButton		boolean	Se for true, ele ocultará o botão "Adicionar Novo" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar botão Adicionar Grupo	hideAddGroupButton		boolean	Se for true, ele ocultará o botão "Adicionar Grupo" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar o nome do campo para destinatários	hideFieldNameForRecipients		boolean	Ocultar nomes de campo para destinatários para campos de entrada de dados e campos avançados. (Exceto o botão Opção, Caixa de Seleção, Imagem e Hiperlink).
Ocultar Borda da Caixa de Seleção	hideCheckboxBorder		boolean	As bordas da caixa de seleção ficarão ocultas nos documentos executados.
Opção Ocultar Seleção do Signatário	hideSignerSelectOption		boolean	Se for true, ele ocultará a caixa de entrada "Nome/Email do Signatário Existente" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar ações do signatário	hideSignerActions		boolean	Se for true, ele ocultará as ações "editar", "alterar" e "remover" do signatário em Partes de Destinatário em uma sessão de envio inserida.
Ocultar nome do remetente	hideSenderName		boolean	Se for true, ele ocultará o nome do remetente em Partes de Destinatário em uma sessão de envio inserida.
Ocultar nome da pasta	hideFolderName		boolean	Se for true, ele ocultará o nome da pasta na navegação em ambas as sessões inseridas.
Ocultar nome de documentos	hideDocumentsName		boolean	Se for true, ele ocultará o nome do documento em ambas as sessões inseridas.
Ocultar o declínio ao sinal	hideDeclineToSign		boolean	Se for true, ele ocultará a opção "Recusar ao Sinal" para o signatário.
Ocultar mais ações	hideMoreAction		boolean	Se for true, ele ocultará o botão "Mais Ações" na sessão de envio/assinatura. No caso de "Enviar Agora": true, ele não ocultará nada.
Ocultar botão Enviar	hideSendButton		boolean	Se for true, ele ocultará o botão Enviar na sessão de envio inserida.
Ocultar o próximo fieldbtn necessário	hideNextRequiredFieldbtn		boolean	Se definido como true, oculta o botão de navegação que move os signatários para o próximo campo necessário.
Sessão inserida necessária	requiredBothEmbeddedSession		boolean	Se for true, ele gerará as URLs de envio e assinatura inseridas juntas.
Senha do envelope	folderPassword		string	Essa senha será exigida pelo signatário/autor para abrir o documento assinado digitalmente. Se o parâmetro for mantido em branco, nenhuma senha será necessária para abrir o documento assinado digitalmente.
Habilitar passo a passo	enableStepByStep		boolean	Para habilitar a ação passo a passo na sessão de envio inserida.
Opção Ocultar Adicionar Partes	hideAddPartiesOption		boolean	Se for true, ele ocultará a opção de adicionar partes no modo Criação de Rascunho e Modelo.
Autoassinar	selfSign		boolean	Ele habilita o autoassinamento inserido por meio de APIs. Esse parâmetro só é aplicável quando o parâmetro createEmbeddedSendingSession for verdadeiro.
URL de êxito do autoassinador	selfSignerSuccessUrl		string	Insira a URL absoluta da página de aterrissagem em seu site/aplicativo, para a qual o usuário será redirecionado após autoassinamento enviar com êxito a pasta no modo de exibição de envio inserido.

Retornos

Nome	Caminho	Tipo	Description
ID	folder.folderId	integer	A ID exclusiva do envelope recém-criado. Use isso em ações subsequentes para fazer referência a esse envelope.
Nome	folder.folderName	string	O nome do envelope recém-criado.
Nome Personalizado	folder.folderCustomName	string	Um nome personalizado para o envelope.
Password	folder.folderPassword	string	A senha de acesso do envelope, se definido.
ID do criador	folder.folderAuthorId	integer	O identificador exclusivo do criador do envelope.
Nome do Criador	folder.folderAuthorFirstName	string	O nome do criador do envelope.
Sobrenome do Criador	folder.folderAuthorLastName	string	O sobrenome do criador do envelope.
Email do Criador	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Função de Criador	folder.folderAuthorRole	string	O papel do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	O identificador exclusivo da empresa que possui o envelope.
Data de criação	folder.folderCreationDate	integer	A data em que o envelope foi criado (carimbo de data/hora Unix em milissegundos).
Data de envio	folder.folderSentDate	integer	A data em que o envelope foi enviado (carimbo de data/hora Unix em milissegundos).
Status	folder.folderStatus	string	O status atual do envelope.
Campo Personalizado 1	folder.custom_field1	string	O primeiro campo de metadados personalizado para o envelope.
Campo Personalizado 2	folder.custom_field2	string	O segundo campo de metadados personalizado para o envelope.
Metadata	folder.metadata	string	Metadados personalizados associados ao envelope.
Identificadores de documento	folder.folderDocumentIds	array of integer	A lista de IDs de documento contidas no envelope.
Documentos	folder.documentsList	array of object	A lista de documentos no envelope.
ID do documento	folder.documentsList.documentId	integer	O identificador exclusivo do documento.
ID do contrato	folder.documentsList.contractId	integer	O identificador exclusivo do contrato.
ID da Empresa	folder.documentsList.companyId	integer	O identificador exclusivo da empresa.
Criado por	folder.documentsList.contractCreatedBy	integer	A ID do usuário da pessoa que criou o contrato.
Data da criação	folder.documentsList.contractCreatedOn	string	A data e a hora em que o contrato foi criado.
Tipo de contrato	folder.documentsList.contractType	string	O tipo do contrato.
Status do contrato	folder.documentsList.contractStatus	string	O status atual do contrato.
Editável	folder.documentsList.editable	boolean	Indica se o item é editável.
ID da versão	folder.documentsList.contractVersionId	integer	O identificador exclusivo da versão do contrato.
Nome da versão	folder.documentsList.contractVersionName	string	O nome da versão do contrato.
Descrição da versão	folder.documentsList.contractVersionDesc	string	Uma descrição da versão do contrato.
Versão criada por	folder.documentsList.versionCreatedby	integer	A ID do usuário da pessoa que criou essa versão.
Versão criada em	folder.documentsList.versionCreatedOn	string	A data e a hora em que essa versão foi criada.
Número de Versão	folder.documentsList.contractVersionNumber	integer	O número de versão do contrato.
Origem da transação	folder.documentsList.contractTransactionSource	string	O sistema de origem que iniciou a transação de contrato.
Destinatários	folder.folderRecipientParties	array of object	A lista de partes de destinatários deste envelope.
ID do destinatário	folder.folderRecipientParties.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	folder.folderRecipientParties.partyDetails.partyId	integer	O identificador exclusivo do destinatário.
Primeiro nome	folder.folderRecipientParties.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O sobrenome do destinatário.
Endereço de e-mail	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de email do destinatário.
Espaço reservado	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se essa parte é um destinatário de espaço reservado.
Address	folder.folderRecipientParties.partyDetails.address	string	O endereço físico do destinatário.
Data de Criação	folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que o registro foi criado (carimbo de data/hora Unix em milissegundos).
Recusar emails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID exclusiva do destinatário	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador de sistema exclusivo para esse destinatário.
Nível de autenticação	folder.folderRecipientParties.partyDetails.authenticationLevel	string	O método de autenticação necessário para esse destinatário.
Data da Atualização da Senha	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A data em que a senha foi atualizada pela última vez.
Status atualizado por senha	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indica se a senha foi atualizada.
ID da Empresa	folder.folderRecipientParties.partyDetails.companyId	integer	O identificador exclusivo da empresa.
Função de Usuário	folder.folderRecipientParties.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.folderRecipientParties.partyDetails.department	string	O departamento ao qual o usuário pertence.
Title	folder.folderRecipientParties.partyDetails.title	string	O cargo do usuário.
Ativo	folder.folderRecipientParties.partyDetails.active	boolean	Indica se o usuário ou registro está ativo.
Local	folder.folderRecipientParties.partyDetails.requestLocale	string	A configuração de localidade para o usuário.
Compartilhar com o Departamento de Departamento	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indica se os envelopes são compartilhados em todo o departamento.
Código de discagem	folder.folderRecipientParties.partyDetails.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.folderRecipientParties.partyDetails.mobileNumber	string	O número de telefone celular.
Filtro de status	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Um filtro para o status do documento.
Filtro de data	folder.folderRecipientParties.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso seguro a campos	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indica se o usuário tem acesso a campos seguros.
Expandir Barra Lateral	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indica se a barra lateral é expandida por padrão.
Validação de email do Adv.	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada de email está habilitada.
ID do gerente	folder.folderRecipientParties.partyDetails.managerId	string	O identificador exclusivo do gerente do usuário.
Contagem de logons	folder.folderRecipientParties.partyDetails.loginCount	integer	O número de vezes que o usuário fez logon.
Email de Redefinição de Senha	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indica se um email de redefinição de senha deve ser enviado.
ID do departamento	folder.folderRecipientParties.partyDetails.departmentId	string	O identificador exclusivo do departamento.
Empresa Primária	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	A empresa primária associada ao usuário.
Tipo de dispositivo	folder.folderRecipientParties.partyDetails.deviceType	string	O tipo de dispositivo usado.
Token de dispositivo	folder.folderRecipientParties.partyDetails.deviceToken	string	O token de notificação por push para o dispositivo.
Descrição do subcontratado	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Uma descrição do subcontratado ou do signatário externo.
Organização subcontratada	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de adição do subcontratado	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (Carimbo de data/hora unix em milissegundos).
Source	folder.folderRecipientParties.partyDetails.source	string	O sistema de origem do qual o signatário externo foi adicionado.
Código de discagem	folder.folderRecipientParties.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.folderRecipientParties.mobileNumber	string	O número de telefone celular.
Tipo de assinatura	folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura que o signatário usará.
Permissões	folder.folderRecipientParties.contractPermissions	string	As permissões concedidas a essa parte para o contrato.
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	O número da sequência de pedidos de assinatura para este destinatário.
Sequência de fluxo de trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número da sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	O identificador exclusivo do envelope.
ID da empresa do destinatário	folder.folderRecipientParties.partyCompanyId	integer	O identificador exclusivo da empresa associada a esse destinatário.
Modo de Compartilhamento	folder.folderRecipientParties.sharingMode	string	O modo de compartilhamento deste envelope.
URL de Acesso do Destinatário	folder.folderRecipientParties.folderAccessURL	string	A URL que o destinatário pode usar para acessar e assinar o envelope.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicado a este envelope.
Comments	folder.folderRecipientParties.extraComments	string	Comentários adicionais incluídos no envelope.
Permitir alteração de nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se o destinatário tem permissão para atualizar seu nome.
Nome atualizado	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se o signatário atualizou seu nome.
Nível de autenticação do signatário	folder.folderRecipientParties.signerAuthenticationLevel	string	O nível de autenticação necessário para o signatário.
Código de acesso	folder.folderRecipientParties.userDefinedAccessCode	string	Um código de acesso personalizado definido para o signatário.
ID da Assinatura	folder.folderRecipientParties.signatureId	string	O identificador exclusivo da assinatura.
Função de destinatário	folder.folderRecipientParties.partyRole	string	A função atribuída a esse destinatário no fluxo de trabalho de assinatura.
Campo Da Empresa	folder.folderRecipientParties.companyFieldValue	string	O valor do campo nome da empresa na assinatura.
Campo Título	folder.folderRecipientParties.titleFieldValue	string	O valor do campo de título na assinatura.
Motivo da assinatura	folder.folderRecipientParties.reasonSigning	string	O motivo pelo qual o destinatário está assinando o documento.
Campo de pagamento adicionado	folder.folderRecipientParties.payFieldAdded	boolean	Indica se um campo de pagamento foi adicionado.
Beneficiário	folder.folderRecipientParties.payee	boolean	Indica se esse destinatário é o destinatário.
Pagamento recorrente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e assinar concluído	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se o processo de impressão e sinal está concluído.
Pago	folder.folderRecipientParties.paid	boolean	Indica se o pagamento foi concluído.
Signatário opcional permitido	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se esse destinatário é um signatário opcional.
Signatários opcionais	folder.folderRecipientParties.optionalSigners	array of integer	A lista de IDs opcionais da parte do signatário para este envelope.
URL de Assinatura do Autor	folder.folderAccessURLForAuthor	string	A URL que o remetente pode usar para acessar o envelope.
URL de Acesso de Rascunho	folder.draftFolderAccessURL	string	A URL usada para acessar a versão de rascunho do envelope.
Assinatura da Sala de Reuniões	folder.boardRoomSign	boolean	Indica se o modo de assinatura da sala de bordo está habilitado.
Incluir logotipo	folder.includeLogo	boolean	Indica se o logotipo da empresa está incluído em emails.
Cor da tela de fundo do botão	folder.email_btnBgColor	string	A cor da tela de fundo do botão de email.
Cor do texto do botão	folder.email_btnTxtColor	string	A cor do texto do botão de email.
Logotipo de email	folder.emailTemplateLogo	string	A URL do logotipo usada no modelo de email.
ID do modelo de email	folder.emailTemplateId	integer	O identificador exclusivo do modelo de email.
Cabeçalho de Email	folder.emailHeader	string	O texto do cabeçalho usado em emails de notificação.
Rodapé de email	folder.emailFooter	string	O texto do rodapé usado em emails de notificação.
Limpar Agendado	folder.purgeFlag	boolean	Indica se o envelope está agendado para limpeza.
Limpar Data de Início	folder.purgeStartDate	string	A data da qual a limpeza está agendada para começar.
Data de término da limpeza	folder.purgeEndDate	string	A data em que a limpeza está agendada para ser concluída.
ID de envio em massa	folder.bulkId	integer	O identificador exclusivo da operação de envio em massa.
Impor ordem de assinatura	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem entrar na sequência definida.
Etapa Atual	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Origem da transação	folder.transactionSource	string	O sistema de origem que iniciou essa transação.
Editável	folder.editable	boolean	Indica se o item é editável.
Assinatura do In-Person	folder.inPersonSignable	boolean	Indica se o envelope pode ser conectado pessoalmente.
Substituir lembretes	folder.overrideAccountReminders	boolean	Indica se as configurações de lembrete no nível da conta são substituídas.
Substituir delegação	folder.overrideAccountRecipientDelegation	boolean	Indica se as configurações de delegação no nível da conta são substituídas.
Permitir Delegação	folder.allowRecipientsToDelegate	boolean	Indica se os destinatários têm permissão para delegar a assinatura.
ID	folder.envelopeId	integer	O identificador exclusivo do envelope.
Nome	folder.envelopeName	string	O nome do envelope.
ID do originador	folder.envelopeOriginatorId	integer	O identificador exclusivo do usuário que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	O identificador exclusivo da empresa que possui o envelope.
Date	folder.envelopeDate	integer	A data em que o envelope foi criado (carimbo de data/hora Unix em milissegundos).
Data Compartilhada	folder.envelopeSharedDate	integer	A data em que o envelope foi compartilhado (carimbo de data/hora Unix em milissegundos).
Status	folder.envelopeStatus	string	O status atual do envelope.
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associadas a este envelope.
Permissões de destinatário	folder.envelopePartyPermissions	array of object	A lista de permissões de destinatário para este envelope.
ID do destinatário	folder.envelopePartyPermissions.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	folder.envelopePartyPermissions.partyDetails.partyId	integer	O identificador exclusivo do destinatário.
Primeiro nome	folder.envelopePartyPermissions.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	folder.envelopePartyPermissions.partyDetails.lastName	string	O sobrenome do destinatário.
Endereço de e-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	O endereço de email do destinatário.
Espaço reservado	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indica se essa parte é um destinatário de espaço reservado.
Address	folder.envelopePartyPermissions.partyDetails.address	string	O endereço físico do destinatário.
Data de Criação	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	A data em que o registro foi criado (carimbo de data/hora Unix em milissegundos).
Recusar emails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID exclusiva do destinatário	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Um identificador de sistema exclusivo para esse destinatário.
Nível de autenticação	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	O método de autenticação necessário para esse destinatário.
Data da Atualização da Senha	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	A data em que a senha foi atualizada pela última vez.
Status atualizado por senha	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indica se a senha foi atualizada.
ID da Empresa	folder.envelopePartyPermissions.partyDetails.companyId	integer	O identificador exclusivo da empresa.
Função de Usuário	folder.envelopePartyPermissions.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.envelopePartyPermissions.partyDetails.department	string	O departamento ao qual o usuário pertence.
Title	folder.envelopePartyPermissions.partyDetails.title	string	O cargo do usuário.
Ativo	folder.envelopePartyPermissions.partyDetails.active	boolean	Indica se o usuário ou registro está ativo.
Local	folder.envelopePartyPermissions.partyDetails.requestLocale	string	A configuração de localidade para o usuário.
Compartilhar com o Departamento de Departamento	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indica se os envelopes são compartilhados em todo o departamento.
Código de discagem	folder.envelopePartyPermissions.partyDetails.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	O número de telefone celular.
Filtro de status	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Um filtro para o status do documento.
Filtro de data	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso seguro a campos	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indica se o usuário tem acesso a campos seguros.
Expandir Barra Lateral	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indica se a barra lateral é expandida por padrão.
Validação de email do Adv.	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada de email está habilitada.
ID do gerente	folder.envelopePartyPermissions.partyDetails.managerId	string	O identificador exclusivo do gerente do usuário.
Contagem de logons	folder.envelopePartyPermissions.partyDetails.loginCount	integer	O número de vezes que o usuário fez logon.
Email de Redefinição de Senha	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indica se um email de redefinição de senha deve ser enviado.
ID do departamento	folder.envelopePartyPermissions.partyDetails.departmentId	string	O identificador exclusivo do departamento.
Empresa Primária	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	A empresa primária associada ao usuário.
Tipo de dispositivo	folder.envelopePartyPermissions.partyDetails.deviceType	string	O tipo de dispositivo usado.
Token de dispositivo	folder.envelopePartyPermissions.partyDetails.deviceToken	string	O token de notificação por push para o dispositivo.
Descrição do subcontratado	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Uma descrição do subcontratado ou do signatário externo.
Organização subcontratada	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de adição do subcontratado	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (Carimbo de data/hora unix em milissegundos).
Source	folder.envelopePartyPermissions.partyDetails.source	string	O sistema de origem do qual o signatário externo foi adicionado.
Código de discagem	folder.envelopePartyPermissions.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.envelopePartyPermissions.mobileNumber	string	O número de telefone celular.
Tipo de assinatura	folder.envelopePartyPermissions.signerSignatureType	string	O tipo de assinatura que o signatário usará.
Permissões	folder.envelopePartyPermissions.contractPermissions	string	As permissões concedidas a essa parte para o contrato.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	O número da sequência de pedidos de assinatura para este destinatário.
Sequência de fluxo de trabalho	folder.envelopePartyPermissions.workflowSignSequence	integer	O número da sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.envelopePartyPermissions.envelopeId	integer	O identificador exclusivo do envelope.
ID da empresa do destinatário	folder.envelopePartyPermissions.partyCompanyId	integer	O identificador exclusivo da empresa associada a esse destinatário.
Modo de Compartilhamento	folder.envelopePartyPermissions.sharingMode	string	O modo de compartilhamento deste envelope.
URL de Acesso do Destinatário	folder.envelopePartyPermissions.folderAccessURL	string	A URL que o destinatário pode usar para acessar e assinar o envelope.
Modo de Segurança	folder.envelopePartyPermissions.securityMode	string	O modo de segurança aplicado a este envelope.
Comments	folder.envelopePartyPermissions.extraComments	string	Comentários adicionais incluídos no envelope.
Permitir alteração de nome	folder.envelopePartyPermissions.allowNameChange	boolean	Indica se o destinatário tem permissão para atualizar seu nome.
Nome atualizado	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indica se o signatário atualizou seu nome.
Nível de autenticação do signatário	folder.envelopePartyPermissions.signerAuthenticationLevel	string	O nível de autenticação necessário para o signatário.
Código de acesso	folder.envelopePartyPermissions.userDefinedAccessCode	string	Um código de acesso personalizado definido para o signatário.
ID da Assinatura	folder.envelopePartyPermissions.signatureId	string	O identificador exclusivo da assinatura.
Função de destinatário	folder.envelopePartyPermissions.partyRole	string	A função atribuída a esse destinatário no fluxo de trabalho de assinatura.
Campo Da Empresa	folder.envelopePartyPermissions.companyFieldValue	string	O valor do campo nome da empresa na assinatura.
Campo Título	folder.envelopePartyPermissions.titleFieldValue	string	O valor do campo de título na assinatura.
Motivo da assinatura	folder.envelopePartyPermissions.reasonSigning	string	O motivo pelo qual o destinatário está assinando o documento.
Campo de pagamento adicionado	folder.envelopePartyPermissions.payFieldAdded	boolean	Indica se um campo de pagamento foi adicionado.
Beneficiário	folder.envelopePartyPermissions.payee	boolean	Indica se esse destinatário é o destinatário.
Pagamento recorrente	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e assinar concluído	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indica se o processo de impressão e sinal está concluído.
Pago	folder.envelopePartyPermissions.paid	boolean	Indica se o pagamento foi concluído.
Nível de autenticação	folder.envelopeAuthenticationLevel	string	O nível de autenticação necessário para o envelope.
Logon Único em Massa	folder.allowSingleSignerInBulk	boolean	Indica se um único signatário é permitido no modo de envio em massa.
Nomenclatura File-Based	folder.folderNameBasedOnFileNaming	boolean	Indica se o nome da pasta é baseado no nome do arquivo.
Nome do doc File-Based	folder.documentNameBasedOnFileNaming	boolean	Indica se o nome do documento é baseado no nome do arquivo.
Nome do certificado File-Based	folder.certificateNameBasedOnFileNaming	boolean	Indica se o nome do certificado é baseado no nome do arquivo.
Nomenclatura de arquivo pré-exec	folder.enableFileNamingBeforeExecution	boolean	Indica se a nomenclatura de arquivo está habilitada antes da execução do documento.
Payee Adicionado	folder.payeeAddedd	boolean	Indica se um destinatário foi adicionado.
Self-Signing Habilitado	folder.selfSignerEnabled	boolean	Indica se o modo de auto-assinatura está habilitado.
Notário Habilitado	folder.notaryEnabled	boolean	Indica se a assinatura de notário está habilitada.
Visibilidade Limitada	folder.limitedVisibilityFlag	boolean	Indica se a visibilidade limitada está habilitada para este envelope.
Visibilidade pós-sinal	folder.postSigningVisibility	boolean	Indica se a visibilidade pós-assinatura está habilitada.
Assinatura molhada	folder.wetSignatureEnabled	boolean	Indica se as assinaturas molhadas estão habilitadas.
Mesclar Habilitado	folder.mergeEnabled	boolean	Indica se a mesclagem de documentos está habilitada.
Sessões de assinatura inseridas	embeddedSigningSessions	array of object	A lista de sessões de assinatura inseridas, uma por destinatário. Presente somente quando createEmbeddedSigningSession for true.
Email do signatário	embeddedSigningSessions.emailIdOfSigner	string	O endereço de email do destinatário para esta sessão de assinatura inserida.
Token de assinatura	embeddedSigningSessions.embeddedToken	string	O token exclusivo para a sessão de assinatura inserida desse destinatário.
URL da Sessão de Assinatura	embeddedSigningSessions.embeddedSessionURL	string	A URL a ser aberta ou inserida para esse destinatário assinar o documento.
Token de envio inserido	embeddedToken	string	O token para a sessão de envio inserida. Presente somente quando createEmbeddedSendingSession for true.
Enviar URL da Sessão	embeddedSessionURL	string	A URL a ser aberta ou inserida para o autor do envelope preparar e enviar o envelope. Presente somente quando createEmbeddedSendingSession for true.
Result	result	string	Resultado da operação.
Message	message	string	Uma mensagem que descreve o resultado da operação.

Criar Envelope com base na URL

ID da operação:: CreateEnvelopefromURL

Cria e envia um envelope usando URLs PDF publicamente acessíveis. Forneça as URLs do documento e os detalhes do destinatário para iniciar o processo de assinatura.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do envelope	folderName	True	string	O nome deste envelope.
Tipo de entrada	inputType		string	Especifica o formato de origem do documento. Defina como url para fornecer URLs de arquivo ou base64 para fornecer conteúdo de arquivo codificado em Base64.
URLs de arquivo	fileUrls	True	array of string	Uma matriz de URLs publicamente acessíveis que apontam para os documentos a serem adicionados a esse envelope.
Nomes de arquivo	fileNames	True	array of string	Uma matriz de nomes de exibição para cada documento, na mesma ordem que urls de arquivo.
Primeiro nome	firstName	True	string	O nome do destinatário.
Apelido	lastName	True	string	O sobrenome do destinatário.
Endereço de e-mail	emailId	True	string	O endereço de email do destinatário.
permissões	permission	True	string
Sequência	sequence	True	integer	Use esse campo para atribuir um número de sequência a um destinatário na lista de partes de destinatário. Use números de sequência exclusivos para cada parte começando com 1, como 1,2,3,4.... Se uma única pessoa aparecer várias vezes no fluxo de trabalho de assinatura, atribua uma sequência diferente sempre que o destinatário for repetido.
signerAuthLevels	signerAuthLevel		string	O nível de autenticação que um signatário aproveitará para fins de verificação
É Espaço Reservado	isPlaceholder		boolean	Use esse campo para iniciar a parte é um espaço reservado. Observação: 1. firstName, lastName, o valor do parâmetro emailId deve estar em branco dessa parte. 2. Para adicionar o espaço reservado, um destinatário deve ser requerado com a permissão 'PARTY_ASSIGNER'.
Função de destinatário	partyRole		string	Use este campo para atribuir uma função de espaço reservado.
Permitir alteração de nome	allowNameChange		string	O valor pode ser verdadeiro ou falso Use esse parâmetro para permitir que o signatário atualize o nome e o sobrenome antes de concluir o processo de assinatura.
Sequência de fluxo de trabalho	workflowSequence		integer	Atribua um número de sequência de fluxo de trabalho a esse destinatário. Quando a Sequência de Entrada está habilitada, os destinatários recebem o convite de assinatura em ordem de sequência crescente.
Host Email Id	hostEmailId		string	Endereço de email do Administrador do In-Person.
Código de acesso	userDefinedAccessCode		string	O parâmetro conterá o Código de Acesso quando o valor "signerAuthLevel" for definido como "Código de Acesso definido pelo usuário" para autenticação. Observação: 1. Os códigos não diferenciam maiúsculas de minúsculas. 2. O sistema não envia esse código, portanto, você deve compartilhar esse código diretamente com o signatário. 3. O código de acesso pode conter alfabetos, números e os seguintes caracteres especiais: @,&,{,},%,(,),~,\|,!,+,^.
Festa é Grupo de Email	partyIsEmailGroup		boolean	Use esse parâmetro ao criar uma parte como em massa. Nota: Se esse parâmetro for true, firstName, lastName e emailId dessa parte serão ignorados.
ID do Grupo de Email	emailGroupId		integer	Passe o email da ID do grupo que você deseja usar para criar em massa.
Logon Único em Massa	allowSingleSignerInBulk		boolean	Use esse parâmetro para permitir que apenas uma pessoa entre no grupo de email.
Código de discagem	dialingCode		string	Use esse campo para atribuir códigos de discagem de país são prefixos de número móvel a um destinatário na lista de partes de destinatários.
Número do Celular	mobileNumber		string	Use esse campo para atribuir um número de celular a um destinatário na lista de partes de destinatário.
Campos	Fields		object
Enviar agora	sendNow		boolean	Quando habilitado, o Foxit eSign envia imediatamente um link de assinatura exclusivo para o endereço de email de cada destinatário. Desabilite isso para salvar o envelope como um rascunho.
Criar sessão de assinatura inserida	createEmbeddedSigningSession	True	boolean	O token de sessão de assinatura será gerado sem enviar emails aos destinatários.
Criar sessão de assinatura inserida para todas as partes	createEmbeddedSigningSessionForAllParties		boolean	Se definido como true, uma URL de assinatura inserida será gerada para cada destinatário no envelope.
Processar marcas de texto	processTextTags	True	boolean	O valor pode ser verdadeiro ou falso. Esse campo é usado para determinar se o Foxit eSign deve analisar os documentos de Marcas de Texto para convertê-los em campos Foxit eSign.
Campos de Acro de Processo	processAcroFields	True	boolean	Este campo é usado para determinar se o Foxit eSign deve analisar os documentos de AcroFields para convertê-los em campos foxit eSign.
Sequência de entrada	signInSequence		boolean	Esse campo é usado para determinar se os destinatários assinarão os documentos do envelope em uma sequência. Se for falso, todos os destinatários receberão emails de convite simultaneamente. Quando verdadeiro, cada destinatário recebe o email de convite sucessivamente após o destinatário anterior concluir a tarefa necessária, como assinar os documentos ou preencher campos, etc.
Habilitar pessoalmente	inPersonEnable		boolean	Esse campo é usado para iniciar o processo de assinatura pessoal que pode ser facilmente concluído em qualquer dispositivo em questão de minutos e evita assinaturas baseadas em email quando necessário. Se for falso, todos os destinatários receberão o email de convite simultaneamente. Quando verdadeiro, o administrador pessoal recebe um email de convite para iniciar o processo de assinatura do signatário.
Corrigir partes de destinatário	fixRecipientParties		boolean	Se for true, no modo de exibição de envio inserido não será possível alterar as partes do envelope que já foram adicionadas como parte dessa solicitação.
Corrigir documentos	fixDocuments		boolean	Se for true, no envio inserido não será possível alterar os documentos do envelope que já foram adicionados como parte dessa solicitação.
Enviar URL de Êxito	sendSuccessUrl		string	Insira a URL absoluta para a página de aterrissagem para a qual o signatário será redirecionado depois de enviar com êxito a pasta no modo de exibição de envio inserido.
Enviar URL de Erro	sendErrorUrl		string	Insira a URL absoluta para a página de aterrissagem para a qual o signatário será redirecionado se o erro vier durante o envio da pasta no modo de exibição de envio inserido.
Criar sessão de envio inserida	createEmbeddedSendingSession		boolean	Se definido como true, ele gerará um token inserido para abrir o modo de exibição de preparação do documento do Foxit eSign.
IDs de email de signatários inseridos	embeddedSignersEmailIds		array of string	Uma matriz de IDs de email de destinatários para os quais uma sessão de assinatura inserida precisa ser criada. As IDs de email das partes destinatários adicionadas na lista de partes.
Url de êxito do sinal	signSuccessUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados após a entrada com êxito no modo de exibição de assinatura inserido.
Url de Recusa de Sinal	signDeclineUrl		string	Insira a URL absoluta para os signatários que serão redirecionados se recusarem a entrar no modo de exibição de assinatura inserido.
Assinar url posterior	signLaterUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados se optarem por entrar posteriormente no modo de exibição de assinatura inserido.
Url de Erro de Sinal	signErrorUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados se o erro vier durante a assinatura do documento no modo de exibição de assinatura inserido.
Permitir enviar agora e sessão de assinatura inserida	allowSendNowAndEmbeddedSigningSession		boolean	Se definido como true, o Foxit eSign enviará um link de assinatura exclusivo para cada destinatário. Isso só é aplicável quando os parâmetros sendNow e createEmbeddedSigningSession são verdadeiros.
Validação avançada de email	allowAdvancedEmailValidation		boolean	Valide o endereço de email das partes quando definido como true.
Assinar url de êxito todas as partes	signSuccessUrlAllParties		boolean	Se definido como true, o signatário será redirecionado para a URL fornecida no signSuccessUrl após a assinatura com êxito. Isso só é aplicável quando o sendNow é verdadeiro.
ID do modelo de email	emailTemplateId		integer	Passe a ID do modelo de email para enviar os modelos de email diferentes dos modelos de email padrão.
ID de instrução do signatário	signerInstructionId		integer	Passe a ID de instrução para enviar instruções do signatário que não sejam as instruções padrão do signatário.
ID da Instrução de Confirmação	confirmationInstructionId		string	Passe a ID de instrução de confirmação para enviar instruções de confirmação diferentes das instruções de confirmação padrão.
Cor do Tema	themeColor		string	Insira o valor do CSS para definir a cor do tema.
Expiração da sessão	sessionExpire		boolean	Defina como true para iniciar a expiração da sessão de assinatura inserida.
Caducidade	expiry		integer	Obrigatório se sessionExpire for true. Insira a duração em milissegundos da expiração na sessão de assinatura inserida.
Nome do campo dependente	dependentFieldName	True	string	O nome do campo cuja visibilidade é controlada pelo campo pai.
Nome do campo pai	parentFieldName	True	string	O nome do campo pai cujo valor controla a visibilidade do campo dependente. Tipos de campo pai com suporte: campo de texto, caixa de texto, caixa de seleção, radiobutton, lista suspensa.
Valor do campo pai	parentFieldValue	True	string	O valor do campo pai que dispara o campo dependente para ficar visível. Para campos de caixa de seleção e botão de opção, use marcado ou desmarcado.
Opções	options	True	string	Opções de correspondência adicionais para campos pai baseados em texto. Valores aceitos: isblank, allowNull, contém.
Metadata	metadata		object	Isso deve estar no par de valores de chave. Máximo de 1.000 pares de valor de chave são permitidos.
Email do remetente	senderEmail		string	insira o email de outro usuário em sua conta que será usado para enviar esta pasta de documentos para as partes de destinatários.
Ocultar o botão Adicionar-me	hideAddMeButton		boolean	Se for true, ele ocultará o botão "Adicionar-me" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar Botão Adicionar Novo	hideAddNewButton		boolean	Se for true, ele ocultará o botão "Adicionar Novo" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar botão Adicionar Grupo	hideAddGroupButton		boolean	Se for true, ele ocultará o botão "Adicionar Grupo" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar o nome do campo para destinatários	hideFieldNameForRecipients		boolean	Ocultar nomes de campo para destinatários para campos de entrada de dados e campos avançados. (Exceto o botão Opção, Caixa de Seleção, Imagem e Hiperlink).
Ocultar Borda da Caixa de Seleção	hideCheckboxBorder		boolean	As bordas da caixa de seleção ficarão ocultas nos documentos executados.
Opção Ocultar Seleção do Signatário	hideSignerSelectOption		boolean	Se for true, ele ocultará a caixa de entrada "Nome/Email do Signatário Existente" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar ações do signatário	hideSignerActions		boolean	Se for true, ele ocultará as ações "editar", "alterar" e "remover" do signatário em Partes de Destinatário em uma sessão de envio inserida.
Ocultar nome do remetente	hideSenderName		boolean	Se for true, ele ocultará o nome do remetente em Partes de Destinatário em uma sessão de envio inserida.
Ocultar nome da pasta	hideFolderName		boolean	Se for true, ele ocultará o nome da pasta na navegação em ambas as sessões inseridas.
Ocultar nome de documentos	hideDocumentsName		boolean	Se for true, ele ocultará o nome do documento em ambas as sessões inseridas.
Ocultar o declínio ao sinal	hideDeclineToSign		boolean	Se for true, ele ocultará a opção "Recusar ao Sinal" para o signatário.
Ocultar mais ações	hideMoreAction		boolean	Se for true, ele ocultará o botão "Mais Ações" na sessão de envio/assinatura. No caso de "Enviar Agora": true, ele não ocultará nada.
Ocultar botão Enviar	hideSendButton		boolean	Se for true, ele ocultará o botão Enviar na sessão de envio inserida.
Ocultar o próximo fieldbtn necessário	hideNextRequiredFieldbtn		boolean	Se definido como true, oculta o botão de navegação que move os signatários para o próximo campo necessário.
Sessão inserida necessária	requiredBothEmbeddedSession		boolean	Se for true, ele gerará as URLs de envio e assinatura inseridas juntas.
Senha do envelope	folderPassword		string	Essa senha será exigida pelo signatário/autor para abrir o documento assinado digitalmente. Se o parâmetro for mantido em branco, nenhuma senha será necessária para abrir o documento assinado digitalmente.
Habilitar passo a passo	enableStepByStep		boolean	Para habilitar a ação passo a passo na sessão de envio inserida.
Opção Ocultar Adicionar Partes	hideAddPartiesOption		boolean	Se for true, ele ocultará a opção de adicionar partes no modo Criação de Rascunho e Modelo.
Autoassinar	selfSign		boolean	Ele habilita o autoassinamento inserido por meio de APIs. Esse parâmetro só é aplicável quando o parâmetro createEmbeddedSendingSession for verdadeiro.
URL de êxito do autoassinador	selfSignerSuccessUrl		string	Insira a URL absoluta da página de aterrissagem em seu site/aplicativo, para a qual o usuário será redirecionado após autoassinamento enviar com êxito a pasta no modo de exibição de envio inserido.

Retornos

Nome	Caminho	Tipo	Description
ID	folder.folderId	integer	A ID exclusiva do envelope recém-criado. Use isso em ações subsequentes para fazer referência a esse envelope.
Nome	folder.folderName	string	O nome do envelope recém-criado.
Nome Personalizado	folder.folderCustomName	string	Um nome personalizado para o envelope.
Password	folder.folderPassword	string	A senha de acesso do envelope, se definido.
ID do criador	folder.folderAuthorId	integer	O identificador exclusivo do criador do envelope.
Nome do Criador	folder.folderAuthorFirstName	string	O nome do criador do envelope.
Sobrenome do Criador	folder.folderAuthorLastName	string	O sobrenome do criador do envelope.
Email do Criador	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Função de Criador	folder.folderAuthorRole	string	O papel do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	O identificador exclusivo da empresa que possui o envelope.
Data de criação	folder.folderCreationDate	integer	A data em que o envelope foi criado (carimbo de data/hora Unix em milissegundos).
Data de envio	folder.folderSentDate	integer	A data em que o envelope foi enviado (carimbo de data/hora Unix em milissegundos).
Status	folder.folderStatus	string	O status atual do envelope.
Campo Personalizado 1	folder.custom_field1	string	O primeiro campo de metadados personalizado para o envelope.
Campo Personalizado 2	folder.custom_field2	string	O segundo campo de metadados personalizado para o envelope.
Metadata	folder.metadata	string	Metadados personalizados associados ao envelope.
Identificadores de documento	folder.folderDocumentIds	array of integer	A lista de IDs de documento contidas no envelope.
Documentos	folder.documentsList	array of object	A lista de documentos no envelope.
ID do documento	folder.documentsList.documentId	integer	O identificador exclusivo do documento.
ID do contrato	folder.documentsList.contractId	integer	O identificador exclusivo do contrato.
ID da Empresa	folder.documentsList.companyId	integer	O identificador exclusivo da empresa.
Criado por	folder.documentsList.contractCreatedBy	integer	A ID do usuário da pessoa que criou o contrato.
Data da criação	folder.documentsList.contractCreatedOn	string	A data e a hora em que o contrato foi criado.
Tipo de contrato	folder.documentsList.contractType	string	O tipo do contrato.
Status do contrato	folder.documentsList.contractStatus	string	O status atual do contrato.
Editável	folder.documentsList.editable	boolean	Indica se o item é editável.
ID da versão	folder.documentsList.contractVersionId	integer	O identificador exclusivo da versão do contrato.
Nome da versão	folder.documentsList.contractVersionName	string	O nome da versão do contrato.
Descrição da versão	folder.documentsList.contractVersionDesc	string	Uma descrição da versão do contrato.
Versão criada por	folder.documentsList.versionCreatedby	integer	A ID do usuário da pessoa que criou essa versão.
Versão criada em	folder.documentsList.versionCreatedOn	string	A data e a hora em que essa versão foi criada.
Número de Versão	folder.documentsList.contractVersionNumber	integer	O número de versão do contrato.
Origem da transação	folder.documentsList.contractTransactionSource	string	O sistema de origem que iniciou a transação de contrato.
Destinatários	folder.folderRecipientParties	array of object	A lista de partes de destinatários deste envelope.
ID do destinatário	folder.folderRecipientParties.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	folder.folderRecipientParties.partyDetails.partyId	integer	O identificador exclusivo do destinatário.
Primeiro nome	folder.folderRecipientParties.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O sobrenome do destinatário.
Endereço de e-mail	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de email do destinatário.
Espaço reservado	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se essa parte é um destinatário de espaço reservado.
Address	folder.folderRecipientParties.partyDetails.address	string	O endereço físico do destinatário.
Data de Criação	folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que o registro foi criado (carimbo de data/hora Unix em milissegundos).
Recusar emails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID exclusiva do destinatário	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador de sistema exclusivo para esse destinatário.
Nível de autenticação	folder.folderRecipientParties.partyDetails.authenticationLevel	string	O método de autenticação necessário para esse destinatário.
Data da Atualização da Senha	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A data em que a senha foi atualizada pela última vez.
Status atualizado por senha	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indica se a senha foi atualizada.
ID da Empresa	folder.folderRecipientParties.partyDetails.companyId	integer	O identificador exclusivo da empresa.
Função de Usuário	folder.folderRecipientParties.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.folderRecipientParties.partyDetails.department	string	O departamento ao qual o usuário pertence.
Title	folder.folderRecipientParties.partyDetails.title	string	O cargo do usuário.
Ativo	folder.folderRecipientParties.partyDetails.active	boolean	Indica se o usuário ou registro está ativo.
Local	folder.folderRecipientParties.partyDetails.requestLocale	string	A configuração de localidade para o usuário.
Compartilhar com o Departamento de Departamento	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indica se os envelopes são compartilhados em todo o departamento.
Código de discagem	folder.folderRecipientParties.partyDetails.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.folderRecipientParties.partyDetails.mobileNumber	string	O número de telefone celular.
Filtro de status	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Um filtro para o status do documento.
Filtro de data	folder.folderRecipientParties.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso seguro a campos	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indica se o usuário tem acesso a campos seguros.
Expandir Barra Lateral	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indica se a barra lateral é expandida por padrão.
Validação de email do Adv.	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada de email está habilitada.
ID do gerente	folder.folderRecipientParties.partyDetails.managerId	string	O identificador exclusivo do gerente do usuário.
Contagem de logons	folder.folderRecipientParties.partyDetails.loginCount	integer	O número de vezes que o usuário fez logon.
Email de Redefinição de Senha	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indica se um email de redefinição de senha deve ser enviado.
ID do departamento	folder.folderRecipientParties.partyDetails.departmentId	string	O identificador exclusivo do departamento.
Empresa Primária	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	A empresa primária associada ao usuário.
Tipo de dispositivo	folder.folderRecipientParties.partyDetails.deviceType	string	O tipo de dispositivo usado.
Token de dispositivo	folder.folderRecipientParties.partyDetails.deviceToken	string	O token de notificação por push para o dispositivo.
Descrição do subcontratado	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Uma descrição do subcontratado ou do signatário externo.
Organização subcontratada	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de adição do subcontratado	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (Carimbo de data/hora unix em milissegundos).
Source	folder.folderRecipientParties.partyDetails.source	string	O sistema de origem do qual o signatário externo foi adicionado.
Código de discagem	folder.folderRecipientParties.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.folderRecipientParties.mobileNumber	string	O número de telefone celular.
Tipo de assinatura	folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura que o signatário usará.
Permissões	folder.folderRecipientParties.contractPermissions	string	As permissões concedidas a essa parte para o contrato.
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	O número da sequência de pedidos de assinatura para este destinatário.
Sequência de fluxo de trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número da sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	O identificador exclusivo do envelope.
ID da empresa do destinatário	folder.folderRecipientParties.partyCompanyId	integer	O identificador exclusivo da empresa associada a esse destinatário.
Modo de Compartilhamento	folder.folderRecipientParties.sharingMode	string	O modo de compartilhamento deste envelope.
URL de Acesso do Destinatário	folder.folderRecipientParties.folderAccessURL	string	A URL que o destinatário pode usar para acessar e assinar o envelope.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicado a este envelope.
Comments	folder.folderRecipientParties.extraComments	string	Comentários adicionais incluídos no envelope.
Permitir alteração de nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se o destinatário tem permissão para atualizar seu nome.
Nome atualizado	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se o signatário atualizou seu nome.
Nível de autenticação do signatário	folder.folderRecipientParties.signerAuthenticationLevel	string	O nível de autenticação necessário para o signatário.
Código de acesso	folder.folderRecipientParties.userDefinedAccessCode	string	Um código de acesso personalizado definido para o signatário.
ID da Assinatura	folder.folderRecipientParties.signatureId	string	O identificador exclusivo da assinatura.
Função de destinatário	folder.folderRecipientParties.partyRole	string	A função atribuída a esse destinatário no fluxo de trabalho de assinatura.
Campo Da Empresa	folder.folderRecipientParties.companyFieldValue	string	O valor do campo nome da empresa na assinatura.
Campo Título	folder.folderRecipientParties.titleFieldValue	string	O valor do campo de título na assinatura.
Motivo da assinatura	folder.folderRecipientParties.reasonSigning	string	O motivo pelo qual o destinatário está assinando o documento.
Campo de pagamento adicionado	folder.folderRecipientParties.payFieldAdded	boolean	Indica se um campo de pagamento foi adicionado.
Beneficiário	folder.folderRecipientParties.payee	boolean	Indica se esse destinatário é o destinatário.
Pagamento recorrente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e assinar concluído	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se o processo de impressão e sinal está concluído.
Pago	folder.folderRecipientParties.paid	boolean	Indica se o pagamento foi concluído.
Signatário opcional permitido	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se esse destinatário é um signatário opcional.
Signatários opcionais	folder.folderRecipientParties.optionalSigners	array of integer	A lista de IDs opcionais da parte do signatário para este envelope.
URL de Assinatura do Autor	folder.folderAccessURLForAuthor	string	A URL que o remetente pode usar para acessar o envelope.
URL de Acesso de Rascunho	folder.draftFolderAccessURL	string	A URL usada para acessar a versão de rascunho do envelope.
Assinatura da Sala de Reuniões	folder.boardRoomSign	boolean	Indica se o modo de assinatura da sala de bordo está habilitado.
Incluir logotipo	folder.includeLogo	boolean	Indica se o logotipo da empresa está incluído em emails.
Cor da tela de fundo do botão	folder.email_btnBgColor	string	A cor da tela de fundo do botão de email.
Cor do texto do botão	folder.email_btnTxtColor	string	A cor do texto do botão de email.
Logotipo de email	folder.emailTemplateLogo	string	A URL do logotipo usada no modelo de email.
ID do modelo de email	folder.emailTemplateId	integer	O identificador exclusivo do modelo de email.
Cabeçalho de Email	folder.emailHeader	string	O texto do cabeçalho usado em emails de notificação.
Rodapé de email	folder.emailFooter	string	O texto do rodapé usado em emails de notificação.
Limpar Agendado	folder.purgeFlag	boolean	Indica se o envelope está agendado para limpeza.
Limpar Data de Início	folder.purgeStartDate	string	A data da qual a limpeza está agendada para começar.
Data de término da limpeza	folder.purgeEndDate	string	A data em que a limpeza está agendada para ser concluída.
ID de envio em massa	folder.bulkId	integer	O identificador exclusivo da operação de envio em massa.
Impor ordem de assinatura	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem entrar na sequência definida.
Etapa Atual	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Origem da transação	folder.transactionSource	string	O sistema de origem que iniciou essa transação.
Editável	folder.editable	boolean	Indica se o item é editável.
Assinatura do In-Person	folder.inPersonSignable	boolean	Indica se o envelope pode ser conectado pessoalmente.
Substituir lembretes	folder.overrideAccountReminders	boolean	Indica se as configurações de lembrete no nível da conta são substituídas.
Substituir delegação	folder.overrideAccountRecipientDelegation	boolean	Indica se as configurações de delegação no nível da conta são substituídas.
Permitir Delegação	folder.allowRecipientsToDelegate	boolean	Indica se os destinatários têm permissão para delegar a assinatura.
ID	folder.envelopeId	integer	O identificador exclusivo do envelope.
Nome	folder.envelopeName	string	O nome do envelope.
ID do originador	folder.envelopeOriginatorId	integer	O identificador exclusivo do usuário que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	O identificador exclusivo da empresa que possui o envelope.
Date	folder.envelopeDate	integer	A data em que o envelope foi criado (carimbo de data/hora Unix em milissegundos).
Data Compartilhada	folder.envelopeSharedDate	integer	A data em que o envelope foi compartilhado (carimbo de data/hora Unix em milissegundos).
Status	folder.envelopeStatus	string	O status atual do envelope.
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associadas a este envelope.
Permissões de destinatário	folder.envelopePartyPermissions	array of object	A lista de permissões de destinatário para este envelope.
ID do destinatário	folder.envelopePartyPermissions.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	folder.envelopePartyPermissions.partyDetails.partyId	integer	O identificador exclusivo do destinatário.
Primeiro nome	folder.envelopePartyPermissions.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	folder.envelopePartyPermissions.partyDetails.lastName	string	O sobrenome do destinatário.
Endereço de e-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	O endereço de email do destinatário.
Espaço reservado	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indica se essa parte é um destinatário de espaço reservado.
Address	folder.envelopePartyPermissions.partyDetails.address	string	O endereço físico do destinatário.
Data de Criação	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	A data em que o registro foi criado (carimbo de data/hora Unix em milissegundos).
Recusar emails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID exclusiva do destinatário	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Um identificador de sistema exclusivo para esse destinatário.
Nível de autenticação	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	O método de autenticação necessário para esse destinatário.
Data da Atualização da Senha	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	A data em que a senha foi atualizada pela última vez.
Status atualizado por senha	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indica se a senha foi atualizada.
ID da Empresa	folder.envelopePartyPermissions.partyDetails.companyId	integer	O identificador exclusivo da empresa.
Função de Usuário	folder.envelopePartyPermissions.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.envelopePartyPermissions.partyDetails.department	string	O departamento ao qual o usuário pertence.
Title	folder.envelopePartyPermissions.partyDetails.title	string	O cargo do usuário.
Ativo	folder.envelopePartyPermissions.partyDetails.active	boolean	Indica se o usuário ou registro está ativo.
Local	folder.envelopePartyPermissions.partyDetails.requestLocale	string	A configuração de localidade para o usuário.
Compartilhar com o Departamento de Departamento	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indica se os envelopes são compartilhados em todo o departamento.
Código de discagem	folder.envelopePartyPermissions.partyDetails.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	O número de telefone celular.
Filtro de status	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Um filtro para o status do documento.
Filtro de data	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso seguro a campos	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indica se o usuário tem acesso a campos seguros.
Expandir Barra Lateral	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indica se a barra lateral é expandida por padrão.
Validação de email do Adv.	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada de email está habilitada.
ID do gerente	folder.envelopePartyPermissions.partyDetails.managerId	string	O identificador exclusivo do gerente do usuário.
Contagem de logons	folder.envelopePartyPermissions.partyDetails.loginCount	integer	O número de vezes que o usuário fez logon.
Email de Redefinição de Senha	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indica se um email de redefinição de senha deve ser enviado.
ID do departamento	folder.envelopePartyPermissions.partyDetails.departmentId	string	O identificador exclusivo do departamento.
Empresa Primária	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	A empresa primária associada ao usuário.
Tipo de dispositivo	folder.envelopePartyPermissions.partyDetails.deviceType	string	O tipo de dispositivo usado.
Token de dispositivo	folder.envelopePartyPermissions.partyDetails.deviceToken	string	O token de notificação por push para o dispositivo.
Descrição do subcontratado	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Uma descrição do subcontratado ou do signatário externo.
Organização subcontratada	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de adição do subcontratado	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (Carimbo de data/hora unix em milissegundos).
Source	folder.envelopePartyPermissions.partyDetails.source	string	O sistema de origem do qual o signatário externo foi adicionado.
Código de discagem	folder.envelopePartyPermissions.dialingCode	string	O código de discagem internacional para o número de telefone.
Número do Celular	folder.envelopePartyPermissions.mobileNumber	string	O número de telefone celular.
Tipo de assinatura	folder.envelopePartyPermissions.signerSignatureType	string	O tipo de assinatura que o signatário usará.
Permissões	folder.envelopePartyPermissions.contractPermissions	string	As permissões concedidas a essa parte para o contrato.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	O número da sequência de pedidos de assinatura para este destinatário.
Sequência de fluxo de trabalho	folder.envelopePartyPermissions.workflowSignSequence	integer	O número da sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.envelopePartyPermissions.envelopeId	integer	O identificador exclusivo do envelope.
ID da empresa do destinatário	folder.envelopePartyPermissions.partyCompanyId	integer	O identificador exclusivo da empresa associada a esse destinatário.
Modo de Compartilhamento	folder.envelopePartyPermissions.sharingMode	string	O modo de compartilhamento deste envelope.
URL de Acesso do Destinatário	folder.envelopePartyPermissions.folderAccessURL	string	A URL que o destinatário pode usar para acessar e assinar o envelope.
Modo de Segurança	folder.envelopePartyPermissions.securityMode	string	O modo de segurança aplicado a este envelope.
Comments	folder.envelopePartyPermissions.extraComments	string	Comentários adicionais incluídos no envelope.
Permitir alteração de nome	folder.envelopePartyPermissions.allowNameChange	boolean	Indica se o destinatário tem permissão para atualizar seu nome.
Nome atualizado	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indica se o signatário atualizou seu nome.
Nível de autenticação do signatário	folder.envelopePartyPermissions.signerAuthenticationLevel	string	O nível de autenticação necessário para o signatário.
Código de acesso	folder.envelopePartyPermissions.userDefinedAccessCode	string	Um código de acesso personalizado definido para o signatário.
ID da Assinatura	folder.envelopePartyPermissions.signatureId	string	O identificador exclusivo da assinatura.
Função de destinatário	folder.envelopePartyPermissions.partyRole	string	A função atribuída a esse destinatário no fluxo de trabalho de assinatura.
Campo Da Empresa	folder.envelopePartyPermissions.companyFieldValue	string	O valor do campo nome da empresa na assinatura.
Campo Título	folder.envelopePartyPermissions.titleFieldValue	string	O valor do campo de título na assinatura.
Motivo da assinatura	folder.envelopePartyPermissions.reasonSigning	string	O motivo pelo qual o destinatário está assinando o documento.
Campo de pagamento adicionado	folder.envelopePartyPermissions.payFieldAdded	boolean	Indica se um campo de pagamento foi adicionado.
Beneficiário	folder.envelopePartyPermissions.payee	boolean	Indica se esse destinatário é o destinatário.
Pagamento recorrente	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e assinar concluído	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indica se o processo de impressão e sinal está concluído.
Pago	folder.envelopePartyPermissions.paid	boolean	Indica se o pagamento foi concluído.
Nível de autenticação	folder.envelopeAuthenticationLevel	string	O nível de autenticação necessário para o envelope.
Logon Único em Massa	folder.allowSingleSignerInBulk	boolean	Indica se um único signatário é permitido no modo de envio em massa.
Nomenclatura File-Based	folder.folderNameBasedOnFileNaming	boolean	Indica se o nome da pasta é baseado no nome do arquivo.
Nome do doc File-Based	folder.documentNameBasedOnFileNaming	boolean	Indica se o nome do documento é baseado no nome do arquivo.
Nome do certificado File-Based	folder.certificateNameBasedOnFileNaming	boolean	Indica se o nome do certificado é baseado no nome do arquivo.
Nomenclatura de arquivo pré-exec	folder.enableFileNamingBeforeExecution	boolean	Indica se a nomenclatura de arquivo está habilitada antes da execução do documento.
Payee Adicionado	folder.payeeAddedd	boolean	Indica se um destinatário foi adicionado.
Self-Signing Habilitado	folder.selfSignerEnabled	boolean	Indica se o modo de auto-assinatura está habilitado.
Notário Habilitado	folder.notaryEnabled	boolean	Indica se a assinatura de notário está habilitada.
Visibilidade Limitada	folder.limitedVisibilityFlag	boolean	Indica se a visibilidade limitada está habilitada para este envelope.
Visibilidade pós-sinal	folder.postSigningVisibility	boolean	Indica se a visibilidade pós-assinatura está habilitada.
Assinatura molhada	folder.wetSignatureEnabled	boolean	Indica se as assinaturas molhadas estão habilitadas.
Mesclar Habilitado	folder.mergeEnabled	boolean	Indica se a mesclagem de documentos está habilitada.
Sessões de assinatura inseridas	embeddedSigningSessions	array of object	A lista de sessões de assinatura inseridas, uma por destinatário. Presente somente quando createEmbeddedSigningSession for true.
Email do signatário	embeddedSigningSessions.emailIdOfSigner	string	O endereço de email do destinatário para esta sessão de assinatura inserida.
Token de assinatura	embeddedSigningSessions.embeddedToken	string	O token exclusivo para a sessão de assinatura inserida desse destinatário.
URL da Sessão de Assinatura	embeddedSigningSessions.embeddedSessionURL	string	A URL a ser aberta ou inserida para esse destinatário assinar o documento.
Token de envio inserido	embeddedToken	string	O token da sessão de envio inserida. Presente somente quando createEmbeddedSendingSession for true.
Enviar URL da Sessão	embeddedSessionURL	string	A URL a ser aberta ou inserida para o autor do envelope preparar e enviar o envelope. Presente somente quando createEmbeddedSendingSession for true.
Result	result	string	Resultado da operação.
Message	message	string	Uma mensagem que descreve o resultado da operação.

Criar envelope com base no modelo

ID da operação:: CreateEnvelopefromTemplate

Cria e envia um envelope usando um modelo existente. Os detalhes do destinatário podem ser personalizados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do envelope	folderName		string	Nome da pasta de documentos. Se esse valor não for fornecido, o nome da pasta do documento será mantido igual aos nomes dos modelos.
IDs de modelo	templateIds	True	array of integer	Uma matriz de IDs de modelo que você deseja usar para criar os documentos para essa pasta.
Campos	fields		object	Você pode passar os valores de campo usados nos modelos para preenchi-los nos documentos criados a partir do modelo. FIELD_NAME é o nome do campo usado no modelo. FIELD_VALUE é o valor do campo do documento.
Validação avançada de email	allowAdvancedEmailValidation		boolean	Valide os endereços de email das partes quando definidos como verdadeiros.
Primeiro nome	firstName	True	string	O nome do destinatário.
Apelido	lastName	True	string	O sobrenome do destinatário.
Endereço de e-mail	emailId	True	string	O endereço de email do destinatário.
permissões	permission	True	string
Sequência	sequence	True	integer	Use esse campo para atribuir um número de sequência a um destinatário na lista de partes de destinatário. Use números de sequência exclusivos para cada parte começando com 1, como 1,2,3,4.... Se uma única pessoa aparecer várias vezes no fluxo de trabalho de assinatura, atribua uma sequência diferente sempre que o destinatário for repetido.
signerAuthLevels	signerAuthLevel		string	O nível de autenticação que um signatário aproveitará para fins de verificação
É Espaço Reservado	isPlaceholder		boolean	Use esse campo para iniciar a parte é um espaço reservado. Observação: 1. firstName, lastName, o valor do parâmetro emailId deve estar em branco dessa parte. 2. Para adicionar o espaço reservado, um destinatário deve ser requerado com a permissão 'PARTY_ASSIGNER'.
Função de destinatário	partyRole		string	Use este campo para atribuir uma função de espaço reservado.
Permitir alteração de nome	allowNameChange		string	O valor pode ser verdadeiro ou falso Use esse parâmetro para permitir que o signatário atualize o nome e o sobrenome antes de concluir o processo de assinatura.
Sequência de fluxo de trabalho	workflowSequence		integer	Atribua um número de sequência de fluxo de trabalho a esse destinatário. Quando a Sequência de Entrada está habilitada, os destinatários recebem o convite de assinatura em ordem de sequência crescente.
Host Email Id	hostEmailId		string	Endereço de email do Administrador do In-Person.
Código de acesso	userDefinedAccessCode		string	O parâmetro conterá o Código de Acesso quando o valor "signerAuthLevel" for definido como "Código de Acesso definido pelo usuário" para autenticação. Observação: 1. Os códigos não diferenciam maiúsculas de minúsculas. 2. O sistema não envia esse código, portanto, você deve compartilhar esse código diretamente com o signatário. 3. O código de acesso pode conter alfabetos, números e os seguintes caracteres especiais: @,&,{,},%,(,),~,\|,!,+,^.
Festa é Grupo de Email	partyIsEmailGroup		boolean	Use esse parâmetro ao criar uma parte como em massa. Nota: Se esse parâmetro for true, firstName, lastName e emailId dessa parte serão ignorados.
ID do Grupo de Email	emailGroupId		integer	Passe o email da ID do grupo que você deseja usar para criar em massa.
Logon Único em Massa	allowSingleSignerInBulk		boolean	Use esse parâmetro para permitir que apenas uma pessoa entre no grupo de email.
Código de discagem	dialingCode		string	Use esse campo para atribuir códigos de discagem de país são prefixos de número móvel a um destinatário na lista de partes de destinatários.
Número do Celular	mobileNumber		string	Use esse campo para atribuir um número de celular a um destinatário na lista de partes de destinatário.
Senha do envelope	folderPassword		string	Essa senha será exigida pelo signatário/autor para abrir o documento assinado digitalmente. Se o parâmetro for mantido em branco, nenhuma senha será necessária para abrir o documento assinado digitalmente.
Sequência de entrada	signInSequence		boolean	Esse campo é usado para determinar se os destinatários assinarão os documentos do envelope em uma sequência. Se for falso, todos os destinatários receberão emails de convite simultaneamente. Quando verdadeiro, cada destinatário recebe o email de convite sucessivamente após o destinatário anterior concluir a tarefa necessária, como assinar os documentos ou preencher campos, etc.
Habilitar pessoalmente	inPersonEnable		boolean	Esse campo é usado para iniciar o processo de assinatura pessoal que pode ser facilmente concluído em qualquer dispositivo em questão de minutos e evita assinaturas baseadas em email quando necessário. Se for falso, todos os destinatários receberão o email de convite simultaneamente. Quando verdadeiro, o administrador pessoal recebe um email de convite para iniciar o processo de assinatura do signatário.
Enviar agora	sendNow		boolean	Quando habilitado, o Foxit eSign envia imediatamente um link de assinatura exclusivo para o endereço de email de cada destinatário. Desabilite isso para salvar o envelope como um rascunho.
Assinar url de êxito todas as partes	signSuccessUrlAllParties		boolean	Se definido como true, o signatário será redirecionado para a URL fornecida no signSuccessUrl após a assinatura com êxito. Isso só é aplicável quando o sendNow é verdadeiro.
Criar sessão de envio inserida	createEmbeddedSendingSession		boolean	Se definido como true, ele gerará uma URL inserida para abrir a exibição de preparação do documento do Foxit eSign.
Corrigir partes de destinatário	fixRecipientParties		boolean	Se for true, no modo de exibição de envio inserido não será possível alterar as partes do envelope que já foram adicionadas como parte dessa solicitação.
Corrigir documentos	fixDocuments		boolean	Se for true, no envio inserido não será possível alterar os documentos do envelope que já foram adicionados como parte dessa solicitação.
Enviar URL de Êxito	sendSuccessUrl		string	Insira a URL absoluta para a página de aterrissagem para a qual o signatário será redirecionado depois de enviar com êxito a pasta no modo de exibição de envio inserido.
Enviar URL de Erro	sendErrorUrl		string	Insira a URL absoluta da página de aterrissagem para a qual o signatário será redirecionado se o erro vier durante o envio da pasta no modo de exibição de envio inserido.
Opção Ocultar Seleção do Signatário	hideSignerSelectOption		boolean	Se for true, ele ocultará a caixa de entrada "Nome/Email do Signatário Existente" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar ações do signatário	hideSignerActions		boolean	Se for true, ele ocultará as ações "editar", "alterar" e "remover" do signatário em Partes de Destinatário em uma sessão de envio inserida.
Ocultar nome do remetente	hideSenderName		boolean	Se for true, ele ocultará o nome do remetente em Partes de Destinatário em uma sessão de envio inserida.
Ocultar botão Enviar	hideSendButton		boolean	Se for true, ele ocultará o botão Enviar na sessão de envio inserida.
Ocultar nome da pasta	hideFolderName		boolean	Se for true, ele ocultará o nome da pasta na navegação em ambas as sessões inseridas.
Ocultar nome de documentos	hideDocumentsName		boolean	Se for true, ele ocultará o nome do documento em ambas as sessões inseridas.
Ocultar o botão Adicionar-me	hideAddMeButton		boolean	Se for true, ele ocultará o botão "Adicionar-me" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar Botão Adicionar Novo	hideAddNewButton		boolean	Se for true, ele ocultará o botão "Adicionar Novo" em Partes de Destinatário em uma sessão de envio inserida.
Ocultar botão Adicionar Grupo	hideAddGroupButton		boolean	Se for true, ele ocultará o botão "Adicionar Grupo" em Partes de Destinatário em uma sessão de envio inserida.
Criar sessão de assinatura inserida	createEmbeddedSigningSession		boolean	O token de sessão de assinatura será gerado sem enviar emails aos destinatários.
Criar sessão de assinatura inserida para todas as partes	createEmbeddedSigningSessionForAllParties		boolean	Se definido como true, uma URL de assinatura inserida será gerada para cada destinatário no envelope. Se for falso, somente os destinatários listados nas IDs de Email dos Signatários Inseridos receberão uma sessão inserida.
IDs de email de signatários inseridos	embeddedSignersEmailIds		array of string	Uma matriz de IDs de email de destinatários para os quais uma sessão de assinatura inserida precisa ser criada. As IDs de email das partes destinatários adicionadas na lista de partes.
Url de êxito do sinal	signSuccessUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados após a entrada com êxito no modo de exibição de assinatura inserido.
Url de Recusa de Sinal	signDeclineUrl		string	Insira a URL absoluta para os signatários que serão redirecionados se recusarem a entrar no modo de exibição de assinatura inserido.
Assinar url posterior	signLaterUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados se optarem por entrar posteriormente no modo de exibição de assinatura inserido.
Url de Erro de Sinal	signErrorUrl		string	Insira a URL absoluta para os signatários aos quais serão redirecionados se o erro vier durante a assinatura do documento no modo de exibição de assinatura inserido.
Ocultar Próximo Campo Necessário Btn	hideNextRequiredFieldBtn		boolean	Se definido como true, oculta o botão de navegação que move os signatários para o próximo campo necessário.
Cor do Tema	themeColor		string	Insira o valor do CSS para definir a cor do tema.
Ocultar o declínio ao sinal	hideDeclineToSign		boolean	Se definido como true, oculta a opção Recusar para Assinar na tela de assinatura.
Ocultar mais ações	hideMoreAction		boolean	Se definido como true, oculta o botão Mais Ações na sessão de envio e assinatura. Não tem efeito quando Enviar Agora é verdadeiro.
Opção Ocultar Adicionar Partes	hideAddPartiesOption		boolean	Se definido como true, ocultará a opção de adicionar partes no modo Criação de Rascunho e Modelo.
Expiração da sessão	sessionExpire		boolean	Defina como true para iniciar a expiração da sessão de assinatura inserida.
Caducidade	expiry		integer	Obrigatório se sessionExpire for true. Insira a duração em milissegundos da expiração na sessão de assinatura inserida.
Email do remetente	senderEmail		string	insira o email de outro usuário em sua conta que será usado para enviar esta pasta de documentos para as partes de destinatários.
Permitir enviar agora e sessão de assinatura inserida	allowSendNowAndEmbeddedSigningSession		boolean	Se definido como true, o Foxit eSign envia um email de convite de assinatura para cada destinatário e também gera um link de assinatura inserido para destinatários cujo email está incluído no Email do Signatário Inserido. O email e o link inserido estão ativos simultaneamente.
Habilitar passo a passo	enableStepByStep		boolean	Para habilitar a ação passo a passo na sessão de envio inserida.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a operação foi bem-sucedida (por exemplo, 'êxito').
Message	message	string	Uma descrição do resultado da operação.
Sessões de assinatura inseridas	embeddedSigningSessions	array of object	A lista de sessões de assinatura inseridas, uma por destinatário. Presente somente quando createEmbeddedSigningSession for true.
Email do signatário	embeddedSigningSessions.emailIdOfSigner	string	O endereço de email do destinatário para esta sessão de assinatura inserida.
Token de assinatura	embeddedSigningSessions.embeddedToken	string	O token exclusivo para a sessão de assinatura inserida desse destinatário.
URL da Sessão de Assinatura	embeddedSigningSessions.embeddedSessionURL	string	A URL a ser aberta ou inserida para esse destinatário assinar o documento.
Token de envio inserido	embeddedToken	string	O token para a sessão de envio inserida. Presente somente quando createEmbeddedSendingSession for true.
Enviar URL da Sessão	embeddedSessionURL	string	A URL a ser aberta ou inserida para o autor do envelope preparar e enviar o envelope. Presente somente quando createEmbeddedSendingSession for true.
ID	folder.folderId	integer	A ID exclusiva do envelope criado. Use isso para referenciar o envelope em ações subsequentes.
Nome	folder.folderName	string	O nome do envelope.
Nome Personalizado	folder.folderCustomName	string	O nome personalizado atribuído ao envelope.
Password	folder.folderPassword	string	A senha definida para o envelope, se houver.
ID do autor	folder.folderAuthorId	integer	A ID exclusiva do usuário que criou o envelope.
Nome do autor	folder.folderAuthorFirstName	string	O nome do criador do envelope.
Sobrenome do Autor	folder.folderAuthorLastName	string	O sobrenome do criador do envelope.
Autor Email	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Função de Autor	folder.folderAuthorRole	string	A função de conta do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	A ID exclusiva da empresa à qual o envelope pertence.
Data de Criação	folder.folderCreationDate	integer	A data e a hora em que o envelope foi criado, em milissegundos unix.
Data de envio	folder.folderSentDate	integer	A data e a hora em que o envelope foi enviado aos destinatários, em milissegundos unix.
Status	folder.folderStatus	string	O status atual do envelope (por exemplo, SHARED, EXECUTED, DRAFT, CANCELLED).
Campo Personalizado 1	folder.custom_field1	string	O valor do campo personalizado 1 definido no envelope.
Campo Personalizado 2	folder.custom_field2	string	O valor do campo personalizado 2 definido no envelope.
Metadata	folder.metadata	string	Quaisquer metadados adicionais associados ao envelope.
Identificadores de documento	folder.folderDocumentIds	array of integer	A lista de IDs de documento incluídas neste envelope.
Documentos	folder.documentsList	array of object	Detalhes de cada documento incluído no envelope.
ID do documento	folder.documentsList.documentId	integer	O identificador exclusivo do documento.
ID do contrato	folder.documentsList.contractId	integer	O identificador exclusivo do contrato associado a este documento.
ID da Empresa	folder.documentsList.companyId	integer	A ID exclusiva da empresa à qual este documento pertence.
Criado por	folder.documentsList.contractCreatedBy	integer	A ID do usuário da pessoa que criou o contrato.
Data da criação	folder.documentsList.contractCreatedOn	string	A data em que o contrato foi criado.
Tipo de contrato	folder.documentsList.contractType	string	O tipo do contrato.
Status do documento	folder.documentsList.contractStatus	string	O status de assinatura atual do documento (por exemplo, WAITING_FOR_SIGNATURE, EXECUTED).
Editável	folder.documentsList.editable	boolean	Indica se o documento pode ser editado.
ID da versão	folder.documentsList.contractVersionId	integer	A ID exclusiva da versão atual do documento.
Nome da versão	folder.documentsList.contractVersionName	string	O nome da versão atual do documento.
Descrição da versão	folder.documentsList.contractVersionDesc	string	Uma descrição da versão atual do documento.
Versão criada por	folder.documentsList.versionCreatedby	integer	A ID do usuário da pessoa que criou esta versão do documento.
Versão criada em	folder.documentsList.versionCreatedOn	string	A data em que esta versão do documento foi criada.
Número de Versão	folder.documentsList.contractVersionNumber	integer	O número de versão do documento.
Origem da transação	folder.documentsList.contractTransactionSource	string	A origem da transação do contrato.
Destinatários	folder.folderRecipientParties	array of object	A lista de destinatários desse envelope, incluindo seus links de assinatura individuais.
ID do destinatário	folder.folderRecipientParties.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	folder.folderRecipientParties.partyDetails.partyId	integer	O identificador exclusivo do destinatário.
Primeiro nome	folder.folderRecipientParties.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O sobrenome do destinatário.
Email	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de email do destinatário.
É Espaço Reservado	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se esse destinatário é um espaço reservado.
Address	folder.folderRecipientParties.partyDetails.address	string	O endereço do destinatário.
Data de criação da conta	folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que a conta do destinatário foi criada, em milissegundos unix.
Recusar emails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID da Terceira Parte Exclusiva	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador de cadeia de caracteres exclusivo para o destinatário.
Nível de autenticação	folder.folderRecipientParties.partyDetails.authenticationLevel	string	O nível de autenticação necessário para esse destinatário.
ID da Empresa	folder.folderRecipientParties.partyDetails.companyId	integer	A ID da empresa à qual o destinatário pertence.
Função de Usuário	folder.folderRecipientParties.partyDetails.userRole	string	O papel do destinatário dentro de sua organização.
Departamento	folder.folderRecipientParties.partyDetails.department	string	O departamento do destinatário.
Title	folder.folderRecipientParties.partyDetails.title	string	O cargo do destinatário.
Ativo	folder.folderRecipientParties.partyDetails.active	boolean	Indica se a conta do destinatário está ativa.
Código de discagem	folder.folderRecipientParties.partyDetails.dialingCode	string	O código de discagem do país para o número de telefone do destinatário.
Número do Celular	folder.folderRecipientParties.partyDetails.mobileNumber	string	O número de telefone celular do destinatário.
Descrição do subcontratado	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Uma descrição do subcontratado, se aplicável.
Organização subcontratada	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado, se aplicável.
Data de adição do subcontratado	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado, em milissegundos unix.
Source	folder.folderRecipientParties.partyDetails.source	string	A origem por meio da qual o destinatário foi adicionado.
Código de discagem	folder.folderRecipientParties.dialingCode	string	O código de discagem do país para o número de celular do destinatário.
Número do Celular	folder.folderRecipientParties.mobileNumber	string	O número de celular do destinatário.
Tipo de assinatura	folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura permitido para esse destinatário.
Permissões	folder.folderRecipientParties.contractPermissions	string	As permissões de assinatura concedidas a esse destinatário (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	A posição desse destinatário na ordem de assinatura.
Sequência de fluxo de trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número da sequência de assinatura de fluxo de trabalho para esse destinatário.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	A ID do envelope ao qual este destinatário pertence.
ID da empresa de festa	folder.folderRecipientParties.partyCompanyId	integer	A ID da empresa à qual este destinatário pertence.
Modo de Compartilhamento	folder.folderRecipientParties.sharingMode	string	O método usado para compartilhar o documento com esse destinatário (por exemplo, email).
URL de assinatura	folder.folderRecipientParties.folderAccessURL	string	A URL de assinatura exclusiva para este destinatário. Use isso para compartilhar o link de assinatura diretamente.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicado ao acesso desse destinatário.
Comentários Extras	folder.folderRecipientParties.extraComments	string	Quaisquer comentários adicionais incluídos no convite de assinatura para este destinatário.
Permitir alteração de nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se o destinatário tem permissão para alterar seu nome antes de assinar.
Nome atualizado	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se o destinatário atualizou o nome de exibição.
Nível de autenticação	folder.folderRecipientParties.signerAuthenticationLevel	string	O método de autenticação necessário para que esse destinatário acesse o documento.
Código de acesso	folder.folderRecipientParties.userDefinedAccessCode	string	Um código de acesso personalizado necessário para que esse destinatário abra o documento.
ID da Assinatura	folder.folderRecipientParties.signatureId	string	A ID da assinatura salva usada por esse destinatário.
Função de destinatário	folder.folderRecipientParties.partyRole	string	A função atribuída a esse destinatário no envelope.
Valor do campo da empresa	folder.folderRecipientParties.companyFieldValue	string	O valor do campo da empresa pré-preenchido para esse destinatário.
Valor do campo de título	folder.folderRecipientParties.titleFieldValue	string	O valor do campo de título pré-preenchido para este destinatário.
Motivo da assinatura	folder.folderRecipientParties.reasonSigning	string	O motivo da assinatura fornecida por esse destinatário.
Campo de pagamento adicionado	folder.folderRecipientParties.payFieldAdded	boolean	Indica se um campo de pagamento foi adicionado para esse destinatário.
É o Payee	folder.folderRecipientParties.payee	boolean	Indica se esse destinatário é um destinatário.
O campo recorrente existe	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se existem campos de pagamento recorrentes para esse destinatário.
Imprimir e assinar concluído	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se o destinatário concluiu uma ação de impressão e sinal.
Permitir Signatário Opcional	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se esse destinatário pode ser ignorado como um signatário opcional.
Signatários opcionais	folder.folderRecipientParties.optionalSigners	string	A lista de signatários opcionais associados a esse destinatário, se houver.
Pago	folder.folderRecipientParties.paid	boolean	Indica se esse destinatário concluiu o pagamento.
URL de Acesso do Autor	folder.folderAccessURLForAuthor	string	A URL do autor do envelope para acessar o documento.
URL de Acesso de Rascunho	folder.draftFolderAccessURL	string	A URL para acessar o envelope enquanto ele estiver em estado de rascunho.
Placa da Sala de Administração	folder.boardRoomSign	boolean	Indica se a assinatura da sala de bordo está habilitada para este envelope.
Incluir logotipo	folder.includeLogo	boolean	Indica se o logotipo da empresa está incluído nas notificações por email.
Cor do botão Email	folder.email_btnBgColor	string	A cor da tela de fundo do botão de ação no email de assinatura.
Cor do Texto do Botão de Email	folder.email_btnTxtColor	string	A cor do texto do botão de ação no email de assinatura.
Logotipo de email	folder.emailTemplateLogo	string	A imagem de logotipo usada no modelo de email.
ID do modelo de email	folder.emailTemplateId	integer	A ID do modelo de email usado para assinar notificações.
Cabeçalho de Email	folder.emailHeader	string	O texto do cabeçalho personalizado nos emails de notificação de assinatura.
Rodapé de email	folder.emailFooter	string	O texto do rodapé personalizado na assinatura de emails de notificação.
Limpar Agendado	folder.purgeFlag	boolean	Indica se esse envelope está agendado para limpeza automática.
Limpar Data de Início	folder.purgeStartDate	string	A data da qual o período de limpeza começa.
Data de término da limpeza	folder.purgeEndDate	string	A data em que o envelope será limpo.
ID em massa	folder.bulkId	integer	A ID do lote de envio em massa ao qual este envelope pertence, se houver.
Impor ordem de assinatura	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem entrar na ordem especificada.
Etapa atual do fluxo de trabalho	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Origem da transação	folder.transactionSource	string	A origem que iniciou essa transação de envelope.
Editável	folder.editable	boolean	Indica se o envelope ainda pode ser editado.
Assinatura do In-Person	folder.inPersonSignable	boolean	Indica se o envelope pode ser conectado pessoalmente.
Substituir lembretes	folder.overrideAccountReminders	boolean	Indica se as configurações de lembrete no nível da conta são substituídas para este envelope.
Substituir delegação	folder.overrideAccountRecipientDelegation	boolean	Indica se as configurações de delegação no nível da conta são substituídas para este envelope.
Permitir Delegação	folder.allowRecipientsToDelegate	boolean	Indica se os destinatários têm permissão para delegar sua assinatura a outra pessoa.
ID	folder.envelopeId	integer	A ID exclusiva do envelope. Mesmo valor que a ID do Envelope (folderId).
Nome	folder.envelopeName	string	O nome do envelope. Mesmo valor que Nome do Envelope (folderName).
ID do originador	folder.envelopeOriginatorId	integer	A ID do usuário da pessoa que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	A ID da empresa à qual o envelope pertence.
Date	folder.envelopeDate	integer	A data e a hora em que o envelope foi criado, em milissegundos unix.
Data Compartilhada	folder.envelopeSharedDate	integer	A data e a hora em que o envelope foi compartilhado com os destinatários, em milissegundos unix.
Status	folder.envelopeStatus	string	O status atual do envelope. Mesmo valor que o Status do Envelope (folderStatus).
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associadas a este envelope.
Permissões de partes	folder.envelopePartyPermissions	array of object	A lista de destinatários e suas permissões de assinatura. Mesma estrutura que Destinatários.
ID do destinatário	folder.envelopePartyPermissions.partyId	integer	O identificador exclusivo do destinatário.
URL de assinatura	folder.envelopePartyPermissions.folderAccessURL	string	A URL de assinatura exclusiva para este destinatário.
Permissões	folder.envelopePartyPermissions.contractPermissions	string	As permissões de assinatura para este destinatário.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	A posição desse destinatário na ordem de assinatura.
Nível de autenticação	folder.envelopeAuthenticationLevel	string	O nível de autenticação aplicado ao envelope inteiro.
Permitir o logon único em massa	folder.allowSingleSignerInBulk	boolean	Indica se um único signatário é permitido no modo de envio em massa.
Nome com base no arquivo	folder.folderNameBasedOnFileNaming	boolean	Indica se o nome do envelope é derivado do nome do arquivo.
Nome do documento com base no arquivo	folder.documentNameBasedOnFileNaming	boolean	Indica se o nome do documento é derivado do nome do arquivo.
Nome do certificado com base no arquivo	folder.certificateNameBasedOnFileNaming	boolean	Indica se o nome do certificado é derivado do nome do arquivo.
Habilitar nomenclatura de arquivo	folder.enableFileNamingBeforeExecution	boolean	Indica se a nomenclatura de arquivo é solicitada antes do envio do envelope.
Payee Adicionado	folder.payeeAddedd	boolean	Indica se um destinatário foi adicionado ao envelope.
Autoassinador	folder.selfSignerEnabled	boolean	Indica se o remetente também é um signatário neste envelope.
Notário Habilitado	folder.notaryEnabled	boolean	Indica se a autenticação de autenticação está habilitada para este envelope.
Visibilidade Limitada	folder.limitedVisibilityFlag	boolean	Indica se a visibilidade limitada do documento está habilitada.
Visibilidade pós-assinatura	folder.postSigningVisibility	boolean	Indica se os destinatários podem exibir o documento assinado após a conclusão.
Assinatura molhada habilitada	folder.wetSignatureEnabled	boolean	Indica se as assinaturas molhadas (manuscritas) estão habilitadas para este envelope.
Mesclar Habilitado	folder.mergeEnabled	boolean	Indica se a mesclagem de documentos está habilitada para este envelope.

Criar grupo de email

ID da operação:: CreateEmailGroup

Cria um novo grupo de email que pode ser usado para enviar envelopes para vários destinatários ao mesmo tempo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do Grupo	emailGroupName	True	string	O nome do novo grupo de email.
Descrição do Grupo	emailGroupDescription		string	Uma descrição opcional para o grupo de email.
Permitir validação avançada de email	allowAdvancedEmailValidation		boolean	Quando habilitado, o Foxit eSign valida que todos os endereços de email no grupo podem ser acessados antes de enviar.
Primeiro nome	firstName	True	string	O nome do destinatário.
Apelido	lastName	True	string	O sobrenome do destinatário.
Email	emailId	True	string	O endereço de email do destinatário.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Message	message	string	Uma mensagem de confirmação para a ação executada.
ID do grupo	emailGroup.groupId	integer	O identificador exclusivo do grupo de email. Use essa ID ao enviar envelopes para o grupo.
Nome do Grupo	emailGroup.groupName	string	O nome do grupo de email.
Descrição do Grupo	emailGroup.groupDesc	string	A descrição do grupo de email.
Data de Criação	emailGroup.dateCreated	integer	A data em que o grupo de email foi criado, em milissegundos unix.
ID da Empresa	emailGroup.companyId	integer	A conta da empresa à qual este grupo de email pertence.
Parties	emailGroup.parties	array of object	A lista de destinatários no grupo de email.
Primeiro nome	emailGroup.parties.firstName	string	O nome do destinatário.
Apelido	emailGroup.parties.lastName	string	O sobrenome do destinatário.
Email	emailGroup.parties.emailId	string	O endereço de email do destinatário.

Criar modelo a partir da URL

ID da operação:: CreateTemplatefromURL

Cria um novo modelo usando uma URL PDF acessível publicamente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do Modelo	templateName	True	string	O nome do modelo. Deve terminar com a extensão .pdf (por exemplo, onboarding.pdf).
URL do modelo	templateUrl	True	string	A URL acessível publicamente do documento PDF a ser usada como modelo.
Tipo de entrada	inputType	True	string	O método de entrada para o documento. Sempre definido como 'url' para esta ação.
Processar marcas de texto	processTextTags	True	boolean	Quando habilitado, o Foxit eSign examinará o documento em busca de Marcas de Texto e os converterá automaticamente em campos de assinatura.
Campos de Acro de Processo	processAcroFields	True	boolean	Quando habilitado, o Foxit eSign examinará o documento em busca de AcroFields e os converterá automaticamente em campos de assinatura.
Compartilhar Tudo	shareAll	True	boolean	Compartilhe este modelo com todos os usuários em sua conta.
Número de partes	numberOfParties	True	integer	Adicione o número de partes no modelo. Os valores desse parâmetro devem ser inferiores a 20.
Cor do Tema	themeColor		string	Insira um valor css para uma cor para alterar o tema de createEmbeddedTemplateSession.
Autor Email	authorEmail		string	Insira o email de outro usuário em uma conta que será usada como autor deste modelo.
Criar sessão de modelo inserido	createEmbeddedTemplateSession		boolean	Se definido como true, uma sessão de modelo inserida para abrir diretamente o modo de exibição de preparação do modelo foxit eSign. Arrastar e soltar vários campos no modelo estará disponível.
Url de redirecionamento	redirectURL		string	Se createEmbeddedTemplateSession for true, a URL absoluta poderá ser inserida para a página de aterrissagem em qualquer site/aplicativo para o qual o usuário será redirecionado depois de clicar em "salvar e fechar" no modo de exibição de modelo inserido.
Ocultar Modelo de Envio	hideSendTemplate		boolean	Se for true, ele ocultará o botão Enviar em um modo de exibição de modelo inserido.
Corrigir partes de destinatário	fixRecipientParties		boolean	Se for true, no modo de exibição de modelo inserido não será possível alterar as partes do envelope que já foram adicionadas.
Campos	Fields		object
permissões	permission	True	string
Sequência	sequence	True	integer	Um número de sequência exclusivo para essa parte, a partir de 1. Define a ordem de assinatura quando a Sequência de Entrada está habilitada.
Função de destinatário	partyRole	True	string	A função atribuída a essa parte no modelo.
Ocultar mais ações	hideMoreAction		boolean	Se for true, ele ocultará o botão "Mais Ações" na sessão de modelo.
Ocultar compartilhamento com todos	hideShareWithAll		boolean	Se for true, ele ocultará a opção "Compartilhar com Todos" na sessão de modelo.
Ocultar Adicionar Parte	hideAddParty		boolean	Se for true, ele ocultará todas as opções da parte de adição em uma sessão de modelo inserida.
Botão Ocultar-me	hideMeButton		boolean	Se for true, ele ocultará o botão "Eu" em Partes de Destinatário em uma sessão de modelo inserida.
Botão Ocultar Outras Pessoas	hideOthersButton		boolean	Se for true, ele ocultará o botão "Outros" em Partes de Destinatário em uma sessão de modelo inserida.
Opção Ocultar Seleção de Contato Existente	hideExistingContactSelectOption		boolean	Se for true, ele ocultará a caixa de entrada "Localizar e Adicionar Contato Existente" em Partes de Destinatário em uma sessão de modelo inserida.
Ocultar o nome do campo para destinatários	hideFieldNameForRecipients		boolean	Ocultar nomes de campo para destinatários para campos de entrada de dados e campos avançados. (Exceto o botão Opção, Caixa de Seleção, Imagem e Hiperlink).
Ocultar Borda da Caixa de Seleção	hideCheckboxBorder		boolean	As bordas da caixa de seleção ficarão ocultas nos documentos executados.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a operação foi bem-sucedida (por exemplo, 'êxito').
Message	message	string	Uma descrição do resultado da operação.
ID	template.templateId	integer	A ID exclusiva do modelo criado. Use isso para criar envelopes com base neste modelo.
Nome	template.templateName	string	O nome do modelo.
Description	template.templateDesc	string	Uma descrição do modelo.
Tipo	template.templateType	string	O tipo do modelo.
Data de Criação	template.templateCreationDate	string	A data em que o modelo foi criado.
Data da Última Atualização	template.templateLastUpdateDate	string	A data em que o modelo foi atualizado pela última vez.
Editável	template.editable	boolean	Indica se o modelo pode ser editado.
Número de partes	template.numberOfParties	integer	O número de partes de destinatário definidas no modelo.
Total de Páginas	template.totalPages	integer	O número total de páginas no documento de modelo.
ID da Empresa	template.companyId	integer	A ID da empresa à qual este modelo pertence.
Compartilhado com Todos	template.shareAll	boolean	Indica se esse modelo é compartilhado com todos os usuários na conta.
Padrão de nome personalizado	template.templateCustomName	string	O padrão de nome personalizado aplicado a envelopes criados a partir desse modelo.
Permissões de partes	template.templatePartyPermissions	array of object	A lista de funções de destinatário e suas permissões definidas neste modelo.
ID do Participante	template.templatePartyPermissions.template_party_id	integer	A ID exclusiva dessa entrada de festa de modelo.
ID	template.templatePartyPermissions.templateId	integer	A ID do modelo ao qual essa parte pertence.
Permissões	template.templatePartyPermissions.templatePermissions	string	As permissões de assinatura para essa parte (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	template.templatePartyPermissions.partySequence	integer	A posição da ordem de assinatura para esta parte.
Função party	template.templatePartyPermissions.templatePartyRole	string	O nome da função atribuído a essa parte no modelo. Use isso ao criar um envelope a partir do modelo.
ID do Participante	template.templatePartyPermissions.partyId	integer	A ID da parte atribuída a essa função, se pré-atribuída.
ID do usuário	template.templateCreatedBy.partyId	integer	A ID exclusiva do usuário.
Primeiro nome	template.templateCreatedBy.firstName	string	O nome do usuário.
Apelido	template.templateCreatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateCreatedBy.emailId	string	O endereço de email do usuário.
ID da Empresa	template.templateCreatedBy.companyId	integer	A ID da empresa à qual o usuário pertence.
Função de Usuário	template.templateCreatedBy.userRole	string	A função do usuário dentro de sua organização.
Ativo	template.templateCreatedBy.active	boolean	Indica se a conta do usuário está ativa.
ID do usuário	template.templateLastUpdatedBy.partyId	integer	A ID exclusiva do usuário.
Primeiro nome	template.templateLastUpdatedBy.firstName	string	O nome do usuário.
Apelido	template.templateLastUpdatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateLastUpdatedBy.emailId	string	O endereço de email do usuário.
ID da Empresa	template.templateLastUpdatedBy.companyId	integer	A ID da empresa à qual o usuário pertence.
Função de Usuário	template.templateLastUpdatedBy.userRole	string	A função do usuário dentro de sua organização.
Ativo	template.templateLastUpdatedBy.active	boolean	Indica se a conta do usuário está ativa.
Campos de modelo	allfields	array of object	A lista de todos os campos de assinatura e formulário definidos no modelo.
ID do campo	allfields.fieldTagId	integer	O identificador exclusivo do campo.
ID do Modelo	allfields.templateId	integer	A ID do modelo ao qual este campo pertence.
ID da Empresa	allfields.companyId	integer	A conta da empresa à qual este campo pertence.
Tipo de campo	allfields.fieldType	string	O tipo do campo (por exemplo, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Número da Página	allfields.documentPageNumber	integer	O número da página do documento em que esse campo é colocado.
Parte Responsável	allfields.partyResponsible	integer	O número de sequência de partes responsável por preencher esse campo.
Sequência de festas	allfields.partyResponsibleSequence	integer	A posição da sequência da parte responsável.
Field Doc ID	allfields.docFieldId	string	O identificador no nível do documento para este campo.
É dependente	allfields.dependent	boolean	Indica se a visibilidade desse campo depende do valor de outro campo.
Ordem de Tabulação	allfields.tabOrder	integer	A ordem de tabulação para navegar entre campos.
Obrigatório	allfields.required	boolean	Indica se esse campo deve ser preenchido antes que o documento possa ser assinado.
Nome do campo personalizado	allfields.customFieldName	string	Um nome personalizado atribuído a este campo.
Compartilhar Tudo	allfields.shareAll	boolean	Indica se esse campo é compartilhado com todos os usuários.
Permitir Edição	allfields.allowEdit	boolean	Indica se esse campo pode ser editado pelo destinatário.
Nome do campo de texto	allfields.textfieldName	string	O rótulo do campo de texto (aplicável quando fieldType é 'textfield').
Valor	allfields.value	string	O valor pré-preenchido ou inserido do campo.
Tamanho da fonte	allfields.fontSize	integer	O tamanho da fonte usado para texto neste campo.
Cor do Tipo de Letra	allfields.fontColor	string	A cor da fonte usada para texto neste campo (por exemplo, #000000).
Somente leitura	allfields.readOnly	boolean	Indica se o campo é somente leitura e não pode ser editado pelo destinatário.
Várias Linhas	allfields.multiLine	boolean	Indica se o campo de texto aceita várias linhas de entrada (aplicável quando fieldType é 'textfield').
Limite de Carateres	allfields.characterLimit	integer	O número máximo de caracteres permitido no campo (aplicável quando fieldType é 'textfield').
Nome do campo de data	allfields.datefieldName	string	O rótulo do campo de data (aplicável quando fieldType é 'datefield').
Formato de data	allfields.dateFormat	string	O formato de data usado por esse campo (por exemplo, MM/DD/YYYY) (aplicável quando fieldType é 'datefield').
Nome da caixa de seleção	allfields.cbname	string	O rótulo do campo de caixa de seleção (aplicável quando fieldType é 'checkboxfield').
Grupo caixa de seleção	allfields.cbgroup	string	O nome do grupo para essa caixa de seleção (aplicável quando fieldType é 'checkboxfield').
Verificado	allfields.checked	boolean	Indica se a caixa de seleção é marcada por padrão (aplicável quando fieldType é 'checkboxfield').
Nome do campo protegido	allfields.securedfieldName	string	O rótulo do campo protegido (aplicável quando fieldType é 'securedfield').
Caracteres a serem exibidos	allfields.charToDisplay	integer	O número de caracteres desmascarados a serem exibidos no final de um valor de campo protegido (aplicável quando fieldType é 'securedfield').
ID da Assinatura	allfields.signatureId	string	A ID da assinatura aplicada a esse campo de sinal (aplicável quando fieldType é 'signfield').
Imagem Inicial	allfields.initialImage	string	Os dados de imagem para as iniciais aplicadas a esse campo (aplicável quando fieldType é 'initialfield').
Nome do campo anexo	allfields.attachmentfieldName	string	O nome do campo de anexo (aplicável quando fieldType é 'attachmentfield').
Descrição do anexo	allfields.attachmentfieldDescription	string	Uma descrição do que anexar (aplicável quando fieldType é 'attachmentfield').

Criar modelo a partir de Base64

ID da operação:: CreateTemplatefromBase64

Cria um novo modelo usando uma cadeia de caracteres PDF codificada em Base64. Use isso quando o arquivo PDF já estiver disponível como uma cadeia de caracteres Base64 em seu fluxo, por exemplo, de um arquivo SharePoint ou OneDrive documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do Modelo	templateName	True	string	O nome do modelo. Deve terminar com a extensão .pdf (por exemplo, onboarding.pdf).
Cadeia de caracteres de arquivo Base64	base64FileString	True	string	Cadeia de caracteres BASE64 de um PDF para a criação do modelo. Ele deve ser acessível publicamente quando você estiver criando o modelo.
Tipo de entrada	inputType	True	string	O método de entrada para o documento. Sempre definido como 'base64' para esta ação.
Processar marcas de texto	processTextTags	True	boolean	Quando habilitado, o Foxit eSign examinará o documento em busca de Marcas de Texto e os converterá automaticamente em campos de assinatura.
Campos de Acro de Processo	processAcroFields	True	boolean	Quando habilitado, o Foxit eSign examinará o documento em busca de AcroFields e os converterá automaticamente em campos de assinatura.
Compartilhar Tudo	shareAll	True	boolean	Compartilhe este modelo com todos os usuários em sua conta.
Número de partes	numberOfParties	True	integer	O número de partes de destinatário para este modelo. Deve ser menor que 20.
Cor do Tema	themeColor		string	Um valor de cor CSS para personalizar o tema da sessão de modelo inserido (por exemplo, #42caf4).
Autor Email	authorEmail		string	O endereço de email de outro usuário na conta a ser definido como o autor deste modelo.
Criar sessão de modelo inserido	createEmbeddedTemplateSession		boolean	Se definido como true, uma sessão de modelo inserida será criada para que você possa abrir o editor de modelos foxit eSign diretamente e arrastar e soltar campos para o modelo.
URL de redirecionamento	redirectURL		string	Se a Sessão Criar Modelo Inserido for verdadeira, a URL para a qual redirecionar o usuário depois de clicar em Salvar e Fechar no editor de modelo inserido.
Ocultar Modelo de Envio	hideSendTemplate		boolean	Se for true, o botão Enviar ficará oculto no editor de modelo inserido.
Corrigir partes de destinatário	fixRecipientParties		boolean	Se for true, as partes de destinatário já adicionadas não poderão ser alteradas no editor de modelo inserido.
Campos	Fields		object
permissões	permission	True	string
Sequência	sequence	True	integer	Um número de sequência exclusivo para essa parte, a partir de 1. Define a ordem de assinatura quando a Sequência de Entrada está habilitada.
Função de destinatário	partyRole	True	string	A função atribuída a essa parte no modelo.
Ocultar mais ações	hideMoreAction		boolean	Se for true, o botão Mais Ações ficará oculto na sessão de modelo inserida.
Ocultar compartilhamento com todos	hideShareWithAll		boolean	Se for true, a opção Compartilhar com Todos ficará oculta na sessão de modelo inserida.
Ocultar Adicionar Parte	hideAddParty		boolean	Se for true, todas as opções de adição de partes estarão ocultas na sessão de modelo inserida.
Botão Ocultar-me	hideMeButton		boolean	Se for true, o botão Me em Partes de Destinatário fica oculto na sessão de modelo inserida.
Botão Ocultar Outras Pessoas	hideOthersButton		boolean	Se for true, o botão Outros em Partes de Destinatário fica oculto na sessão de modelo inserida.
Ocultar o nome do campo para destinatários	hideFieldNameForRecipients		boolean	Se for true, os nomes de campo serão ocultos dos destinatários para entrada de dados e campos avançados.
Ocultar Borda da Caixa de Seleção	hideCheckboxBorder		boolean	Se for true, as bordas da caixa de seleção estarão ocultas nos documentos executados.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a operação foi bem-sucedida (por exemplo, 'êxito').
Message	message	string	Uma descrição do resultado da operação.
ID	template.templateId	integer	A ID exclusiva do modelo criado. Use isso para criar envelopes com base neste modelo.
Nome	template.templateName	string	O nome do modelo.
Description	template.templateDesc	string	Uma descrição do modelo.
Tipo	template.templateType	string	O tipo do modelo.
Data de Criação	template.templateCreationDate	string	A data em que o modelo foi criado.
Data da Última Atualização	template.templateLastUpdateDate	string	A data em que o modelo foi atualizado pela última vez.
Editável	template.editable	boolean	Indica se o modelo pode ser editado.
Número de partes	template.numberOfParties	integer	O número de partes de destinatário definidas no modelo.
Total de Páginas	template.totalPages	integer	O número total de páginas no documento de modelo.
ID da Empresa	template.companyId	integer	A ID da empresa à qual este modelo pertence.
Compartilhado com Todos	template.shareAll	boolean	Indica se esse modelo é compartilhado com todos os usuários na conta.
Permissões de partes	template.templatePartyPermissions	array of object	A lista de funções de destinatário e suas permissões definidas neste modelo.
ID do Participante	template.templatePartyPermissions.template_party_id	integer	A ID exclusiva dessa entrada de festa de modelo.
ID	template.templatePartyPermissions.templateId	integer	A ID do modelo ao qual essa parte pertence.
Permissões	template.templatePartyPermissions.templatePermissions	string	As permissões de assinatura para essa parte (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	template.templatePartyPermissions.partySequence	integer	A posição da ordem de assinatura para esta parte.
Função party	template.templatePartyPermissions.templatePartyRole	string	O nome da função atribuído a essa parte no modelo. Use isso ao criar um envelope a partir do modelo.
ID do usuário	template.templateCreatedBy.partyId	integer	A ID exclusiva do usuário.
Primeiro nome	template.templateCreatedBy.firstName	string	O nome do usuário.
Apelido	template.templateCreatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateCreatedBy.emailId	string	O endereço de email do usuário.
Campos de modelo	allfields	array of object	A lista de todos os campos de assinatura e formulário definidos no modelo.
ID do campo	allfields.fieldTagId	integer	O identificador exclusivo do campo.
ID do Modelo	allfields.templateId	integer	A ID do modelo ao qual este campo pertence.
ID da Empresa	allfields.companyId	integer	A conta da empresa à qual este campo pertence.
Tipo de campo	allfields.fieldType	string	O tipo do campo (por exemplo, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Número da Página	allfields.documentPageNumber	integer	O número da página do documento em que esse campo é colocado.
Parte Responsável	allfields.partyResponsible	integer	O número de sequência de partes responsável por preencher esse campo.
Sequência de festas	allfields.partyResponsibleSequence	integer	A posição da sequência da parte responsável.
Field Doc ID	allfields.docFieldId	string	O identificador no nível do documento para este campo.
É dependente	allfields.dependent	boolean	Indica se a visibilidade desse campo depende do valor de outro campo.
Ordem de Tabulação	allfields.tabOrder	integer	A ordem de tabulação para navegar entre campos.
Obrigatório	allfields.required	boolean	Indica se esse campo deve ser preenchido antes que o documento possa ser assinado.
Nome do campo personalizado	allfields.customFieldName	string	Um nome personalizado atribuído a este campo.
Compartilhar Tudo	allfields.shareAll	boolean	Indica se esse campo é compartilhado com todos os usuários.
Permitir Edição	allfields.allowEdit	boolean	Indica se esse campo pode ser editado pelo destinatário.
Nome do campo de texto	allfields.textfieldName	string	O rótulo do campo de texto (aplicável quando fieldType é 'textfield').
Valor	allfields.value	string	O valor pré-preenchido ou inserido do campo.
Tamanho da fonte	allfields.fontSize	integer	O tamanho da fonte usado para texto neste campo.
Cor do Tipo de Letra	allfields.fontColor	string	A cor da fonte usada para texto neste campo (por exemplo, #000000).
Somente leitura	allfields.readOnly	boolean	Indica se o campo é somente leitura e não pode ser editado pelo destinatário.
Várias Linhas	allfields.multiLine	boolean	Indica se o campo de texto aceita várias linhas de entrada (aplicável quando fieldType é 'textfield').
Limite de Carateres	allfields.characterLimit	integer	O número máximo de caracteres permitido no campo (aplicável quando fieldType é 'textfield').
Nome do campo de data	allfields.datefieldName	string	O rótulo do campo de data (aplicável quando fieldType é 'datefield').
Formato de data	allfields.dateFormat	string	O formato de data usado por esse campo (por exemplo, MM/DD/YYYY) (aplicável quando fieldType é 'datefield').
Nome da caixa de seleção	allfields.cbname	string	O rótulo do campo de caixa de seleção (aplicável quando fieldType é 'checkboxfield').
Grupo caixa de seleção	allfields.cbgroup	string	O nome do grupo para essa caixa de seleção (aplicável quando fieldType é 'checkboxfield').
Verificado	allfields.checked	boolean	Indica se a caixa de seleção é marcada por padrão (aplicável quando fieldType é 'checkboxfield').
Nome do campo protegido	allfields.securedfieldName	string	O rótulo do campo protegido (aplicável quando fieldType é 'securedfield').
Caracteres a serem exibidos	allfields.charToDisplay	integer	O número de caracteres desmascarados a serem exibidos no final de um valor de campo protegido (aplicável quando fieldType é 'securedfield').
ID da Assinatura	allfields.signatureId	string	A ID da assinatura aplicada a esse campo de sinal (aplicável quando fieldType é 'signfield').
Imagem Inicial	allfields.initialImage	string	Os dados de imagem para as iniciais aplicadas a esse campo (aplicável quando fieldType é 'initialfield').
Nome do campo anexo	allfields.attachmentfieldName	string	O nome do campo de anexo (aplicável quando fieldType é 'attachmentfield').
Descrição do anexo	allfields.attachmentfieldDescription	string	Uma descrição do que anexar (aplicável quando fieldType é 'attachmentfield').

Enviar lembrete de assinatura

ID da operação:: SendSignatureReminder

Envia uma notificação de lembrete para destinatários pendentes de um envelope, solicitando que eles concluam a assinatura.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	folderId	True	integer	A ID do envelope.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Envelope ID	reminder sent	integer	A ID do envelope para o qual o lembrete foi enviado.

Excluir Envelopes

ID da operação:: DeleteEnvelopes

Exclui permanentemente um ou mais envelopes.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
IDs de pasta	folderIds	True	array of integer	Uma matriz de IDs de envelope em que agir.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a operação foi bem-sucedida.

Listar todos os canais do Webhook

ID da operação:: ListallWebhookChannels

Retorna uma lista de todos os canais de webhook configurados em sua conta.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Total de canais	total_channel	integer	O número total de canais de webhook configurados na conta.
Canais do Webhook	templatesList	array of object	A lista de todos os canais de webhook na conta.
ID do Canal	templatesList.channelId	integer	O identificador exclusivo do canal do webhook.
ID da Empresa	templatesList.companyId	integer	A conta da empresa à qual este canal pertence.
Nome do canal	templatesList.channelName	string	O nome do canal do webhook.
Webhook URL	templatesList.webhookUrl	string	A URL que o Foxit eSign chamará quando ocorrer um evento assinado.
Segredo do Webhook	templatesList.webhookSecret	string	A chave secreta usada para verificar os conteúdos do webhook.
Data de Criação	templatesList.dateCreated	integer	A data em que o canal foi criado, em milissegundos unix.
Data atualizada	templatesList.dateUpdated	integer	A data em que o canal foi atualizado pela última vez, em milissegundos unix.
Nível do Webhook	templatesList.webhookLevel	string	O escopo do canal do webhook. 'Conta' (gatilhos para todos os envelopes) ou 'Aplicativo de API' (gatilhos somente para envelopes criados por meio da API).
Status	templatesList.status	string	O status atual do canal. 'ativo' ou 'desativo'.
Envelope Enviado	templatesList.eventsSubscribedMap.folder_sent	boolean	Dispara quando um envelope é enviado aos destinatários.
Envelope Exibido	templatesList.eventsSubscribedMap.folder_viewed	boolean	Dispara quando um envelope é aberto por um destinatário.
Envelope assinado	templatesList.eventsSubscribedMap.folder_signed	boolean	Dispara quando um envelope é assinado por um destinatário.
Envelope cancelado	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Dispara quando um envelope é cancelado.
Envelope executado	templatesList.eventsSubscribedMap.folder_executed	boolean	Dispara quando todas as partes assinaram e o envelope é totalmente executado.
Envelope Excluído	templatesList.eventsSubscribedMap.folder_deleted	boolean	Dispara quando um envelope é excluído.

Mover envelopes para a lixeira

ID da operação:: MoveEnvelopestoRecycleBin

Move um ou mais envelopes para a lixeira. Os envelopes na lixeira não são excluídos permanentemente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
IDs de pasta	folderIds	True	array of integer	Uma matriz de IDs de envelope em que agir.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a operação foi bem-sucedida.

Obter detalhes do canal do Webhook

ID da operação:: GetWebhookChannelDetails

Recupera os detalhes de um canal de webhook específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Canal	channelId	True	string	O identificador exclusivo do canal de webhook a ser recuperado.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
ID	channel.channelId	integer	O identificador exclusivo do canal do webhook.
ID da Empresa	channel.companyId	integer	A conta da empresa à qual este canal pertence.
Nome	channel.channelName	string	O nome do canal do webhook.
Webhook URL	channel.webhookUrl	string	A URL que o Foxit eSign chamará quando ocorrer um evento assinado.
Segredo do Webhook	channel.webhookSecret	string	A chave secreta usada para verificar os conteúdos do webhook.
Data de Criação	channel.dateCreated	integer	A data em que o canal foi criado, em milissegundos unix.
Data atualizada	channel.dateUpdated	integer	A data em que o canal foi atualizado pela última vez, em milissegundos unix.
Nível do Webhook	channel.webhookLevel	string	O escopo do canal do webhook. 'Conta' (gatilhos para todos os envelopes) ou 'Aplicativo de API' (gatilhos somente para envelopes criados por meio da API).
Status	channel.status	string	O status atual do canal. 'ativo' ou 'desativo'.
Envelope Enviado	channel.eventsSubscribedMap.folder_sent	boolean	Dispara quando um envelope é enviado aos destinatários.
Envelope Exibido	channel.eventsSubscribedMap.folder_viewed	boolean	Dispara quando um envelope é aberto por um destinatário.
Envelope assinado	channel.eventsSubscribedMap.folder_signed	boolean	Dispara quando um envelope é assinado por um destinatário.
Envelope cancelado	channel.eventsSubscribedMap.folder_cancelled	boolean	Dispara quando um envelope é cancelado.
Envelope executado	channel.eventsSubscribedMap.folder_executed	boolean	Dispara quando todas as partes assinaram e o envelope é totalmente executado.
Envelope Excluído	channel.eventsSubscribedMap.folder_deleted	boolean	Dispara quando um envelope é excluído.

Obter detalhes do envelope

ID da operação:: GetEnvelopeDetails

Recupera detalhes completos de um envelope, incluindo seu status, destinatários e documentos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	folderId	True	integer	O identificador exclusivo do envelope a ser recuperado.
Token de acesso	access_token		string	O token de acesso OAuth 2.0 para autenticação.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a operação foi bem-sucedida (por exemplo, 'êxito').
ID	folder.folderId	integer	A ID exclusiva do envelope.
Nome	folder.folderName	string	O nome do envelope.
ID do autor	folder.folderAuthorId	integer	A ID exclusiva do usuário que criou o envelope.
Nome do autor	folder.folderAuthorFirstName	string	O nome do criador do envelope.
Sobrenome do Autor	folder.folderAuthorLastName	string	O sobrenome do criador do envelope.
Autor Email	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Função de Autor	folder.folderAuthorRole	string	A função de conta do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	A ID exclusiva da empresa à qual o envelope pertence.
Data de Criação	folder.folderCreationDate	integer	A data e a hora em que o envelope foi criado, em milissegundos unix.
Data de envio	folder.folderSentDate	integer	A data e a hora em que o envelope foi enviado aos destinatários, em milissegundos unix. Nulo se ainda não foi enviado.
Status	folder.folderStatus	string	O status atual do envelope (por exemplo, SHARED, EXECUTED, DRAFT, CANCELLED).
Identificadores de documento	folder.folderDocumentIds	array of integer	A lista de IDs de documento incluídas neste envelope.
Documentos	folder.documentsList	array of object	Detalhes de cada documento incluído no envelope.
ID do documento	folder.documentsList.documentId	integer	O identificador exclusivo do documento.
ID do contrato	folder.documentsList.contractId	integer	O identificador exclusivo do contrato associado a este documento.
ID da Empresa	folder.documentsList.companyId	integer	A ID exclusiva da empresa à qual este documento pertence.
Criado por	folder.documentsList.contractCreatedBy	integer	A ID do usuário da pessoa que criou o contrato.
Data da criação	folder.documentsList.contractCreatedOn	integer	A data em que o contrato foi criado, em milissegundos unix.
Tipo de contrato	folder.documentsList.contractType	string	O tipo ou categoria do contrato.
Status do documento	folder.documentsList.contractStatus	string	O status de assinatura atual do documento (por exemplo, WAITING_FOR_SIGNATURE, EXECUTED).
Editável	folder.documentsList.editable	boolean	Indica se o documento pode ser editado.
ID da versão	folder.documentsList.contractVersionId	integer	A ID exclusiva da versão atual do documento.
Nome da versão	folder.documentsList.contractVersionName	string	O nome da versão atual do documento.
Descrição da versão	folder.documentsList.contractVersionDesc	string	Uma descrição da versão atual do documento.
Versão criada por	folder.documentsList.versionCreatedby	integer	A ID do usuário da pessoa que criou esta versão do documento.
Versão criada em	folder.documentsList.versionCreatedOn	integer	A data em que esta versão do documento foi criada, em milissegundos unix.
Número de Versão	folder.documentsList.contractVersionNumber	integer	O número de versão do documento.
Destinatários	folder.folderRecipientParties	array of object	A lista de destinatários desse envelope, incluindo o status de assinatura e os links de acesso.
ID do destinatário	folder.folderRecipientParties.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	folder.folderRecipientParties.partyDetails.partyId	integer	O identificador exclusivo do destinatário.
Primeiro nome	folder.folderRecipientParties.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O sobrenome do destinatário.
Email	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de email do destinatário.
Address	folder.folderRecipientParties.partyDetails.address	string	O endereço do destinatário.
Data de criação da conta	folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que a conta do destinatário foi criada, em milissegundos unix.
Permissões	folder.folderRecipientParties.contractPermissions	string	As permissões de assinatura concedidas a esse destinatário (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	A posição desse destinatário na ordem de assinatura.
Sequência de fluxo de trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número da sequência de assinatura de fluxo de trabalho para esse destinatário.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	A ID do envelope ao qual este destinatário pertence.
Modo de Compartilhamento	folder.folderRecipientParties.sharingMode	string	O método usado para compartilhar o documento com esse destinatário (por exemplo, email).
URL de assinatura	folder.folderRecipientParties.folderAccessURL	string	A URL de assinatura exclusiva para este destinatário. Nulo se o envelope já tiver sido concluído ou cancelado.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicado ao acesso desse destinatário.
Comentários Extras	folder.folderRecipientParties.extraComments	string	Quaisquer comentários adicionais incluídos no convite de assinatura para este destinatário.
URL de Acesso do Autor	folder.folderAccessURLForAuthor	string	A URL do autor do envelope para acessar o documento. Null caso não seja aplicável.
ID em massa	folder.bulkId	integer	A ID do lote de envio em massa ao qual este envelope pertence, se houver.
Impor ordem de assinatura	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem entrar na ordem especificada.
Etapa atual do fluxo de trabalho	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Origem da transação	folder.transactionSource	string	A origem que iniciou essa transação de envelope.
Editável	folder.editable	boolean	Indica se o envelope ainda pode ser editado.
Assinatura do In-Person	folder.inPersonSignable	boolean	Indica se o envelope pode ser conectado pessoalmente.
Substituir lembretes	folder.overrideAccountReminders	boolean	Indica se as configurações de lembrete no nível da conta são substituídas para este envelope.
ID	folder.envelopeId	integer	A ID exclusiva do envelope. Mesmo valor que a ID do Envelope (folderId).
Nome	folder.envelopeName	string	O nome do envelope. Mesmo valor que Nome do Envelope (folderName).
ID do originador	folder.envelopeOriginatorId	integer	A ID do usuário da pessoa que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	A ID da empresa à qual o envelope pertence.
Date	folder.envelopeDate	integer	A data e a hora em que o envelope foi criado, em milissegundos unix.
Data Compartilhada	folder.envelopeSharedDate	integer	A data e a hora em que o envelope foi compartilhado com os destinatários, em milissegundos unix. Nulo, se ainda não compartilhado.
Status	folder.envelopeStatus	string	O status atual do envelope. Mesmo valor que o Status do Envelope (folderStatus).
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associadas a este envelope.
Permissões de partes	folder.envelopePartyPermissions	array of object	A lista de destinatários e suas permissões de assinatura. Mesma estrutura que Destinatários.
ID do destinatário	folder.envelopePartyPermissions.partyId	integer	O identificador exclusivo do destinatário.
Primeiro nome	folder.envelopePartyPermissions.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	folder.envelopePartyPermissions.partyDetails.lastName	string	O sobrenome do destinatário.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	O endereço de email do destinatário.
Permissões	folder.envelopePartyPermissions.contractPermissions	string	As permissões de assinatura para este destinatário.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	A posição desse destinatário na ordem de assinatura.
URL de assinatura	folder.envelopePartyPermissions.folderAccessURL	string	A URL de assinatura exclusiva para este destinatário.
Todos os Campos	allFields	array of object	A lista de todos os campos de assinatura e formulário colocados nos documentos do envelope.
ID do campo	allFields.fieldTagId	integer	O identificador exclusivo do campo.
ID do documento	allFields.contractId	integer	A ID do documento ao qual este campo pertence.
ID da versão	allFields.versionId	integer	A ID da versão do documento ao qual este campo pertence.
Tipo de campo	allFields.fieldType	string	O tipo do campo (por exemplo, signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
Número da Página	allFields.documentPageNumber	integer	O número da página em que esse campo é colocado.
Field Doc ID	allFields.docFieldId	string	O identificador no nível do documento para este campo.
Parte Responsável	allFields.partyResponsible	integer	A ID da parte responsável por preencher esse campo.
É dependente	allFields.dependent	boolean	Indica se a visibilidade desse campo depende do valor de outro campo.
Obrigatório	allFields.required	boolean	Indica se esse campo deve ser preenchido antes que o documento possa ser enviado.
Valor do campo	allFields.value	string	O valor atual do campo, se preenchido.
Valores de campo	allFieldsNameValue	array of object	Uma lista simplificada de todos os nomes de campo e seus valores atuais. Use isso para ler dados de campo preenchidos de um envelope assinado.
ID do campo	allFieldsNameValue.fieldId	integer	O identificador exclusivo do campo.
ID do documento	allFieldsNameValue.documentId	integer	A ID do documento ao qual este campo pertence.
ID da versão	allFieldsNameValue.documentVersionId	integer	A ID da versão do documento ao qual este campo pertence.
Tipo de campo	allFieldsNameValue.fieldType	string	O tipo do campo (por exemplo, textfield, signfield, datefield, checkboxfield, dropdownfield).
Nome do campo	allFieldsNameValue.name	string	O rótulo ou o nome do campo conforme definido no modelo.
Valor do campo	allFieldsNameValue.value	string	O valor inserido ou selecionado para este campo.
Histórico de envelopes	Folder History	array of object	A trilha de auditoria de todas as ações tomadas neste envelope, em ordem cronológica.
Primeiro nome	Folder History.firstName	string	O nome da pessoa que executou a ação.
Apelido	Folder History.lastName	string	O sobrenome da pessoa que executou a ação.
Email	Folder History.email	string	O endereço de email da pessoa que executou a ação.
Envelope ID	Folder History.envelopeId	integer	A ID do envelope no qual a ação foi executada.
Date	Folder History.dateChanged	integer	A data e a hora em que a ação ocorreu, em milissegundos unix.
ID do Participante	Folder History.changeDoneByParty	integer	A ID da parte da pessoa que executou a ação.
Ação	Folder History.action	string	A ação executada no envelope (por exemplo, Created, InviteSentTo, InviteAccepted, Signed, Executed).

Obter detalhes do grupo de email

ID da operação:: GetEmailGroupDetails

Recupera detalhes de um grupo de email existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nomes de grupo de email	emailGroupNames	True	array of string	Uma matriz de nomes de grupo de email usada para identificar os grupos.

Retornos

Nome	Caminho	Tipo	Description
Grupos de Email	allEmailGroups	array of object	A lista de grupos de email que correspondem aos nomes de grupo solicitados.
ID do grupo	allEmailGroups.groupId	integer	O identificador exclusivo do grupo de email.
Nome do Grupo	allEmailGroups.groupName	string	O nome do grupo de email.
Descrição do Grupo	allEmailGroups.groupDesc	string	A descrição do grupo de email.
Data de Criação	allEmailGroups.dateCreated	integer	A data em que o grupo de email foi criado, em milissegundos unix.
ID da Empresa	allEmailGroups.companyId	integer	A conta da empresa à qual este grupo de email pertence.
Parties	allEmailGroups.parties	array of object	A lista de destinatários neste grupo de email.
Primeiro nome	allEmailGroups.parties.firstName	string	O nome do destinatário.
Apelido	allEmailGroups.parties.lastName	string	O sobrenome do destinatário.
Email	allEmailGroups.parties.emailId	string	O endereço de email do destinatário.

Obter detalhes do modelo

ID da operação:: GetTemplateDetails

Recupera todos os detalhes de um modelo específico, incluindo seus campos e destinatários.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Modelo	templateId	True	string	O identificador exclusivo do modelo a ser recuperado.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
ID	template.templateId	integer	O identificador exclusivo do modelo.
Nome	template.templateName	string	O nome do modelo.
Description	template.templateDesc	string	Uma descrição do modelo.
Tipo	template.templateType	string	O tipo do modelo.
Data de criação	template.templateCreationDate	integer	A data em que o modelo foi criado, em milissegundos unix.
Data da Última Atualização	template.templateLastUpdateDate	integer	A data em que o modelo foi atualizado pela última vez, em milissegundos unix.
Editável	template.editable	boolean	Indica se o modelo pode ser editado.
Número de partes	template.numberOfParties	integer	O número de partes de assinatura definidas no modelo.
Total de Páginas	template.totalPages	integer	O número total de páginas no documento de modelo.
ID da Empresa	template.companyId	integer	A conta da empresa à qual o modelo pertence.
Compartilhar com todos	template.shareAll	boolean	Indica se o modelo é compartilhado com todos os usuários na conta.
Padrão de nome personalizado	template.templateCustomName	string	O padrão de nome personalizado aplicado a envelopes criados a partir desse modelo.
Permissões de partes	template.templatePartyPermissions	array of object	A lista de funções de destinatário e suas permissões de assinatura definidas neste modelo.
ID do Participante	template.templatePartyPermissions.template_party_id	integer	A ID exclusiva dessa entrada de festa de modelo.
ID	template.templatePartyPermissions.templateId	integer	A ID do modelo ao qual essa parte pertence.
Permissões	template.templatePartyPermissions.templatePermissions	string	As permissões de assinatura para essa parte (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	template.templatePartyPermissions.partySequence	integer	A posição da ordem de assinatura para esta parte.
Função party	template.templatePartyPermissions.templatePartyRole	string	O nome da função atribuído a essa parte. Use esse valor ao criar um envelope desse modelo.
ID do Participante	template.templatePartyPermissions.partyId	integer	A ID da parte atribuída a essa função, se pré-atribuída.
ID do Participante	template.templateCreatedBy.partyId	integer	O identificador exclusivo do usuário.
Primeiro nome	template.templateCreatedBy.firstName	string	Primeiro nome do usuário.
Apelido	template.templateCreatedBy.lastName	string	Sobrenome do usuário.
Email	template.templateCreatedBy.emailId	string	O endereço de email do usuário.
Departamento	template.templateCreatedBy.department	string	O departamento do usuário.
Title	template.templateCreatedBy.title	string	O cargo do usuário.
Ativo	template.templateCreatedBy.active	boolean	Indica se a conta de utilizador está ativa.
ID do Participante	template.templateLastUpdatedBy.partyId	integer	O identificador exclusivo do usuário.
Primeiro nome	template.templateLastUpdatedBy.firstName	string	Primeiro nome do usuário.
Apelido	template.templateLastUpdatedBy.lastName	string	Sobrenome do usuário.
Email	template.templateLastUpdatedBy.emailId	string	O endereço de email do usuário.
Departamento	template.templateLastUpdatedBy.department	string	O departamento do usuário.
Title	template.templateLastUpdatedBy.title	string	O cargo do usuário.
Ativo	template.templateLastUpdatedBy.active	boolean	Indica se a conta de utilizador está ativa.
Todos os Campos	allfields	array of object	A lista de todos os campos definidos neste modelo.
ID da marca de campo	allfields.fieldTagId	integer	O identificador exclusivo do campo.
ID do Modelo	allfields.templateId	integer	A ID do modelo ao qual este campo pertence.
ID da Empresa	allfields.companyId	integer	A conta da empresa à qual este campo pertence.
Tipo de campo	allfields.fieldType	string	O tipo do campo (por exemplo, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Número da Página	allfields.documentPageNumber	integer	O número da página do documento em que esse campo é colocado.
Responsável pela parte	allfields.partyResponsible	integer	O número de sequência de partes responsável por concluir este campo.
Sequência de festas	allfields.partyResponsibleSequence	integer	A posição da sequência da parte responsável.
ID do Campo do Doc	allfields.docFieldId	string	O identificador desse campo dentro do documento.
Dependente	allfields.dependent	boolean	Indica se a visibilidade desse campo depende do valor de outro campo.
Ordem de Tabulação	allfields.tabOrder	integer	A ordem de tabulação para navegar entre campos.
Obrigatório	allfields.required	boolean	Indica se esse campo deve ser concluído antes que o documento possa ser assinado.
Nome do campo personalizado	allfields.customFieldName	string	Um nome personalizado atribuído a este campo.
Compartilhar Tudo	allfields.shareAll	boolean	Indica se esse campo é compartilhado com todos os usuários.
Permitir Edição	allfields.allowEdit	boolean	Indica se esse campo pode ser editado pelo destinatário.
Nome do campo de texto	allfields.textfieldName	string	O rótulo do campo de texto (aplicável quando fieldType é 'textfield').
Valor	allfields.value	string	O valor pré-preenchido ou inserido do campo.
Tamanho da fonte	allfields.fontSize	integer	O tamanho da fonte usado para texto neste campo.
Cor do Tipo de Letra	allfields.fontColor	string	A cor da fonte usada para texto neste campo (por exemplo, #000000).
Somente leitura	allfields.readOnly	boolean	Indica se o campo é somente leitura e não pode ser editado pelo destinatário.
Várias Linhas	allfields.multiLine	boolean	Indica se o campo de texto aceita várias linhas de entrada (aplicável quando fieldType é 'textfield').
Limite de Carateres	allfields.characterLimit	integer	O número máximo de caracteres permitido no campo (aplicável quando fieldType é 'textfield').
Nome do campo de data	allfields.datefieldName	string	O rótulo do campo de data (aplicável quando fieldType é 'datefield').
Formato de data	allfields.dateFormat	string	O formato de data usado por esse campo (por exemplo, MM/DD/YYYY) (aplicável quando fieldType é 'datefield').
Nome da caixa de seleção	allfields.cbname	string	O rótulo do campo de caixa de seleção (aplicável quando fieldType é 'checkboxfield').
Grupo caixa de seleção	allfields.cbgroup	string	O nome do grupo dessa caixa de seleção, usado quando várias caixas de seleção são vinculadas (aplicável quando fieldType é 'checkboxfield').
Verificado	allfields.checked	boolean	Indica se a caixa de seleção é marcada por padrão (aplicável quando fieldType é 'checkboxfield').
Nome do campo protegido	allfields.securedfieldName	string	O rótulo do campo protegido (aplicável quando fieldType é 'securedfield').
Caracteres a serem exibidos	allfields.charToDisplay	integer	O número de caracteres desmascarados a serem exibidos no final de um valor de campo protegido (aplicável quando fieldType é 'securedfield').
ID da Assinatura	allfields.signatureId	string	A ID da assinatura aplicada a esse campo de sinal (aplicável quando fieldType é 'signfield').
Imagem Inicial	allfields.initialImage	string	Os dados de imagem para as iniciais aplicadas a esse campo (aplicável quando fieldType é 'initialfield').
Nome do campo anexo	allfields.attachmentfieldName	string	O nome do campo de anexo (aplicável quando fieldType é 'attachmentfield').
Descrição do anexo	allfields.attachmentfieldDescription	string	Uma descrição do que anexar (aplicável quando fieldType é 'attachmentfield').

Obter histórico de atividades de envelope

ID da operação:: GetEnvelopeActivityHistory

Recupera um log de atividades completo para um envelope, mostrando todas as ações executadas pelos destinatários e pelo remetente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	folderId	True	integer	O identificador exclusivo do envelope cujo histórico de atividades você deseja recuperar.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Envelope ID	details.folderId	integer	O identificador exclusivo do envelope.
Documentos fechados	details.enclosedDocuments	string	O nome dos documentos colocados no envelope.
Destinatários	details.envelopeRecipients	string	Os nomes de todos os destinatários no envelope.
Autor	details.author	string	O nome do usuário que criou o envelope.
Status	details.status	string	O status atual do envelope (por exemplo, SHARED, EXECUTED, CANCELLED).
Data da atividade mais recente	details.latestActivityDate	string	A data e a hora da atividade mais recente no envelope.
Data de Criação	details.dateCreated	string	A data e a hora em que o envelope foi criado.
Data enviada	details.dateSent	string	A data e a hora em que o envelope foi enviado aos destinatários.
Activities	details.activities	array of object	A lista cronológica de todas as ações tomadas neste envelope.
Activity	details.activities.activity	string	Uma descrição legível pelo ser humano da ação que ocorreu.
Ação	details.activities.action	string	O tipo de ação executada (por exemplo, Created, Invitation Sent, Opened, Viewed, Signed).
Usuário	details.activities.user	string	O nome do usuário que executou a ação.
Envelope Status	details.activities.folderStatus	string	O status do envelope no momento em que essa ação ocorreu.
Hora	details.activities.time	string	A data e a hora em que a ação ocorreu.
Source	details.activities.source	string	A origem da qual a ação foi executada (por exemplo, Web).
Endereço IP	details.activities.ipAddress	string	O endereço IP do qual a ação foi executada, se disponível.

Obter histórico de envelope excluído

ID da operação:: GetDeletedEnvelopeHistory

Recupera um histórico de envelopes que foram excluídos ou movidos para a lixeira.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Envelope ID	folderId	True	string	O identificador exclusivo do envelope cujo histórico de exclusão você deseja recuperar.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Informações de envelope excluídas	Deleted Folder Log Info	array of object	Informações resumidas sobre o envelope excluído.
Envelope ID	Deleted Folder Log Info.folderId	integer	O identificador exclusivo do envelope excluído.
Nome do envelope	Deleted Folder Log Info.folderName	string	O nome do envelope excluído.
Nome do documento	Deleted Folder Log Info.documentName	string	O nome do documento no envelope excluído.
ID do documento	Deleted Folder Log Info.documentId	string	O identificador exclusivo do documento no envelope excluído.
Data de exclusão	Deleted Folder Log Info.deletionDate	integer	A data e a hora em que o envelope foi excluído, em milissegundos unix.
Excluído por	Deleted Folder Log Info.deletedBy	string	O nome do usuário que excluiu o envelope.
Histórico de logs de exclusão	Deleted Folder Log History	array of object	O log passo a passo de todas as ações de exclusão executadas no envelope.
Executado por	Deleted Folder Log History.partiesName	string	O nome do usuário que executou a etapa de exclusão.
Source	Deleted Folder Log History.source	string	A origem da qual a exclusão foi iniciada (por exemplo, Web, API).
Event	Deleted Folder Log History.event	string	A ação de exclusão específica executada (por exemplo, Excluir Pasta, Excluir Todas as Partes da Pasta).

Obter IDs de envelope

ID da operação:: GetEnvelopeIds

Retorna uma lista de IDs de envelope filtradas por status. Use isso para localizar envelopes em um estado específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Data de	dateFrom	True	string	Início do intervalo de datas de criação do envelope. Formato aceito: YYYY-MM-DD.
Data para	dateTo	True	string	Fim do intervalo de datas de criação do envelope. Formato aceito: YYYY-MM-DD. O valor dateTo deve estar dentro de 6 meses do valor dateFrom.
Status	status		string	Filtrar envelopes por status. Valores aceitos: EXECUTADO, COMPARTILHADO, RASCUNHO, PARCIALMENTE ASSINADO, CANCELADO, EXPIRADO, EXCLUÍDO. Se omitido, os envelopes com qualquer status serão retornados.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Message	message	string	Uma mensagem de resumo indicando quantas IDs de envelope foram retornadas.
Envelope IDs	allFolderIds	array of integer	A lista de IDs de envelope que correspondem aos critérios de filtro. Use essas IDs com Obter Detalhes do Envelope para recuperar informações completas do envelope.

Obter modelos por IDs de modelo

ID da operação:: GetTemplatesbyTemplateIds

Recupera detalhes de um ou mais modelos por suas IDs.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
IDs de modelo	templateIds	True	array of integer	Uma matriz de IDs de modelo a serem recuperadas.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Total de modelos	total_templates	integer	O número total de modelos retornados.
Lista de modelos	templateIdList	object	Um mapa de dados de modelo chaveado pela ID do modelo. Cada entrada contém os detalhes do modelo e seus campos.

Obter uma lista de todos os modelos

ID da operação:: GetalistofallTemplates

Retorna uma lista de todos os modelos disponíveis em sua conta.

Retornos

Nome	Caminho	Tipo	Description
Result	result	string	Indica se a solicitação foi bem-sucedida.
Total de modelos	total_templates	integer	O número total de modelos em sua conta.
Lista de modelos	templatesList	array of object	A lista de todos os modelos disponíveis na conta.
ID do Modelo	templatesList.templateId	integer	O identificador exclusivo do modelo. Use essa ID com Criar Envelope do Modelo para enviar o modelo para assinatura.
Nome do Modelo	templatesList.templateName	string	O nome do modelo.
Descrição do modelo	templatesList.templateDesc	string	Uma descrição do modelo.
Tipo de modelo	templatesList.templateType	string	O tipo ou categoria do modelo.
Data de criação	templatesList.templateCreationDate	integer	A data em que o modelo foi criado, em milissegundos unix.
Data da Última Atualização	templatesList.templateLastUpdateDate	integer	A data em que o modelo foi atualizado pela última vez, em milissegundos unix.
Editável	templatesList.editable	boolean	Indica se o modelo pode ser editado.
Número de partes	templatesList.numberOfParties	integer	O número de partes de assinatura definidas no modelo.
ID da Empresa	templatesList.companyId	integer	A conta da empresa à qual o modelo pertence.
Compartilhar com todos	templatesList.shareAll	boolean	Indica se o modelo é compartilhado com todos os usuários na conta.
ID do Participante	templatesList.templateCreatedBy.partyId	integer	O identificador exclusivo do usuário.
Primeiro nome	templatesList.templateCreatedBy.firstName	string	Primeiro nome do usuário.
Apelido	templatesList.templateCreatedBy.lastName	string	Sobrenome do usuário.
Email	templatesList.templateCreatedBy.emailId	string	O endereço de email do usuário.
ID do Participante	templatesList.templateLastUpdatedBy.partyId	integer	O identificador exclusivo do usuário.
Primeiro nome	templatesList.templateLastUpdatedBy.firstName	string	Primeiro nome do usuário.
Apelido	templatesList.templateLastUpdatedBy.lastName	string	Sobrenome do usuário.
Email	templatesList.templateLastUpdatedBy.emailId	string	O endereço de email do usuário.

Gatilhos

Quando um envelope é assinado	Dispara quando um destinatário assina o envelope.
Quando um envelope é cancelado	Dispara quando um envelope é cancelado por um destinatário ou pelo remetente.
Quando um envelope é enviado	Dispara quando um envelope é enviado aos destinatários. Esse evento só é acionado quando o Nível do Webhook é definido como 'Conta'.
Quando um envelope é excluído	Dispara quando um envelope é excluído.
Quando um envelope é exibido	Dispara quando um destinatário é aberto e exibe o envelope.
Quando um envelope é totalmente executado	Dispara quando todos os destinatários são assinados e o envelope é totalmente executado.

Quando um envelope é assinado

ID da operação:: TriggerEnvelopeSigned

Dispara quando um destinatário assina o envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do canal	channelName	True	string	Um nome para identificar essa assinatura de webhook em sua conta.
Nível do Webhook	webhookLevel	True	string	Conta: é acionada para todos os envelopes (Web e API). Aplicativo de API: é acionado apenas para envelopes criados por meio da API.
Segredo do Webhook	webhookSecret		string	Optional. O Foxit eSign assina cada conteúdo de webhook com HMAC-SHA-256 usando esse segredo para verificação.

Retornos

Os dados de evento recebidos do Foxit eSign quando um evento de webhook é acionado.

WebhookEventPayload: WebhookEventPayload

Quando um envelope é cancelado

ID da operação:: TriggerEnvelopeCancelled

Dispara quando um envelope é cancelado por um destinatário ou pelo remetente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do canal	channelName	True	string	Um nome para identificar essa assinatura de webhook em sua conta.
Nível do Webhook	webhookLevel	True	string	Conta: é acionada para todos os envelopes (Web e API). Aplicativo de API: é acionado apenas para envelopes criados por meio da API.
Segredo do Webhook	webhookSecret		string	Optional. O Foxit eSign assina cada conteúdo de webhook com HMAC-SHA-256 usando esse segredo para verificação.

Retornos

Os dados de evento recebidos do Foxit eSign quando um evento de webhook é acionado.

WebhookEventPayload: WebhookEventPayload

Quando um envelope é enviado

ID da operação:: TriggerEnvelopeSent

Dispara quando um envelope é enviado aos destinatários. Esse evento só é acionado quando o Nível do Webhook é definido como 'Conta'.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do canal	channelName	True	string	Um nome para identificar essa assinatura de webhook em sua conta.
Nível do Webhook	webhookLevel	True	string	Conta: é acionada para envelopes enviados via Web ou API. Aplicativo de API: é acionado apenas para envelopes criados por meio da API. O evento folder_sent é acionado apenas no nível da conta.
Segredo do Webhook	webhookSecret		string	Optional. O Foxit eSign assina cada conteúdo de webhook com HMAC-SHA-256 usando esse segredo para verificação.

Retornos

Os dados de evento recebidos do Foxit eSign quando um evento de webhook é acionado.

WebhookEventPayload: WebhookEventPayload

Quando um envelope é excluído

ID da operação:: TriggerEnvelopeDeleted

Dispara quando um envelope é excluído.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do canal	channelName	True	string	Um nome para identificar essa assinatura de webhook em sua conta.
Nível do Webhook	webhookLevel	True	string	Conta: é acionada para todos os envelopes (Web e API). Aplicativo de API: é acionado apenas para envelopes criados por meio da API.
Segredo do Webhook	webhookSecret		string	Optional. O Foxit eSign assina cada conteúdo de webhook com HMAC-SHA-256 usando esse segredo para verificação.

Retornos

Os dados de evento recebidos do Foxit eSign quando um evento de webhook é acionado.

WebhookEventPayload: WebhookEventPayload

Quando um envelope é exibido

ID da operação:: TriggerEnvelopeViewed

Dispara quando um destinatário é aberto e exibe o envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do canal	channelName	True	string	Um nome para identificar essa assinatura de webhook em sua conta.
Nível do Webhook	webhookLevel	True	string	Conta: é acionada para todos os envelopes (Web e API). Aplicativo de API: é acionado apenas para envelopes criados por meio da API.
Segredo do Webhook	webhookSecret		string	Optional. O Foxit eSign assina cada conteúdo de webhook com HMAC-SHA-256 usando esse segredo para verificação.

Retornos

Os dados de evento recebidos do Foxit eSign quando um evento de webhook é acionado.

WebhookEventPayload: WebhookEventPayload

Quando um envelope é totalmente executado

ID da operação:: TriggerEnvelopeExecuted

Dispara quando todos os destinatários são assinados e o envelope é totalmente executado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do canal	channelName	True	string	Um nome para identificar essa assinatura de webhook em sua conta.
Nível do Webhook	webhookLevel	True	string	Conta: é acionada para todos os envelopes (Web e API). Aplicativo de API: é acionado apenas para envelopes criados por meio da API.
Segredo do Webhook	webhookSecret		string	Optional. O Foxit eSign assina cada conteúdo de webhook com HMAC-SHA-256 usando esse segredo para verificação.

Retornos

Os dados de evento recebidos do Foxit eSign quando um evento de webhook é acionado.

WebhookEventPayload: WebhookEventPayload

Definições

WebhookEventPayload

Os dados de evento recebidos do Foxit eSign quando um evento de webhook é acionado.

Nome	Caminho	Tipo	Description
Nome do evento	event_name	string	O nome do evento que foi disparado (por exemplo, folder_sent, folder_signed, folder_executed).
Data do Evento	event_date	integer	A data e a hora em que o evento ocorreu (carimbo de data/hora unix em milissegundos).
ID	data.folder.folderId	integer	A ID exclusiva do envelope.
Nome	data.folder.folderName	string	O nome do envelope.
Nome Personalizado	data.folder.folderCustomName	string	O nome personalizado atribuído ao envelope.
Password	data.folder.folderPassword	string	A senha de acesso do envelope, se definido.
ID do criador	data.folder.folderAuthorId	integer	A ID do usuário do criador do envelope.
Nome do Criador	data.folder.folderAuthorFirstName	string	O nome do criador do envelope.
Sobrenome do Criador	data.folder.folderAuthorLastName	string	O sobrenome do criador do envelope.
Email do Criador	data.folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Função de Criador	data.folder.folderAuthorRole	string	A função de conta do criador do envelope.
ID da Empresa	data.folder.folderCompanyId	integer	A ID da empresa que possui o envelope.
Data de criação	data.folder.folderCreationDate	integer	A data em que o envelope foi criado (carimbo de data/hora Unix em milissegundos).
Data de envio	data.folder.folderSentDate	integer	A data em que o envelope foi enviado (carimbo de data/hora Unix em milissegundos).
Status	data.folder.folderStatus	string	O status atual do envelope.
Campo Personalizado 1	data.folder.custom_field1	string	O primeiro campo de metadados personalizado.
Campo Personalizado 2	data.folder.custom_field2	string	O segundo campo de metadados personalizado.
Metadata	data.folder.metadata	string	Metadados personalizados associados ao envelope.
Identificadores de documento	data.folder.folderDocumentIds	array of integer	A lista de IDs de documento no envelope.
Documentos	data.folder.documentsList	array of object	A lista de documentos no envelope.
ID do documento	data.folder.documentsList.documentId	integer	O identificador exclusivo do documento.
ID do contrato	data.folder.documentsList.contractId	integer	A ID do contrato deste documento.
ID da Empresa	data.folder.documentsList.companyId	integer	A ID da empresa deste documento.
Criado por	data.folder.documentsList.contractCreatedBy	integer	A ID do usuário da pessoa que criou o contrato.
Data da criação	data.folder.documentsList.contractCreatedOn	integer	A data em que o contrato foi criado (carimbo de data/hora unix em milissegundos).
Tipo de contrato	data.folder.documentsList.contractType	string	O tipo do contrato.
Status do contrato	data.folder.documentsList.contractStatus	string	O status atual do contrato.
Editável	data.folder.documentsList.editable	boolean	Indica se o documento é editável.
ID da versão	data.folder.documentsList.contractVersionId	integer	A ID da versão do contrato.
Nome da versão	data.folder.documentsList.contractVersionName	string	O nome da versão do contrato.
Descrição da versão	data.folder.documentsList.contractVersionDesc	string	Uma descrição da versão do contrato.
Versão criada por	data.folder.documentsList.versionCreatedby	integer	A ID do usuário da pessoa que criou essa versão.
Versão criada em	data.folder.documentsList.versionCreatedOn	integer	A data em que essa versão foi criada (carimbo de data/hora unix em milissegundos).
Número de Versão	data.folder.documentsList.contractVersionNumber	integer	O número de versão do contrato.
Origem da transação	data.folder.documentsList.contractTransactionSource	string	O sistema de origem que iniciou o contrato.
Destinatários	data.folder.folderRecipientParties	array of object	A lista de destinatários deste envelope.
ID do destinatário	data.folder.folderRecipientParties.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	data.folder.folderRecipientParties.partyDetails.partyId	integer	A ID exclusiva do destinatário.
Primeiro nome	data.folder.folderRecipientParties.partyDetails.firstName	string	O nome próprio do destinatário.
Apelido	data.folder.folderRecipientParties.partyDetails.lastName	string	O sobrenome do destinatário.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	O endereço de email do destinatário.
Espaço reservado	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Se este é um destinatário de espaço reservado.
Address	data.folder.folderRecipientParties.partyDetails.address	string	O endereço do destinatário.
Data de Criação	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que o registro do destinatário foi criado (carimbo de data/hora Unix em milissegundos).
Recusar emails	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Se o destinatário optou por não enviar emails.
Identificação Única	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador de sistema exclusivo para esse destinatário.
Nível de autenticação	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	O método de autenticação para esse destinatário.
Data da Atualização da Senha	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A data em que a senha foi atualizada pela última vez.
Status da senha	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Se a senha foi atualizada.
Código de discagem	data.folder.folderRecipientParties.dialingCode	string	O código de discagem internacional.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	O número de celular do destinatário.
Tipo de assinatura	data.folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura que o signatário usará.
Permissões	data.folder.folderRecipientParties.contractPermissions	string	As permissões concedidas a esse destinatário.
Ordem de Assinatura	data.folder.folderRecipientParties.partySequence	integer	A ordem de assinatura deste destinatário.
Sequência de fluxo de trabalho	data.folder.folderRecipientParties.workflowSignSequence	integer	O número da sequência de assinatura do fluxo de trabalho.
Envelope ID	data.folder.folderRecipientParties.envelopeId	integer	A ID do envelope associada a esse destinatário.
ID da empresa do destinatário	data.folder.folderRecipientParties.partyCompanyId	integer	A ID da empresa desse destinatário.
Modo de Compartilhamento	data.folder.folderRecipientParties.sharingMode	string	O modo de compartilhamento desse destinatário.
URL de Assinatura do Destinatário	data.folder.folderRecipientParties.folderAccessURL	string	A URL desse destinatário para acessar e assinar o envelope.
Modo de Segurança	data.folder.folderRecipientParties.securityMode	string	O modo de segurança desse destinatário.
Comments	data.folder.folderRecipientParties.extraComments	string	Comentários adicionais para o destinatário.
Permitir alteração de nome	data.folder.folderRecipientParties.allowNameChange	boolean	Se o destinatário pode atualizar seu nome.
Nome atualizado	data.folder.folderRecipientParties.signerNameUpdated	boolean	Se o signatário atualizou seu nome.
Nível de autenticação do signatário	data.folder.folderRecipientParties.signerAuthenticationLevel	string	O nível de autenticação necessário para o signatário.
Código de acesso	data.folder.folderRecipientParties.userDefinedAccessCode	string	Um código de acesso personalizado para o signatário.
ID da Assinatura	data.folder.folderRecipientParties.signatureId	string	A ID da assinatura aplicada.
Função	data.folder.folderRecipientParties.partyRole	string	A função desse destinatário no fluxo de trabalho de assinatura.
Campo Da Empresa	data.folder.folderRecipientParties.companyFieldValue	string	O valor do campo nome da empresa.
Campo Título	data.folder.folderRecipientParties.titleFieldValue	string	O valor do campo de título.
Motivo da assinatura	data.folder.folderRecipientParties.reasonSigning	string	A razão dada para assinar.
Campo de pagamento adicionado	data.folder.folderRecipientParties.payFieldAdded	boolean	Se um campo de pagamento foi adicionado.
Beneficiário	data.folder.folderRecipientParties.payee	boolean	Se esse destinatário é o destinatário.
Pagamento recorrente	data.folder.folderRecipientParties.recurringFieldExist	boolean	Se existe um campo de pagamento recorrente.
Imprimir e assinar concluído	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Se a impressão e o sinal estão concluídos.
Signatário opcional	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Se esse destinatário é um signatário opcional.
Signatários opcionais	data.folder.folderRecipientParties.optionalSigners	array of integer	IDs opcionais da parte do signatário.
Pago	data.folder.folderRecipientParties.paid	boolean	Se o pagamento foi concluído.
URL de Acesso do Autor	data.folder.folderAccessURLForAuthor	string	A URL do autor do envelope para acessar o envelope.
URL de Acesso de Rascunho	data.folder.draftFolderAccessURL	string	A URL para acessar o envelope no estado de rascunho.
Assinatura da Sala de Reuniões	data.folder.boardRoomSign	boolean	Se o modo de assinatura da sala de reuniões está habilitado.
Incluir logotipo	data.folder.includeLogo	boolean	Se o logotipo da empresa está incluído em emails.
Cor da tela de fundo do botão	data.folder.email_btnBgColor	string	A cor da tela de fundo do botão de ação de email.
Cor do texto do botão	data.folder.email_btnTxtColor	string	A cor do texto do botão de ação de email.
Logotipo de email	data.folder.emailTemplateLogo	string	A URL do logotipo usada no modelo de email.
ID do modelo de email	data.folder.emailTemplateId	integer	A ID do modelo de email usado.
Cabeçalho de Email	data.folder.emailHeader	string	O texto do cabeçalho em emails de notificação.
Rodapé de email	data.folder.emailFooter	string	O texto do rodapé em emails de notificação.
Limpar Agendado	data.folder.purgeFlag	boolean	Se o envelope está agendado para limpeza.
Limpar Data de Início	data.folder.purgeStartDate	string	A data de início da agenda de limpeza.
Data de término da limpeza	data.folder.purgeEndDate	string	A data de término da agenda de limpeza.
ID em massa	data.folder.bulkId	integer	A ID da operação de envio em massa, se aplicável.
Impor ordem de assinatura	data.folder.enforceSignWorkflow	boolean	Se os destinatários devem entrar na ordem definida.
Etapa atual do fluxo de trabalho	data.folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Origem da transação	data.folder.transactionSource	string	O sistema de origem que iniciou essa transação.
Editável	data.folder.editable	boolean	Se o envelope é editável.
Assinatura do In-Person	data.folder.inPersonSignable	boolean	Se o envelope dá suporte à assinatura pessoal.
Substituir lembretes	data.folder.overrideAccountReminders	boolean	Se as configurações de lembrete no nível da conta são substituídas.
Substituir delegação	data.folder.overrideAccountRecipientDelegation	boolean	Se as configurações de delegação no nível da conta são substituídas.
Permitir Delegação	data.folder.allowRecipientsToDelegate	boolean	Se os destinatários podem delegar a assinatura.
ID	data.folder.envelopeId	integer	A ID de envelope exclusiva (alias de folderId).
Nome	data.folder.envelopeName	string	O nome do envelope (alias de folderName).
ID do originador	data.folder.envelopeOriginatorId	integer	A ID do usuário que originou o envelope.
ID da Empresa	data.folder.envelopeCompanyId	integer	A ID da empresa que possui o envelope.
Date	data.folder.envelopeDate	integer	A data em que o envelope foi criado (carimbo de data/hora Unix em milissegundos).
Data Compartilhada	data.folder.envelopeSharedDate	integer	A data em que o envelope foi compartilhado (carimbo de data/hora Unix em milissegundos).
Status	data.folder.envelopeStatus	string	O status atual do envelope.
IDs de contrato	data.folder.envelopeContractIds	array of integer	As IDs do contrato associadas a este envelope.
Permissões de partes	data.folder.envelopePartyPermissions	array of object	A lista de permissões do destinatário (mesma estrutura que Destinatários).
ID do destinatário	data.folder.envelopePartyPermissions.partyId	integer	O identificador exclusivo do destinatário.
ID do destinatário	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Primeiro nome	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Apelido	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Espaço reservado	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Data de Criação	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Recusar emails	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Identificação Única	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Nível de autenticação	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Data da Atualização da Senha	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Status da senha	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Código de discagem	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Tipo de assinatura	data.folder.envelopePartyPermissions.signerSignatureType	string
Permissões	data.folder.envelopePartyPermissions.contractPermissions	string
Ordem de Assinatura	data.folder.envelopePartyPermissions.partySequence	integer
Sequência de fluxo de trabalho	data.folder.envelopePartyPermissions.workflowSignSequence	integer
Envelope ID	data.folder.envelopePartyPermissions.envelopeId	integer
ID da empresa do destinatário	data.folder.envelopePartyPermissions.partyCompanyId	integer
Modo de Compartilhamento	data.folder.envelopePartyPermissions.sharingMode	string
URL de Assinatura do Destinatário	data.folder.envelopePartyPermissions.folderAccessURL	string
Modo de Segurança	data.folder.envelopePartyPermissions.securityMode	string
Comments	data.folder.envelopePartyPermissions.extraComments	string
Permitir alteração de nome	data.folder.envelopePartyPermissions.allowNameChange	boolean
Nome atualizado	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Nível de autenticação do signatário	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Código de acesso	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
ID da Assinatura	data.folder.envelopePartyPermissions.signatureId	string
Função	data.folder.envelopePartyPermissions.partyRole	string
Campo Da Empresa	data.folder.envelopePartyPermissions.companyFieldValue	string
Campo Título	data.folder.envelopePartyPermissions.titleFieldValue	string
Motivo da assinatura	data.folder.envelopePartyPermissions.reasonSigning	string
Campo de pagamento adicionado	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Beneficiário	data.folder.envelopePartyPermissions.payee	boolean
Pagamento recorrente	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Imprimir e assinar concluído	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Signatário opcional	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Signatários opcionais	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Pago	data.folder.envelopePartyPermissions.paid	boolean
Nível de autenticação	data.folder.envelopeAuthenticationLevel	string	O nível de autenticação necessário para o envelope.
Logon Único em Massa	data.folder.allowSingleSignerInBulk	boolean	Se um único signatário é permitido no modo em massa.
Nome da pasta File-Based	data.folder.folderNameBasedOnFileNaming	boolean
File-Based Nome do Documento	data.folder.documentNameBasedOnFileNaming	boolean
File-Based Nome do Certificado	data.folder.certificateNameBasedOnFileNaming	boolean
Nomenclatura de arquivo pré-exec	data.folder.enableFileNamingBeforeExecution	boolean
Payee Adicionado	data.folder.payeeAddedd	boolean
Self-Signing Habilitado	data.folder.selfSignerEnabled	boolean
Notário Habilitado	data.folder.notaryEnabled	boolean
Visibilidade Limitada	data.folder.limitedVisibilityFlag	boolean
Visibilidade pós-sinal	data.folder.postSigningVisibility	boolean
Assinatura molhada	data.folder.wetSignatureEnabled	boolean
Mesclar Habilitado	data.folder.mergeEnabled	boolean

binário

Esse é o tipo de dados básico 'binary'.