Foxit eSign (Pré-visualização)

A Foxit eSign é uma solução de assinatura eletrónica que lhe permite enviar, assinar e gerir documentos online — eliminando a necessidade de imprimir, digitalizar ou enviar por correio. Carregue o seu documento, defina campos de assinatura e envie-o aos destinatários para assinaturas eletrónicas rápidas e legalmente vinculativas.

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

Serviço	Class	Regions
Estúdio Copiloto	Premium	Todas as regiões Power Automate exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes:      - Regiões Azure Government      - Regiões Azure China      - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes:      - Governo dos EUA (CCG)      - 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 (CCG)      - 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
Editora	Foxit Software Inc.
Sítio Web	https://www.foxit.com/esign-pdf/
Política de privacidade	https://www.foxit.com/company/privacy-policy.html
Categorias	Produtividade; Conteúdo e Ficheiros

Foxit eSign

Foxit eSign é uma solução de assinatura eletrónica de nível empresarial que permite às empresas enviar, assinar e gerir documentos legalmente vinculativos inteiramente online — eliminando a necessidade de imprimir, digitalizar ou enviar por correio. Carregue o seu documento, defina campos de assinatura e envie-o aos destinatários para assinaturas eletrónicas rápidas e seguras. O Foxit eSign está totalmente em conformidade com as principais leis de assinatura eletrónica, incluindo ESIGN e UETA, utiliza encriptação para proteger documentos em trânsito e em repouso, e suporta autenticação multifator para garantir que apenas os signatários autorizados possam aceder e assinar os seus documentos.

O conector Foxit eSign para Microsoft Power Automate permite-lhe automatizar todo o seu fluxo de trabalho de assinatura de documentos — desde a criação de envelopes e envio para assinatura, até ao acompanhamento do estado, download de documentos concluídos, gestão de modelos e ativação de ações a jusante quando ocorrem eventos de envelope.

Publisher: Foxit Corporation

Pré-requisitos

Para usar esse conector, você precisará:

• Um plano Microsoft Power Apps ou Power Automate com conector personalizado ou acesso premium
• Uma conta Foxit eSign — crie uma aqui
• Acesso à API ativado na sua conta Foxit eSign (ver Obtenção de Credenciais abaixo)

Obtenção de credenciais

1. Crie uma conta Foxit eSign se ainda não tiver uma.
2. Contacte a equipa de Vendas da Foxit para solicitar a ativação do acesso à API na sua conta. Uma vez aprovado, o acesso à API será ativado na sua conta.
3. No Power Automate, procure por Foxit eSign na lista de conectores e selecione Criar ligação.
4. Será redirecionado para a página de login da Foxit eSign. Inicie sessão com as suas credenciais Foxit eSign para autorizar a ligação.
5. Uma vez autorizada, a ligação está pronta a ser usada nos seus fluxos.

Introdução

Depois de criar uma ligação, pode começar a construir fluxos usando o conector Foxit eSign:

• Use gatilhos para iniciar automaticamente um fluxo quando ocorre um evento envelope (por exemplo, quando todas as partes assinaram).
• Use ações para criar envelopes, enviar lembretes de assinatura, descarregar documentos concluídos, gerir modelos e muito mais.
• Encadear várias ações — por exemplo, criar um envelope a partir de um modelo, esperar pelo disparador totalmente executado, depois descarregar o documento assinado e armazená-lo no SharePoint.

Gatilhos suportados

Trigger	Descrição
Quando um envelope é enviado	Dispara quando um envelope é enviado aos destinatários. Requer o Nível Webhook definido como Conta.
Quando um envelope é visualizado	Dispara quando o destinatário abre e vê o envelope.
Quando um envelope é assinado	Dispara quando o destinatário assina o envelope.
Quando um envelope é cancelado	Dispara quando um envelope é cancelado por um destinatário ou pelo remetente.
Quando um envelope é totalmente executado	Dispara quando todos os destinatários assinam e o envelope está totalmente preenchido.
Quando um envelope é eliminado	Dispara quando um envelope é apagado.

Ações Suportadas

Envelopes

Action	Descrição
Criar envelope a partir da URL	Cria e envia um envelope usando uma URL PDF acessível publicamente.
Criar envelope a partir do Base64	Cria e envia um envelope usando um documento PDF codificado em Base64.
Criar Envelope a partir do Modelo	Cria e envia um envelope a partir de um modelo Foxit eSign existente.
Obtenha Detalhes do Envelope	Recupera todos os detalhes e o estado atual de um envelope.
Obtenha IDs de envelopes	Recupera uma lista de IDs de envelope com base nos critérios do filtro.
Enviar Lembrete de Assinatura	Envia uma notificação de lembrete aos assinantes pendentes de um envelope.
Descarregar Ficheiros de Envelope	Descarrega todos os documentos assinados num envelope como ficheiro zip.
Descarregar PDF de Documento Único	Descarrega um único documento de um envelope em PDF.
Mover envelopes para o Contentor de Reciclagem	Move um ou mais envelopes para o contentor de reciclagem.
Cancelar envelope	Cancela um envelope e notifica os destinatários.
Apagar envelopes	Apaga permanentemente um ou mais envelopes.
Obtenha Histórico de Atividades do Envelope	Recupera o registo completo de atividade de um envelope.
Obter Histórico de Envelopes Eliminados	Recupera o histórico dos envelopes apagados na conta.

Modelos

Action	Descrição
Criar Modelo a partir de URL	Cria um modelo de assinatura reutilizável usando uma URL PDF acessível publicamente.
Criar Modelo a partir do Base64	Cria um modelo de assinatura reutilizável usando um documento PDF codificado em Base64.
Obtenha Detalhes do Modelo	Recupera todos os detalhes de um modelo específico, incluindo definições de campos.
Obtenha Modelos por IDs de Modelos	Recupera detalhes de um ou mais modelos pelos seus IDs.
Obtenha uma lista de todos os modelos	Recupera todos os modelos disponíveis na conta.

Webhooks

Action	Descrição
Lista de Todos os Canais Webhook	Devolve uma lista de todos os canais webhook configurados na conta.
Obtenha Detalhes do Canal Webhook	Recupera os detalhes de um canal webhook específico.

Grupos de Email

Action	Descrição
Criar Grupo de Email	Cria um novo grupo de email para usar como destinatários em envelopes.
Obtenha Detalhes do Grupo de Email	Recupera os dados e membros de um grupo de email.

Relatórios

Action	Descrição
Descarregar Relatório	Descarrega um relatório de atividade da conta em formato Microsoft Excel.

Problemas conhecidos e limitações

• Limite de Taxa: A API Foxit eSign permite até 4.000 pedidos por 5 minutos por conta. Pedidos que excedam este limite recebem uma 429 Too Many Requests resposta. Recomenda-se implementar lógica de retentativas com recuo exponencial nos fluxos para gerir isto de forma eficiente.

• Limite de Tamanho do Ficheiro: O tamanho máximo de ficheiro por documento é de 25 MB. Este limite aplica-se a ficheiros individuais, não ao tamanho total do envelope.

• Dessubscrição Automática do Webhook: Devido a uma limitação na API de eliminação de webhooks do Foxit eSign (que usa um método POST em vez de DELETE), o Power Automate não pode limpar automaticamente as subscrições do canal webhook quando um fluxo baseado em gatilho é eliminado ou modificado. Use a ação Listar Todos os Canais Webhook para identificar canais ativos e o portal Foxit eSign para remover subscrições ao desativar um fluxo.

• Quando um envelope é enviado — Apenas Nível de Conta: O disparador "Quando um envelope é enviado" só é ativado quando o Nível Webhook está definido como Conta. Não dispara para envelopes criados ao nível da API App . Certifique-se de selecionar o nível da conta ao configurar este gatilho.

• Disponibilidade Regional: O conector está disponível tanto para contas da América do Norte (NA1) como das regiões da UE. Selecione a região do servidor apropriada ao configurar a sua ligação. Ligar à região errada resultará em falhas de autenticação.

• Tamanho do Documento Base64: Ao usar as ações Create Envelope a partir do Base64 ou Create Template a partir do Base64, a cadeia codificada no Base64 deve corresponder a um ficheiro fonte com no máximo 25 MB.

Support

Para apoio aos programadores, contacte a equipa da Foxit eSign em devsupport@foxitsoftware.com.

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

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Apagar envelopes	Apaga permanentemente um ou mais envelopes.
Cancelar a subscrição do Webhook Trigger	Apaga uma subscrição ativa de canal webhook pelo seu ID de canal. Utilize esta ação para limpar subscrições de webhooks que já não são necessárias.
Cancelar envelope	Cancela um envelope enviado. Os destinatários já não poderão assinar os documentos.
Criar envelope a partir da URL	Cria e envia um envelope usando URLs PDF acessíveis publicamente. Forneça as URLs dos documentos e os dados do destinatário para iniciar o processo de assinatura.
Criar envelope a partir do Base64	Cria e envia um envelope usando um documento PDF codificado em Base64.
Criar Envelope a partir do Modelo	Cria e envia um envelope usando um modelo existente. Os dados do destinatário podem ser personalizados.
Criar Grupo de Email	Cria um novo grupo de email que pode ser usado para enviar envelopes a vários destinatários ao mesmo tempo.
Criar Modelo a partir de URL	Cria um novo modelo usando uma URL PDF acessível publicamente.
Criar Modelo a partir do Base64	Cria um novo template usando uma string PDF codificada em Base64. Use isto quando o seu ficheiro PDF já estiver disponível como uma string Base64 no seu fluxo, por exemplo, a partir de um ficheiro SharePoint ou documento do OneDrive.
Descarregar Ficheiros de Envelope	Descarrega os documentos concluídos de um envelope como ficheiro.
Descarregar PDF de Documento Único	Descarrega um único documento de um envelope em formato PDF.
Descarregar Relatório	Descarrega um relatório de atividade de envelope como ficheiro Microsoft Excel. Use os filtros para restringir os resultados por estado, intervalo de datas, nome do envelope, autor ou signatário.
Enviar Lembrete de Assinatura	Envia uma notificação de lembrete aos destinatários pendentes de um envelope, incentivando-os a terminar a assinatura.
Listar todos os canais Webhook	Devolve uma lista de todos os canais webhook configurados na sua conta.
Mover envelopes para o Contentor de Reciclagem	Move um ou mais envelopes para o contentor de reciclagem. Os envelopes no contentor de reciclagem não são eliminados permanentemente.
Obtenha Detalhes do Canal Webhook	Recupera os detalhes de um canal webhook específico.
Obtenha Detalhes do Envelope	Recupera todos os detalhes de um envelope, incluindo o seu estado, destinatários e documentos.
Obtenha Detalhes do Grupo de Email	Recupera detalhes de um grupo de email existente.
Obtenha Detalhes do Modelo	Recupera todos os detalhes de um modelo específico, incluindo os seus campos e destinatários.
Obtenha Histórico de Atividades do Envelope	Recupera um registo completo de atividade de um envelope, mostrando todas as ações tomadas pelos destinatários e pelo remetente.
Obtenha IDs de envelopes	Devolve uma lista de IDs de envelopes filtrados por estado. Usa isto para encontrar envelopes num estado específico.
Obtenha Modelos por Ids de Modelos	Recupera detalhes de um ou mais modelos pelos seus IDs.
Obtenha uma lista de todos os Modelos	Devolve uma lista de todos os modelos disponíveis na sua conta.
Obter Histórico de Envelopes Eliminados	Recupera um histórico de envelopes que foram apagados ou movidos para o contentor de reciclagem.

Apagar envelopes

ID da Operação:

DeleteEnvelopes

Apaga permanentemente um ou mais envelopes.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
folderIds	folderIds		array of integer

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a operação teve sucesso.

Cancelar a subscrição do Webhook Trigger

ID da Operação:

DeleteTriggerWebhookChannel

Apaga uma subscrição ativa de canal webhook pelo seu ID de canal. Utilize esta ação para limpar subscrições de webhooks que já não são necessárias.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do canal	channelId	True	integer	O ID do canal do webhook para apagar.

Cancelar envelope

ID da Operação:

CancelEnvelope

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Envelope ID	folderId	True	integer	O ID do envelope para cancelar.
Motivo do Cancelamento	reason_for_cancellation	True	string	A razão para cancelar este envelope. Isto está registado no histórico de atividade do envelope.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
IDs de Envelopes Cancelados	folders cancelled	array of integer	A lista de IDs de envelopes que foram cancelados com sucesso.

Criar envelope a partir da URL

ID da Operação:

CreateEnvelopefromURL

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do envelope	folderName	True	string	O nome deste envelope.
Tipo de entrada	inputType		string	Especifica o formato da fonte do documento. Defina para url para fornecer URLs de ficheiros, ou base64 para fornecer conteúdo codificado em Base64.
URLs de ficheiros	fileUrls	True	array of string	Um conjunto de URLs publicamente acessíveis que apontam para os documentos a serem adicionados a este envelope.
Nomes dos ficheiros	fileNames	True	array of string	Um array de nomes de visualização para cada documento, na mesma ordem dos URLs dos ficheiros.
Nome Próprio	firstName	True	string	O primeiro 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 e-mail do destinatário.
permissões	permission	True	string
Sequência	sequence	True	integer	Use este campo para atribuir um número de sequência a um destinatário na lista de partes destinatárias. Use números de sequência únicos para cada grupo começando por 1, como 1,2,3,4.... Se uma única pessoa aparecer várias vezes no fluxo de trabalho de assinatura, por favor atribua uma sequência diferente cada vez que o destinatário é repetido.
SignerAuthLevels	signerAuthLevel		string	O nível de autenticação que um signatário irá utilizar para efeitos de verificação
É um Placeholder	isPlaceholder		boolean	Use este campo para iniciar o grupo como um marcador de lugar. Nota: 1. o valor do parâmetro firstName, ApelidoNome, EmailId deve estar em branco nesta parte. 2. Para adicionar o marcador de lugar, um destinatário deve ser solicitado com permissão 'PARTY_ASSIGNER'.
Função do destinatário	partyRole		string	Use este campo para atribuir um papel de marcador de posição.
Permitir Mudança de Nome	allowNameChange		string	O valor pode ser verdadeiro ou falso. Use este parâmetro para permitir que o signatário atualize o nome e apelido 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 este destinatário. Quando a Sequência de Sessão está ativada, os destinatários recebem o convite de assinatura por ordem crescente de sequência.
ID do Email do Anfitrião	hostEmailId		string	Endereço de email do In-Person Administrador.
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 utilizador" para autenticação. Nota: 1. Os códigos não distinguem maiúsculas e minúsculas. 2. O sistema não envia este código, por isso deve partilhá-lo diretamente com o signatário. 3. O código de acesso pode conter alfabetos, números e os seguintes caracteres especiais: @,&,{,},%,(,),~,|,!,+,^.
A Festa é Grupo de Email	partyIsEmailGroup		boolean	Usa este parâmetro ao criar um grupo em massa. Nota: Se este parâmetro for verdadeiro, FirstName, ApelName e EmailId desta parte serão ignorados.
ID do Grupo de Email	emailGroupId		integer	Passa o email ao ID do grupo que queres usar para criar em massa.
Bloco de Signatários Únicos	allowSingleSignerInBulk		boolean	Use este parâmetro para permitir que apenas uma pessoa entre no grupo de email.
Código de discagem	dialingCode		string	Utilize este campo para atribuir a um país que os códigos de chamada de entrada são prefixos de número móvel a um destinatário na lista de partes destinatárias.
Número de telemóvel	mobileNumber		string	Use este campo para atribuir um número de telemóvel a um destinatário na lista de partes destinatárias.
Campos	Fields		object
Enviar Agora	sendNow		boolean	Quando ativado, o Foxit eSign envia imediatamente um link de assinatura único para o endereço de email de cada destinatário. Desative isto para guardar o envelope como um rascunho em vez disso.
Criar Sessão de Assinatura Incorporada	createEmbeddedSigningSession	True	boolean	O token de sessão de assinatura será gerado sem enviar emails aos destinatários.
Criar Sessão de Assinatura Incorporada para Todas as Partes	createEmbeddedSigningSessionForAllParties		boolean	Se definido como verdadeiro, será gerado um URL de assinatura embutido para cada destinatário no envelope.
Etiquetas de Texto de Processos	processTextTags	True	boolean	O valor pode ser verdadeiro ou falso. Este campo é usado para determinar se o Foxit eSign deve analisar os documentos em busca de Etiquetas de Texto para os converter 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 para os AcroFields para os converter em campos Foxit eSign.
Sequência de Iniciar Sessão	signInSequence		boolean	Este campo é usado para determinar se os destinatários irão assinar os documentos do envelope numa sequência. Se for falso, todos os destinatários recebem um email de convite simultaneamente. Quando é verdade, cada destinatário recebe um email de convite sucessivamente depois de o destinatário anterior completar a tarefa necessária, como assinar os documentos ou preencher campos, etc.
Ativação Presencial	inPersonEnable		boolean	Este campo é utilizado para iniciar o processo de assinatura presencial, que pode ser facilmente realizado em qualquer dispositivo em poucos minutos e evita assinaturas por email quando necessário. Se for falso, então todos os destinatários recebem o email de convite simultaneamente. Quando isso acontece, o administrador presencial recebe um e-mail de convite para iniciar o processo de assinatura do signatário.
Partidos Beneficiários do Fix	fixRecipientParties		boolean	Se for verdade, então na vista de envio embutida não pode alterar as partes do envelope que já foram adicionadas como parte deste pedido.
Corrigir Documentos	fixDocuments		boolean	Se for verdade, então no envio embutido não pode alterar os documentos do envelope que já foram adicionados como parte deste pedido.
Enviar URL de Sucesso	sendSuccessUrl		string	Introduza o URL absoluto da página de destino, para a qual o signatário será redirecionado após enviar com sucesso a pasta na visualização de envio incorporada.
URL de Erro de Envio	sendErrorUrl		string	Introduza a URL absoluta da página de destino, para a qual o signatário será redirecionado caso surja erro durante o envio da pasta na visualização de envio incorporada.
Criar Sessão de Envio Embutida	createEmbeddedSendingSession		boolean	Se definido como true, gerará um token embutido para abrir a visualização de preparação de documentos do Foxit eSign.
IDs de Email dos Signatários Incorporados	embeddedSignersEmailIds		array of string	Uma variedade de IDs de email dos destinatários para quem precisa de ser criada uma sessão de assinatura embutida. Os IDs de email das partes destinatárias adicionados à lista de partes.
URL de Sucesso do Sinal	signSuccessUrl		string	Introduza o URL absoluto para os signatários para os quais serão redirecionados após iniciar sessão com sucesso na vista de assinatura embutida.
URL de Declinar de Sinal	signDeclineUrl		string	Insira o URL absoluto para os signatários, para os quais serão redirecionados se recusarem iniciar sessão na visualização de assinatura incorporada.
Assinar depois URL	signLaterUrl		string	Insira a URL absoluta para os signatários que serão redirecionados se optar por assinar mais tarde na vista de assinatura incorporada.
URL de erro de sinal	signErrorUrl		string	Introduza a URL absoluta para os signatários para os quais serão redirecionados caso ocorra erro durante a assinatura do documento na vista de assinatura incorporada.
Permitir Enviar Agora e Sessão de Assinatura Embutida	allowSendNowAndEmbeddedSigningSession		boolean	Se definido como verdadeiro, o Foxit eSign enviará um link de assinatura único a cada destinatário. Isto SÓ se aplica 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 verdadeiro.
Assinar Sucesso URL Todas as Partes	signSuccessUrlAllParties		boolean	Se definido como verdadeiro, o signatário será redirecionado para o URL fornecido no signSuccessUrl após a assinatura bem-sucedida. Isto só se aplica quando o sendNow é verdadeiro.
ID do Modelo de Email	emailTemplateId		integer	Passe o ID do modelo de email para enviar os modelos de email que não sejam os modelos padrão.
Id de Instrução do Signador	signerInstructionId		integer	Passe o ID da instrução para enviar instruções do signatário diferentes das instruções padrão do signador.
ID da Instrução de Confirmação	confirmationInstructionId		string	Passe o id da 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	Introduza o valor 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 embutida.
Validade	expiry		integer	Obrigatório se sessionExpire for verdadeiro. Introduza a duração em milissegundos após a expiração da sessão de assinatura incorporada.
Nome do campo dependente	dependentFieldName	True	string	O nome do campo cuja visibilidade é controlada pelo campo pai.
Nome do campo principal	parentFieldName	True	string	O nome do campo pai cujo valor controla a visibilidade do campo dependente. Tipos de campos pais suportados: campo de texto, caixa de texto, caixa de seleção, botão de seleção, menu suspenso.
Valor do Campo Pai	parentFieldValue	True	string	O valor do campo pai que desencadeia o campo dependente para se tornar visível. Para campos de caixas de seleção e de botão de intermissão, use 'verificado ou desmarcado'.
Opções	options	True	string	Opções adicionais de correspondência para campos pais baseados em texto. Valores aceites: isblank, allowNull, contains.
Metadados	metadata		object	Isto deve estar em par-chave-valor. São permitidos no máximo 1000 pares de valor-chave.
E-mail do remetente	senderEmail		string	Introduza o email de outro utilizador na sua conta, que será usado para enviar esta(s) pasta(s) de documento(s) às partes destinatárias.
Ocultar Botão Adicionar-me	hideAddMeButton		boolean	Se for verdade, irá ocultar o botão "Adicionar-me" nas Partes Destinatárias numa sessão de envio incorporada.
Ocultar Adicionar Novo Botão	hideAddNewButton		boolean	Se for verdade, irá ocultar o botão "Adicionar Novo" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar botão Adicionar Grupo	hideAddGroupButton		boolean	Se for verdade, irá ocultar o botão "Adicionar Grupo" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Nome do Campo para Destinatários	hideFieldNameForRecipients		boolean	Ocultar os nomes dos campos para Destinatários para Campos de Introdução de Dados e Campos Avançados. (Exceto botão de Radio, Caixa de Seleção, Imagem e Hiperligação).
Ocultar Limite da Caixa de Seleção	hideCheckboxBorder		boolean	As fronteiras da Caixa de Seleção ficarão escondidas nos documentos assinados.
Ocultar Opção de Seleção de Signatário	hideSignerSelectOption		boolean	Se for verdade, irá ocultar a caixa de entrada "Nome do Assinante/Email Existente" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Ações do Signatário	hideSignerActions		boolean	Se for verdade, irá ocultar as ações do signatário em "editar", "alterar" e "remover" as ações das Partes Destinatárias numa sessão de envio embutida.
Ocultar Nome do Remetente	hideSenderName		boolean	Se for verdade, irá ocultar o nome do remetente nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Nome da Pasta	hideFolderName		boolean	Se for verdade, irá esconder o nome da pasta na navegação em ambas as sessões incorporadas.
Ocultar Nome dos Documentos	hideDocumentsName		boolean	Se for verdade, irá esconder o nome do documento em ambas as sessões incorporadas.
Esconder Recusar Assinar	hideDeclineToSign		boolean	Se for verdade, irá ocultar a opção "Recusar assinar" para o signatário.
Esconder Mais Ação	hideMoreAction		boolean	Se for verdade, vai esconder o botão "Mais Ações" na sessão de envio/assinatura. No caso de "Enviar Agora": verdade, não esconde nada.
Ocultar Botão de Enviar	hideSendButton		boolean	Se for verdade, irá esconder o botão Enviar na sessão de envio embutida.
Esconder-se A Seguir: Fieldbtn Obrigatório	hideNextRequiredFieldbtn		boolean	Se definido como verdadeiro, esconde o botão de navegação que move os utilizadores para o campo seguinte exigido.
Requeria ambas as sessões embutidas	requiredBothEmbeddedSession		boolean	Se for verdade, irá gerar os URLs de envio e assinatura incorporados em conjunto.
Palavra-passe do envelope	folderPassword		string	Esta palavra-passe será exigida pelo signatário/autor para abrir o documento assinado digitalmente. Se o parâmetro for mantido em branco, não será necessária palavra-passe para abrir o documento assinado digitalmente.
Ativar Passo a Passo	enableStepByStep		boolean	Para permitir ações passo a passo na sessão de envio embutida.
Ocultar Opção de Adicionar Grupos	hideAddPartiesOption		boolean	Se for verdade, irá ocultar a opção de adicionar grupos no modo Rascunho e Criação de Modelos.
Auto-Signo	selfSign		boolean	Permite o Self Sign embutido através de APIs. Este parâmetro só é aplicável quando o parâmetro createEmbeddedSendingSession é verdadeiro.
URL de Sucesso do Auto-Assinante	selfSignerSuccessUrl		string	Introduza o URL absoluto da landing page no seu site/aplicação, para onde o utilizador será redirecionado após o Self Sign enviar com sucesso a pasta na visualização de envio incorporada.

Devoluções

Name	Caminho	Tipo	Descrição
ID	folder.folderId	integer	O ID único do envelope recém-criado. Use isto em ações subsequentes para referenciar este 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 palavra-passe de acesso para o envelope, se definida.
ID do criador	folder.folderAuthorId	integer	O identificador único do criador do envelope.
Nome próprio do criador	folder.folderAuthorFirstName	string	O primeiro nome do criador do envelope.
Sobrenome do criador	folder.folderAuthorLastName	string	O apelido do criador do envelope.
E-mail do criador	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Papel do Criador	folder.folderAuthorRole	string	O papel do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	O identificador único da empresa que detém o envelope.
Data de criação	folder.folderCreationDate	integer	A data em que o envelope foi criado (carimbo de tempo Unix em milissegundos).
Data de envio	folder.folderSentDate	integer	A data em que o envelope foi enviado (carimbo Unix em milissegundos).
Situação	folder.folderStatus	string	O estado 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.
Metadados	folder.metadata	string	Metadados personalizados associados ao envelope.
Identificadores de Documento	folder.folderDocumentIds	array of integer	A lista de IDs de documentos contida no envelope.
Documents	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 único do contrato.
ID da Empresa	folder.documentsList.companyId	integer	O identificador único da empresa.
Criado por	folder.documentsList.contractCreatedBy	integer	O ID de utilizador da pessoa que criou o contrato.
Criado em	folder.documentsList.contractCreatedOn	string	A data e hora da criação do contrato.
Tipo de Contrato	folder.documentsList.contractType	string	O tipo de contrato.
Estado do Contrato	folder.documentsList.contractStatus	string	O estado 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 único da versão contratual.
Nome da Versão	folder.documentsList.contractVersionName	string	O nome da versão contratual.
Descrição da Versão	folder.documentsList.contractVersionDesc	string	Uma descrição da versão contratual.
Versão criada por	folder.documentsList.versionCreatedby	integer	O ID de utilizador da pessoa que criou esta versão.
Versão criada em	folder.documentsList.versionCreatedOn	string	A data e hora em que esta versão foi criada.
Número da versão	folder.documentsList.contractVersionNumber	integer	O número de versão do contrato.
Fonte da Transação	folder.documentsList.contractTransactionSource	string	O sistema de origem que iniciou a transação contratual.
Destinatários	folder.folderRecipientParties	array of object	A lista das partes destinatárias 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.
Nome Próprio	folder.folderRecipientParties.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O apelido do destinatário.
Endereço de E-mail	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de e-mail do destinatário.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se este partido é um destinatário provisório.
Morada	folder.folderRecipientParties.partyDetails.address	string	A morada física do destinatário.
Data de Criação	folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que o registo foi criado (carimbo de tempo Unix em milissegundos).
Emails de Exclusão	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID único do destinatário	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador de sistema único para este destinatário.
Nível de Autenticação	folder.folderRecipientParties.partyDetails.authenticationLevel	string	O método de autenticação necessário para este destinatário.
Data de atualização da palavra-passe	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A data em que a palavra-passe foi atualizada pela última vez.
Estado atualizado da palavra-passe	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indica se a palavra-passe foi atualizada.
ID da Empresa	folder.folderRecipientParties.partyDetails.companyId	integer	O identificador único da empresa.
Função do utilizador	folder.folderRecipientParties.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.folderRecipientParties.partyDetails.department	string	O departamento a que o utilizador pertence.
Título	folder.folderRecipientParties.partyDetails.title	string	O cargo do usuário.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indica se o utilizador ou o registo está ativo.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	A definição de localização para o utilizador.
Partilhar com o Departamento	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indica se os envelopes são partilhados entre o departamento.
Código de discagem	folder.folderRecipientParties.partyDetails.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.folderRecipientParties.partyDetails.mobileNumber	string	O número de telemóvel.
Filtro de Estado	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Um filtro para o estado do documento.
Filtro de Data	folder.folderRecipientParties.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso Seguro de Campo	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indica se o utilizador tem acesso a campos seguros.
Expandir a barra lateral	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indica se a barra lateral está expandida por defeito.
Validação Avançada de Email	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada do email está ativada.
ID do Gestor	folder.folderRecipientParties.partyDetails.managerId	string	O identificador único do gestor do utilizador.
Contagem de Login	folder.folderRecipientParties.partyDetails.loginCount	integer	O número de vezes que o utilizador iniciou sessão.
Email de Redefinição de Palavra-passe	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indica se deve ser enviado um email de redefinição de palavra-passe.
ID do departamento	folder.folderRecipientParties.partyDetails.departmentId	string	O identificador único do departamento.
Companhia Primária	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	A principal empresa associada ao utilizador.
Tipo de dispositivo	folder.folderRecipientParties.partyDetails.deviceType	string	O tipo de dispositivo utilizado.
Token de Dispositivo	folder.folderRecipientParties.partyDetails.deviceToken	string	O token de notificação push para o dispositivo.
Descrição do Subempreiteiro	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Uma descrição do subempreiteiro ou do signatário externo.
Organização de Subcontratantes	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de Adição do Subempreiteiro	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (carimbo de tempo Unix em milissegundos).
Source	folder.folderRecipientParties.partyDetails.source	string	O sistema de origem a partir do qual foi adicionado o signatário externo.
Código de discagem	folder.folderRecipientParties.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.folderRecipientParties.mobileNumber	string	O número de telemóvel.
Tipo de assinatura	folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura que o signatário irá usar.
Permissions	folder.folderRecipientParties.contractPermissions	string	As permissões concedidas a esta parte para o contrato.
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	O número de sequência da ordem de assinatura para este destinatário.
Sequência de Fluxo de Trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número de sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	O identificador único do envelope.
ID da empresa destinatária	folder.folderRecipientParties.partyCompanyId	integer	O identificador único da empresa associada a este destinatário.
Modo de Partilha	folder.folderRecipientParties.sharingMode	string	O modo de partilha para este envelope.
URL de acesso do destinatário	folder.folderRecipientParties.folderAccessURL	string	A URL que o destinatário pode usar para aceder e assinar o envelope.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicava-se a este envelope.
Comments	folder.folderRecipientParties.extraComments	string	Comentários adicionais incluídos com o envelope.
Permitir Mudança de Nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se o destinatário pode atualizar o seu nome.
Nome Atualizado	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se o signatário atualizou o seu nome.
Nível Auth de Signer	folder.folderRecipientParties.signerAuthenticationLevel	string	O nível de autenticação exigido 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 único da assinatura.
Função do destinatário	folder.folderRecipientParties.partyRole	string	O papel atribuído a este destinatário no fluxo de trabalho de assinatura.
Company Field	folder.folderRecipientParties.companyFieldValue	string	O valor do campo do 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	A razão pela qual o destinatário está a assinar o documento.
Campo de Pagamento Adicionado	folder.folderRecipientParties.payFieldAdded	boolean	Indica se foi adicionado um campo de pagamento.
Beneficiário	folder.folderRecipientParties.payee	boolean	Indica se este destinatário é o beneficiário.
Pagamento Recorrente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e Assinar Feito	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se o processo de impressão e assinatura está concluído.
Paid	folder.folderRecipientParties.paid	boolean	Indica se o pagamento foi concluído.
Signatário Opcional Permitido	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se este destinatário é um signatário opcional.
Signatários Opcionais	folder.folderRecipientParties.optionalSigners	array of integer	A lista de IDs opcionais dos signatários para este envelope.
URL de assinatura do autor	folder.folderAccessURLForAuthor	string	O URL que o remetente pode usar para aceder ao envelope.
URL de Acesso ao Rascunho	folder.draftFolderAccessURL	string	O URL usado para aceder à versão preliminar do envelope.
Sessão de Assinaturas na Sala de Administração	folder.boardRoomSign	boolean	Indica se o modo de assinatura na sala de reuniões está ativado.
Incluir logótipo	folder.includeLogo	boolean	Indica se o logótipo da empresa está incluído nos emails.
Cor de Fundo do Botão	folder.email_btnBgColor	string	A cor 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.
Logótipo do Email	folder.emailTemplateLogo	string	A URL do logótipo usada no modelo de email.
ID do Modelo de Email	folder.emailTemplateId	integer	O identificador único do modelo de email.
Cabeçalho do Email	folder.emailHeader	string	O texto do cabeçalho usado nos emails de notificação.
Rodapé do Email	folder.emailFooter	string	O texto do rodapé usado nos emails de notificação.
Purga Agendada	folder.purgeFlag	boolean	Indica se o envelope está programado para purga.
Data de início da purga	folder.purgeStartDate	string	A data a partir da qual a purga está prevista para começar.
Data de Fim da Purga	folder.purgeEndDate	string	A data em que a purga está programada para terminar.
ID de envio em massa	folder.bulkId	integer	O identificador único da operação de envio em massa.
Fazer cumprir a Ordem de Sinalização	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem assinar na sequência definida.
Etapa atual	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Fonte da Transação	folder.transactionSource	string	O sistema de origem que iniciou esta transação.
Editável	folder.editable	boolean	Indica se o item é editável.
In-Person Assinatura	folder.inPersonSignable	boolean	Indica se o envelope pode ser assinado pessoalmente.
Lembretes de Sobreposição	folder.overrideAccountReminders	boolean	Indica se as definições de lembrete ao nível da conta foram sobrepostas.
Delegação de Sobreposição	folder.overrideAccountRecipientDelegation	boolean	Indica se as definições de delegação ao nível da conta foram sobrepostas.
Permitir Delegação	folder.allowRecipientsToDelegate	boolean	Indica se os destinatários podem delegar a assinatura.
ID	folder.envelopeId	integer	O identificador único do envelope.
Nome	folder.envelopeName	string	O nome do envelope.
ID do originador	folder.envelopeOriginatorId	integer	O identificador único do utilizador que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	O identificador único da empresa que detém o envelope.
Date	folder.envelopeDate	integer	A data em que o envelope foi criado (carimbo de tempo Unix em milissegundos).
Data Partilhada	folder.envelopeSharedDate	integer	A data em que o envelope foi partilhado (carimbo de tempo Unix em milissegundos).
Situação	folder.envelopeStatus	string	O estado atual do envelope.
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associados a este envelope.
Permissões do Destinatário	folder.envelopePartyPermissions	array of object	A lista de permissões do 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.
Nome Próprio	folder.envelopePartyPermissions.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	folder.envelopePartyPermissions.partyDetails.lastName	string	O apelido do destinatário.
Endereço de E-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	O endereço de e-mail do destinatário.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indica se este partido é um destinatário provisório.
Morada	folder.envelopePartyPermissions.partyDetails.address	string	A morada física do destinatário.
Data de Criação	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	A data em que o registo foi criado (carimbo de tempo Unix em milissegundos).
Emails de Exclusão	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID único do destinatário	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Um identificador de sistema único para este destinatário.
Nível de Autenticação	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	O método de autenticação necessário para este destinatário.
Data de atualização da palavra-passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	A data em que a palavra-passe foi atualizada pela última vez.
Estado atualizado da palavra-passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indica se a palavra-passe foi atualizada.
ID da Empresa	folder.envelopePartyPermissions.partyDetails.companyId	integer	O identificador único da empresa.
Função do utilizador	folder.envelopePartyPermissions.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.envelopePartyPermissions.partyDetails.department	string	O departamento a que o utilizador pertence.
Título	folder.envelopePartyPermissions.partyDetails.title	string	O cargo do usuário.
Active	folder.envelopePartyPermissions.partyDetails.active	boolean	Indica se o utilizador ou o registo está ativo.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	A definição de localização para o utilizador.
Partilhar com o Departamento	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indica se os envelopes são partilhados entre o departamento.
Código de discagem	folder.envelopePartyPermissions.partyDetails.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	O número de telemóvel.
Filtro de Estado	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Um filtro para o estado do documento.
Filtro de Data	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso Seguro de Campo	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indica se o utilizador tem acesso a campos seguros.
Expandir a barra lateral	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indica se a barra lateral está expandida por defeito.
Validação Avançada de Email	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada do email está ativada.
ID do Gestor	folder.envelopePartyPermissions.partyDetails.managerId	string	O identificador único do gestor do utilizador.
Contagem de Login	folder.envelopePartyPermissions.partyDetails.loginCount	integer	O número de vezes que o utilizador iniciou sessão.
Email de Redefinição de Palavra-passe	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indica se deve ser enviado um email de redefinição de palavra-passe.
ID do departamento	folder.envelopePartyPermissions.partyDetails.departmentId	string	O identificador único do departamento.
Companhia Primária	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	A principal empresa associada ao utilizador.
Tipo de dispositivo	folder.envelopePartyPermissions.partyDetails.deviceType	string	O tipo de dispositivo utilizado.
Token de Dispositivo	folder.envelopePartyPermissions.partyDetails.deviceToken	string	O token de notificação push para o dispositivo.
Descrição do Subempreiteiro	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Uma descrição do subempreiteiro ou do signatário externo.
Organização de Subcontratantes	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de Adição do Subempreiteiro	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (carimbo de tempo Unix em milissegundos).
Source	folder.envelopePartyPermissions.partyDetails.source	string	O sistema de origem a partir do qual foi adicionado o signatário externo.
Código de discagem	folder.envelopePartyPermissions.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.envelopePartyPermissions.mobileNumber	string	O número de telemóvel.
Tipo de assinatura	folder.envelopePartyPermissions.signerSignatureType	string	O tipo de assinatura que o signatário irá usar.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	As permissões concedidas a esta parte para o contrato.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	O número de sequência da ordem de assinatura para este destinatário.
Sequência de Fluxo de Trabalho	folder.envelopePartyPermissions.workflowSignSequence	integer	O número de sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.envelopePartyPermissions.envelopeId	integer	O identificador único do envelope.
ID da empresa destinatária	folder.envelopePartyPermissions.partyCompanyId	integer	O identificador único da empresa associada a este destinatário.
Modo de Partilha	folder.envelopePartyPermissions.sharingMode	string	O modo de partilha para este envelope.
URL de acesso do destinatário	folder.envelopePartyPermissions.folderAccessURL	string	A URL que o destinatário pode usar para aceder e assinar o envelope.
Modo de Segurança	folder.envelopePartyPermissions.securityMode	string	O modo de segurança aplicava-se a este envelope.
Comments	folder.envelopePartyPermissions.extraComments	string	Comentários adicionais incluídos com o envelope.
Permitir Mudança de Nome	folder.envelopePartyPermissions.allowNameChange	boolean	Indica se o destinatário pode atualizar o seu nome.
Nome Atualizado	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indica se o signatário atualizou o seu nome.
Nível Auth de Signer	folder.envelopePartyPermissions.signerAuthenticationLevel	string	O nível de autenticação exigido 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 único da assinatura.
Função do destinatário	folder.envelopePartyPermissions.partyRole	string	O papel atribuído a este destinatário no fluxo de trabalho de assinatura.
Company Field	folder.envelopePartyPermissions.companyFieldValue	string	O valor do campo do 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	A razão pela qual o destinatário está a assinar o documento.
Campo de Pagamento Adicionado	folder.envelopePartyPermissions.payFieldAdded	boolean	Indica se foi adicionado um campo de pagamento.
Beneficiário	folder.envelopePartyPermissions.payee	boolean	Indica se este destinatário é o beneficiário.
Pagamento Recorrente	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e Assinar Feito	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indica se o processo de impressão e assinatura está concluído.
Paid	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.
Bloco de Signatários Únicos	folder.allowSingleSignerInBulk	boolean	Indica se um único signatário é permitido em modo de envio em massa.
File-Based Nomeação	folder.folderNameBasedOnFileNaming	boolean	Indica se o nome da pasta é baseado no nome do ficheiro.
Doc File-Based Nome	folder.documentNameBasedOnFileNaming	boolean	Indica se o nome do documento é baseado no nome do ficheiro.
Certificado File-Based Nome	folder.certificateNameBasedOnFileNaming	boolean	Indica se o nome do certificado é baseado no nome do ficheiro.
Nomenclatura de ficheiros pré-executivo	folder.enableFileNamingBeforeExecution	boolean	Indica se a nomeação dos ficheiros está ativada antes da execução do documento.
Acrescentou o beneficiário	folder.payeeAddedd	boolean	Indica se foi adicionado um beneficiário.
Self-Signing Ativado	folder.selfSignerEnabled	boolean	Indica se o modo de auto-assinatura está ativado.
Notário Habilitado	folder.notaryEnabled	boolean	Indica se a assinatura notarial está ativada.
Visibilidade Limitada	folder.limitedVisibilityFlag	boolean	Indica se a visibilidade limitada está ativada para este envelope.
Visibilidade após a Placa	folder.postSigningVisibility	boolean	Indica se a visibilidade após a assinatura está ativada.
Assinatura Húmida	folder.wetSignatureEnabled	boolean	Indica se as assinaturas húmidas estão ativadas.
Fusão Ativada	folder.mergeEnabled	boolean	Indica se a fusão de documentos está ativada.
Sessões de Assinatura Embutidas	embeddedSigningSessions	array of object	A lista de sessões de assinatura embutidas, uma por destinatário. Só está presente quando createEmbeddedSigningSession for verdadeiro.
E-mail do signatário	embeddedSigningSessions.emailIdOfSigner	string	O endereço de email do destinatário desta sessão de assinatura incorporada.
Token de assinatura	embeddedSigningSessions.embeddedToken	string	O token único para a sessão de assinatura embutida deste destinatário.
URL da Sessão de Assinatura	embeddedSigningSessions.embeddedSessionURL	string	O URL para abrir ou incorporar para este destinatário assinar o documento.
Token de Envio Embutido	embeddedToken	string	O token para a sessão de envio embutida. Só está presente quando createEmbeddedSendingSession for verdadeiro.
URL de Sessão de Envio	embeddedSessionURL	string	O URL para abrir ou incorporar para que o autor do envelope prepare e envie o envelope. Só está presente quando createEmbeddedSendingSession for verdadeiro.
Result	result	string	O resultado da operação.
Message	message	string	Uma mensagem a descrever o resultado da operação.

Criar envelope a partir do Base64

ID da Operação:

CreateEnvelopefromBase64

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do envelope	folderName	True	string	O nome deste envelope.
Tipo de entrada	inputType		string	Tipo de entrada para a fonte do documento. Corrigido para base64 para esta ação.
Cadeias de ficheiros Base64	base64FileString	True	array of string	Um conjunto de documentos PDF codificados em Base64 para enviar.
Nomes dos ficheiros	fileNames	True	array of string	Um array de nomes de visualização para cada documento, na mesma ordem do array de String de Ficheiros Base64.
Nome Próprio	firstName	True	string	O primeiro 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 e-mail do destinatário.
permissões	permission	True	string
Sequência	sequence	True	integer	Use este campo para atribuir um número de sequência a um destinatário na lista de partes destinatárias. Use números de sequência únicos para cada grupo começando por 1, como 1,2,3,4.... Se uma única pessoa aparecer várias vezes no fluxo de trabalho de assinatura, por favor atribua uma sequência diferente cada vez que o destinatário é repetido.
SignerAuthLevels	signerAuthLevel		string	O nível de autenticação que um signatário irá utilizar para efeitos de verificação
É um Placeholder	isPlaceholder		boolean	Use este campo para iniciar o grupo como um marcador de lugar. Nota: 1. o valor do parâmetro firstName, ApelidoNome, EmailId deve estar em branco nesta parte. 2. Para adicionar o marcador de lugar, um destinatário deve ser solicitado com permissão 'PARTY_ASSIGNER'.
Função do destinatário	partyRole		string	Use este campo para atribuir um papel de marcador de posição.
Permitir Mudança de Nome	allowNameChange		string	O valor pode ser verdadeiro ou falso. Use este parâmetro para permitir que o signatário atualize o nome e apelido 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 este destinatário. Quando a Sequência de Sessão está ativada, os destinatários recebem o convite de assinatura por ordem crescente de sequência.
ID do Email do Anfitrião	hostEmailId		string	Endereço de email do In-Person Administrador.
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 utilizador" para autenticação. Nota: 1. Os códigos não distinguem maiúsculas e minúsculas. 2. O sistema não envia este código, por isso deve partilhá-lo diretamente com o signatário. 3. O código de acesso pode conter alfabetos, números e os seguintes caracteres especiais: @,&,{,},%,(,),~,|,!,+,^.
A Festa é Grupo de Email	partyIsEmailGroup		boolean	Usa este parâmetro ao criar um grupo em massa. Nota: Se este parâmetro for verdadeiro, FirstName, ApelName e EmailId desta parte serão ignorados.
ID do Grupo de Email	emailGroupId		integer	Passa o email ao ID do grupo que queres usar para criar em massa.
Bloco de Signatários Únicos	allowSingleSignerInBulk		boolean	Use este parâmetro para permitir que apenas uma pessoa entre no grupo de email.
Código de discagem	dialingCode		string	Utilize este campo para atribuir a um país que os códigos de chamada de entrada são prefixos de número móvel a um destinatário na lista de partes destinatárias.
Número de telemóvel	mobileNumber		string	Use este campo para atribuir um número de telemóvel a um destinatário na lista de partes destinatárias.
Campos	Fields		object
Enviar Agora	sendNow		boolean	Quando ativado, o Foxit eSign envia imediatamente um link de assinatura único para o endereço de email de cada destinatário. Desative isto para guardar o envelope como um rascunho em vez disso.
Criar Sessão de Assinatura Incorporada	createEmbeddedSigningSession	True	boolean	O token de sessão de assinatura será gerado sem enviar emails aos destinatários.
Criar Sessão de Assinatura Incorporada para Todas as Partes	createEmbeddedSigningSessionForAllParties		boolean	Se definido como verdadeiro, será gerado um URL de assinatura embutido para cada destinatário no envelope.
Etiquetas de Texto de Processos	processTextTags	True	boolean	O valor pode ser verdadeiro ou falso. Este campo é usado para determinar se o Foxit eSign deve analisar os documentos em busca de Etiquetas de Texto para os converter 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 para os AcroFields para os converter em campos Foxit eSign.
Sequência de Iniciar Sessão	signInSequence		boolean	Este campo é usado para determinar se os destinatários irão assinar os documentos do envelope numa sequência. Se for falso, todos os destinatários recebem um email de convite simultaneamente. Quando é verdade, cada destinatário recebe um email de convite sucessivamente depois de o destinatário anterior completar a tarefa necessária, como assinar os documentos ou preencher campos, etc.
Ativação Presencial	inPersonEnable		boolean	Este campo é utilizado para iniciar o processo de assinatura presencial, que pode ser facilmente realizado em qualquer dispositivo em poucos minutos e evita assinaturas por email quando necessário. Se for falso, então todos os destinatários recebem o email de convite simultaneamente. Quando isso acontece, o administrador presencial recebe um e-mail de convite para iniciar o processo de assinatura do signatário.
Partidos Beneficiários do Fix	fixRecipientParties		boolean	Se for verdade, então na vista de envio embutida não pode alterar as partes do envelope que já foram adicionadas como parte deste pedido.
Corrigir Documentos	fixDocuments		boolean	Se for verdade, então no envio embutido não pode alterar os documentos do envelope que já foram adicionados como parte deste pedido.
Enviar URL de Sucesso	sendSuccessUrl		string	Introduza o URL absoluto da página de destino, para a qual o signatário será redirecionado após enviar com sucesso a pasta na visualização de envio incorporada.
URL de Erro de Envio	sendErrorUrl		string	Introduza a URL absoluta da página de destino, para a qual o signatário será redirecionado caso surja erro durante o envio da pasta na visualização de envio incorporada.
Criar Sessão de Envio Embutida	createEmbeddedSendingSession		boolean	Se definido como true, gerará um token embutido para abrir a visualização de preparação de documentos do Foxit eSign.
IDs de Email dos Signatários Incorporados	embeddedSignersEmailIds		array of string	Uma variedade de IDs de email dos destinatários para quem precisa de ser criada uma sessão de assinatura embutida. Os IDs de email das partes destinatárias adicionados à lista de partes.
URL de Sucesso do Sinal	signSuccessUrl		string	Introduza o URL absoluto para os signatários para os quais serão redirecionados após iniciar sessão com sucesso na vista de assinatura embutida.
URL de Declinar de Sinal	signDeclineUrl		string	Insira o URL absoluto para os signatários, para os quais serão redirecionados se recusarem iniciar sessão na visualização de assinatura incorporada.
Assinar depois URL	signLaterUrl		string	Insira a URL absoluta para os signatários que serão redirecionados se optar por assinar mais tarde na vista de assinatura incorporada.
URL de erro de sinal	signErrorUrl		string	Introduza a URL absoluta para os signatários para os quais serão redirecionados caso ocorra erro durante a assinatura do documento na vista de assinatura incorporada.
Permitir Enviar Agora e Sessão de Assinatura Embutida	allowSendNowAndEmbeddedSigningSession		boolean	Se definido como verdadeiro, o Foxit eSign enviará um link de assinatura único a cada destinatário. Isto SÓ se aplica 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 verdadeiro.
Assinar Sucesso URL Todas as Partes	signSuccessUrlAllParties		boolean	Se definido como verdadeiro, o signatário será redirecionado para o URL fornecido no signSuccessUrl após a assinatura bem-sucedida. Isto só se aplica quando o sendNow é verdadeiro.
ID do Modelo de Email	emailTemplateId		integer	Passe o ID do modelo de email para enviar os modelos de email que não sejam os modelos padrão.
Id de Instrução do Signador	signerInstructionId		integer	Passe o ID da instrução para enviar instruções do signatário diferentes das instruções padrão do signador.
ID da Instrução de Confirmação	confirmationInstructionId		string	Passe o id da 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	Introduza o valor 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 embutida.
Validade	expiry		integer	Obrigatório se sessionExpire for verdadeiro. Introduza a duração em milissegundos após a expiração da sessão de assinatura incorporada.
Nome do campo dependente	dependentFieldName	True	string	O nome do campo cuja visibilidade é controlada pelo campo pai.
Nome do campo principal	parentFieldName	True	string	O nome do campo pai cujo valor controla a visibilidade do campo dependente. Tipos de campos pais suportados: campo de texto, caixa de texto, caixa de seleção, botão de seleção, menu suspenso.
Valor do Campo Pai	parentFieldValue	True	string	O valor do campo pai que desencadeia o campo dependente para se tornar visível. Para campos de caixas de seleção e de botão de intermissão, use 'verificado ou desmarcado'.
Opções	options	True	string	Opções adicionais de correspondência para campos pais baseados em texto. Valores aceites: isblank, allowNull, contains.
Metadados	metadata		object	Isto deve estar em par-chave-valor. São permitidos no máximo 1000 pares de valor-chave.
E-mail do remetente	senderEmail		string	Introduza o email de outro utilizador na sua conta, que será usado para enviar esta(s) pasta(s) de documento(s) às partes destinatárias.
Ocultar Botão Adicionar-me	hideAddMeButton		boolean	Se for verdade, irá ocultar o botão "Adicionar-me" nas Partes Destinatárias numa sessão de envio incorporada.
Ocultar Adicionar Novo Botão	hideAddNewButton		boolean	Se for verdade, irá ocultar o botão "Adicionar Novo" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar botão Adicionar Grupo	hideAddGroupButton		boolean	Se for verdade, irá ocultar o botão "Adicionar Grupo" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Nome do Campo para Destinatários	hideFieldNameForRecipients		boolean	Ocultar os nomes dos campos para Destinatários para Campos de Introdução de Dados e Campos Avançados. (Exceto botão de Radio, Caixa de Seleção, Imagem e Hiperligação).
Ocultar Limite da Caixa de Seleção	hideCheckboxBorder		boolean	As fronteiras da Caixa de Seleção ficarão escondidas nos documentos assinados.
Ocultar Opção de Seleção de Signatário	hideSignerSelectOption		boolean	Se for verdade, irá ocultar a caixa de entrada "Nome do Assinante/Email Existente" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Ações do Signatário	hideSignerActions		boolean	Se for verdade, irá ocultar as ações do signatário em "editar", "alterar" e "remover" as ações das Partes Destinatárias numa sessão de envio embutida.
Ocultar Nome do Remetente	hideSenderName		boolean	Se for verdade, irá ocultar o nome do remetente nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Nome da Pasta	hideFolderName		boolean	Se for verdade, irá esconder o nome da pasta na navegação em ambas as sessões incorporadas.
Ocultar Nome dos Documentos	hideDocumentsName		boolean	Se for verdade, irá esconder o nome do documento em ambas as sessões incorporadas.
Esconder Recusar Assinar	hideDeclineToSign		boolean	Se for verdade, irá ocultar a opção "Recusar assinar" para o signatário.
Esconder Mais Ação	hideMoreAction		boolean	Se for verdade, vai esconder o botão "Mais Ações" na sessão de envio/assinatura. No caso de "Enviar Agora": verdade, não esconde nada.
Ocultar Botão de Enviar	hideSendButton		boolean	Se for verdade, irá esconder o botão Enviar na sessão de envio embutida.
Esconder-se A Seguir: Fieldbtn Obrigatório	hideNextRequiredFieldbtn		boolean	Se definido como verdadeiro, esconde o botão de navegação que move os utilizadores para o campo seguinte exigido.
Requeria ambas as sessões embutidas	requiredBothEmbeddedSession		boolean	Se for verdade, irá gerar os URLs de envio e assinatura incorporados em conjunto.
Palavra-passe do envelope	folderPassword		string	Esta palavra-passe será exigida pelo signatário/autor para abrir o documento assinado digitalmente. Se o parâmetro for mantido em branco, não será necessária palavra-passe para abrir o documento assinado digitalmente.
Ativar Passo a Passo	enableStepByStep		boolean	Para permitir ações passo a passo na sessão de envio embutida.
Ocultar Opção de Adicionar Grupos	hideAddPartiesOption		boolean	Se for verdade, irá ocultar a opção de adicionar grupos no modo Rascunho e Criação de Modelos.
Auto-Signo	selfSign		boolean	Permite o Self Sign embutido através de APIs. Este parâmetro só é aplicável quando o parâmetro createEmbeddedSendingSession é verdadeiro.
URL de Sucesso do Auto-Assinante	selfSignerSuccessUrl		string	Introduza o URL absoluto da landing page no seu site/aplicação, para onde o utilizador será redirecionado após o Self Sign enviar com sucesso a pasta na visualização de envio incorporada.

Devoluções

Name	Caminho	Tipo	Descrição
ID	folder.folderId	integer	O ID único do envelope recém-criado. Use isto em ações subsequentes para referenciar este 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 palavra-passe de acesso para o envelope, se definida.
ID do criador	folder.folderAuthorId	integer	O identificador único do criador do envelope.
Nome próprio do criador	folder.folderAuthorFirstName	string	O primeiro nome do criador do envelope.
Sobrenome do criador	folder.folderAuthorLastName	string	O apelido do criador do envelope.
E-mail do criador	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Papel do Criador	folder.folderAuthorRole	string	O papel do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	O identificador único da empresa que detém o envelope.
Data de criação	folder.folderCreationDate	integer	A data em que o envelope foi criado (carimbo de tempo Unix em milissegundos).
Data de envio	folder.folderSentDate	integer	A data em que o envelope foi enviado (carimbo Unix em milissegundos).
Situação	folder.folderStatus	string	O estado 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.
Metadados	folder.metadata	string	Metadados personalizados associados ao envelope.
Identificadores de Documento	folder.folderDocumentIds	array of integer	A lista de IDs de documentos contida no envelope.
Documents	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 único do contrato.
ID da Empresa	folder.documentsList.companyId	integer	O identificador único da empresa.
Criado por	folder.documentsList.contractCreatedBy	integer	O ID de utilizador da pessoa que criou o contrato.
Criado em	folder.documentsList.contractCreatedOn	string	A data e hora da criação do contrato.
Tipo de Contrato	folder.documentsList.contractType	string	O tipo de contrato.
Estado do Contrato	folder.documentsList.contractStatus	string	O estado 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 único da versão contratual.
Nome da Versão	folder.documentsList.contractVersionName	string	O nome da versão contratual.
Descrição da Versão	folder.documentsList.contractVersionDesc	string	Uma descrição da versão contratual.
Versão criada por	folder.documentsList.versionCreatedby	integer	O ID de utilizador da pessoa que criou esta versão.
Versão criada em	folder.documentsList.versionCreatedOn	string	A data e hora em que esta versão foi criada.
Número da versão	folder.documentsList.contractVersionNumber	integer	O número de versão do contrato.
Fonte da Transação	folder.documentsList.contractTransactionSource	string	O sistema de origem que iniciou a transação contratual.
Destinatários	folder.folderRecipientParties	array of object	A lista das partes destinatárias 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.
Nome Próprio	folder.folderRecipientParties.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O apelido do destinatário.
Endereço de E-mail	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de e-mail do destinatário.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se este partido é um destinatário provisório.
Morada	folder.folderRecipientParties.partyDetails.address	string	A morada física do destinatário.
Data de Criação	folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que o registo foi criado (carimbo de tempo Unix em milissegundos).
Emails de Exclusão	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID único do destinatário	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador de sistema único para este destinatário.
Nível de Autenticação	folder.folderRecipientParties.partyDetails.authenticationLevel	string	O método de autenticação necessário para este destinatário.
Data de atualização da palavra-passe	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A data em que a palavra-passe foi atualizada pela última vez.
Estado atualizado da palavra-passe	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indica se a palavra-passe foi atualizada.
ID da Empresa	folder.folderRecipientParties.partyDetails.companyId	integer	O identificador único da empresa.
Função do utilizador	folder.folderRecipientParties.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.folderRecipientParties.partyDetails.department	string	O departamento a que o utilizador pertence.
Título	folder.folderRecipientParties.partyDetails.title	string	O cargo do usuário.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indica se o utilizador ou o registo está ativo.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	A definição de localização para o utilizador.
Partilhar com o Departamento	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indica se os envelopes são partilhados entre o departamento.
Código de discagem	folder.folderRecipientParties.partyDetails.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.folderRecipientParties.partyDetails.mobileNumber	string	O número de telemóvel.
Filtro de Estado	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Um filtro para o estado do documento.
Filtro de Data	folder.folderRecipientParties.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso Seguro de Campo	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indica se o utilizador tem acesso a campos seguros.
Expandir a barra lateral	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indica se a barra lateral está expandida por defeito.
Validação Avançada de Email	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada do email está ativada.
ID do Gestor	folder.folderRecipientParties.partyDetails.managerId	string	O identificador único do gestor do utilizador.
Contagem de Login	folder.folderRecipientParties.partyDetails.loginCount	integer	O número de vezes que o utilizador iniciou sessão.
Email de Redefinição de Palavra-passe	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indica se deve ser enviado um email de redefinição de palavra-passe.
ID do departamento	folder.folderRecipientParties.partyDetails.departmentId	string	O identificador único do departamento.
Companhia Primária	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	A principal empresa associada ao utilizador.
Tipo de dispositivo	folder.folderRecipientParties.partyDetails.deviceType	string	O tipo de dispositivo utilizado.
Token de Dispositivo	folder.folderRecipientParties.partyDetails.deviceToken	string	O token de notificação push para o dispositivo.
Descrição do Subempreiteiro	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Uma descrição do subempreiteiro ou do signatário externo.
Organização de Subcontratantes	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de Adição do Subempreiteiro	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (carimbo de tempo Unix em milissegundos).
Source	folder.folderRecipientParties.partyDetails.source	string	O sistema de origem a partir do qual foi adicionado o signatário externo.
Código de discagem	folder.folderRecipientParties.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.folderRecipientParties.mobileNumber	string	O número de telemóvel.
Tipo de assinatura	folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura que o signatário irá usar.
Permissions	folder.folderRecipientParties.contractPermissions	string	As permissões concedidas a esta parte para o contrato.
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	O número de sequência da ordem de assinatura para este destinatário.
Sequência de Fluxo de Trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número de sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	O identificador único do envelope.
ID da empresa destinatária	folder.folderRecipientParties.partyCompanyId	integer	O identificador único da empresa associada a este destinatário.
Modo de Partilha	folder.folderRecipientParties.sharingMode	string	O modo de partilha para este envelope.
URL de acesso do destinatário	folder.folderRecipientParties.folderAccessURL	string	A URL que o destinatário pode usar para aceder e assinar o envelope.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicava-se a este envelope.
Comments	folder.folderRecipientParties.extraComments	string	Comentários adicionais incluídos com o envelope.
Permitir Mudança de Nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se o destinatário pode atualizar o seu nome.
Nome Atualizado	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se o signatário atualizou o seu nome.
Nível Auth de Signer	folder.folderRecipientParties.signerAuthenticationLevel	string	O nível de autenticação exigido 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 único da assinatura.
Função do destinatário	folder.folderRecipientParties.partyRole	string	O papel atribuído a este destinatário no fluxo de trabalho de assinatura.
Company Field	folder.folderRecipientParties.companyFieldValue	string	O valor do campo do 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	A razão pela qual o destinatário está a assinar o documento.
Campo de Pagamento Adicionado	folder.folderRecipientParties.payFieldAdded	boolean	Indica se foi adicionado um campo de pagamento.
Beneficiário	folder.folderRecipientParties.payee	boolean	Indica se este destinatário é o beneficiário.
Pagamento Recorrente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e Assinar Feito	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se o processo de impressão e assinatura está concluído.
Paid	folder.folderRecipientParties.paid	boolean	Indica se o pagamento foi concluído.
Signatário Opcional Permitido	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se este destinatário é um signatário opcional.
Signatários Opcionais	folder.folderRecipientParties.optionalSigners	array of integer	A lista de IDs opcionais dos signatários para este envelope.
URL de assinatura do autor	folder.folderAccessURLForAuthor	string	O URL que o remetente pode usar para aceder ao envelope.
URL de Acesso ao Rascunho	folder.draftFolderAccessURL	string	O URL usado para aceder à versão preliminar do envelope.
Sessão de Assinaturas na Sala de Administração	folder.boardRoomSign	boolean	Indica se o modo de assinatura na sala de reuniões está ativado.
Incluir logótipo	folder.includeLogo	boolean	Indica se o logótipo da empresa está incluído nos emails.
Cor de Fundo do Botão	folder.email_btnBgColor	string	A cor 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.
Logótipo do Email	folder.emailTemplateLogo	string	A URL do logótipo usada no modelo de email.
ID do Modelo de Email	folder.emailTemplateId	integer	O identificador único do modelo de email.
Cabeçalho do Email	folder.emailHeader	string	O texto do cabeçalho usado nos emails de notificação.
Rodapé do Email	folder.emailFooter	string	O texto do rodapé usado nos emails de notificação.
Purga Agendada	folder.purgeFlag	boolean	Indica se o envelope está programado para purga.
Data de início da purga	folder.purgeStartDate	string	A data a partir da qual a purga está prevista para começar.
Data de Fim da Purga	folder.purgeEndDate	string	A data em que a purga está programada para terminar.
ID de envio em massa	folder.bulkId	integer	O identificador único da operação de envio em massa.
Fazer cumprir a Ordem de Sinalização	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem assinar na sequência definida.
Etapa atual	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Fonte da Transação	folder.transactionSource	string	O sistema de origem que iniciou esta transação.
Editável	folder.editable	boolean	Indica se o item é editável.
In-Person Assinatura	folder.inPersonSignable	boolean	Indica se o envelope pode ser assinado pessoalmente.
Lembretes de Sobreposição	folder.overrideAccountReminders	boolean	Indica se as definições de lembrete ao nível da conta foram sobrepostas.
Delegação de Sobreposição	folder.overrideAccountRecipientDelegation	boolean	Indica se as definições de delegação ao nível da conta foram sobrepostas.
Permitir Delegação	folder.allowRecipientsToDelegate	boolean	Indica se os destinatários podem delegar a assinatura.
ID	folder.envelopeId	integer	O identificador único do envelope.
Nome	folder.envelopeName	string	O nome do envelope.
ID do originador	folder.envelopeOriginatorId	integer	O identificador único do utilizador que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	O identificador único da empresa que detém o envelope.
Date	folder.envelopeDate	integer	A data em que o envelope foi criado (carimbo de tempo Unix em milissegundos).
Data Partilhada	folder.envelopeSharedDate	integer	A data em que o envelope foi partilhado (carimbo de tempo Unix em milissegundos).
Situação	folder.envelopeStatus	string	O estado atual do envelope.
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associados a este envelope.
Permissões do Destinatário	folder.envelopePartyPermissions	array of object	A lista de permissões do 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.
Nome Próprio	folder.envelopePartyPermissions.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	folder.envelopePartyPermissions.partyDetails.lastName	string	O apelido do destinatário.
Endereço de E-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	O endereço de e-mail do destinatário.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indica se este partido é um destinatário provisório.
Morada	folder.envelopePartyPermissions.partyDetails.address	string	A morada física do destinatário.
Data de Criação	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	A data em que o registo foi criado (carimbo de tempo Unix em milissegundos).
Emails de Exclusão	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID único do destinatário	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Um identificador de sistema único para este destinatário.
Nível de Autenticação	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	O método de autenticação necessário para este destinatário.
Data de atualização da palavra-passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	A data em que a palavra-passe foi atualizada pela última vez.
Estado atualizado da palavra-passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indica se a palavra-passe foi atualizada.
ID da Empresa	folder.envelopePartyPermissions.partyDetails.companyId	integer	O identificador único da empresa.
Função do utilizador	folder.envelopePartyPermissions.partyDetails.userRole	string	A função atribuída ao usuário.
Departamento	folder.envelopePartyPermissions.partyDetails.department	string	O departamento a que o utilizador pertence.
Título	folder.envelopePartyPermissions.partyDetails.title	string	O cargo do usuário.
Active	folder.envelopePartyPermissions.partyDetails.active	boolean	Indica se o utilizador ou o registo está ativo.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	A definição de localização para o utilizador.
Partilhar com o Departamento	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indica se os envelopes são partilhados entre o departamento.
Código de discagem	folder.envelopePartyPermissions.partyDetails.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	O número de telemóvel.
Filtro de Estado	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Um filtro para o estado do documento.
Filtro de Data	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Um filtro para a data do documento.
Acesso Seguro de Campo	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indica se o utilizador tem acesso a campos seguros.
Expandir a barra lateral	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indica se a barra lateral está expandida por defeito.
Validação Avançada de Email	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indica se a validação avançada do email está ativada.
ID do Gestor	folder.envelopePartyPermissions.partyDetails.managerId	string	O identificador único do gestor do utilizador.
Contagem de Login	folder.envelopePartyPermissions.partyDetails.loginCount	integer	O número de vezes que o utilizador iniciou sessão.
Email de Redefinição de Palavra-passe	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indica se deve ser enviado um email de redefinição de palavra-passe.
ID do departamento	folder.envelopePartyPermissions.partyDetails.departmentId	string	O identificador único do departamento.
Companhia Primária	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	A principal empresa associada ao utilizador.
Tipo de dispositivo	folder.envelopePartyPermissions.partyDetails.deviceType	string	O tipo de dispositivo utilizado.
Token de Dispositivo	folder.envelopePartyPermissions.partyDetails.deviceToken	string	O token de notificação push para o dispositivo.
Descrição do Subempreiteiro	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Uma descrição do subempreiteiro ou do signatário externo.
Organização de Subcontratantes	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	O nome da organização do subcontratado ou do signatário externo.
Data de Adição do Subempreiteiro	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado (carimbo de tempo Unix em milissegundos).
Source	folder.envelopePartyPermissions.partyDetails.source	string	O sistema de origem a partir do qual foi adicionado o signatário externo.
Código de discagem	folder.envelopePartyPermissions.dialingCode	string	O código internacional de discagem para o número de telefone.
Número de telemóvel	folder.envelopePartyPermissions.mobileNumber	string	O número de telemóvel.
Tipo de assinatura	folder.envelopePartyPermissions.signerSignatureType	string	O tipo de assinatura que o signatário irá usar.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	As permissões concedidas a esta parte para o contrato.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	O número de sequência da ordem de assinatura para este destinatário.
Sequência de Fluxo de Trabalho	folder.envelopePartyPermissions.workflowSignSequence	integer	O número de sequência de assinatura do fluxo de trabalho.
Envelope ID	folder.envelopePartyPermissions.envelopeId	integer	O identificador único do envelope.
ID da empresa destinatária	folder.envelopePartyPermissions.partyCompanyId	integer	O identificador único da empresa associada a este destinatário.
Modo de Partilha	folder.envelopePartyPermissions.sharingMode	string	O modo de partilha para este envelope.
URL de acesso do destinatário	folder.envelopePartyPermissions.folderAccessURL	string	A URL que o destinatário pode usar para aceder e assinar o envelope.
Modo de Segurança	folder.envelopePartyPermissions.securityMode	string	O modo de segurança aplicava-se a este envelope.
Comments	folder.envelopePartyPermissions.extraComments	string	Comentários adicionais incluídos com o envelope.
Permitir Mudança de Nome	folder.envelopePartyPermissions.allowNameChange	boolean	Indica se o destinatário pode atualizar o seu nome.
Nome Atualizado	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indica se o signatário atualizou o seu nome.
Nível Auth de Signer	folder.envelopePartyPermissions.signerAuthenticationLevel	string	O nível de autenticação exigido 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 único da assinatura.
Função do destinatário	folder.envelopePartyPermissions.partyRole	string	O papel atribuído a este destinatário no fluxo de trabalho de assinatura.
Company Field	folder.envelopePartyPermissions.companyFieldValue	string	O valor do campo do 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	A razão pela qual o destinatário está a assinar o documento.
Campo de Pagamento Adicionado	folder.envelopePartyPermissions.payFieldAdded	boolean	Indica se foi adicionado um campo de pagamento.
Beneficiário	folder.envelopePartyPermissions.payee	boolean	Indica se este destinatário é o beneficiário.
Pagamento Recorrente	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indica se existe um campo de pagamento recorrente.
Imprimir e Assinar Feito	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indica se o processo de impressão e assinatura está concluído.
Paid	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.
Bloco de Signatários Únicos	folder.allowSingleSignerInBulk	boolean	Indica se um único signatário é permitido em modo de envio em massa.
File-Based Nomeação	folder.folderNameBasedOnFileNaming	boolean	Indica se o nome da pasta é baseado no nome do ficheiro.
Doc File-Based Nome	folder.documentNameBasedOnFileNaming	boolean	Indica se o nome do documento é baseado no nome do ficheiro.
Certificado File-Based Nome	folder.certificateNameBasedOnFileNaming	boolean	Indica se o nome do certificado é baseado no nome do ficheiro.
Nomenclatura de ficheiros pré-executivo	folder.enableFileNamingBeforeExecution	boolean	Indica se a nomeação dos ficheiros está ativada antes da execução do documento.
Acrescentou o beneficiário	folder.payeeAddedd	boolean	Indica se foi adicionado um beneficiário.
Self-Signing Ativado	folder.selfSignerEnabled	boolean	Indica se o modo de auto-assinatura está ativado.
Notário Habilitado	folder.notaryEnabled	boolean	Indica se a assinatura notarial está ativada.
Visibilidade Limitada	folder.limitedVisibilityFlag	boolean	Indica se a visibilidade limitada está ativada para este envelope.
Visibilidade após a Placa	folder.postSigningVisibility	boolean	Indica se a visibilidade após a assinatura está ativada.
Assinatura Húmida	folder.wetSignatureEnabled	boolean	Indica se as assinaturas húmidas estão ativadas.
Fusão Ativada	folder.mergeEnabled	boolean	Indica se a fusão de documentos está ativada.
Sessões de Assinatura Embutidas	embeddedSigningSessions	array of object	A lista de sessões de assinatura embutidas, uma por destinatário. Só está presente quando createEmbeddedSigningSession for verdadeiro.
E-mail do signatário	embeddedSigningSessions.emailIdOfSigner	string	O endereço de email do destinatário desta sessão de assinatura incorporada.
Token de assinatura	embeddedSigningSessions.embeddedToken	string	O token único para a sessão de assinatura embutida deste destinatário.
URL da Sessão de Assinatura	embeddedSigningSessions.embeddedSessionURL	string	O URL para abrir ou incorporar para este destinatário assinar o documento.
Token de Envio Embutido	embeddedToken	string	O token para a sessão de envio embutida. Só está presente quando createEmbeddedSendingSession for verdadeiro.
URL de Sessão de Envio	embeddedSessionURL	string	O URL para abrir ou incorporar para que o autor do envelope prepare e envie o envelope. Só está presente quando createEmbeddedSendingSession for verdadeiro.
Result	result	string	O resultado da operação.
Message	message	string	Uma mensagem a descrever o resultado da operação.

Criar Envelope a partir do Modelo

ID da Operação:

CreateEnvelopefromTemplate

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do envelope	folderName		string	Nome da pasta do(s) documento(s). Se este valor não for fornecido, então o nome da pasta do documento(s) mantém-se igual ao nome(s) modelo(s).
Template Ids	templateIds	True	array of integer	Um conjunto de IDs de modelo que quer usar para criar os documentos desta pasta.
Campos	fields		object	Pode passar os valores dos campos usados nos modelos para os pré-preencher nos documentos criados a partir do modelo. FIELD_NAME é o nome do campo utilizado 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.
Nome Próprio	firstName	True	string	O primeiro 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 e-mail do destinatário.
permissões	permission	True	string
Sequência	sequence	True	integer	Use este campo para atribuir um número de sequência a um destinatário na lista de partes destinatárias. Use números de sequência únicos para cada grupo começando por 1, como 1,2,3,4.... Se uma única pessoa aparecer várias vezes no fluxo de trabalho de assinatura, por favor atribua uma sequência diferente cada vez que o destinatário é repetido.
SignerAuthLevels	signerAuthLevel		string	O nível de autenticação que um signatário irá utilizar para efeitos de verificação
É um Placeholder	isPlaceholder		boolean	Use este campo para iniciar o grupo como um marcador de lugar. Nota: 1. o valor do parâmetro firstName, ApelidoNome, EmailId deve estar em branco nesta parte. 2. Para adicionar o marcador de lugar, um destinatário deve ser solicitado com permissão 'PARTY_ASSIGNER'.
Função do destinatário	partyRole		string	Use este campo para atribuir um papel de marcador de posição.
Permitir Mudança de Nome	allowNameChange		string	O valor pode ser verdadeiro ou falso. Use este parâmetro para permitir que o signatário atualize o nome e apelido 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 este destinatário. Quando a Sequência de Sessão está ativada, os destinatários recebem o convite de assinatura por ordem crescente de sequência.
ID do Email do Anfitrião	hostEmailId		string	Endereço de email do In-Person Administrador.
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 utilizador" para autenticação. Nota: 1. Os códigos não distinguem maiúsculas e minúsculas. 2. O sistema não envia este código, por isso deve partilhá-lo diretamente com o signatário. 3. O código de acesso pode conter alfabetos, números e os seguintes caracteres especiais: @,&,{,},%,(,),~,|,!,+,^.
A Festa é Grupo de Email	partyIsEmailGroup		boolean	Usa este parâmetro ao criar um grupo em massa. Nota: Se este parâmetro for verdadeiro, FirstName, ApelName e EmailId desta parte serão ignorados.
ID do Grupo de Email	emailGroupId		integer	Passa o email ao ID do grupo que queres usar para criar em massa.
Bloco de Signatários Únicos	allowSingleSignerInBulk		boolean	Use este parâmetro para permitir que apenas uma pessoa entre no grupo de email.
Código de discagem	dialingCode		string	Utilize este campo para atribuir a um país que os códigos de chamada de entrada são prefixos de número móvel a um destinatário na lista de partes destinatárias.
Número de telemóvel	mobileNumber		string	Use este campo para atribuir um número de telemóvel a um destinatário na lista de partes destinatárias.
Palavra-passe do envelope	folderPassword		string	Esta palavra-passe será exigida pelo signatário/autor para abrir o documento assinado digitalmente. Se o parâmetro for mantido em branco, não será necessária palavra-passe para abrir o documento assinado digitalmente.
Sequência de Iniciar Sessão	signInSequence		boolean	Este campo é usado para determinar se os destinatários irão assinar os documentos do envelope numa sequência. Se for falso, todos os destinatários recebem um email de convite simultaneamente. Quando é verdade, cada destinatário recebe um email de convite sucessivamente depois de o destinatário anterior completar a tarefa necessária, como assinar os documentos ou preencher campos, etc.
Ativação Presencial	inPersonEnable		boolean	Este campo é utilizado para iniciar o processo de assinatura presencial, que pode ser facilmente realizado em qualquer dispositivo em poucos minutos e evita assinaturas por email quando necessário. Se for falso, então todos os destinatários recebem o email de convite simultaneamente. Quando isso acontece, o administrador presencial recebe um e-mail de convite para iniciar o processo de assinatura do signatário.
Enviar Agora	sendNow		boolean	Quando ativado, o Foxit eSign envia imediatamente um link de assinatura único para o endereço de email de cada destinatário. Desative isto para guardar o envelope como um rascunho em vez disso.
Assinar Sucesso URL Todas as Partes	signSuccessUrlAllParties		boolean	Se definido como verdadeiro, o signatário será redirecionado para o URL fornecido no signSuccessUrl após a assinatura bem-sucedida. Isto só se aplica quando o sendNow é verdadeiro.
Criar Sessão de Envio Embutida	createEmbeddedSendingSession		boolean	Se definido como verdadeiro, gerará um URL incorporado para abrir a visualização de preparação de documentos do Foxit eSign.
Partidos Beneficiários do Fix	fixRecipientParties		boolean	Se for verdade, então na vista de envio embutida não pode alterar as partes do envelope que já foram adicionadas como parte deste pedido.
Corrigir Documentos	fixDocuments		boolean	Se for verdade, então no envio embutido não pode alterar os documentos do envelope que já foram adicionados como parte deste pedido.
Enviar URL de Sucesso	sendSuccessUrl		string	Introduza o URL absoluto da página de destino, para a qual o signatário será redirecionado após enviar com sucesso a pasta na visualização de envio incorporada.
URL de Erro de Envio	sendErrorUrl		string	Introduza a URL absoluta da página de destino, para a qual o signatário será redirecionado caso surja erro durante o envio da pasta na visualização de envio incorporada.
Ocultar Opção de Seleção de Signatário	hideSignerSelectOption		boolean	Se for verdade, irá ocultar a caixa de entrada "Nome do Assinante/Email Existente" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Ações do Signatário	hideSignerActions		boolean	Se for verdade, irá ocultar as ações do signatário em "editar", "alterar" e "remover" as ações das Partes Destinatárias numa sessão de envio embutida.
Ocultar Nome do Remetente	hideSenderName		boolean	Se for verdade, irá ocultar o nome do remetente nas Partes Destinatárias numa sessão de envio embutida.
Ocultar Botão de Enviar	hideSendButton		boolean	Se for verdade, irá esconder o botão Enviar na sessão de envio embutida.
Ocultar Nome da Pasta	hideFolderName		boolean	Se for verdade, irá esconder o nome da pasta na navegação em ambas as sessões incorporadas.
Ocultar Nome dos Documentos	hideDocumentsName		boolean	Se for verdade, irá esconder o nome do documento em ambas as sessões incorporadas.
Ocultar Botão Adicionar-me	hideAddMeButton		boolean	Se for verdade, irá ocultar o botão "Adicionar-me" nas Partes Destinatárias numa sessão de envio incorporada.
Ocultar Adicionar Novo Botão	hideAddNewButton		boolean	Se for verdade, irá ocultar o botão "Adicionar Novo" nas Partes Destinatárias numa sessão de envio embutida.
Ocultar botão Adicionar Grupo	hideAddGroupButton		boolean	Se for verdade, irá ocultar o botão "Adicionar Grupo" nas Partes Destinatárias numa sessão de envio embutida.
Criar Sessão de Assinatura Incorporada	createEmbeddedSigningSession		boolean	O token de sessão de assinatura será gerado sem enviar emails aos destinatários.
Criar Sessão de Assinatura Incorporada para Todas as Partes	createEmbeddedSigningSessionForAllParties		boolean	Se definido como verdadeiro, é gerado um URL de assinatura embutido para cada destinatário no envelope. Se for falso, apenas os destinatários listados nos IDs de Email dos Signatários Incorporados recebem uma sessão incorporada.
IDs de Email dos Signatários Incorporados	embeddedSignersEmailIds		array of string	Uma variedade de IDs de email dos destinatários para quem precisa de ser criada uma sessão de assinatura embutida. Os IDs de email das partes destinatárias adicionados à lista de partes.
URL de Sucesso do Sinal	signSuccessUrl		string	Introduza o URL absoluto para os signatários para os quais serão redirecionados após iniciar sessão com sucesso na vista de assinatura embutida.
URL de Declinar de Sinal	signDeclineUrl		string	Insira o URL absoluto para os signatários, para os quais serão redirecionados se recusarem iniciar sessão na visualização de assinatura incorporada.
Assinar depois URL	signLaterUrl		string	Insira a URL absoluta para os signatários que serão redirecionados se optar por assinar mais tarde na vista de assinatura incorporada.
URL de erro de sinal	signErrorUrl		string	Introduza a URL absoluta para os signatários para os quais serão redirecionados caso ocorra erro durante a assinatura do documento na vista de assinatura incorporada.
Esconder Próximo Campo Obrigatório Btn	hideNextRequiredFieldBtn		boolean	Se definido como verdadeiro, esconde o botão de navegação que move os utilizadores para o campo seguinte exigido.
Cor do tema	themeColor		string	Introduza o valor CSS para definir a cor do tema.
Esconder Recusar Assinar	hideDeclineToSign		boolean	Se definido como verdadeiro, oculta a opção Recusar Assinar no ecrã de assinatura.
Esconder Mais Ação	hideMoreAction		boolean	Se definido como verdadeiro, esconde o botão Mais Ações na sessão de envio e assinatura. Não tem efeito quando Enviar Agora é verdadeiro.
Ocultar Opção de Adicionar Grupos	hideAddPartiesOption		boolean	Se definido como verdadeiro, esconde a opção de adicionar grupos em modo Rascunho e Criação de Modelos.
Expiração da Sessão	sessionExpire		boolean	Defina como true para iniciar a expiração da sessão de assinatura embutida.
Validade	expiry		integer	Obrigatório se sessionExpire for verdadeiro. Introduza a duração em milissegundos após a expiração da sessão de assinatura incorporada.
E-mail do remetente	senderEmail		string	Introduza o email de outro utilizador na sua conta, que será usado para enviar esta(s) pasta(s) de documento(s) às partes destinatárias.
Permitir Enviar Agora e Sessão de Assinatura Embutida	allowSendNowAndEmbeddedSigningSession		boolean	Se definido como verdadeiro, o Foxit eSign envia um e-mail de convite de assinatura a cada destinatário e também gera um link de assinatura embutido para os destinatários cujo email está incluído no Email do Signador Incorporado. Tanto o email como o link incorporado estão ativos simultaneamente.
Ativar Passo a Passo	enableStepByStep		boolean	Para permitir ações passo a passo na sessão de envio embutida.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a operação teve sucesso (por exemplo, 'sucesso').
Message	message	string	Uma descrição do resultado da operação.
Sessões de Assinatura Embutidas	embeddedSigningSessions	array of object	A lista de sessões de assinatura embutidas, uma por destinatário. Só está presente quando createEmbeddedSigningSession for verdadeiro.
E-mail do signatário	embeddedSigningSessions.emailIdOfSigner	string	O endereço de email do destinatário desta sessão de assinatura incorporada.
Token de assinatura	embeddedSigningSessions.embeddedToken	string	O token único para a sessão de assinatura embutida deste destinatário.
URL da Sessão de Assinatura	embeddedSigningSessions.embeddedSessionURL	string	O URL para abrir ou incorporar para este destinatário assinar o documento.
Token de Envio Embutido	embeddedToken	string	O token para a sessão de envio embutida. Só está presente quando createEmbeddedSendingSession for verdadeiro.
URL de Sessão de Envio	embeddedSessionURL	string	O URL para abrir ou incorporar para que o autor do envelope prepare e envie o envelope. Só está presente quando createEmbeddedSendingSession for verdadeiro.
ID	folder.folderId	integer	O ID único do envelope criado. Use isto 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 palavra-passe definida para o envelope, se houver.
ID do autor	folder.folderAuthorId	integer	O ID único do utilizador que criou o envelope.
Primeiro Nome do Autor	folder.folderAuthorFirstName	string	O primeiro nome do criador do envelope.
Apelido do Autor	folder.folderAuthorLastName	string	O apelido do criador do envelope.
Email do Autor	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Papel do autor	folder.folderAuthorRole	string	O papel da conta do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	O ID único da empresa a que pertence o envelope.
Data de criação	folder.folderCreationDate	integer	A data e hora em que o envelope foi criado, em milissegundos Unix.
Data de envio	folder.folderSentDate	integer	A data e hora em que o envelope foi enviado aos destinatários, em milissegundos Unix.
Situação	folder.folderStatus	string	O estado atual do envelope (ex.: PARTILHADO, EXECUTADO, RASCUNHO, CANCELADO).
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.
Metadados	folder.metadata	string	Quaisquer metadados adicionais associados ao envelope.
Identificadores de Documento	folder.folderDocumentIds	array of integer	A lista de IDs de documentos incluída neste envelope.
Documents	folder.documentsList	array of object	Detalhes de cada documento incluídos no envelope.
ID do documento	folder.documentsList.documentId	integer	O identificador exclusivo do documento.
ID do contrato	folder.documentsList.contractId	integer	O identificador único do contrato associado a este documento.
ID da Empresa	folder.documentsList.companyId	integer	O ID único da empresa a que este documento pertence.
Criado por	folder.documentsList.contractCreatedBy	integer	O ID de utilizador da pessoa que criou o contrato.
Criado em	folder.documentsList.contractCreatedOn	string	A data em que o contrato foi criado.
Tipo de Contrato	folder.documentsList.contractType	string	O tipo de contrato.
Estado do documento	folder.documentsList.contractStatus	string	O estado atual de assinatura do documento (por exemplo, WAITING_FOR_SIGNATURE, EXECUTADO).
Editável	folder.documentsList.editable	boolean	Indica se o documento pode ser editado.
ID da versão	folder.documentsList.contractVersionId	integer	O ID único 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	O ID de utilizador 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 da versão	folder.documentsList.contractVersionNumber	integer	O número da versão do documento.
Fonte da Transação	folder.documentsList.contractTransactionSource	string	A origem da transação contratual.
Destinatários	folder.folderRecipientParties	array of object	A lista de destinatários deste envelope, incluindo os seus links individuais para assinar.
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.
Nome Próprio	folder.folderRecipientParties.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O apelido do destinatário.
Email	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de e-mail do destinatário.
É um Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se este destinatário é um marcador de lugar.
Morada	folder.folderRecipientParties.partyDetails.address	string	A morada 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.
Emails de Exclusão	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se o destinatário optou por não receber notificações por email.
ID de Partido Único	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador único de string para o destinatário.
Nível de Autenticação	folder.folderRecipientParties.partyDetails.authenticationLevel	string	O nível de autenticação exigido para este destinatário.
ID da Empresa	folder.folderRecipientParties.partyDetails.companyId	integer	O ID da empresa a que o destinatário pertence.
Função do utilizador	folder.folderRecipientParties.partyDetails.userRole	string	O papel do destinatário dentro da sua organização.
Departamento	folder.folderRecipientParties.partyDetails.department	string	O departamento do destinatário.
Título	folder.folderRecipientParties.partyDetails.title	string	O cargo do destinatário.
Active	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 de telemóvel	folder.folderRecipientParties.partyDetails.mobileNumber	string	O número de telemóvel do destinatário.
Descrição do Subempreiteiro	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Uma descrição do subempreiteiro, se aplicável.
Organização de Subcontratantes	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	O nome da organização do subempreiteiro, se aplicável.
Data de Adição do Subempreiteiro	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	A data em que o subcontratado foi adicionado, em milissegundos Unix.
Source	folder.folderRecipientParties.partyDetails.source	string	A fonte através 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 móvel do destinatário.
Número de telemóvel	folder.folderRecipientParties.mobileNumber	string	O número de telemóvel do destinatário.
Tipo de assinatura	folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura permitia este destinatário.
Permissions	folder.folderRecipientParties.contractPermissions	string	As permissões de assinatura concedidas a este destinatário (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	A posição deste destinatário na ordem de assinatura.
Sequência de Fluxo de Trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número de sequência de assinatura do fluxo de trabalho para este destinatário.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	O ID do envelope a que este destinatário pertence.
ID da empresa do partido	folder.folderRecipientParties.partyCompanyId	integer	O documento de identificação da empresa a que este destinatário pertence.
Modo de Partilha	folder.folderRecipientParties.sharingMode	string	O método utilizado para partilhar o documento com este destinatário (por exemplo, email).
URL de assinatura	folder.folderRecipientParties.folderAccessURL	string	O URL de assinatura único para este destinatário. Use isto para partilhar diretamente o link de assinatura.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicava-se ao acesso deste destinatário.
Comentários Extra	folder.folderRecipientParties.extraComments	string	Quaisquer comentários adicionais incluídos no convite de assinatura para este destinatário.
Permitir Mudança de Nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se o destinatário pode mudar o nome antes de assinar.
Nome Atualizado	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se o destinatário atualizou o seu nome de visualização.
Nível de Autenticação	folder.folderRecipientParties.signerAuthenticationLevel	string	O método de autenticação necessário para que este destinatário possa aceder ao documento.
Código de Acesso	folder.folderRecipientParties.userDefinedAccessCode	string	É necessário um código de acesso personalizado para este destinatário abrir o documento.
ID da assinatura	folder.folderRecipientParties.signatureId	string	O ID da assinatura guardada usada por este destinatário.
Função do destinatário	folder.folderRecipientParties.partyRole	string	O papel atribuído a este destinatário no envelope.
Valor do Campo da Companhia	folder.folderRecipientParties.companyFieldValue	string	O valor do campo da empresa pré-preenchido para este 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	A razão da assinatura fornecida por este destinatário.
Campo de Pagamento Adicionado	folder.folderRecipientParties.payFieldAdded	boolean	Indica se foi adicionado um campo de pagamento para este destinatário.
É o Pagador	folder.folderRecipientParties.payee	boolean	Indica se este beneficiário é beneficiário.
Existe um campo recorrente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se existem campos de pagamento recorrentes para este destinatário.
Impressão e Assinatura Concluídas	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se o destinatário completou uma ação de imprimir e assinar.
Permitir Signatário Opcional	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se este destinatário pode ser ignorado como signatário opcional.
Signatários Opcionais	folder.folderRecipientParties.optionalSigners	string	A lista de signatários opcionais associados a este destinatário, se houver.
Paid	folder.folderRecipientParties.paid	boolean	Indica se este destinatário completou o pagamento.
URL de Acesso ao Autor	folder.folderAccessURLForAuthor	string	O URL do autor do envelope para aceder ao documento.
URL de Acesso ao Rascunho	folder.draftFolderAccessURL	string	O URL para aceder ao envelope enquanto está em estado de rascunho.
Placa da Sala de Reuniões	folder.boardRoomSign	boolean	Indica se a assinatura na sala de conselhos está ativada para este envelope.
Incluir logótipo	folder.includeLogo	boolean	Indica se o logótipo da empresa está incluído nas notificações por email.
Cor do Botão do Email	folder.email_btnBgColor	string	A cor de fundo do botão de ação no email de assinatura.
Cor do Texto do Botão do Email	folder.email_btnTxtColor	string	A cor do texto do botão de ação no email de assinatura.
Logótipo do Email	folder.emailTemplateLogo	string	A imagem do logótipo usada no modelo de email.
ID do Modelo de Email	folder.emailTemplateId	integer	O ID do modelo de email usado para assinar notificações.
Cabeçalho do Email	folder.emailHeader	string	O texto de cabeçalho personalizado nos emails de notificação de assinatura.
Rodapé do Email	folder.emailFooter	string	O texto personalizado do rodapé nos emails de notificação de assinatura.
Purga Agendada	folder.purgeFlag	boolean	Indica se este envelope está programado para purga automática.
Data de início da purga	folder.purgeStartDate	string	A data a partir da qual começa o período de purga.
Data de Fim da Purga	folder.purgeEndDate	string	A data em que o envelope será purgado.
ID em massa	folder.bulkId	integer	O ID do lote de envio em massa a que este envelope pertence, se é que existe.
Fazer cumprir a Ordem de Sinalização	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem assinar na ordem especificada.
Etapa do Fluxo de Trabalho Atual	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Fonte da Transação	folder.transactionSource	string	A fonte que iniciou esta transação de envelope.
Editável	folder.editable	boolean	Indica se o envelope ainda pode ser editado.
In-Person Assinatura	folder.inPersonSignable	boolean	Indica se o envelope pode ser assinado pessoalmente.
Lembretes de Sobreposição	folder.overrideAccountReminders	boolean	Indica se as definições de lembrete ao nível da conta foram sobrepostas para este envelope.
Delegação de Sobreposição	folder.overrideAccountRecipientDelegation	boolean	Indica se as definições de delegação ao nível da conta estão sobrepostas para este envelope.
Permitir Delegação	folder.allowRecipientsToDelegate	boolean	Indica se os destinatários podem delegar a sua assinatura a outra pessoa.
ID	folder.envelopeId	integer	O ID único do envelope. Mesmo valor que o ID do envelope (folderId).
Nome	folder.envelopeName	string	O nome do envelope. Mesmo valor que Nome do Envelope (NomeFolderName).
ID do originador	folder.envelopeOriginatorId	integer	O ID de utilizador da pessoa que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	O documento de identificação da empresa a que pertence o envelope.
Date	folder.envelopeDate	integer	A data e hora em que o envelope foi criado, em milissegundos Unix.
Data Partilhada	folder.envelopeSharedDate	integer	A data e hora em que o envelope era partilhado com os destinatários, em milissegundos Unix.
Situação	folder.envelopeStatus	string	O estado atual do envelope. O mesmo valor que o Estado do Envelope (PastaStatus).
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associados a este envelope.
Permissões de Partido	folder.envelopePartyPermissions	array of object	A lista dos destinatários e as suas permissões de assinatura. Mesma estrutura que os Recipientes.
ID do destinatário	folder.envelopePartyPermissions.partyId	integer	O identificador exclusivo do destinatário.
URL de assinatura	folder.envelopePartyPermissions.folderAccessURL	string	O URL de assinatura único para este destinatário.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	As permissões de assinatura para este destinatário.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	A posição deste destinatário na ordem de assinatura.
Nível de Autenticação	folder.envelopeAuthenticationLevel	string	O nível de autenticação aplicava-se a todo o envelope.
Permitir Bloco de Signatários Únicos	folder.allowSingleSignerInBulk	boolean	Indica se um único signatário é permitido em modo de envio em massa.
Nome Baseado no Ficheiro	folder.folderNameBasedOnFileNaming	boolean	Indica se o nome do envelope deriva do nome do ficheiro.
Nome do Documento Baseado no Ficheiro	folder.documentNameBasedOnFileNaming	boolean	Indica se o nome do documento deriva do nome do ficheiro.
Nome do Certificado Baseado no Ficheiro	folder.certificateNameBasedOnFileNaming	boolean	Indica se o nome do certificado deriva do nome do ficheiro.
Ativar Nomeação de Ficheiros	folder.enableFileNamingBeforeExecution	boolean	Indica se a nomeação do ficheiro é solicitada antes do envelope ser enviado.
Acrescentou o beneficiário	folder.payeeAddedd	boolean	Indica se um beneficiário foi adicionado ao envelope.
Auto-assinante	folder.selfSignerEnabled	boolean	Indica se o remetente também é signatário neste envelope.
Notário Habilitado	folder.notaryEnabled	boolean	Indica se a autenticação está ativada para este envelope.
Visibilidade Limitada	folder.limitedVisibilityFlag	boolean	Indica se a visibilidade limitada do documento está ativada.
Visibilidade Pós-Assinatura	folder.postSigningVisibility	boolean	Indica se os destinatários podem ver o documento assinado após a conclusão.
Assinatura Húmida Ativada	folder.wetSignatureEnabled	boolean	Indica se as assinaturas húmidas (manuscritas) estão ativadas para este envelope.
Fusão Ativada	folder.mergeEnabled	boolean	Indica se a fusão de documentos está ativada 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 a vários destinatários ao mesmo tempo.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
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 ativado, o Foxit eSign valida que todos os endereços de email do grupo estão acessíveis antes de serem enviados.
Nome Próprio	firstName	True	string	O primeiro nome do destinatário.
Apelido	lastName	True	string	O sobrenome do destinatário.
Email	emailId	True	string	O endereço de e-mail do destinatário.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
Message	message	string	Uma mensagem de confirmação da ação realizada.
ID do grupo	emailGroup.groupId	integer	O identificador único do grupo de email. Use este ID ao enviar envelopes ao 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 a que pertence este grupo de email.
Parties	emailGroup.parties	array of object	A lista de destinatários no grupo de email.
Nome Próprio	emailGroup.parties.firstName	string	O primeiro nome do destinatário.
Apelido	emailGroup.parties.lastName	string	O sobrenome do destinatário.
Email	emailGroup.parties.emailId	string	O endereço de e-mail do destinatário.

Criar Modelo a partir de URL

ID da Operação:

CreateTemplatefromURL

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
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 publicamente acessível do documento PDF para usar como modelo.
Tipo de entrada	inputType	True	string	O método de entrada para o documento. Define sempre o 'url' para esta ação.
Etiquetas de Texto de Processos	processTextTags	True	boolean	Quando ativado, o Foxit eSign irá analisar o documento em busca de Etiquetas de Texto e convertê-las automaticamente em campos de assinatura.
Campos de Acro de Processo	processAcroFields	True	boolean	Quando ativado, o Foxit eSign escanea o documento à procura de AcroFields e converte-os automaticamente em campos de assinatura.
Partilhar Tudo	shareAll	True	boolean	Partilhe este modelo com todos os utilizadores da sua conta.
Número de Partidos	numberOfParties	True	integer	Adicione o número de partidos no modelo. Os valores deste parâmetro devem ser inferiores a 20.
Cor do tema	themeColor		string	Introduza um valor css para uma cor para alterar o tema do createEmbeddedTemplateSession.
Email do Autor	authorEmail		string	Introduza o email de outro utilizador numa conta que será usado como autor deste modelo.
Criar Sessão de Modelo Incorporado	createEmbeddedTemplateSession		boolean	Se definido como verdadeiro, uma sessão template embutida para abrir diretamente a visualização de preparação do template Foxit eSign. Arrastar e largar vários campos no modelo estará disponível.
URL de redirecionamento	redirectURL		string	Se createEmbeddedTemplateSession for verdadeiro, a URL absoluta pode ser introduzida para a landing page em qualquer site/aplicação, para a qual o utilizador será redirecionado após clicar em "guardar e fechar" na visualização do modelo incorporado.
Ocultar Modelo de Envio	hideSendTemplate		boolean	Se for verdade, irá esconder o botão Enviar numa visualização de template embutida.
Partidos Beneficiários do Fix	fixRecipientParties		boolean	Se for verdade, então na vista modelo embutida não pode 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 único para este grupo, começando em 1. Define a ordem de assinatura quando a Sequência de Início de Sessão está ativada.
Função do destinatário	partyRole	True	string	O papel atribuído a este grupo no modelo.
Esconder Mais Ação	hideMoreAction		boolean	Se for verdade, vai esconder o botão "Mais Ações" na sessão do template.
Esconder Partilhar com Todos	hideShareWithAll		boolean	Se for verdade, irá esconder a opção "Partilhar com Todos" na sessão do modelo.
Ocultar Adicionar Partido	hideAddParty		boolean	Se for verdade, irá esconder todas as opções de adicionar grupo numa sessão de template incorporada.
Botão de Esconder-me	hideMeButton		boolean	Se for verdade, irá esconder o botão "Eu" nas Partes Destinatárias numa sessão template incorporada.
Botão de Ocultar Outros	hideOthersButton		boolean	Se for verdade, irá esconder o botão "Outros" nas Partes Destinatárias numa sessão template incorporada.
Ocultar Opção de Selecionar Contacto Existente	hideExistingContactSelectOption		boolean	Se for verdade, irá ocultar a caixa de entrada "Encontrar e Adicionar Contacto Existente" nas Partes Destinatárias numa sessão modelo incorporada.
Ocultar Nome do Campo para Destinatários	hideFieldNameForRecipients		boolean	Ocultar os nomes dos campos para Destinatários para Campos de Introdução de Dados e Campos Avançados. (Exceto botão de Radio, Caixa de Seleção, Imagem e Hiperligação).
Ocultar Limite da Caixa de Seleção	hideCheckboxBorder		boolean	As fronteiras da Caixa de Seleção ficarão escondidas nos documentos assinados.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a operação teve sucesso (por exemplo, 'sucesso').
Message	message	string	Uma descrição do resultado da operação.
ID	template.templateId	integer	O ID único do modelo criado. Use isto para criar envelopes a partir deste modelo.
Nome	template.templateName	string	O nome do modelo.
Descrição	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 partidos	template.numberOfParties	integer	O número de partes destinatárias definido no modelo.
Total de Páginas	template.totalPages	integer	O número total de páginas no documento modelo.
ID da Empresa	template.companyId	integer	O ID da empresa a que este modelo pertence.
Partilhado com Todos	template.shareAll	boolean	Indica se este modelo é partilhado com todos os utilizadores da conta.
Padrão de Nome Personalizado	template.templateCustomName	string	O padrão personalizado de nomes aplicava-se a envelopes criados a partir deste modelo.
Permissões de Partido	template.templatePartyPermissions	array of object	A lista de papéis destinatários e as suas permissões definidas neste modelo.
ID da Parte	template.templatePartyPermissions.template_party_id	integer	O ID único desta entrada modelo de festa.
ID	template.templatePartyPermissions.templateId	integer	O ID do modelo a que este partido pertence.
Permissions	template.templatePartyPermissions.templatePermissions	string	As permissões de assinatura para esta parte (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	template.templatePartyPermissions.partySequence	integer	A posição da ordem de assinatura para este partido.
Papel do Partido	template.templatePartyPermissions.templatePartyRole	string	O nome do papel atribuído a este grupo no modelo. Use isto ao criar um envelope a partir do modelo.
ID da Parte	template.templatePartyPermissions.partyId	integer	O ID da parte atribuída a esta função, se pré-atribuído.
ID de utilizador	template.templateCreatedBy.partyId	integer	O ID exclusivo do usuário.
Nome Próprio	template.templateCreatedBy.firstName	string	O primeiro nome do usuário.
Apelido	template.templateCreatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateCreatedBy.emailId	string	O endereço de correio eletrónico do utilizador.
ID da Empresa	template.templateCreatedBy.companyId	integer	O ID da empresa a que o utilizador pertence.
Função do utilizador	template.templateCreatedBy.userRole	string	O papel do utilizador dentro da sua organização.
Active	template.templateCreatedBy.active	boolean	Indica se a conta do utilizador está ativa.
ID de utilizador	template.templateLastUpdatedBy.partyId	integer	O ID exclusivo do usuário.
Nome Próprio	template.templateLastUpdatedBy.firstName	string	O primeiro nome do usuário.
Apelido	template.templateLastUpdatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateLastUpdatedBy.emailId	string	O endereço de correio eletrónico do utilizador.
ID da Empresa	template.templateLastUpdatedBy.companyId	integer	O ID da empresa a que o utilizador pertence.
Função do utilizador	template.templateLastUpdatedBy.userRole	string	O papel do utilizador dentro da sua organização.
Active	template.templateLastUpdatedBy.active	boolean	Indica se a conta do utilizador está ativa.
Campos Template	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	O ID do modelo a que este campo pertence.
ID da Empresa	allfields.companyId	integer	A conta da empresa a que pertence esta área.
Tipo de campo	allfields.fieldType	string	O tipo do campo (por exemplo, campo de sinal, campo inicial, campo de texto, campo de data, campo de verificação, campo seguro, campo anexo).
Número da página	allfields.documentPageNumber	integer	O número de página do documento onde este campo está colocado.
Parte responsável	allfields.partyResponsible	integer	O número de sequência do grupo responsável por preencher este campo.
Sequência da Festa	allfields.partyResponsibleSequence	integer	A posição de sequência da parte responsável.
ID do Documento de Campo	allfields.docFieldId	string	O identificador ao nível do documento para este campo.
É dependente	allfields.dependent	boolean	Indica se a visibilidade deste campo depende do valor de outro campo.
Ordem de tablatura	allfields.tabOrder	integer	A ordem de tabulação para navegar entre campos.
Obrigatório	allfields.required	boolean	Indica se este campo deve ser preenchido antes de o documento poder ser assinado.
Nome do campo personalizado	allfields.customFieldName	string	Um nome personalizado atribuído a este campo.
Partilhar Tudo	allfields.shareAll	boolean	Indica se este campo é partilhado com todos os utilizadores.
Permitir edição	allfields.allowEdit	boolean	Indica se este campo pode ser editado pelo destinatário.
Nome do campo do texto	allfields.textfieldName	string	O rótulo do campo de texto (aplicável quando fieldType é 'textfield').
Value	allfields.value	string	O valor pré-preenchido ou introduzido do campo.
Tamanho da fonte	allfields.fontSize	integer	O tamanho da fonte usado para o texto nesta área.
Cor do Tipo de Letra	allfields.fontColor	string	A cor da fonte usada para o texto neste campo (por exemplo, #000000).
Somente leitura	allfields.readOnly	boolean	Indica se o campo é apenas leitura e não pode ser editado pelo destinatário.
Multi Line	allfields.multiLine	boolean	Indica se o campo de texto aceita várias linhas de entrada (aplicável quando o 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 data (aplicável quando campoTipo é 'campo data').
Formato de data	allfields.dateFormat	string	O formato de data utilizado por este campo (por exemplo, MM/DD/YYYY) (aplicável quando o Typede de campo é 'campo de data').
Nome da Caixa de Seleção	allfields.cbname	string	O rótulo do campo de checkbox (aplicável quando fieldType é 'checkboxfield').
Grupo de Caixa de Seleção	allfields.cbgroup	string	O nome do grupo para esta caixa de seleção (aplicável quando fieldType é 'checkboxfield').
Verificado	allfields.checked	boolean	Indica se a caixa de seleção está assinalada por defeito (aplicável quando o fieldType é 'checkboxfield').
Nome do Campo Assegurado	allfields.securedfieldName	string	O rótulo do campo protegido (aplicável quando o campo Tipo é 'campo seguro').
Personagens para Exibir	allfields.charToDisplay	integer	O número de caracteres não mascarados a mostrar no final de um valor de campo seguro (aplicável quando o FieldType é 'campo seguro').
ID da assinatura	allfields.signatureId	string	O ID da assinatura aplicado a este campo de sinal (aplicável quando o Typede do Campo é 'campo de sinal').
Imagem Inicial	allfields.initialImage	string	Os dados da imagem para as iniciais aplicam-se a este campo (aplicável quando o fieldType é 'initialfield').
Nome do Campo de Anexo	allfields.attachmentfieldName	string	O nome do campo de anexo (aplicável quando o campo Tipo é 'campo de anexo').
Descrição do Anexo	allfields.attachmentfieldDescription	string	Uma descrição do que anexar (aplicável quando o fieldType é 'attachmentfield').

Criar Modelo a partir do Base64

ID da Operação:

CreateTemplatefromBase64

Cria um novo template usando uma string PDF codificada em Base64. Use isto quando o seu ficheiro PDF já estiver disponível como uma string Base64 no seu fluxo, por exemplo, a partir de um ficheiro SharePoint ou documento do OneDrive.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do Modelo	templateName	True	string	O nome do modelo. Deve terminar com a extensão .pdf (por exemplo, onboarding.pdf).
Cadeia de ficheiros Base64	base64FileString	True	string	String BASE64 de um PDF para a criação do modelo. Deve ser acessível ao público quando estiver a criar o modelo.
Tipo de entrada	inputType	True	string	O método de entrada para o documento. Sempre definido para 'base64' para esta ação.
Etiquetas de Texto de Processos	processTextTags	True	boolean	Quando ativado, o Foxit eSign irá analisar o documento em busca de Etiquetas de Texto e convertê-las automaticamente em campos de assinatura.
Campos de Acro de Processo	processAcroFields	True	boolean	Quando ativado, o Foxit eSign escanea o documento à procura de AcroFields e converte-os automaticamente em campos de assinatura.
Partilhar Tudo	shareAll	True	boolean	Partilhe este modelo com todos os utilizadores da sua conta.
Número de Partidos	numberOfParties	True	integer	O número de partes beneficiárias deste modelo. Deve ser menos de 20.
Cor do tema	themeColor		string	Um valor de cor CSS para personalizar o tema da sessão do template incorporado (por exemplo, #42caf4).
Email do Autor	authorEmail		string	O endereço de email de outro utilizador na conta será definido como autor deste modelo.
Criar Sessão de Modelo Incorporado	createEmbeddedTemplateSession		boolean	Se definido como true, cria-se uma sessão de template embutida para que possas abrir diretamente o editor de templates Foxit eSign e arrastar e largar campos para o template.
URL de Redirecionamento	redirectURL		string	Se criar Sessão de Template Embutido for verdadeira, o URL para redirecionar o utilizador depois de clicar em Guardar e Fechar no editor de templates embutido.
Ocultar Modelo de Envio	hideSendTemplate		boolean	Se for verdade, o botão Enviar fica oculto no editor de templates incorporado.
Partidos Beneficiários do Fix	fixRecipientParties		boolean	Se for verdade, as partes destinatárias já adicionadas não podem ser alteradas no editor de templates incorporado.
Campos	Fields		object
permissões	permission	True	string
Sequência	sequence	True	integer	Um número de sequência único para este grupo, começando em 1. Define a ordem de assinatura quando a Sequência de Início de Sessão está ativada.
Função do destinatário	partyRole	True	string	O papel atribuído a este grupo no modelo.
Esconder Mais Ação	hideMoreAction		boolean	Se for verdade, o botão Mais Ações está escondido na sessão do modelo incorporado.
Esconder Partilhar com Todos	hideShareWithAll		boolean	Se for verdade, a opção Partilhar com Todos fica oculta na sessão do modelo incorporado.
Ocultar Adicionar Partido	hideAddParty		boolean	Se for verdade, todas as opções de adicionar grupo ficam ocultas na sessão do modelo incorporado.
Botão de Esconder-me	hideMeButton		boolean	Se for verdade, o botão Eu nas Partes Destinatárias está escondido na sessão do modelo incorporado.
Botão de Ocultar Outros	hideOthersButton		boolean	Se for verdade, o botão Outros nas Partes Destinatárias está escondido na sessão do modelo incorporado.
Ocultar Nome do Campo para Destinatários	hideFieldNameForRecipients		boolean	Se for verdade, os nomes dos campos ficam ocultos aos destinatários para introdução de dados e campos avançados.
Ocultar Limite da Caixa de Seleção	hideCheckboxBorder		boolean	Se for verdade, as bordas das caixas de seleção ficam ocultas nos documentos executados.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a operação teve sucesso (por exemplo, 'sucesso').
Message	message	string	Uma descrição do resultado da operação.
ID	template.templateId	integer	O ID único do modelo criado. Use isto para criar envelopes a partir deste modelo.
Nome	template.templateName	string	O nome do modelo.
Descrição	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 partidos	template.numberOfParties	integer	O número de partes destinatárias definido no modelo.
Total de Páginas	template.totalPages	integer	O número total de páginas no documento modelo.
ID da Empresa	template.companyId	integer	O ID da empresa a que este modelo pertence.
Partilhado com Todos	template.shareAll	boolean	Indica se este modelo é partilhado com todos os utilizadores da conta.
Permissões de Partido	template.templatePartyPermissions	array of object	A lista de papéis destinatários e as suas permissões definidas neste modelo.
ID da Parte	template.templatePartyPermissions.template_party_id	integer	O ID único desta entrada modelo de festa.
ID	template.templatePartyPermissions.templateId	integer	O ID do modelo a que este partido pertence.
Permissions	template.templatePartyPermissions.templatePermissions	string	As permissões de assinatura para esta parte (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	template.templatePartyPermissions.partySequence	integer	A posição da ordem de assinatura para este partido.
Papel do Partido	template.templatePartyPermissions.templatePartyRole	string	O nome do papel atribuído a este grupo no modelo. Use isto ao criar um envelope a partir do modelo.
ID de utilizador	template.templateCreatedBy.partyId	integer	O ID exclusivo do usuário.
Nome Próprio	template.templateCreatedBy.firstName	string	O primeiro nome do usuário.
Apelido	template.templateCreatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateCreatedBy.emailId	string	O endereço de correio eletrónico do utilizador.
Campos Template	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	O ID do modelo a que este campo pertence.
ID da Empresa	allfields.companyId	integer	A conta da empresa a que pertence esta área.
Tipo de campo	allfields.fieldType	string	O tipo do campo (por exemplo, campo de sinal, campo inicial, campo de texto, campo de data, campo de verificação, campo seguro, campo anexo).
Número da página	allfields.documentPageNumber	integer	O número de página do documento onde este campo está colocado.
Parte responsável	allfields.partyResponsible	integer	O número de sequência do grupo responsável por preencher este campo.
Sequência da Festa	allfields.partyResponsibleSequence	integer	A posição de sequência da parte responsável.
ID do Documento de Campo	allfields.docFieldId	string	O identificador ao nível do documento para este campo.
É dependente	allfields.dependent	boolean	Indica se a visibilidade deste campo depende do valor de outro campo.
Ordem de tablatura	allfields.tabOrder	integer	A ordem de tabulação para navegar entre campos.
Obrigatório	allfields.required	boolean	Indica se este campo deve ser preenchido antes de o documento poder ser assinado.
Nome do campo personalizado	allfields.customFieldName	string	Um nome personalizado atribuído a este campo.
Partilhar Tudo	allfields.shareAll	boolean	Indica se este campo é partilhado com todos os utilizadores.
Permitir edição	allfields.allowEdit	boolean	Indica se este campo pode ser editado pelo destinatário.
Nome do campo do texto	allfields.textfieldName	string	O rótulo do campo de texto (aplicável quando fieldType é 'textfield').
Value	allfields.value	string	O valor pré-preenchido ou introduzido do campo.
Tamanho da fonte	allfields.fontSize	integer	O tamanho da fonte usado para o texto nesta área.
Cor do Tipo de Letra	allfields.fontColor	string	A cor da fonte usada para o texto neste campo (por exemplo, #000000).
Somente leitura	allfields.readOnly	boolean	Indica se o campo é apenas leitura e não pode ser editado pelo destinatário.
Multi Line	allfields.multiLine	boolean	Indica se o campo de texto aceita várias linhas de entrada (aplicável quando o 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 data (aplicável quando campoTipo é 'campo data').
Formato de data	allfields.dateFormat	string	O formato de data utilizado por este campo (por exemplo, MM/DD/YYYY) (aplicável quando o Typede de campo é 'campo de data').
Nome da Caixa de Seleção	allfields.cbname	string	O rótulo do campo de checkbox (aplicável quando fieldType é 'checkboxfield').
Grupo de Caixa de Seleção	allfields.cbgroup	string	O nome do grupo para esta caixa de seleção (aplicável quando fieldType é 'checkboxfield').
Verificado	allfields.checked	boolean	Indica se a caixa de seleção está assinalada por defeito (aplicável quando o fieldType é 'checkboxfield').
Nome do Campo Assegurado	allfields.securedfieldName	string	O rótulo do campo protegido (aplicável quando o campo Tipo é 'campo seguro').
Personagens para Exibir	allfields.charToDisplay	integer	O número de caracteres não mascarados a mostrar no final de um valor de campo seguro (aplicável quando o FieldType é 'campo seguro').
ID da assinatura	allfields.signatureId	string	O ID da assinatura aplicado a este campo de sinal (aplicável quando o Typede do Campo é 'campo de sinal').
Imagem Inicial	allfields.initialImage	string	Os dados da imagem para as iniciais aplicam-se a este campo (aplicável quando o fieldType é 'initialfield').
Nome do Campo de Anexo	allfields.attachmentfieldName	string	O nome do campo de anexo (aplicável quando o campo Tipo é 'campo de anexo').
Descrição do Anexo	allfields.attachmentfieldDescription	string	Uma descrição do que anexar (aplicável quando o fieldType é 'attachmentfield').

Descarregar Ficheiros de Envelope

ID da Operação:

DownloadEnvelopeFiles

Descarrega os documentos concluídos de um envelope como ficheiro.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Envelope ID	folderId	True	string	O identificador único do envelope cujos documentos quer descarregar.

Devoluções

response

binary

Descarregar PDF de Documento Único

ID da Operação:

DownloadSingleDocumentPDF

Descarrega um único documento de um envelope em formato PDF.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Envelope ID	folderId	True	string	O identificador único do envelope que contém o documento a descarregar.
Número do documento	docNumber	True	string	O índice do documento a descarregar, começando em 1.

Devoluções

response

binary

Descarregar Relatório

ID da Operação:

DownloadReport

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
envelopeStatus	status		string	Os estados da pasta pela qual iremos filtrar um relatório
Data de Criação	creationDateFrom		string	Início do intervalo de datas de criação. Formato aceite: YYYY-MM-DD.
Data de Criação até	creationDateTo		string	Fim do intervalo de datas de criação. Formato aceite: YYYY-MM-DD.
Nome do envelope	folderName		string	Qualquer pasta que contenha esta cadeia.
Incluir campos	includeFields		string	Defina para 'true' para incluir os valores do campo envelope no relatório. Por defeito, é 'falso'.
Email do Autor	authorEmail		string	Filtre o relatório para incluir apenas envelopes criados pelo endereço de email deste autor.
E-mail do signatário	signerEmail		string	Filtre o relatório para incluir apenas envelopes onde este endereço de email seja um signatário.

Devoluções

Ficheiro de Relatório

binary

Enviar Lembrete de Assinatura

ID da Operação:

SendSignatureReminder

Envia uma notificação de lembrete aos destinatários pendentes de um envelope, incentivando-os a terminar a assinatura.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Envelope ID	folderId	True	integer	O ID do envelope.

Devoluções

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

Listar todos os canais Webhook

ID da Operação:

ListallWebhookChannels

Devolve uma lista de todos os canais webhook configurados na sua conta.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
Total de Canais	total_channel	integer	O número total de canais webhook configurados na conta.
Canais Webhook	templatesList	array of object	A lista de todos os canais de webhook na conta.
ID do canal	templatesList.channelId	integer	O identificador único do canal webhook.
ID da Empresa	templatesList.companyId	integer	A conta da empresa a que este canal pertence.
Nome do Canal	templatesList.channelName	string	O nome do canal webhook.
Webhook URL	templatesList.webhookUrl	string	O URL que o Foxit eSign chamará quando ocorrer um evento subscrito.
Webhook Secret	templatesList.webhookSecret	string	A chave secreta usada para verificar as cargas úteis do webhook.
Data de Criação	templatesList.dateCreated	integer	A data em que o canal foi criado, em milissegundos Unix.
Data de atualização	templatesList.dateUpdated	integer	A data em que o canal foi atualizado pela última vez, em milissegundos Unix.
Nível Webhook	templatesList.webhookLevel	string	O âmbito do canal webhook. Ou 'Account' (ativa-se para todos os envelopes) ou 'API App' (dispara apenas para envelopes criados via API).
Situação	templatesList.status	string	O estado atual do canal. Ou 'ativo' ou 'deativo'.
Envelope enviado	templatesList.eventsSubscribedMap.folder_sent	boolean	Desencadeia quando um envelope é enviado aos destinatários.
Envelope Vista	templatesList.eventsSubscribedMap.folder_viewed	boolean	Ativa-se quando um envelope é aberto por um destinatário.
Envelope Assinado	templatesList.eventsSubscribedMap.folder_signed	boolean	Ativa-se quando um envelope é assinado por um destinatário.
Envelope Cancelado	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Desencadeia quando um envelope é cancelado.
Envelope Executado	templatesList.eventsSubscribedMap.folder_executed	boolean	Desencadeia quando todas as partes assinam e o envelope está totalmente executado.
Envelope Eliminado	templatesList.eventsSubscribedMap.folder_deleted	boolean	Ativa-se quando um envelope é eliminado.

Mover envelopes para o Contentor de Reciclagem

ID da Operação:

MoveEnvelopestoRecycleBin

Move um ou mais envelopes para o contentor de reciclagem. Os envelopes no contentor de reciclagem não são eliminados permanentemente.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Ids de pastas	folderIds	True	array of integer	Um conjunto de IDs de envelope para agir.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a operação teve sucesso.

Obtenha Detalhes do Canal Webhook

ID da Operação:

GetWebhookChannelDetails

Recupera os detalhes de um canal webhook específico.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do canal	channelId	True	string	O identificador único do canal webhook a recuperar.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
ID	channel.channelId	integer	O identificador único do canal webhook.
ID da Empresa	channel.companyId	integer	A conta da empresa a que este canal pertence.
Nome	channel.channelName	string	O nome do canal webhook.
Webhook URL	channel.webhookUrl	string	O URL que o Foxit eSign chamará quando ocorrer um evento subscrito.
Webhook Secret	channel.webhookSecret	string	A chave secreta usada para verificar as cargas úteis do webhook.
Data de Criação	channel.dateCreated	integer	A data em que o canal foi criado, em milissegundos Unix.
Data de atualização	channel.dateUpdated	integer	A data em que o canal foi atualizado pela última vez, em milissegundos Unix.
Nível Webhook	channel.webhookLevel	string	O âmbito do canal webhook. Ou 'Account' (ativa-se para todos os envelopes) ou 'API App' (dispara apenas para envelopes criados via API).
Situação	channel.status	string	O estado atual do canal. Ou 'ativo' ou 'deativo'.
Envelope enviado	channel.eventsSubscribedMap.folder_sent	boolean	Desencadeia quando um envelope é enviado aos destinatários.
Envelope Vista	channel.eventsSubscribedMap.folder_viewed	boolean	Ativa-se quando um envelope é aberto por um destinatário.
Envelope Assinado	channel.eventsSubscribedMap.folder_signed	boolean	Ativa-se quando um envelope é assinado por um destinatário.
Envelope Cancelado	channel.eventsSubscribedMap.folder_cancelled	boolean	Desencadeia quando um envelope é cancelado.
Envelope Executado	channel.eventsSubscribedMap.folder_executed	boolean	Desencadeia quando todas as partes assinam e o envelope está totalmente executado.
Envelope Eliminado	channel.eventsSubscribedMap.folder_deleted	boolean	Ativa-se quando um envelope é eliminado.

Obtenha Detalhes do Envelope

ID da Operação:

GetEnvelopeDetails

Recupera todos os detalhes de um envelope, incluindo o seu estado, destinatários e documentos.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Envelope ID	folderId	True	integer	O identificador único do envelope a recuperar.
Token de Acesso	access_token		string	O token de acesso OAuth 2.0 para autenticação.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a operação teve sucesso (por exemplo, 'sucesso').
ID	folder.folderId	integer	O ID único do envelope.
Nome	folder.folderName	string	O nome do envelope.
ID do autor	folder.folderAuthorId	integer	O ID único do utilizador que criou o envelope.
Primeiro Nome do Autor	folder.folderAuthorFirstName	string	O primeiro nome do criador do envelope.
Apelido do Autor	folder.folderAuthorLastName	string	O apelido do criador do envelope.
Email do Autor	folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Papel do autor	folder.folderAuthorRole	string	O papel da conta do criador do envelope.
ID da Empresa	folder.folderCompanyId	integer	O ID único da empresa a que pertence o envelope.
Data de criação	folder.folderCreationDate	integer	A data e hora em que o envelope foi criado, em milissegundos Unix.
Data de envio	folder.folderSentDate	integer	A data e hora em que o envelope foi enviado aos destinatários, em milissegundos Unix. Nulo se ainda não foi enviado.
Situação	folder.folderStatus	string	O estado atual do envelope (ex.: PARTILHADO, EXECUTADO, RASCUNHO, CANCELADO).
Identificadores de Documento	folder.folderDocumentIds	array of integer	A lista de IDs de documentos incluída neste envelope.
Documents	folder.documentsList	array of object	Detalhes de cada documento incluídos no envelope.
ID do documento	folder.documentsList.documentId	integer	O identificador exclusivo do documento.
ID do contrato	folder.documentsList.contractId	integer	O identificador único do contrato associado a este documento.
ID da Empresa	folder.documentsList.companyId	integer	O ID único da empresa a que este documento pertence.
Criado por	folder.documentsList.contractCreatedBy	integer	O ID de utilizador da pessoa que criou o contrato.
Criado em	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.
Estado do documento	folder.documentsList.contractStatus	string	O estado atual de assinatura do documento (por exemplo, WAITING_FOR_SIGNATURE, EXECUTADO).
Editável	folder.documentsList.editable	boolean	Indica se o documento pode ser editado.
ID da versão	folder.documentsList.contractVersionId	integer	O ID único 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	O ID de utilizador 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 da versão	folder.documentsList.contractVersionNumber	integer	O número da versão do documento.
Destinatários	folder.folderRecipientParties	array of object	A lista dos destinatários deste envelope, incluindo o seu estado 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.
Nome Próprio	folder.folderRecipientParties.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	folder.folderRecipientParties.partyDetails.lastName	string	O apelido do destinatário.
Email	folder.folderRecipientParties.partyDetails.emailId	string	O endereço de e-mail do destinatário.
Morada	folder.folderRecipientParties.partyDetails.address	string	A morada 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.
Permissions	folder.folderRecipientParties.contractPermissions	string	As permissões de assinatura concedidas a este destinatário (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	folder.folderRecipientParties.partySequence	integer	A posição deste destinatário na ordem de assinatura.
Sequência de Fluxo de Trabalho	folder.folderRecipientParties.workflowSignSequence	integer	O número de sequência de assinatura do fluxo de trabalho para este destinatário.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	O ID do envelope a que este destinatário pertence.
Modo de Partilha	folder.folderRecipientParties.sharingMode	string	O método utilizado para partilhar o documento com este destinatário (por exemplo, email).
URL de assinatura	folder.folderRecipientParties.folderAccessURL	string	O URL de assinatura único para este destinatário. Nulo se o envelope já tiver sido preenchido ou cancelado.
Modo de Segurança	folder.folderRecipientParties.securityMode	string	O modo de segurança aplicava-se ao acesso deste destinatário.
Comentários Extra	folder.folderRecipientParties.extraComments	string	Quaisquer comentários adicionais incluídos no convite de assinatura para este destinatário.
URL de Acesso ao Autor	folder.folderAccessURLForAuthor	string	O URL do autor do envelope para aceder ao documento. Nulo se não for aplicável.
ID em massa	folder.bulkId	integer	O ID do lote de envio em massa a que este envelope pertence, se é que existe.
Fazer cumprir a Ordem de Sinalização	folder.enforceSignWorkflow	boolean	Indica se os destinatários devem assinar na ordem especificada.
Etapa do Fluxo de Trabalho Atual	folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Fonte da Transação	folder.transactionSource	string	A fonte que iniciou esta transação de envelope.
Editável	folder.editable	boolean	Indica se o envelope ainda pode ser editado.
In-Person Assinatura	folder.inPersonSignable	boolean	Indica se o envelope pode ser assinado pessoalmente.
Lembretes de Sobreposição	folder.overrideAccountReminders	boolean	Indica se as definições de lembrete ao nível da conta foram sobrepostas para este envelope.
ID	folder.envelopeId	integer	O ID único do envelope. Mesmo valor que o ID do envelope (folderId).
Nome	folder.envelopeName	string	O nome do envelope. Mesmo valor que Nome do Envelope (NomeFolderName).
ID do originador	folder.envelopeOriginatorId	integer	O ID de utilizador da pessoa que criou o envelope.
ID da Empresa	folder.envelopeCompanyId	integer	O documento de identificação da empresa a que pertence o envelope.
Date	folder.envelopeDate	integer	A data e hora em que o envelope foi criado, em milissegundos Unix.
Data Partilhada	folder.envelopeSharedDate	integer	A data e hora em que o envelope era partilhado com os destinatários, em milissegundos Unix. Nulo se ainda não partilhado.
Situação	folder.envelopeStatus	string	O estado atual do envelope. O mesmo valor que o Estado do Envelope (PastaStatus).
IDs de contrato	folder.envelopeContractIds	array of integer	A lista de IDs de contrato associados a este envelope.
Permissões de Partido	folder.envelopePartyPermissions	array of object	A lista dos destinatários e as suas permissões de assinatura. Mesma estrutura que os Recipientes.
ID do destinatário	folder.envelopePartyPermissions.partyId	integer	O identificador exclusivo do destinatário.
Nome Próprio	folder.envelopePartyPermissions.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	folder.envelopePartyPermissions.partyDetails.lastName	string	O apelido do destinatário.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	O endereço de e-mail do destinatário.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	As permissões de assinatura para este destinatário.
Ordem de Assinatura	folder.envelopePartyPermissions.partySequence	integer	A posição deste destinatário na ordem de assinatura.
URL de assinatura	folder.envelopePartyPermissions.folderAccessURL	string	O URL de assinatura único 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	O ID do documento a que este campo pertence.
ID da versão	allFields.versionId	integer	O ID da versão do documento a que este campo pertence.
Tipo de campo	allFields.fieldType	string	O tipo do campo (por exemplo, campo de sinal, campo de texto, campo de data, campo de verificação, campo de descida, campo inicial).
Número da página	allFields.documentPageNumber	integer	O número da página onde este campo está colocado.
ID do Documento de Campo	allFields.docFieldId	string	O identificador ao nível do documento para este campo.
Parte responsável	allFields.partyResponsible	integer	O ID do grupo responsável por preencher este campo.
É dependente	allFields.dependent	boolean	Indica se a visibilidade deste campo depende do valor de outro campo.
Obrigatório	allFields.required	boolean	Indica se este campo deve ser preenchido antes de o documento poder ser submetido.
Valor de 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 campos e os seus valores atuais. Use isto para ler dados de campos preenchidos a partir de um envelope assinado.
ID do campo	allFieldsNameValue.fieldId	integer	O identificador exclusivo do campo.
ID do documento	allFieldsNameValue.documentId	integer	O ID do documento a que este campo pertence.
ID da versão	allFieldsNameValue.documentVersionId	integer	O ID da versão do documento a que este campo pertence.
Tipo de campo	allFieldsNameValue.fieldType	string	O tipo do campo (por exemplo, campo de texto, campo de sinal, campo de data, campo de seleção, campo de descida).
Nome do campo	allFieldsNameValue.name	string	O rótulo ou nome do campo conforme definido no modelo.
Valor de Campo	allFieldsNameValue.value	string	O valor introduzido ou selecionado para este campo.
História do envelope	Folder History	array of object	O registo de auditoria de todas as ações tomadas neste envelope, por ordem cronológica.
Nome Próprio	Folder History.firstName	string	O primeiro nome da pessoa que realizou a ação.
Apelido	Folder History.lastName	string	O apelido da pessoa que realizou a ação.
Email	Folder History.email	string	O endereço de email da pessoa que realizou a ação.
Envelope ID	Folder History.envelopeId	integer	O ID do envelope onde a ação foi realizada.
Date	Folder History.dateChanged	integer	A data e hora em que a ação ocorreu, em milissegundos Unix.
ID da Parte	Folder History.changeDoneByParty	integer	O ID do partido da pessoa que realizou a ação.
Action	Folder History.action	string	A ação realizada no envelope (por exemplo, Criado, Enviado, Aceitado, Assinado, Executado).

Obtenha Detalhes do Grupo de Email

ID da Operação:

GetEmailGroupDetails

Recupera detalhes de um grupo de email existente.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nomes de Grupos de Email	emailGroupNames	True	array of string	Uma variedade de nomes de grupos de email usados para identificar os grupos.

Devoluções

Name	Caminho	Tipo	Descrição
Grupos de Email	allEmailGroups	array of object	A lista de grupos de email que correspondem aos nomes dos grupos pedidos.
ID do grupo	allEmailGroups.groupId	integer	O identificador único 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 a que pertence este grupo de email.
Parties	allEmailGroups.parties	array of object	A lista de destinatários neste grupo de email.
Nome Próprio	allEmailGroups.parties.firstName	string	O primeiro nome do destinatário.
Apelido	allEmailGroups.parties.lastName	string	O sobrenome do destinatário.
Email	allEmailGroups.parties.emailId	string	O endereço de e-mail do destinatário.

Obtenha Detalhes do Modelo

ID da Operação:

GetTemplateDetails

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do modelo	templateId	True	string	O identificador único do modelo a recuperar.

Devoluções

Name	Caminho	Tipo	Descrição
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.
Descrição	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 partidos	template.numberOfParties	integer	O número de partes signatárias definidas no modelo.
Total de Páginas	template.totalPages	integer	O número total de páginas no documento modelo.
ID da Empresa	template.companyId	integer	A conta da empresa a que pertence o modelo.
Partilhar com Todos	template.shareAll	boolean	Indica se o modelo é partilhado com todos os utilizadores da conta.
Padrão de Nome Personalizado	template.templateCustomName	string	O padrão personalizado de nomes aplicava-se a envelopes criados a partir deste modelo.
Permissões de Partido	template.templatePartyPermissions	array of object	A lista de funções dos destinatários e as suas permissões de assinatura definidas neste modelo.
ID da Parte	template.templatePartyPermissions.template_party_id	integer	O ID único desta entrada modelo de festa.
ID	template.templatePartyPermissions.templateId	integer	O ID do modelo a que este partido pertence.
Permissions	template.templatePartyPermissions.templatePermissions	string	As permissões de assinatura para esta parte (por exemplo, FILL_FIELDS_AND_SIGN).
Ordem de Assinatura	template.templatePartyPermissions.partySequence	integer	A posição da ordem de assinatura para este partido.
Papel do Partido	template.templatePartyPermissions.templatePartyRole	string	O nome do papel atribuído a este grupo. Use este valor ao criar um envelope a partir deste modelo.
ID da Parte	template.templatePartyPermissions.partyId	integer	O ID da parte atribuída a esta função, se pré-atribuído.
ID da Parte	template.templateCreatedBy.partyId	integer	O identificador único do utilizador.
Nome Próprio	template.templateCreatedBy.firstName	string	O primeiro nome do usuário.
Apelido	template.templateCreatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateCreatedBy.emailId	string	O endereço de e-mail do utilizador.
Departamento	template.templateCreatedBy.department	string	O departamento do utilizador.
Título	template.templateCreatedBy.title	string	O cargo do usuário.
Active	template.templateCreatedBy.active	boolean	Indica se a conta de utilizador está ativa.
ID da Parte	template.templateLastUpdatedBy.partyId	integer	O identificador único do utilizador.
Nome Próprio	template.templateLastUpdatedBy.firstName	string	O primeiro nome do usuário.
Apelido	template.templateLastUpdatedBy.lastName	string	O sobrenome do usuário.
Email	template.templateLastUpdatedBy.emailId	string	O endereço de e-mail do utilizador.
Departamento	template.templateLastUpdatedBy.department	string	O departamento do utilizador.
Título	template.templateLastUpdatedBy.title	string	O cargo do usuário.
Active	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 Etiqueta de Campo	allfields.fieldTagId	integer	O identificador exclusivo do campo.
ID do modelo	allfields.templateId	integer	O ID do modelo a que este campo pertence.
ID da Empresa	allfields.companyId	integer	A conta da empresa a que pertence esta área.
Tipo de campo	allfields.fieldType	string	O tipo do campo (por exemplo, campo de sinal, campo inicial, campo de texto, campo de data, campo de verificação, campo seguro, campo anexo).
Número da página	allfields.documentPageNumber	integer	O número de página do documento onde este campo está colocado.
Partido Responsável	allfields.partyResponsible	integer	O número de sequência do grupo responsável por completar este campo.
Sequência da Festa	allfields.partyResponsibleSequence	integer	A posição de sequência da parte responsável.
ID de campo do Doc	allfields.docFieldId	string	O identificador deste campo dentro do documento.
Dependente	allfields.dependent	boolean	Indica se a visibilidade deste campo depende do valor de outro campo.
Ordem de tablatura	allfields.tabOrder	integer	A ordem de tabulação para navegar entre campos.
Obrigatório	allfields.required	boolean	Indica se este campo deve ser preenchido antes de o documento poder ser assinado.
Nome do campo personalizado	allfields.customFieldName	string	Um nome personalizado atribuído a este campo.
Partilhar Tudo	allfields.shareAll	boolean	Indica se este campo é partilhado com todos os utilizadores.
Permitir edição	allfields.allowEdit	boolean	Indica se este campo pode ser editado pelo destinatário.
Nome do campo do texto	allfields.textfieldName	string	O rótulo do campo de texto (aplicável quando fieldType é 'textfield').
Value	allfields.value	string	O valor pré-preenchido ou introduzido do campo.
Tamanho da fonte	allfields.fontSize	integer	O tamanho da fonte usado para o texto nesta área.
Cor do Tipo de Letra	allfields.fontColor	string	A cor da fonte usada para o texto neste campo (por exemplo, #000000).
Somente leitura	allfields.readOnly	boolean	Indica se o campo é apenas leitura e não pode ser editado pelo destinatário.
Multi Line	allfields.multiLine	boolean	Indica se o campo de texto aceita várias linhas de entrada (aplicável quando o 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 data (aplicável quando campoTipo é 'campo data').
Formato de data	allfields.dateFormat	string	O formato de data utilizado por este campo (por exemplo, MM/DD/YYYY) (aplicável quando o Typede de campo é 'campo de data').
Nome da Caixa de Seleção	allfields.cbname	string	O rótulo do campo de checkbox (aplicável quando fieldType é 'checkboxfield').
Grupo de Caixa de Seleção	allfields.cbgroup	string	O nome do grupo para esta caixa de seleção, usado quando múltiplas caixas de seleção estão ligadas (aplicável quando fieldType é 'checkboxfield').
Verificado	allfields.checked	boolean	Indica se a caixa de seleção está assinalada por defeito (aplicável quando o fieldType é 'checkboxfield').
Nome do Campo Assegurado	allfields.securedfieldName	string	O rótulo do campo protegido (aplicável quando o campo Tipo é 'campo seguro').
Personagens para Exibir	allfields.charToDisplay	integer	O número de caracteres não mascarados a mostrar no final de um valor de campo seguro (aplicável quando o FieldType é 'campo seguro').
ID da assinatura	allfields.signatureId	string	O ID da assinatura aplicado a este campo de sinal (aplicável quando o Typede do Campo é 'campo de sinal').
Imagem Inicial	allfields.initialImage	string	Os dados da imagem para as iniciais aplicam-se a este campo (aplicável quando o fieldType é 'initialfield').
Nome do Campo de Anexo	allfields.attachmentfieldName	string	O nome do campo de anexo (aplicável quando o campo Tipo é 'campo de anexo').
Descrição do Anexo	allfields.attachmentfieldDescription	string	Uma descrição do que anexar (aplicável quando o fieldType é 'attachmentfield').

Obtenha Histórico de Atividades do Envelope

ID da Operação:

GetEnvelopeActivityHistory

Recupera um registo completo de atividade de um envelope, mostrando todas as ações tomadas pelos destinatários e pelo remetente.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Envelope ID	folderId	True	integer	O identificador único do envelope cujo histórico de atividade quer recuperar.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
Envelope ID	details.folderId	integer	O identificador único do envelope.
Documentos anexos	details.enclosedDocuments	string	O nome do(s) documento(s) incluído(s) no envelope.
Destinatários	details.envelopeRecipients	string	Os nomes de todos os destinatários no envelope.
Author	details.author	string	O nome do utilizador que criou o envelope.
Situação	details.status	string	O estado atual do envelope (por exemplo, PARTILHADO, EXECUTADO, CANCELADO).
Data de Atividade Recente	details.latestActivityDate	string	A data e hora da atividade mais recente no envelope.
Data de Criação	details.dateCreated	string	A data e hora em que o envelope foi criado.
Data de envio	details.dateSent	string	A data e 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 para humanos da ação que ocorreu.
Action	details.activities.action	string	O tipo de ação realizada (por exemplo, Criada, Convite Enviado, Aberto, Visualizado, Assinado).
User	details.activities.user	string	O nome do utilizador que realizou a ação.
Estado do envelope	details.activities.folderStatus	string	O estado do envelope na altura em que esta ação ocorreu.
Time	details.activities.time	string	A data e hora da ação ocorreu.
Source	details.activities.source	string	A fonte de onde a ação foi realizada (por exemplo, Web).
Endereço IP	details.activities.ipAddress	string	O endereço IP a partir do qual a ação foi realizada, se disponível.

Obtenha IDs de envelopes

ID da Operação:

GetEnvelopeIds

Devolve uma lista de IDs de envelopes filtrados por estado. Usa isto para encontrar envelopes num estado específico.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Data de	dateFrom	True	string	Início do intervalo de datas de criação do envelope. Formato aceite: YYYY-MM-DD.
Data para	dateTo	True	string	Fim do intervalo de datas de criação do envelope. Formato aceite: YYYY-MM-DD. A data de avaliação deve ser dentro de 6 meses após a data de valor.
Situação	status		string	Filtra os envelopes por estado. Valores aceites: EXECUTADO, PARTILHADO, RASCUNHADO, PARCIALMENTE ASSINADO, CANCELADO, EXPIRADO, ELIMINADO. Se forem omitidos, envelopes com qualquer estado são devolvidos.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
Message	message	string	Uma mensagem resumo a indicar quantos IDs de envelope foram devolvidos.
Envelope IDs	allFolderIds	array of integer	A lista de IDs de envelope que correspondem aos critérios do filtro. Use estes IDs com Obter Detalhes do Envelope para obter a informação completa do envelope.

Obtenha Modelos por Ids de Modelos

ID da Operação:

GetTemplatesbyTemplateIds

Recupera detalhes de um ou mais modelos pelos seus IDs.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Template Ids	templateIds	True	array of integer	Um conjunto de IDs de modelo para recuperar.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
Modelos Totais	total_templates	integer	O número total de modelos devolvidos.
Lista de Modelos	templateIdList	object	Um mapa dos dados do modelo indexado pelo ID do modelo. Cada entrada contém os detalhes do modelo e os seus campos.

Obtenha uma lista de todos os Modelos

ID da Operação:

GetalistofallTemplates

Devolve uma lista de todos os modelos disponíveis na sua conta.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
Modelos Totais	total_templates	integer	O número total de modelos na 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 este ID com Criar Envelope a partir 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 partidos	templatesList.numberOfParties	integer	O número de partes signatárias definidas no modelo.
ID da Empresa	templatesList.companyId	integer	A conta da empresa a que pertence o modelo.
Partilhar com Todos	templatesList.shareAll	boolean	Indica se o modelo é partilhado com todos os utilizadores da conta.
ID da Parte	templatesList.templateCreatedBy.partyId	integer	O identificador único do utilizador.
Nome Próprio	templatesList.templateCreatedBy.firstName	string	O primeiro nome do usuário.
Apelido	templatesList.templateCreatedBy.lastName	string	O sobrenome do usuário.
Email	templatesList.templateCreatedBy.emailId	string	O endereço de e-mail do utilizador.
ID da Parte	templatesList.templateLastUpdatedBy.partyId	integer	O identificador único do utilizador.
Nome Próprio	templatesList.templateLastUpdatedBy.firstName	string	O primeiro nome do usuário.
Apelido	templatesList.templateLastUpdatedBy.lastName	string	O sobrenome do usuário.
Email	templatesList.templateLastUpdatedBy.emailId	string	O endereço de e-mail do utilizador.

Obter Histórico de Envelopes Eliminados

ID da Operação:

GetDeletedEnvelopeHistory

Recupera um histórico de envelopes que foram apagados ou movidos para o contentor de reciclagem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Envelope ID	folderId	True	string	O identificador único do envelope cujo histórico de eliminação quer recuperar.

Devoluções

Name	Caminho	Tipo	Descrição
Result	result	string	Indica se a solicitação foi bem-sucedida.
Informação do Envelope Eliminado	Deleted Folder Log Info	array of object	Informação resumida sobre o envelope eliminado.
Envelope ID	Deleted Folder Log Info.folderId	integer	O identificador único do envelope apagado.
Nome do envelope	Deleted Folder Log Info.folderName	string	O nome do envelope apagado.
Nome do documento	Deleted Folder Log Info.documentName	string	O nome do documento no envelope apagado.
ID do documento	Deleted Folder Log Info.documentId	string	O identificador único do documento no envelope eliminado.
Data de eliminação	Deleted Folder Log Info.deletionDate	integer	A data e hora em que o envelope foi apagado, em milissegundos Unix.
Eliminado por	Deleted Folder Log Info.deletedBy	string	O nome do utilizador que apagou o envelope.
Histórico do Registo de Eliminação	Deleted Folder Log History	array of object	O registo passo a passo de todas as ações de eliminação realizadas no envelope.
Interpretado por	Deleted Folder Log History.partiesName	string	O nome do utilizador que realizou a etapa de eliminação.
Source	Deleted Folder Log History.source	string	A fonte a partir da qual a eliminação foi iniciada (por exemplo, Web, API).
Event	Deleted Folder Log History.event	string	A ação específica de eliminação realizada (por exemplo, Eliminar Pasta, Eliminar Todas as Partes da Pasta).

Acionadores

Quando um envelope é assinado	É ativado quando o destinatário assina o envelope.
Quando um envelope é cancelado	Desencadeia-se quando um envelope é cancelado por um destinatário ou pelo remetente.
Quando um envelope é eliminado	Ativa-se quando um envelope é eliminado.
Quando um envelope é enviado	Desencadeia quando um envelope é enviado aos destinatários. Este evento só é ativado quando o Nível Webhook está definido como 'Conta'.
Quando um envelope é totalmente executado	Desencadeia-se quando todos os destinatários assinam e o envelope está totalmente executado.
Quando um envelope é visualizado	Desencadeia quando o destinatário abre e vê o envelope.

Quando um envelope é assinado

ID da Operação:

TriggerEnvelopeSigned

É ativado quando o destinatário assina o envelope.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do Canal	channelName	True	string	Um nome para identificar esta subscrição do webhook na sua conta.
Nível Webhook	webhookLevel	True	string	Conta: dispara para todos os envelopes (web e API). App API: só funciona para envelopes criados via API.
Webhook Secret	webhookSecret		string	Optional. O Foxit eSign assina cada carga útil de webhook com o HMAC-SHA-256 usando este segredo para verificação.

Devoluções

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

WebhookEventPayload

WebhookEventPayload

Quando um envelope é cancelado

ID da Operação:

TriggerEnvelopeCancelled

Desencadeia-se quando um envelope é cancelado por um destinatário ou pelo remetente.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do Canal	channelName	True	string	Um nome para identificar esta subscrição do webhook na sua conta.
Nível Webhook	webhookLevel	True	string	Conta: dispara para todos os envelopes (web e API). App API: só funciona para envelopes criados via API.
Webhook Secret	webhookSecret		string	Optional. O Foxit eSign assina cada carga útil de webhook com o HMAC-SHA-256 usando este segredo para verificação.

Devoluções

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

WebhookEventPayload

WebhookEventPayload

Quando um envelope é eliminado

ID da Operação:

TriggerEnvelopeDeleted

Ativa-se quando um envelope é eliminado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do Canal	channelName	True	string	Um nome para identificar esta subscrição do webhook na sua conta.
Nível Webhook	webhookLevel	True	string	Conta: dispara para todos os envelopes (web e API). App API: só funciona para envelopes criados via API.
Webhook Secret	webhookSecret		string	Optional. O Foxit eSign assina cada carga útil de webhook com o HMAC-SHA-256 usando este segredo para verificação.

Devoluções

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

WebhookEventPayload

WebhookEventPayload

Quando um envelope é enviado

ID da Operação:

TriggerEnvelopeSent

Desencadeia quando um envelope é enviado aos destinatários. Este evento só é ativado quando o Nível Webhook está definido como 'Conta'.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do Canal	channelName	True	string	Um nome para identificar esta subscrição do webhook na sua conta.
Nível Webhook	webhookLevel	True	string	Conta: dispara envelopes enviados via web ou API. App API: só funciona para envelopes criados via API. O evento folder_sent só é ativado ao nível da Conta.
Webhook Secret	webhookSecret		string	Optional. O Foxit eSign assina cada carga útil de webhook com o HMAC-SHA-256 usando este segredo para verificação.

Devoluções

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

WebhookEventPayload

WebhookEventPayload

Quando um envelope é totalmente executado

ID da Operação:

TriggerEnvelopeExecuted

Desencadeia-se quando todos os destinatários assinam e o envelope está totalmente executado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do Canal	channelName	True	string	Um nome para identificar esta subscrição do webhook na sua conta.
Nível Webhook	webhookLevel	True	string	Conta: dispara para todos os envelopes (web e API). App API: só funciona para envelopes criados via API.
Webhook Secret	webhookSecret		string	Optional. O Foxit eSign assina cada carga útil de webhook com o HMAC-SHA-256 usando este segredo para verificação.

Devoluções

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

WebhookEventPayload

WebhookEventPayload

Quando um envelope é visualizado

ID da Operação:

TriggerEnvelopeViewed

Desencadeia quando o destinatário abre e vê o envelope.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome do Canal	channelName	True	string	Um nome para identificar esta subscrição do webhook na sua conta.
Nível Webhook	webhookLevel	True	string	Conta: dispara para todos os envelopes (web e API). App API: só funciona para envelopes criados via API.
Webhook Secret	webhookSecret		string	Optional. O Foxit eSign assina cada carga útil de webhook com o HMAC-SHA-256 usando este segredo para verificação.

Devoluções

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

WebhookEventPayload

WebhookEventPayload

Definições

WebhookEventPayload

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

Name	Caminho	Tipo	Descrição
Nome do evento	event_name	string	O nome do evento que disparou (por exemplo, folder_sent, folder_signed, folder_executed).
Data do Evento	event_date	integer	A data e hora do evento ocorreu (carimbo temporal do Unix em milissegundos).
ID	data.folder.folderId	integer	O ID único 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 palavra-passe de acesso para o envelope, se definida.
ID do criador	data.folder.folderAuthorId	integer	O ID de utilizador do criador do envelope.
Nome próprio do criador	data.folder.folderAuthorFirstName	string	O primeiro nome do criador do envelope.
Sobrenome do criador	data.folder.folderAuthorLastName	string	O apelido do criador do envelope.
E-mail do criador	data.folder.folderAuthorEmail	string	O endereço de email do criador do envelope.
Papel do Criador	data.folder.folderAuthorRole	string	O papel da conta do criador do envelope.
ID da Empresa	data.folder.folderCompanyId	integer	O ID da empresa que detém o envelope.
Data de criação	data.folder.folderCreationDate	integer	A data em que o envelope foi criado (carimbo de tempo Unix em milissegundos).
Data de envio	data.folder.folderSentDate	integer	A data em que o envelope foi enviado (carimbo Unix em milissegundos).
Situação	data.folder.folderStatus	string	O estado 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.
Metadados	data.folder.metadata	string	Metadados personalizados associados ao envelope.
Identificadores de Documento	data.folder.folderDocumentIds	array of integer	A lista de documentos de identificação no envelope.
Documents	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	O ID do contrato deste documento.
ID da Empresa	data.folder.documentsList.companyId	integer	O ID da empresa para este documento.
Criado por	data.folder.documentsList.contractCreatedBy	integer	O ID de utilizador da pessoa que criou o contrato.
Criado em	data.folder.documentsList.contractCreatedOn	integer	A data em que o contrato foi criado (carimbo de tempo Unix em milissegundos).
Tipo de Contrato	data.folder.documentsList.contractType	string	O tipo de contrato.
Estado do Contrato	data.folder.documentsList.contractStatus	string	O estado 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	O ID da versão do contrato.
Nome da Versão	data.folder.documentsList.contractVersionName	string	O nome da versão contratual.
Descrição da Versão	data.folder.documentsList.contractVersionDesc	string	Uma descrição da versão contratual.
Versão criada por	data.folder.documentsList.versionCreatedby	integer	O ID de utilizador da pessoa que criou esta versão.
Versão criada em	data.folder.documentsList.versionCreatedOn	integer	A data em que esta versão foi criada (carimbo temporal do Unix em milissegundos).
Número da versão	data.folder.documentsList.contractVersionNumber	integer	O número de versão do contrato.
Fonte 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	O ID único do destinatário.
Nome Próprio	data.folder.folderRecipientParties.partyDetails.firstName	string	O primeiro nome do destinatário.
Apelido	data.folder.folderRecipientParties.partyDetails.lastName	string	O apelido do destinatário.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	O endereço de e-mail do destinatário.
Placeholder	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Se isto é um destinatário provisório.
Morada	data.folder.folderRecipientParties.partyDetails.address	string	A morada do destinatário.
Data de Criação	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	A data em que o registo destinatário foi criado (carimbo de tempo Unix em milissegundos).
Emails de Exclusão	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Se o destinatário optou por não receber emails.
Identificador único	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Um identificador de sistema único para este destinatário.
Nível de Autenticação	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	O método de autenticação para este destinatário.
Data de atualização da palavra-passe	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A data em que a palavra-passe foi atualizada pela última vez.
Estado da palavra-passe	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Se a palavra-passe foi atualizada.
Código de discagem	data.folder.folderRecipientParties.dialingCode	string	O código internacional de discagem.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	O número de telemóvel do destinatário.
Tipo de assinatura	data.folder.folderRecipientParties.signerSignatureType	string	O tipo de assinatura que o signatário irá usar.
Permissions	data.folder.folderRecipientParties.contractPermissions	string	As permissões concedidas a este 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 de sequência de assinatura do fluxo de trabalho.
Envelope ID	data.folder.folderRecipientParties.envelopeId	integer	O ID do envelope associado a este destinatário.
ID da empresa destinatária	data.folder.folderRecipientParties.partyCompanyId	integer	O ID da empresa deste destinatário.
Modo de Partilha	data.folder.folderRecipientParties.sharingMode	string	O modo de partilha para este destinatário.
URL de assinatura do destinatário	data.folder.folderRecipientParties.folderAccessURL	string	O URL para este destinatário aceder e assinar o envelope.
Modo de Segurança	data.folder.folderRecipientParties.securityMode	string	O modo de segurança para este destinatário.
Comments	data.folder.folderRecipientParties.extraComments	string	Comentários adicionais para o destinatário.
Permitir Mudança de Nome	data.folder.folderRecipientParties.allowNameChange	boolean	Se o destinatário pode atualizar o seu nome.
Nome Atualizado	data.folder.folderRecipientParties.signerNameUpdated	boolean	Se o signatário atualizou o seu nome.
Nível Auth de Signer	data.folder.folderRecipientParties.signerAuthenticationLevel	string	O nível de autenticação exigido 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	O ID da assinatura aplicada.
Função	data.folder.folderRecipientParties.partyRole	string	O papel deste destinatário no fluxo de trabalho de assinatura.
Company Field	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 foi adicionado um campo de pagamento.
Beneficiário	data.folder.folderRecipientParties.payee	boolean	Se este beneficiário é o beneficiário.
Pagamento Recorrente	data.folder.folderRecipientParties.recurringFieldExist	boolean	Se existe um campo de pagamento recorrente.
Imprimir e Assinar Feito	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Se a impressão e assinatura está completa.
Signatário Opcional	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Se este destinatário é um signatário opcional.
Signatários Opcionais	data.folder.folderRecipientParties.optionalSigners	array of integer	IDs opcionais de parte de assinatura.
Paid	data.folder.folderRecipientParties.paid	boolean	Se o pagamento foi concluído.
URL de Acesso ao Autor	data.folder.folderAccessURLForAuthor	string	O URL para o autor do envelope aceder ao envelope.
URL de Acesso ao Rascunho	data.folder.draftFolderAccessURL	string	O URL para aceder ao envelope em estado de rascunho.
Sessão de Assinaturas na Sala de Administração	data.folder.boardRoomSign	boolean	Se o modo de assinatura na sala de reuniões está ativado.
Incluir logótipo	data.folder.includeLogo	boolean	Se o logótipo da empresa está incluído nos emails.
Cor de Fundo do Botão	data.folder.email_btnBgColor	string	A cor de fundo do botão de ação do email.
Cor do Texto do Botão	data.folder.email_btnTxtColor	string	A cor do texto do botão de ação do email.
Logótipo do Email	data.folder.emailTemplateLogo	string	A URL do logótipo usada no modelo de email.
ID do Modelo de Email	data.folder.emailTemplateId	integer	O ID do modelo de email utilizado.
Cabeçalho do Email	data.folder.emailHeader	string	O texto do cabeçalho nos emails de notificação.
Rodapé do Email	data.folder.emailFooter	string	O texto do rodapé nos emails de notificação.
Purga Agendada	data.folder.purgeFlag	boolean	Se o envelope está programado para purga.
Data de início da purga	data.folder.purgeStartDate	string	A data de início do calendário de purgas.
Data de Fim da Purga	data.folder.purgeEndDate	string	A data final do calendário de purgas.
ID em massa	data.folder.bulkId	integer	O ID da operação de envio em massa, se aplicável.
Fazer cumprir a Ordem de Sinalização	data.folder.enforceSignWorkflow	boolean	Se os destinatários têm de assinar na ordem definida.
Etapa do Fluxo de Trabalho Atual	data.folder.currentWorkflowStep	integer	A etapa atual no fluxo de trabalho de assinatura.
Fonte da Transação	data.folder.transactionSource	string	O sistema de origem que iniciou esta transação.
Editável	data.folder.editable	boolean	Se o envelope é editável.
In-Person Assinatura	data.folder.inPersonSignable	boolean	Se o envelope suporta a assinatura presencial.
Lembretes de Sobreposição	data.folder.overrideAccountReminders	boolean	Se as definições de lembrete ao nível da conta são sobrepostas.
Delegação de Sobreposição	data.folder.overrideAccountRecipientDelegation	boolean	Se as definições de delegação ao nível da conta são sobrepostas.
Permitir Delegação	data.folder.allowRecipientsToDelegate	boolean	Se os destinatários podem delegar a assinatura.
ID	data.folder.envelopeId	integer	O ID único do envelope (pseudónimo de folderId).
Nome	data.folder.envelopeName	string	O nome do envelope (alias de folderName).
ID do originador	data.folder.envelopeOriginatorId	integer	O ID de utilizador que originou o envelope.
ID da Empresa	data.folder.envelopeCompanyId	integer	O ID da empresa que detém o envelope.
Date	data.folder.envelopeDate	integer	A data em que o envelope foi criado (carimbo de tempo Unix em milissegundos).
Data Partilhada	data.folder.envelopeSharedDate	integer	A data em que o envelope foi partilhado (carimbo de tempo Unix em milissegundos).
Situação	data.folder.envelopeStatus	string	O estado atual do envelope.
IDs de contrato	data.folder.envelopeContractIds	array of integer	Os IDs do contrato associados a este envelope.
Permissões de Partido	data.folder.envelopePartyPermissions	array of object	A lista de permissões dos destinatários (mesma estrutura dos 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
Nome Próprio	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Apelido	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Placeholder	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Morada	data.folder.envelopePartyPermissions.partyDetails.address	string
Data de Criação	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Emails de Exclusão	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Identificador único	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Nível de Autenticação	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Data de atualização da palavra-passe	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Estado da palavra-passe	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
Permissions	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 destinatária	data.folder.envelopePartyPermissions.partyCompanyId	integer
Modo de Partilha	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 Mudança de Nome	data.folder.envelopePartyPermissions.allowNameChange	boolean
Nome Atualizado	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Nível Auth de Signer	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
Company Field	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 Feito	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Signatário Opcional	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Signatários Opcionais	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Paid	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.
Bloco de Signatários Únicos	data.folder.allowSingleSignerInBulk	boolean	Se um único signatário é permitido em modo em massa.
File-Based Nome da pasta	data.folder.folderNameBasedOnFileNaming	boolean
File-Based Nome do Doc	data.folder.documentNameBasedOnFileNaming	boolean
File-Based Nome do Certificado	data.folder.certificateNameBasedOnFileNaming	boolean
Nomenclatura de ficheiros pré-executivo	data.folder.enableFileNamingBeforeExecution	boolean
Acrescentou o beneficiário	data.folder.payeeAddedd	boolean
Self-Signing Ativado	data.folder.selfSignerEnabled	boolean
Notário Habilitado	data.folder.notaryEnabled	boolean
Visibilidade Limitada	data.folder.limitedVisibilityFlag	boolean
Visibilidade após a Placa	data.folder.postSigningVisibility	boolean
Assinatura Húmida	data.folder.wetSignatureEnabled	boolean
Fusão Ativada	data.folder.mergeEnabled	boolean

binário

Este é o tipo de dados básico 'binário'.