Adobe Acrobat Assinar

A Adobe é o serviço de assinatura de documentos digitais mais confiável do mundo. Com o Adobe Acrobat Sign, você pode transformar processos manuais em experiências totalmente digitais. Incorpore a funcionalidade Adobe Acrobat Sign em seus aplicativos favoritos para criar, enviar e monitorar o status dos contratos.

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

Serviço	Class	Regiões
Estúdio Copiloto	Standard	Todas as regiões do Power Automatic , exceto as seguintes: - 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 do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Standard	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Standard	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte do Adobe Acrobat Sign
URL	https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Email	support@echosign.zendesk.com

Metadados do conector
Editora	ADOBE INC.
Sítio Web	https://acrobat.adobe.com/us/en/sign.html
Política de privacidade	https://www.adobe.com/privacy/policy.html
Categorias	Sítio Web

Adobe Acrobat Assinar

Editora: Adobe, Inc.

Pré-requisitos

A conta do Adobe Acrobat Sign é necessária.

Como obter credenciais

N/A

Introdução ao conector

Guia do usuário do conector https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Problemas conhecidos e limitações

N/A

Erros e soluções comuns

N/A

FAQ

Guia do usuário do conector https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Limites de Limitação

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

Ações

Cancelar um contrato	Cancela o contrato identificado por agreementId no caminho.
Carregar um documento e obter um ID de documento	Esta operação carrega um documento na sua conta do Adobe Acrobat Sign e retorna uma ID de documento para ele. Este documento é armazenado temporariamente no Adobe Acrobat Sign e a ID do documento pode ser usada para outras operações, como a criação de um contrato.
Carregue um documento e obtenha um ID de documento (antigo) [PRETERIDO]	Esta operação carrega um documento na sua conta do Adobe Acrobat Sign e retorna uma ID de documento para ele. Este documento é armazenado temporariamente no Adobe Acrobat Sign e a ID do documento pode ser usada para outras operações, como a criação de um contrato.
Criar um contrato a partir de um documento carregado e enviar para assinatura	Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.
Criar um contrato a partir de um documento carregado e enviar para assinatura (Antigo) [PRETERIDO]	Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.
Criar um contrato a partir de um fluxo de trabalho e enviar para assinatura	Esta operação cria um contrato a partir de um fluxo de trabalho no Adobe Acrobat Sign e envia-o para assinatura.
Criar um contrato a partir de um modelo de biblioteca e enviar para assinatura	Esta operação cria um contrato a partir de um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.
Criar um contrato a partir de um modelo de biblioteca e enviar para assinatura (Antigo) [PRETERIDO]	Esta operação cria um contrato a partir de um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.
Criar um contrato a partir de um URL de documento e enviar para assinatura	Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.
Criar um contrato a partir de um URL de documento e enviar para assinatura (Antigo) [DEPRECATED]	Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.
Criar um contrato a partir do conteúdo de um arquivo e enviar para assinatura	Esta operação cria um contrato a partir de um arquivo no Adobe Acrobat Sign e o envia para assinatura.
Criar um modelo de biblioteca a partir de um documento carregado	Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um documento carregado. Use este modelo para enviar contratos.
Criar um modelo de biblioteca a partir de um documento carregado (Antigo) [PRETERIDO]	Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um documento carregado. Use este modelo para enviar contratos.
Criar um modelo de biblioteca a partir de um URL de documento	Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um URL de documento. Use este modelo para enviar contratos
Criar um modelo de biblioteca a partir de um URL de documento (antigo) [PRETERIDO]	Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um URL de documento. Use este modelo para enviar contratos
Obtenha uma lista de todos os contratos	Esta operação busca a lista de todos os contratos do usuário.
Obter as informações detalhadas do fluxo de trabalho	Esta operação obtém informações detalhadas sobre o fluxo de trabalho.
Obter dados de campo de formulário de acordo (Antigo) [PRETERIDO]	Recupera dados inseridos nos campos de formulário interativo do contrato.
Obter dados de campo de formulário de contrato em formato CSV	Recupera dados inseridos nos campos de formulário interativo do contrato.
Obter dados de campo de formulário de contrato no formato JSON	Recupera dados inseridos nos campos de formulário interativo do contrato.
Obter o status de um contrato	Esta operação busca todas as informações atuais de um contrato, como status.
Obter o status de um contrato [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Obter o status de um contrato . ~~Esta operação busca todas as informações atuais de um contrato, como status.~~
Obter o URL de visualização do contrato	Recupera a url de exibição de estado mais recente do contrato.
Obter um documento de um contrato	Esta operação busca o fluxo de arquivos de um documento específico do contrato.
Obter um documento de um contrato [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Obter um documento de um contrato . ~~Esta operação busca o fluxo de arquivos de um documento específico do contrato.~~
Obter um PDF da pista de auditoria do contrato	Esta operação busca o fluxo de arquivo PDF da trilha de auditoria do contrato. Observe que o fluxo de arquivos deve ser armazenado com um nome de arquivo que termina em .pdf extensão de arquivo.
Obter um PDF de um contrato assinado	Esta operação busca o fluxo de arquivos PDF do contrato combinado ou assinado. Observe que o fluxo de arquivos deve ser armazenado com um nome de arquivo que termina em .pdf extensão de arquivo.
Obter um PDF de um contrato assinado [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Obter um PDF de um contrato assinado . ~~Esta operação busca o fluxo de arquivos PDF do contrato combinado ou assinado. Observe que o fluxo de arquivos deve ser armazenado com um nome de arquivo que termina em .pdf extensão de arquivo.~~
Obter uma lista de todos os acordos (Antigo) [DEPRECATED]	Esta operação busca a lista de todos os contratos do usuário.
Obter uma lista de todos os acordos com base em critérios de pesquisa	Esta operação pesquisa acordos por critérios como ID do fluxo de trabalho, etc.
Obter uma lista de todos os fluxos de trabalho	Esta operação busca a lista de todos os fluxos de trabalho do usuário.
Obter uma lista de todos os formulários Web	Esta operação busca a lista de todos os formulários da Web do usuário.
Obter uma lista de todos os grupos aos quais o usuário pertence	Esta operação busca a lista de todos os grupos aos quais o usuário pertence.
Obter uma lista de todos os IDs de documentos de um contrato	Esta operação obtém os IDs de todos os documentos e documentos comprovativos de um contrato.
Obter uma lista de todos os IDs de documentos de um contrato [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Obter uma lista de todos os IDs de documentos de um contrato . ~~Esta operação obtém os IDs de todos os documentos e documentos comprovativos de um contrato.~~
Obter uma lista de todos os modelos de biblioteca	Esta operação busca a lista de todos os documentos armazenados como modelos na biblioteca do Adobe Acrobat Sign do usuário.
Obter uma lista de todos os modelos de biblioteca (Antigo) [PRETERIDO]	Esta operação busca a lista de todos os documentos armazenados como modelos na biblioteca do Adobe Acrobat Sign do usuário.
Recuperar o URL de assinatura	Esta operação recupera a URL da página de assinatura eletrônica do(s) signatário(s) atual(is) de um contrato.

Cancelar um contrato

ID da Operação:: CancelAgreement

Cancela o contrato identificado por agreementId no caminho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato que deve ser cancelado.
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Estado de Agrement	state		string	O estado em que o acordo deve aterrar.
Comment	comment		string	Um comentário opcional descrevendo o motivo do cancelamento para os destinatários.
Outros	notifyOthers		boolean	Se você gostaria ou não que os destinatários fossem notificados.

Carregar um documento e obter um ID de documento

ID da Operação:: CreateTransientDocument_V2

Esta operação carrega um documento na sua conta do Adobe Acrobat Sign e retorna uma ID de documento para ele. Este documento é armazenado temporariamente no Adobe Acrobat Sign e a ID do documento pode ser usada para outras operações, como a criação de um contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do arquivo	File-Name	True	string	O nome do documento a ser carregado, com extensão
Conteúdo do Ficheiro	File	True	contentOnly	O fluxo de arquivos do documento a ser carregado
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

Um JSON que contém a ID do documento carregado

Body: TransientDocumentResponse

Carregue um documento e obtenha um ID de documento (antigo) [PRETERIDO]

ID da Operação:: CreateTransientDocument

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do arquivo	File-Name	True	string	O nome do documento a ser carregado, com extensão
Conteúdo do Ficheiro	File	True	contentOnly	O fluxo de arquivos do documento a ser carregado

Devoluções

Um JSON que contém a ID do documento carregado

Body: TransientDocumentResponse

Criar um contrato a partir de um documento carregado e enviar para assinatura

ID da Operação:: CreateAgreementById_V2

Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome do contrato	name	True	string	O nome do contrato
ID	transientDocumentId	True	string	O ID do documento recebido ao carregar um documento transitório
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que pretende solicitar - assinatura eletrónica ou escrita
Email	email	True	string	O e-mail do participante
Authentication	authenticationMethod		string	Autenticação padrão: e-mail (Nenhum)
Palavra-passe	password		string	A palavra-passe necessária para o participante
Código do país	countryCode		string	Código do país do telefone do destinatário necessário para visualizar & assinar o documento
N.º de telefone	phone		string	Número de telefone do destinatário necessário para visualizar & assinar o contrato
ID do fornecedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Encomenda	order	True	integer	Índice começando com 1, indicando a posição em que o grupo de assinatura precisa assinar.
Funções	role	True	string	As funções atuais do conjunto de participantes (signatário, aprovador, etc.).
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários solicitando sua ação
Tipo de envio	sendType		string	Tipo de experiência utilizada pela entidade cedente para enviar um acordo
Email	email		string	O email do CC do acordo
Tempo de expiração	expirationTime		string	Prazo após o qual o Contrato expira. Exemplo: 2020-12-31T23:59:00Z
ID externo	externalId		string	Um valor arbitrário do seu sistema
Frequência do lembrete	reminderFrequency		string	Com que frequência pretende enviar lembretes?
Palavra-passe do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Valor	defaultValue		string	O valor padrão do campo
Atraso de redirecionamento	redirectDelay		string	O atraso (em segundos) antes que o usuário seja levado para a página de sucesso.
URL de redirecionamento	redirectUrl		string	URL para redirecionar depois de concluir o processo de assinatura, por exemplo: https://adobe.com
E-mails iniciais	initEmails		string	Controle e-mails de notificação para eventos de início de contrato.
Estado	state	True	string	O estado em que o acordo deve aterrar.

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponseV6

Criar um contrato a partir de um documento carregado e enviar para assinatura (Antigo) [PRETERIDO]

ID da Operação:: CreateAgreementById

Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do contrato	name	True	string	O nome do contrato
ID do documento	transientDocumentId	True	string	O ID do documento recebido ao carregar um documento
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que pretende solicitar - Assinatura eletrónica ou Escrita
E-mail do destinatário	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário	recipientSetRole	True	string	Especificar a função do destinatário
Message	message		string	Uma mensagem opcional para os destinatários solicitando sua ação
Dias para o prazo	daysUntilSigningDeadline		integer	O número de dias que faltam para o documento expirar
Frequência do lembrete	reminderFrequency		string	Com que frequência deseja enviar lembretes?
Palavra-passe do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
ID do documento (2)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (3)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (4)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (5)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (6)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (7)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (8)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (9)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (10)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
E-mail do destinatário (2)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (2)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (2)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (3)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (3)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (3)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (4)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (4)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (4)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (5)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (5)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (5)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (6)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (6)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (6)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (7)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (7)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (7)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (8)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (8)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (8)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (9)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (9)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (9)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (10)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (10)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (10)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (11)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (11)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (11)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (12)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (12)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (12)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (13)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (13)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (13)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (14)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (14)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (14)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (15)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (15)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (15)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (16)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (16)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (16)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (17)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (17)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (17)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (18)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (18)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (18)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (19)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (19)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (19)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (20)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (20)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (20)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (21)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (21)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (21)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (22)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (22)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (22)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (23)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (23)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (23)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (24)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (24)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (24)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (25)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (25)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (25)	recipientSetRole	True	string	Especificar a função do destinatário
Nome do campo de formulário (1)	fieldName		string	O nome do campo
Valor do campo de formulário (1)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (2)	fieldName		string	O nome do campo
Valor do campo de formulário (2)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (3)	fieldName		string	O nome do campo
Valor do campo de formulário (3)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (4)	fieldName		string	O nome do campo
Valor do campo de formulário (4)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (5)	fieldName		string	O nome do campo
Valor do campo de formulário (5)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (6)	fieldName		string	O nome do campo
Valor do campo de formulário (6)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (7)	fieldName		string	O nome do campo
Valor do campo de formulário (7)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (8)	fieldName		string	O nome do campo
Valor do campo de formulário (8)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (9)	fieldName		string	O nome do campo
Valor do campo de formulário (9)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (10)	fieldName		string	O nome do campo
Valor do campo de formulário (10)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (11)	fieldName		string	O nome do campo
Valor do campo de formulário (11)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (12)	fieldName		string	O nome do campo
Valor do campo de formulário (12)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (13)	fieldName		string	O nome do campo
Valor do campo de formulário (13)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (14)	fieldName		string	O nome do campo
Valor do campo de formulário (14)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (15)	fieldName		string	O nome do campo
Valor do campo de formulário (15)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (16)	fieldName		string	O nome do campo
Valor do campo de formulário (16)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (17)	fieldName		string	O nome do campo
Valor do campo de formulário (17)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (18)	fieldName		string	O nome do campo
Valor do campo de formulário (18)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (19)	fieldName		string	O nome do campo
Valor do campo de formulário (19)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (20)	fieldName		string	O nome do campo
Valor do campo de formulário (20)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (21)	fieldName		string	O nome do campo
Valor do campo de formulário (21)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (22)	fieldName		string	O nome do campo
Valor do campo de formulário (22)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (23)	fieldName		string	O nome do campo
Valor do campo de formulário (23)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (24)	fieldName		string	O nome do campo
Valor do campo de formulário (24)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (25)	fieldName		string	O nome do campo
Valor do campo de formulário (25)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (26)	fieldName		string	O nome do campo
Valor do campo de formulário (26)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (27)	fieldName		string	O nome do campo
Valor do campo de formulário (27)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (28)	fieldName		string	O nome do campo
Valor do campo de formulário (28)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (29)	fieldName		string	O nome do campo
Valor do campo de formulário (29)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (30)	fieldName		string	O nome do campo
Valor do campo de formulário (30)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (31)	fieldName		string	O nome do campo
Valor do campo de formulário (31)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (32)	fieldName		string	O nome do campo
Valor do campo de formulário (32)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (33)	fieldName		string	O nome do campo
Valor do campo de formulário (33)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (34)	fieldName		string	O nome do campo
Valor do campo de formulário (34)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (35)	fieldName		string	O nome do campo
Valor do campo de formulário (35)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (36)	fieldName		string	O nome do campo
Valor do campo de formulário (36)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (37)	fieldName		string	O nome do campo
Valor do campo de formulário (37)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (38)	fieldName		string	O nome do campo
Valor do campo de formulário (38)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (39)	fieldName		string	O nome do campo
Valor do campo de formulário (39)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (40)	fieldName		string	O nome do campo
Valor do campo de formulário (40)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (41)	fieldName		string	O nome do campo
Valor do campo de formulário (41)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (42)	fieldName		string	O nome do campo
Valor do campo de formulário (42)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (43)	fieldName		string	O nome do campo
Valor do campo de formulário (43)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (44)	fieldName		string	O nome do campo
Valor do campo de formulário (44)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (45)	fieldName		string	O nome do campo
Valor do campo de formulário (45)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (46)	fieldName		string	O nome do campo
Valor do campo de formulário (46)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (47)	fieldName		string	O nome do campo
Valor do campo de formulário (47)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (48)	fieldName		string	O nome do campo
Valor do campo de formulário (48)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (49)	fieldName		string	O nome do campo
Valor do campo de formulário (49)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (50)	fieldName		string	O nome do campo
Valor do campo de formulário (50)	defaultValue		string	O valor padrão do campo

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponse

Criar um contrato a partir de um fluxo de trabalho e enviar para assinatura

ID da Operação:: CreateAgreementFromWorkflow

Esta operação cria um contrato a partir de um fluxo de trabalho no Adobe Acrobat Sign e envia-o para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user	True	string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	True	string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado
Nome/ID do fluxo de trabalho	workflowIdParam	True	string	Selecione o fluxo de trabalho personalizado na lista ou insira o ID do fluxo de trabalho personalizado.
agreementWorkflowSchema	agreementWorkflowSchema	True	dynamic	Detalhes do evento selecionado.

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponseV6

Criar um contrato a partir de um modelo de biblioteca e enviar para assinatura

ID da Operação:: CreateAgreementByTemplate_V2

Esta operação cria um contrato a partir de um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome do contrato	name	True	string	O nome do contrato
Template	libraryDocumentId	True	string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que pretende solicitar - assinatura eletrónica ou escrita
Email	email	True	string	O e-mail do participante
Authentication	authenticationMethod		string	Autenticação padrão: e-mail (Nenhum)
Palavra-passe	password		string	A palavra-passe necessária para o participante
Código do país	countryCode		string	Código do país do telefone do destinatário necessário para visualizar & assinar o documento
N.º de telefone	phone		string	Número de telefone do destinatário necessário para visualizar & assinar o contrato
ID do fornecedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Encomenda	order	True	integer	Índice começando com 1, indicando a posição em que o grupo de assinatura precisa assinar.
Funções	role	True	string	As funções atuais do conjunto de participantes (signatário, aprovador, etc.).
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários solicitando sua ação
Tipo de envio	sendType		string	Tipo de experiência utilizada pela entidade cedente para enviar um acordo
Email	email		string	O email do CC do acordo
Tempo de expiração	expirationTime		string	Prazo após o qual o Contrato expira. Exemplo: 2020-12-31T23:59:00Z
ID externo	externalId		string	Um valor arbitrário do seu sistema
Frequência do lembrete	reminderFrequency		string	Com que frequência pretende enviar lembretes?
Palavra-passe do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Valor	defaultValue		string	O valor padrão do campo
Atraso de redirecionamento	redirectDelay		string	O atraso (em segundos) antes que o usuário seja levado para a página de sucesso.
URL de redirecionamento	redirectUrl		string	URL para redirecionar depois de concluir o processo de assinatura, por exemplo: https://adobe.com
E-mails iniciais	initEmails		string	Controle e-mails de notificação para eventos de início de contrato.
Estado	state	True	string	O estado em que o acordo deve aterrar.

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponseV6

Criar um contrato a partir de um modelo de biblioteca e enviar para assinatura (Antigo) [PRETERIDO]

ID da Operação:: CreateAgreementByTemplate

Esta operação cria um contrato a partir de um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do contrato	name	True	string	O nome do contrato
Modelo de biblioteca de documentos	libraryDocumentId	True	string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que pretende solicitar - Assinatura eletrónica ou Escrita
E-mail do destinatário	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário	recipientSetRole	True	string	Especificar a função do destinatário
Message	message		string	Uma mensagem opcional para os destinatários solicitando sua ação
Dias para o prazo	daysUntilSigningDeadline		integer	O número de dias que faltam para o documento expirar
Frequência do lembrete	reminderFrequency		string	Com que frequência deseja enviar lembretes?
Palavra-passe do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Modelo de biblioteca de documentos (2)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (3)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (4)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (5)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (6)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (7)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (8)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (9)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
Modelo de biblioteca de documentos (10)	libraryDocumentId		string	Escolha um documento a partir dos modelos armazenados na sua biblioteca
E-mail do destinatário (2)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (2)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (2)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (3)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (3)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (3)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (4)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (4)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (4)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (5)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (5)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (5)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (6)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (6)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (6)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (7)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (7)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (7)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (8)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (8)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (8)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (9)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (9)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (9)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (10)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (10)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (10)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (11)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (11)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (11)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (12)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (12)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (12)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (13)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (13)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (13)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (14)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (14)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (14)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (15)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (15)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (15)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (16)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (16)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (16)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (17)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (17)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (17)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (18)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (18)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (18)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (19)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (19)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (19)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (20)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (20)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (20)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (21)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (21)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (21)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (22)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (22)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (22)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (23)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (23)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (23)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (24)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (24)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (24)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (25)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (25)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (25)	recipientSetRole	True	string	Especificar a função do destinatário
Nome do campo de formulário (1)	fieldName		string	O nome do campo
Valor do campo de formulário (1)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (2)	fieldName		string	O nome do campo
Valor do campo de formulário (2)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (3)	fieldName		string	O nome do campo
Valor do campo de formulário (3)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (4)	fieldName		string	O nome do campo
Valor do campo de formulário (4)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (5)	fieldName		string	O nome do campo
Valor do campo de formulário (5)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (6)	fieldName		string	O nome do campo
Valor do campo de formulário (6)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (7)	fieldName		string	O nome do campo
Valor do campo de formulário (7)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (8)	fieldName		string	O nome do campo
Valor do campo de formulário (8)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (9)	fieldName		string	O nome do campo
Valor do campo de formulário (9)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (10)	fieldName		string	O nome do campo
Valor do campo de formulário (10)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (11)	fieldName		string	O nome do campo
Valor do campo de formulário (11)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (12)	fieldName		string	O nome do campo
Valor do campo de formulário (12)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (13)	fieldName		string	O nome do campo
Valor do campo de formulário (13)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (14)	fieldName		string	O nome do campo
Valor do campo de formulário (14)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (15)	fieldName		string	O nome do campo
Valor do campo de formulário (15)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (16)	fieldName		string	O nome do campo
Valor do campo de formulário (16)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (17)	fieldName		string	O nome do campo
Valor do campo de formulário (17)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (18)	fieldName		string	O nome do campo
Valor do campo de formulário (18)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (19)	fieldName		string	O nome do campo
Valor do campo de formulário (19)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (20)	fieldName		string	O nome do campo
Valor do campo de formulário (20)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (21)	fieldName		string	O nome do campo
Valor do campo de formulário (21)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (22)	fieldName		string	O nome do campo
Valor do campo de formulário (22)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (23)	fieldName		string	O nome do campo
Valor do campo de formulário (23)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (24)	fieldName		string	O nome do campo
Valor do campo de formulário (24)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (25)	fieldName		string	O nome do campo
Valor do campo de formulário (25)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (26)	fieldName		string	O nome do campo
Valor do campo de formulário (26)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (27)	fieldName		string	O nome do campo
Valor do campo de formulário (27)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (28)	fieldName		string	O nome do campo
Valor do campo de formulário (28)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (29)	fieldName		string	O nome do campo
Valor do campo de formulário (29)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (30)	fieldName		string	O nome do campo
Valor do campo de formulário (30)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (31)	fieldName		string	O nome do campo
Valor do campo de formulário (31)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (32)	fieldName		string	O nome do campo
Valor do campo de formulário (32)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (33)	fieldName		string	O nome do campo
Valor do campo de formulário (33)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (34)	fieldName		string	O nome do campo
Valor do campo de formulário (34)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (35)	fieldName		string	O nome do campo
Valor do campo de formulário (35)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (36)	fieldName		string	O nome do campo
Valor do campo de formulário (36)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (37)	fieldName		string	O nome do campo
Valor do campo de formulário (37)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (38)	fieldName		string	O nome do campo
Valor do campo de formulário (38)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (39)	fieldName		string	O nome do campo
Valor do campo de formulário (39)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (40)	fieldName		string	O nome do campo
Valor do campo de formulário (40)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (41)	fieldName		string	O nome do campo
Valor do campo de formulário (41)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (42)	fieldName		string	O nome do campo
Valor do campo de formulário (42)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (43)	fieldName		string	O nome do campo
Valor do campo de formulário (43)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (44)	fieldName		string	O nome do campo
Valor do campo de formulário (44)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (45)	fieldName		string	O nome do campo
Valor do campo de formulário (45)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (46)	fieldName		string	O nome do campo
Valor do campo de formulário (46)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (47)	fieldName		string	O nome do campo
Valor do campo de formulário (47)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (48)	fieldName		string	O nome do campo
Valor do campo de formulário (48)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (49)	fieldName		string	O nome do campo
Valor do campo de formulário (49)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (50)	fieldName		string	O nome do campo
Valor do campo de formulário (50)	defaultValue		string	O valor padrão do campo

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponse

Criar um contrato a partir de um URL de documento e enviar para assinatura

ID da Operação:: CreateAgreementByUrl_V2

Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome do contrato	name	True	string	O nome do contrato
URL	url	True	string	Um URL acessível publicamente para recuperar o conteúdo do arquivo bruto
Nome	name	True	string	O nome do ficheiro de sistema original do documento que está a ser enviado
Tipo	mimeType	True	string	O tipo mime do ficheiro referenciado, por exemplo, aplicação/pdf
Tipo de assinatura	signatureType	True	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Email	email	True	string	O e-mail do participante
Authentication	authenticationMethod		string	Autenticação padrão: e-mail (Nenhum)
Palavra-passe	password		string	A palavra-passe necessária para o participante
Código do país	countryCode		string	Código do país do telefone do destinatário necessário para visualizar & assinar o documento
N.º de telefone	phone		string	Número de telefone do destinatário necessário para visualizar & assinar o contrato
ID do fornecedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Encomenda	order	True	integer	Índice começando com 1, indicando a posição em que o grupo de assinatura precisa assinar.
Funções	role	True	string	As funções atuais do conjunto de participantes (signatário, aprovador, etc.).
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários solicitando sua ação
Tipo de envio	sendType		string	Tipo de experiência utilizada pela entidade cedente para enviar um acordo
Email	email		string	O email do CC do acordo
Tempo de expiração	expirationTime		string	Prazo após o qual o Contrato expira. Exemplo: 2020-12-31T23:59:00Z
ID externo	externalId		string	Um valor arbitrário do seu sistema
Frequência do lembrete	reminderFrequency		string	Com que frequência pretende enviar lembretes?
Palavra-passe do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Valor	defaultValue		string	O valor padrão do campo
Atraso de redirecionamento	redirectDelay		string	O atraso (em segundos) antes que o usuário seja levado para a página de sucesso.
URL de redirecionamento	redirectUrl		string	URL para redirecionar depois de concluir o processo de assinatura, por exemplo: https://adobe.com
E-mails iniciais	initEmails		string	Controle e-mails de notificação para eventos de início de contrato.
Estado	state	True	string	O estado em que o acordo deve aterrar.

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponseV6

Criar um contrato a partir de um URL de documento e enviar para assinatura (Antigo) [DEPRECATED]

ID da Operação:: CreateAgreementByUrl

Esta operação cria um contrato a partir de um documento carregado no Adobe Acrobat Sign e envia-o para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do contrato	name	True	string	O nome do contrato
URL	url	True	string	Um URL acessível publicamente para recuperar o documento
Nome	name	True	string	O nome do documento referenciado, com extensão
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que pretende solicitar - Assinatura eletrónica ou Escrita
E-mail do destinatário	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário	recipientSetRole	True	string	Especificar a função do destinatário
Message	message		string	Uma mensagem opcional para os destinatários solicitando sua ação
Dias para o prazo	daysUntilSigningDeadline		integer	O número de dias que faltam para o documento expirar
Frequência do lembrete	reminderFrequency		string	Com que frequência deseja enviar lembretes?
Palavra-passe do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
URL (2)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (2)	name		string	O nome do documento referenciado, com extensão
URL (3)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (3)	name		string	O nome do documento referenciado, com extensão
URL (4)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (4)	name		string	O nome do documento referenciado, com extensão
URL (5)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (5)	name		string	O nome do documento referenciado, com extensão
URL (6)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (6)	name		string	O nome do documento referenciado, com extensão
URL (7)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (7)	name		string	O nome do documento referenciado, com extensão
URL (8)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (8)	name		string	O nome do documento referenciado, com extensão
URL (9)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (9)	name		string	O nome do documento referenciado, com extensão
URL (10)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (10)	name		string	O nome do documento referenciado, com extensão
E-mail do destinatário (2)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (2)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (2)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (3)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (3)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (3)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (4)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (4)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (4)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (5)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (5)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (5)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (6)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (6)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (6)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (7)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (7)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (7)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (8)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (8)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (8)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (9)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (9)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (9)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (10)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (10)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (10)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (11)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (11)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (11)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (12)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (12)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (12)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (13)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (13)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (13)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (14)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (14)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (14)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (15)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (15)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (15)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (16)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (16)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função do destinatário (16)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (17)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (17)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (17)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (18)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (18)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (18)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (19)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (19)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (19)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (20)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (20)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (20)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (21)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (21)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (21)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (22)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (22)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (22)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (23)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (23)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (23)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (24)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (24)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (24)	recipientSetRole	True	string	Especificar a função do destinatário
E-mail do destinatário (25)	email	True	string	E-mail do destinatário
Ordem de assinatura do destinatário (25)	signingOrder	True	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Função de destinatário (25)	recipientSetRole	True	string	Especificar a função do destinatário
Nome do campo de formulário (1)	fieldName		string	O nome do campo
Valor do campo de formulário (1)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (2)	fieldName		string	O nome do campo
Valor do campo de formulário (2)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (3)	fieldName		string	O nome do campo
Valor do campo de formulário (3)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (4)	fieldName		string	O nome do campo
Valor do campo de formulário (4)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (5)	fieldName		string	O nome do campo
Valor do campo de formulário (5)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (6)	fieldName		string	O nome do campo
Valor do campo de formulário (6)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (7)	fieldName		string	O nome do campo
Valor do campo de formulário (7)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (8)	fieldName		string	O nome do campo
Valor do campo de formulário (8)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (9)	fieldName		string	O nome do campo
Valor do campo de formulário (9)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (10)	fieldName		string	O nome do campo
Valor do campo de formulário (10)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (11)	fieldName		string	O nome do campo
Valor do campo de formulário (11)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (12)	fieldName		string	O nome do campo
Valor do campo de formulário (12)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (13)	fieldName		string	O nome do campo
Valor do campo de formulário (13)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (14)	fieldName		string	O nome do campo
Valor do campo de formulário (14)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (15)	fieldName		string	O nome do campo
Valor do campo de formulário (15)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (16)	fieldName		string	O nome do campo
Valor do campo de formulário (16)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (17)	fieldName		string	O nome do campo
Valor do campo de formulário (17)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (18)	fieldName		string	O nome do campo
Valor do campo de formulário (18)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (19)	fieldName		string	O nome do campo
Valor do campo de formulário (19)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (20)	fieldName		string	O nome do campo
Valor do campo de formulário (20)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (21)	fieldName		string	O nome do campo
Valor do campo de formulário (21)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (22)	fieldName		string	O nome do campo
Valor do campo de formulário (22)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (23)	fieldName		string	O nome do campo
Valor do campo de formulário (23)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (24)	fieldName		string	O nome do campo
Valor do campo de formulário (24)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (25)	fieldName		string	O nome do campo
Valor do campo de formulário (25)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (26)	fieldName		string	O nome do campo
Valor do campo de formulário (26)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (27)	fieldName		string	O nome do campo
Valor do campo de formulário (27)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (28)	fieldName		string	O nome do campo
Valor do campo de formulário (28)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (29)	fieldName		string	O nome do campo
Valor do campo de formulário (29)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (30)	fieldName		string	O nome do campo
Valor do campo de formulário (30)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (31)	fieldName		string	O nome do campo
Valor do campo de formulário (31)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (32)	fieldName		string	O nome do campo
Valor do campo de formulário (32)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (33)	fieldName		string	O nome do campo
Valor do campo de formulário (33)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (34)	fieldName		string	O nome do campo
Valor do campo de formulário (34)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (35)	fieldName		string	O nome do campo
Valor do campo de formulário (35)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (36)	fieldName		string	O nome do campo
Valor do campo de formulário (36)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (37)	fieldName		string	O nome do campo
Valor do campo de formulário (37)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (38)	fieldName		string	O nome do campo
Valor do campo de formulário (38)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (39)	fieldName		string	O nome do campo
Valor do campo de formulário (39)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (40)	fieldName		string	O nome do campo
Valor do campo de formulário (40)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (41)	fieldName		string	O nome do campo
Valor do campo de formulário (41)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (42)	fieldName		string	O nome do campo
Valor do campo de formulário (42)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (43)	fieldName		string	O nome do campo
Valor do campo de formulário (43)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (44)	fieldName		string	O nome do campo
Valor do campo de formulário (44)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (45)	fieldName		string	O nome do campo
Valor do campo de formulário (45)	defaultValue		string	O valor padrão do campo
Nome do campo do formulário (46)	fieldName		string	O nome do campo
Valor do campo de formulário (46)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (47)	fieldName		string	O nome do campo
Valor do campo de formulário (47)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (48)	fieldName		string	O nome do campo
Valor do campo de formulário (48)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (49)	fieldName		string	O nome do campo
Valor do campo de formulário (49)	defaultValue		string	O valor padrão do campo
Nome do campo de formulário (50)	fieldName		string	O nome do campo
Valor do campo de formulário (50)	defaultValue		string	O valor padrão do campo

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponse

Criar um contrato a partir do conteúdo de um arquivo e enviar para assinatura

ID da Operação:: CreateAgreementByFileStream

Esta operação cria um contrato a partir de um arquivo no Adobe Acrobat Sign e o envia para assinatura.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome do contrato	name	True	string	O nome do contrato
Nome	fileName	True	string	O nome do documento a ser carregado, com extensão
Content	formData	True	byte	O fluxo de arquivos do documento a ser carregado
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que pretende solicitar - assinatura eletrónica ou escrita
Email	email	True	string	O e-mail do participante
Authentication	authenticationMethod		string	Autenticação padrão: e-mail (Nenhum)
Palavra-passe	password		string	A palavra-passe necessária para o participante
Código do país	countryCode		string	Código do país do telefone do destinatário necessário para visualizar & assinar o documento
N.º de telefone	phone		string	Número de telefone do destinatário necessário para visualizar & assinar o contrato
ID do fornecedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Encomenda	order	True	integer	Índice começando com 1, indicando a posição em que o grupo de assinatura precisa assinar.
Funções	role	True	string	As funções atuais do conjunto de participantes (signatário, aprovador, etc.).
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários solicitando sua ação
Tipo de envio	sendType		string	Tipo de experiência utilizada pela entidade cedente para enviar um acordo
Email	email		string	O email do CC do acordo
Tempo de expiração	expirationTime		string	Prazo após o qual o Contrato expira. Exemplo: 2020-12-31T23:59:00Z
ID externo	externalId		string	Um valor arbitrário do seu sistema
Frequência do lembrete	reminderFrequency		string	Com que frequência pretende enviar lembretes?
Palavra-passe do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Valor	defaultValue		string	O valor padrão do campo
Atraso de redirecionamento	redirectDelay		string	O atraso (em segundos) antes que o usuário seja levado para a página de sucesso.
URL de redirecionamento	redirectUrl		string	URL para redirecionar depois de concluir o processo de assinatura, por exemplo: https://adobe.com
E-mails iniciais	initEmails		string	Controle e-mails de notificação para eventos de início de contrato.
Estado	state	True	string	O estado em que o acordo deve aterrar.

Devoluções

Um JSON que contém a ID do contrato recém-criado

Body: AgreementCreationResponseV6

Criar um modelo de biblioteca a partir de um documento carregado

ID da Operação:: CreateLibraryDocumentById_V2

Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um documento carregado. Use este modelo para enviar contratos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome do Modelo	name	True	string	Nome do contrato usado para identificar o modelo
Tipo de modelo	templateTypes	True	array of string	Uma lista de um ou mais tipos de modelo de biblioteca
Modo de Partilha	sharingMode	True	string	Especifica quem deve ter acesso a este documento da biblioteca
ID	transientDocumentId	True	string	O ID do documento recebido ao carregar um documento transitório
Estado do modelo	state	True	string	Estado do documento da biblioteca.
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado

Devoluções

Um objeto JSON descrevendo o modelo de biblioteca

Body: LibraryDocumentCreationResponseV6

Criar um modelo de biblioteca a partir de um documento carregado (Antigo) [PRETERIDO]

ID da Operação:: CreateLibraryDocumentById

Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um documento carregado. Use este modelo para enviar contratos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do Modelo	name	True	string	Nome do contrato usado para identificar o modelo
Tipo de modelo	libraryTemplateTypes	True	string	Uma lista de um ou mais tipos de modelo de biblioteca
Partilhar com	librarySharingMode	True	string	Especifica quem deve ter acesso a este documento da biblioteca
ID do documento	transientDocumentId	True	string	O ID do documento recebido ao carregar um documento
ID do documento (2)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (3)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (4)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (5)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (6)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (7)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (8)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (9)	transientDocumentId		string	O ID do documento recebido ao carregar um documento
ID do documento (10)	transientDocumentId		string	O ID do documento recebido ao carregar um documento

Devoluções

Um objeto JSON descrevendo o modelo de biblioteca

Body: LibraryDocumentCreationResponse

Criar um modelo de biblioteca a partir de um URL de documento

ID da Operação:: CreateLibraryDocumentByUrl_V2

Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um URL de documento. Use este modelo para enviar contratos

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome do Modelo	name	True	string	Nome do contrato usado para identificar o modelo
Tipo de modelo	templateTypes	True	array of string	Uma lista de um ou mais tipos de modelo de biblioteca
Modo de Partilha	sharingMode	True	string	Especifica quem deve ter acesso a este documento da biblioteca
URL	url	True	string	Um URL acessível publicamente para recuperar o conteúdo do arquivo bruto
Nome	name	True	string	O nome do ficheiro de sistema original do documento que está a ser enviado
Tipo	mimeType	True	string	O tipo mime do ficheiro referenciado, por exemplo, aplicação/pdf
Estado do modelo	state	True	string	Estado do documento da biblioteca.
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado

Devoluções

Um objeto JSON descrevendo o modelo de biblioteca

Body: LibraryDocumentCreationResponseV6

Criar um modelo de biblioteca a partir de um URL de documento (antigo) [PRETERIDO]

ID da Operação:: CreateLibraryDocumentByUrl

Esta operação cria um modelo na biblioteca do Adobe Acrobat Sign a partir de um URL de documento. Use este modelo para enviar contratos

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do Modelo	name	True	string	Nome do contrato usado para identificar o modelo
Tipo de modelo	libraryTemplateTypes	True	string	Uma lista de um ou mais tipos de modelo de biblioteca
Partilhar com	librarySharingMode	True	string	Especifica quem deve ter acesso a este documento da biblioteca
URL	url	True	string	Um URL acessível publicamente para recuperar o documento
Nome	name	True	string	O nome do documento referenciado, com extensão
URL (2)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (2)	name		string	O nome do documento referenciado, com extensão
URL (3)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (3)	name		string	O nome do documento referenciado, com extensão
URL (4)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (4)	name		string	O nome do documento referenciado, com extensão
URL (5)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (5)	name		string	O nome do documento referenciado, com extensão
URL (6)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (6)	name		string	O nome do documento referenciado, com extensão
URL (7)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (7)	name		string	O nome do documento referenciado, com extensão
URL (8)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (8)	name		string	O nome do documento referenciado, com extensão
URL (9)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (9)	name		string	O nome do documento referenciado, com extensão
URL (10)	url		string	Um URL acessível publicamente para recuperar o documento
Nome (10)	name		string	O nome do documento referenciado, com extensão

Devoluções

Um objeto JSON descrevendo o modelo de biblioteca

Body: LibraryDocumentCreationResponse

Obtenha uma lista de todos os contratos

ID da Operação:: GetAllAgreements_V2

Esta operação busca a lista de todos os contratos do usuário.

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	Usado para navegar pelas páginas. Se não for fornecido, retorna a primeira página.
Tamanho da página	pageSize	integer	Número de itens na página de resposta. Por padrão: 100; Máx: 10000
Em nome de	x-api-user	string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado

Devoluções

Um JSON que contém o objeto de matriz de contrato de usuário

Body: userAgreementListV6

Obter as informações detalhadas do fluxo de trabalho

ID da Operação:: GetWorkflowInfo

Esta operação obtém informações detalhadas sobre o fluxo de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do fluxo de trabalho	workflowId	True	string	A ID do fluxo de trabalho cujas informações são necessárias
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado

Devoluções

Um JSON que contém informações detalhadas sobre o fluxo de trabalho

Body: WorkflowDescriptionV6

Obter dados de campo de formulário de acordo (Antigo) [PRETERIDO]

ID da Operação:: GetAgreementFormFieldData

Recupera dados inseridos nos campos de formulário interativo do contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujas informações são necessárias

Devoluções

response: file

Obter dados de campo de formulário de contrato em formato CSV

ID da Operação:: GetAgreementFormFieldData_V2

Recupera dados inseridos nos campos de formulário interativo do contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujas informações são necessárias
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

O conteúdo dos dados do formulário

Conteúdo dos dados do formulário: binary

Obter dados de campo de formulário de contrato no formato JSON

ID da Operação:: GetAgreementFormFieldData_V3

Recupera dados inseridos nos campos de formulário interativo do contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujas informações são necessárias
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

O conteúdo dos dados do formulário

Conteúdo dos dados do formulário: object

Obter o status de um contrato

ID da Operação:: GetAgreementInfo_V2

Esta operação busca todas as informações atuais de um contrato, como status.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujas informações são necessárias
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

Detalhes completos do contrato

Body: AgreementInfoV6

Obter o status de um contrato [DEPRECATED]

ID da Operação:: GetAgreementInfo

Esta ação foi preterida. Em vez disso, use Obter o status de um contrato .

~~Esta operação busca todas as informações atuais de um contrato, como status.~~

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujas informações são necessárias

Devoluções

Os detalhes completos sobre o acordo

Body: AgreementInfo

Obter o URL de visualização do contrato

ID da Operação:: PostAgreementViews

Recupera a url de exibição de estado mais recente do contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujas informações são necessárias
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Ver Nome	name	True	string	Nome da vista de contrato solicitada
Login automático	autoLoginUser		boolean	Se verdadeiro, o URL retornado fará automaticamente o login do usuário
Sem bandeira do Chrome	noChrome		boolean	Se verdadeiro, a página incorporada é mostrada sem um cabeçalho ou rodapé
Frame pai	frameParent		string	Lista separada por vírgulas de urls de domínio onde os URLs podem ser iframed

Devoluções

Lista de pontos de vista do acordo

Body: AgreementViews

Obter um documento de um contrato

ID da Operação:: GetDocument_V2

Esta operação busca o fluxo de arquivos de um documento específico do contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujo documento é necessário
ID do documento	documentId	True	string	O ID do documento específico do contrato
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

O fluxo de arquivos do documento

response: DocumentResponse

Obter um documento de um contrato [DEPRECATED]

ID da Operação:: GetDocument

Esta ação foi preterida. Em vez disso, use Obter um documento de um contrato .

~~Esta operação busca o fluxo de arquivos de um documento específico do contrato.~~

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujo documento é necessário
ID do documento	documentId	True	string	O ID do documento específico do contrato

Devoluções

O fluxo de arquivos do documento

response: DocumentResponse

Obter um PDF da pista de auditoria do contrato

ID da Operação:: GetAgreementAuditTrail

Esta operação busca o fluxo de arquivo PDF da trilha de auditoria do contrato. Observe que o fluxo de arquivos deve ser armazenado com um nome de arquivo que termina em .pdf extensão de arquivo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
ID do contrato	agreementId	True	string	O ID do contrato cujas informações são necessárias

Devoluções

O fluxo de arquivos da trilha de auditoria do contrato

response: AgreementAuditTrailResponse

Obter um PDF de um contrato assinado

ID da Operação:: GetCombinedDocument_V2

Esta operação busca o fluxo de arquivos PDF do contrato combinado ou assinado. Observe que o fluxo de arquivos deve ser armazenado com um nome de arquivo que termina em .pdf extensão de arquivo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato, conforme fornecido pela ação que cria o contrato
Anexar documentos comprovativos?	attachSupportingDocuments		boolean	Se verdadeiro, anexar documentos comprovativos ao contrato assinado PDF
Anexar Relatório de Auditoria?	attachAuditReport		boolean	Se verdadeiro, anexe um relatório de auditoria ao PDF do contrato assinado
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

O fluxo de arquivos do documento

response: CombinedDocumentResponse

Obter um PDF de um contrato assinado [DEPRECATED]

ID da Operação:: GetCombinedDocument

Esta ação foi preterida. Em vez disso, use Obter um PDF de um contrato assinado .

~~Esta operação busca o fluxo de arquivos PDF do contrato combinado ou assinado. Observe que o fluxo de arquivos deve ser armazenado com um nome de arquivo que termina em .pdf extensão de arquivo.~~

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato, conforme fornecido pela ação que cria o contrato
Anexar documentos comprovativos?	attachSupportingDocuments		boolean	Se verdadeiro, anexar documentos comprovativos ao contrato assinado PDF
Anexar Relatório de Auditoria?	auditReport		boolean	Se verdadeiro, anexe um relatório de auditoria ao PDF do contrato assinado

Devoluções

O fluxo de arquivos do documento

response: CombinedDocumentResponse

Obter uma lista de todos os acordos (Antigo) [DEPRECATED]

ID da Operação:: GetAllAgreements

Esta operação busca a lista de todos os contratos do usuário.

Devoluções

Um JSON que contém o objeto de matriz de contrato de usuário

Body: UserAgreements

Obter uma lista de todos os acordos com base em critérios de pesquisa

ID da Operação:: SearchAgreements

Esta operação pesquisa acordos por critérios como ID do fluxo de trabalho, etc.

Parâmetros

Name	Chave	Tipo	Description
Em nome de	x-api-user	string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado
Nome/ID do fluxo de trabalho	workflowId	string	Selecione o fluxo de trabalho personalizado na lista ou insira o ID do fluxo de trabalho personalizado.
Criado após	gt	string	A data-hora mínima permitida. Exemplo: 2020-12-31T23:59:00Z
Criado antes	lt	string	A data-hora máxima permitida. Exemplo: 2023-12-31T23:59:00Z
Tamanho da página	pageSize	integer	Número de itens na página de resposta. Por padrão: 50; Máx: 500
Índice de Início	startIndex	integer	Primeira linha (deslocamento) baseada em 0 dos resultados da pesquisa a serem retornados.

Devoluções

Um JSON que contém o objeto de matriz de contrato de usuário

Body: userAgreementListV6

Obter uma lista de todos os fluxos de trabalho

ID da Operação:: GetAllWorkflows

Esta operação busca a lista de todos os fluxos de trabalho do usuário.

Parâmetros

Name	Chave	Tipo	Description
Incluir fluxos de trabalho de rascunho	includeDraftWorkflows	boolean	Incluir fluxos de trabalho de rascunho
Incluir fluxos de trabalho inativos	includeInactiveWorkflows	boolean	Incluir fluxos de trabalho inativos
Em nome de	x-api-user	string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado

Devoluções

Um JSON que contém o objeto de matriz de fluxo de trabalho do usuário

Body: userWorkflowListV6

Obter uma lista de todos os formulários Web

ID da Operação:: GetAllWebForms

Esta operação busca a lista de todos os formulários da Web do usuário.

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	Usado para navegar pelas páginas. Se não for fornecido, retorna a primeira página.
Tamanho da página	pageSize	integer	Número de itens na página de resposta. Por padrão: 100; Máx: 10000
Em nome de	x-api-user	string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado

Devoluções

Um JSON que contém o objeto de matriz de formulário da Web do usuário

Body: userWidgetListV6

Obter uma lista de todos os grupos aos quais o usuário pertence

ID da Operação:: GetAllUserGroups

Esta operação busca a lista de todos os grupos aos quais o usuário pertence.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
ID de utilizador	userId	True	string	Para obter o resultado para o usuário autorizado, o ID do usuário pode ser substituído por 'eu' sem aspas.

Devoluções

Um JSON que contém a lista de grupos para determinado usuário

Body: UserGroupsInfoV6

Obter uma lista de todos os IDs de documentos de um contrato

ID da Operação:: GetAllDocumentsofAnAgreement_V2

Esta operação obtém os IDs de todos os documentos e documentos comprovativos de um contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujos documentos são necessários
Documentos comprovativos - Tipo de conteúdo	supportingDocumentContentFormat		string	Tipo de conteúdo dos documentos comprovativos do acordo
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

Um JSON que contém os documentos e os objetos de matriz de documentos de suporte

Body: AgreementDocumentsV6

Obter uma lista de todos os IDs de documentos de um contrato [DEPRECATED]

ID da Operação:: GetAllDocumentsofAnAgreement

Esta ação foi preterida. Em vez disso, use Obter uma lista de todos os IDs de documentos de um contrato .

~~Esta operação obtém os IDs de todos os documentos e documentos comprovativos de um contrato.~~

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	O ID do contrato cujos documentos são necessários
Documentos comprovativos - Tipo de conteúdo	supportingDocumentContentFormat		string	Tipo de conteúdo dos documentos comprovativos do acordo

Devoluções

Um JSON que contém os documentos e os objetos de matriz de documentos de suporte

Body: AgreementDocuments

Obter uma lista de todos os modelos de biblioteca

ID da Operação:: GetLibraryDocuments_V2

Esta operação busca a lista de todos os documentos armazenados como modelos na biblioteca do Adobe Acrobat Sign do usuário.

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	Usado para navegar pelas páginas. Se não for fornecido, retorna a primeira página.
Tamanho da página	pageSize	integer	Número de itens na página de resposta. Por padrão: 100; Máx: 10000
Em nome de	x-api-user	string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	string	ID do grupo. Para usar isso - o campo 'Em nome de' precisa ser selecionado

Devoluções

Um JSON que contém o objeto de matriz de modelo de biblioteca

Body: LibraryDocuments

Obter uma lista de todos os modelos de biblioteca (Antigo) [PRETERIDO]

ID da Operação:: GetLibraryDocuments

Esta operação busca a lista de todos os documentos armazenados como modelos na biblioteca do Adobe Acrobat Sign do usuário.

Devoluções

Um JSON que contém o objeto de matriz de modelo de biblioteca

Body: DocumentLibraryItems

Recuperar o URL de assinatura

ID da Operação:: GetSigningUrls

Esta operação recupera a URL da página de assinatura eletrônica do(s) signatário(s) atual(is) de um contrato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato, conforme fornecido pela ação que cria o contrato
Em nome de	x-api-user		string	O e-mail do chamador da API no formato: email:adobesignuser@domain.com

Devoluções

Body: SigningUrlResponse

Acionadores

Quando o estado de um acordo muda	Aciona um novo fluxo quando o status de um contrato é alterado. Abrange os eventos mais comuns do Contrato, como criação, conclusão, etc.
Quando ocorre um evento	Aciona um novo fluxo quando ocorre um evento. Abrange todos os eventos de Contrato, Mega Sign e Web Form.
Quando ocorre um evento de contrato de formulário da Web	Aciona um novo fluxo quando ocorre um evento de contrato de formulário da Web. Abrange os eventos mais comuns do Contrato, como criação, conclusão, etc.
Quando ocorre um evento de grupo	Aciona um novo fluxo quando ocorre um evento de grupo. Abrange todos os eventos de Contrato, Mega Sign e Web Form.
Quando um acordo é enviado a um participante	Aciona um novo fluxo quando um acordo é enviado a um participante.
Quando um fluxo de trabalho de contrato é concluído com êxito	Aciona um novo fluxo quando um fluxo de trabalho de contrato é concluído com êxito
Quando é criado um novo contrato	Aciona um novo fluxo quando um novo contrato é criado.

Quando o estado de um acordo muda

ID da Operação:: CreateWebhookForAgreementStatusUpdated

Aciona um novo fluxo quando o status de um contrato é alterado. Abrange os eventos mais comuns do Contrato, como criação, conclusão, etc.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O âmbito do desencadeamento
Nome/ID do contrato	resourceId		string	Especifique apenas quando "Âmbito" é "Um acordo específico". Selecione um contrato na lista ou insira o ID do contrato.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser acionado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do acordo devem ser enviadas na notificação?
Incluir informações sobre o participante do acordo?	includeParticipantsInfo		boolean	As informações sobre os participantes do acordo devem ser enviadas em notificação?
Incluir informações do documento do contrato?	includeDocumentsInfo		boolean	As informações do documento do contrato devem ser enviadas na notificação?
Incluir informações do documento assinado pelo contrato?	includeSignedDocuments		boolean	Deve ser enviada uma cópia final do documento assinado na notificação da conclusão do acordo?

Devoluções

Body: WebhookPayloadWithSignedDocumentForStatusChange

Quando ocorre um evento

ID da Operação:: CreateWebhookGeneric

Aciona um novo fluxo quando ocorre um evento. Abrange todos os eventos de Contrato, Mega Sign e Web Form.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O âmbito do desencadeamento
Tipo de Recurso	resourceType		string	Especifique apenas quando "Escopo" é "Um recurso específico". Selecione o tipo de recurso para o qual o fluxo deve ser acionado.
ID do Recurso	resourceId		string	Especifique apenas quando "Escopo" é "Um recurso específico". Insira o acordo ou mega sinal ou formulário web ou ID de grupo para o qual o fluxo deve ser acionado.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser acionado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do acordo devem ser enviadas na notificação?
Incluir informações sobre o participante do acordo?	includeParticipantsInfo		boolean	As informações sobre os participantes do acordo devem ser enviadas em notificação?
Incluir informações do documento do contrato?	includeDocumentsInfo		boolean	As informações do documento do contrato devem ser enviadas na notificação?
Incluir informações do documento assinado pelo contrato?	includeSignedDocuments		boolean	Deve ser enviada uma cópia final do documento assinado no momento da conclusão do acordo?
Incluir informações do MegaSign?	includeDetailedInfo		boolean	As informações detalhadas do mega sinal devem ser enviadas em notificação?
Incluir informações de formulário da Web?	includeDetailedInfo		boolean	As informações detalhadas do formulário Web devem ser enviadas na notificação?
Incluir informações do participante do formulário Web?	includeParticipantsInfo		boolean	As informações do participante do formulário Web devem ser enviadas em notificação?
Incluir informações sobre documentos de formulários da Web?	includeDocumentsInfo		boolean	As informações do documento do formulário Web devem ser enviadas na notificação?

Devoluções

Body: WebhookPayloadGeneric

Quando ocorre um evento de contrato de formulário da Web

ID da Operação:: CreateWebhookForWebFormAgreementEvent

Aciona um novo fluxo quando ocorre um evento de contrato de formulário da Web. Abrange os eventos mais comuns do Contrato, como criação, conclusão, etc.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome do gatilho
Tamanho da página de Web Forms	pageSize		integer	Selecione o número de formulários da Web a serem exibidos na lista suspensa
Nome/ID do formulário Web	resourceId	True	string	Selecione o formulário da Web na lista ou insira o ID do formulário da Web.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser acionado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do acordo devem ser enviadas na notificação?
Incluir informações sobre o participante do acordo?	includeParticipantsInfo		boolean	As informações sobre os participantes do acordo devem ser enviadas em notificação?
Incluir informações do documento do contrato?	includeDocumentsInfo		boolean	As informações do documento do contrato devem ser enviadas na notificação?
Incluir informações do documento assinado pelo contrato?	includeSignedDocuments		boolean	Deve ser enviada uma cópia final do documento assinado na notificação da conclusão do acordo?

Devoluções

Body: WebFormWebhookAgreementEventPayload

Quando ocorre um evento de grupo

ID da Operação:: CreateWebhookForGroupEvent

Aciona um novo fluxo quando ocorre um evento de grupo. Abrange todos os eventos de Contrato, Mega Sign e Web Form.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome do gatilho
Nome/ID do Grupo	resourceId		string	ID do grupo
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser acionado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do acordo devem ser enviadas na notificação?
Incluir informações sobre o participante do acordo?	includeParticipantsInfo		boolean	As informações sobre os participantes do acordo devem ser enviadas em notificação?
Incluir informações do documento do contrato?	includeDocumentsInfo		boolean	As informações do documento do contrato devem ser enviadas na notificação?
Incluir informações do documento assinado pelo contrato?	includeSignedDocuments		boolean	Deve ser enviada uma cópia final do documento assinado no momento da conclusão do acordo?
Incluir informações do MegaSign?	includeDetailedInfo		boolean	As informações detalhadas do mega sinal devem ser enviadas em notificação?
Incluir informações de formulário da Web?	includeDetailedInfo		boolean	As informações detalhadas do formulário Web devem ser enviadas na notificação?
Incluir informações do participante do formulário Web?	includeParticipantsInfo		boolean	As informações do participante do formulário Web devem ser enviadas em notificação?
Incluir informações sobre documentos de formulários da Web?	includeDocumentsInfo		boolean	As informações do documento do formulário Web devem ser enviadas na notificação?

Devoluções

Body: GroupWebhookEventPayload

Quando um acordo é enviado a um participante

ID da Operação:: CreateWebhookForAgreementSignatureRequestedEvent

Aciona um novo fluxo quando um acordo é enviado a um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O âmbito do desencadeamento
Nome/ID do contrato	resourceId		string	Especifique apenas quando "Âmbito" é "Um acordo específico". Selecione um contrato na lista ou insira o ID do contrato.
Subscription	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser acionado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do acordo devem ser enviadas na notificação?
Incluir informações sobre o participante do acordo?	includeParticipantsInfo		boolean	As informações sobre os participantes do acordo devem ser enviadas em notificação?
Incluir informações do documento do contrato?	includeDocumentsInfo		boolean	As informações do documento do contrato devem ser enviadas na notificação?

Devoluções

Body: WebhookPayload

Quando um fluxo de trabalho de contrato é concluído com êxito

ID da Operação:: CreateWebhookForAgreementSignedEvent

Aciona um novo fluxo quando um fluxo de trabalho de contrato é concluído com êxito

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O âmbito do desencadeamento
Nome/ID do contrato	resourceId		string	Especifique apenas quando "Âmbito" é "Um acordo específico". Selecione um contrato na lista ou insira o ID do contrato.
Subscription	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser acionado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do acordo devem ser enviadas na notificação?
Incluir informações sobre o participante do acordo?	includeParticipantsInfo		boolean	As informações sobre os participantes do acordo devem ser enviadas em notificação?
Incluir informações do documento do contrato?	includeDocumentsInfo		boolean	As informações do documento do contrato devem ser enviadas na notificação?
Incluir informações do documento assinado pelo contrato?	includeSignedDocuments		boolean	Deve ser enviada uma cópia final do documento assinado no momento da conclusão do acordo?

Devoluções

Body: WebhookPayloadWithSignedDocument

Quando é criado um novo contrato

ID da Operação:: CreateWebhookForAgreementCreatedEvent

Aciona um novo fluxo quando um novo contrato é criado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O âmbito do desencadeamento
Subscription	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser acionado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do acordo devem ser enviadas na notificação?
Incluir informações sobre o participante do acordo?	includeParticipantsInfo		boolean	As informações sobre os participantes do acordo devem ser enviadas em notificação?

Devoluções

Body: WebhookPayloadWithoutNextParticipantSet

Definições

AcordoCriaçãoResposta

Um JSON que contém a ID do contrato recém-criado

Name	Caminho	Tipo	Description
ID do contrato	agreementId	string	A ID exclusiva do contrato que pode ser usada para consultar o status e baixar documentos assinados

AgreementCreationResponseV6

Um JSON que contém a ID do contrato recém-criado

Name	Caminho	Tipo	Description
ID do contrato	id	string	A ID exclusiva do contrato que pode ser usada para consultar o status e baixar documentos assinados

Documentos do Contrato

Um JSON que contém os documentos e os objetos de matriz de documentos de suporte

Name	Caminho	Tipo	Description
Documents	documents	array of Document	Uma lista de objetos que representam os documentos
Documentos comprovativos	supportingDocuments	array of SupportingDocument	Lista dos documentos comprovativos. Este só é devolvido se existir algum documento comprovativo no contrato

AcordoDocumentosV6

Um JSON que contém os documentos e os objetos de matriz de documentos de suporte

Name	Caminho	Tipo	Description
Documents	documents	array of DocumentV6	Uma lista de objetos que representam os documentos
Documentos comprovativos	supportingDocuments	array of SupportingDocumentV6	Lista dos documentos comprovativos. Este só é devolvido se existir algum documento comprovativo no contrato

AcordoInformações

Os detalhes completos sobre o acordo

Name	Caminho	Tipo	Description
ID do contrato	agreementId	string	Um ID exclusivo que pode ser usado para identificar exclusivamente o contrato
Events	events	array of DocumentHistoryEvent	Uma lista ordenada dos eventos na pista de auditoria deste documento
Data de validade	expiration	date	Data a partir da qual o acordo deixa de poder ser assinado
ID da versão mais recente	latestVersionId	string	Um ID exclusivo que identifica exclusivamente a versão atual do contrato
Message	message	string	A mensagem associada ao contrato fornecido pelo remetente
Nome do contrato	name	string	O nome do contrato, especificado pelo remetente
Próximos Conjuntos de Participantes	nextParticipantSetInfos	array of NextParticipantSetInfo	Informações sobre quem deve agir em seguida para alcançar este acordo
Conjuntos de Participantes	participantSetInfos	array of ParticipantSetInfo	Informações sobre todos os conjuntos de participantes deste documento
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Proteção de documentos	securityOptions	string	Informações de segurança sobre o documento que especifica se uma senha é ou não necessária para exibi-lo e assiná-lo
Situação	status	string	Situação atual do acordo

AcordoInfoV6

Detalhes completos do contrato

Name	Caminho	Tipo	Description
ID do contrato	id	string	Um ID exclusivo que pode ser usado para identificar exclusivamente o contrato
Data de criação	createdDate	date	Data de criação do contrato
Primeiro atraso de lembrete	firstReminderDelay	integer	Inteiro que especifica o atraso em horas antes de enviar o primeiro lembrete.
Frequência do lembrete	reminderFrequency	string	Com que frequência deseja enviar lembretes?
Data de validade	expiration	date	Data a partir da qual o acordo deixa de poder ser assinado
Localidade	locale	string	A localidade associada a este contrato - por exemplo, en_US ou fr_FR
Message	message	string	A mensagem associada ao contrato fornecido pelo remetente
Nome do contrato	name	string	O nome do contrato, especificado pelo remetente
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está ativada?
Conjuntos de Participantes	participantSetsInfo	array of ParticipantSetInfoV6	Informações sobre todos os conjuntos de participantes deste documento
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Opções de Segurança	securityOptions	string	Informações de segurança sobre o documento que especifica se uma senha é ou não necessária para exibi-lo e assiná-lo
Situação	status	string	Situação atual do acordo
E-mail do remetente	senderEmail	string	O e-mail do remetente
ID do fluxo de trabalho	workflowId	string	A ID do fluxo de trabalho personalizado que define o caminho de roteamento de um contrato.
CC	ccs	array of CcInfo	Uma lista de uma ou mais CCs que serão copiadas na transação do contrato.
ID do grupo	groupId	string	O identificador exclusivo do grupo ao qual o contrato pertence.

CombinedDocumentResponse

O fluxo de arquivos do documento

Conteúdo do Ficheiro: binary

AcordoAuditTrailResponse

O fluxo de arquivos da trilha de auditoria do contrato

Conteúdo da trilha de auditoria do contrato: binary

DisplayUserInfo

Name	Caminho	Tipo	Description
Empresa	company	string	Exibe o nome da empresa do usuário, se disponível
Email	email	string	Exibe o e-mail do usuário
Nome Completo	fullName	string	Exibe o nome completo do usuário, se disponível.

DisplayUserSetInfo

Name	Caminho	Tipo	Description
Exibir informações do conjunto de usuários	displayUserSetMemberInfos	array of DisplayUserInfo	Exibe as informações sobre o conjunto de usuários
Exibir nome do conjunto de usuários	displayUserSetName	string

Documento

As informações sobre o documento

Name	Caminho	Tipo	Description
ID do documento	documentId	string	O ID exclusivo do documento
Tipo de mímica	mimeType	string	O tipo Mime do documento
Nome	name	string	O nome do documento
Num Páginas	numPages	integer	Número de páginas do documento

Documento V6

As informações sobre o documento

Name	Caminho	Tipo	Description
ID do documento	id	string	O ID exclusivo do documento
Tipo de mímica	mimeType	string	O tipo Mime do documento
Nome	name	string	O nome do documento
Num Páginas	numPages	integer	Número de páginas do documento

DocumentHistoryEvent

Name	Caminho	Tipo	Description
Iniciador de Eventos	actingUserEmail	string	Endereço de e-mail do usuário que iniciou o evento
Data do Evento	date	date	A data do evento de auditoria
Descrição do Evento	description	string	Descrição do evento de auditoria
E-mail do participante	participantEmail	string	Endereço de e-mail do usuário que iniciou o evento
Tipo de Evento	type	string	Tipo de evento de acordo

DocumentLibraryItem

Name	Caminho	Tipo	Description
ID do modelo de biblioteca	libraryDocumentId	string	A ID exclusiva do documento da biblioteca usado ao enviar o documento a ser assinado
Tipos de modelo de biblioteca	libraryTemplateTypes	array of string	Uma lista de um ou mais tipos de modelo de biblioteca
Data de Modificação	modifiedDate	date	O dia em que o modelo de biblioteca foi modificado pela última vez
Nome do modelo de biblioteca	name	string	O nome do modelo de biblioteca
Modo de compartilhamento de modelo	scope	string	O âmbito da visibilidade do modelo de biblioteca

DocumentLibraryItems

Um JSON que contém o objeto de matriz de modelo de biblioteca

Name	Caminho	Tipo	Description
Lista de Modelos de Biblioteca	libraryDocumentList	array of DocumentLibraryItem	Uma lista de itens de modelo de biblioteca

DocumentResponse

O fluxo de arquivos do documento

Conteúdo do Ficheiro: binary

LibraryDocumentCreationResponse

Um objeto JSON descrevendo o modelo de biblioteca

Name	Caminho	Tipo	Description
ID do modelo de biblioteca	libraryDocumentId	string	A ID exclusiva que pode ser usada para fazer referência ao modelo de biblioteca

PróximoParticipantInfo

Name	Caminho	Tipo	Description
Email	email	string	O endereço de e-mail do próximo participante
Nome	name	string	O nome do próximo participante, se disponível
Aguardando desde	waitingSince	date	A data desde a qual o documento aguarda que o participante tome medidas

PróximoParticipantSetInfo

Name	Caminho	Tipo	Description
Próximo Participante Definir Informações do Membro	nextParticipantSetMemberInfos	array of NextParticipantInfo	Informações sobre os membros do próximo conjunto de participantes

ParticipanteInfo

Name	Caminho	Tipo	Description
Empresa	company	string	A empresa do participante, se disponível
Email	email	string	O endereço de e-mail do participante
Nome	name	string	O nome do participante, se disponível
ID do Participante	participantId	string	O ID exclusivo do participante
Opções de Segurança	securityOptions	array of string	Opções de segurança que se aplicam ao participante
Title	title	string	O título do participante, se disponível

ParticipantSetInfo

Name	Caminho	Tipo	Description
ID do Conjunto de Participantes	participantSetId	string	O ID exclusivo do conjunto de participantes
Informações do Participante Definir Membros	participantSetMemberInfos	array of ParticipantInfo	Informações sobre os membros do conjunto de destinatários
Mensagem Privada	privateMessage	string	Mensagem privada para os participantes do conjunto
Funções	roles	array of string	As funções atuais do participante são definidas. Um conjunto de participantes pode ter uma ou mais funções
segurançaOpções	securityOptions	array of string	Opções de segurança que se aplicam ao participante
Ordem de Assinatura	signingOrder	integer	Índice começando com 1, que informa a ordem em que esse destinatário assina
Status do Conjunto de Participantes	status	string	O participante define o status em relação ao documento

ParticipantSetInfoV6

Name	Caminho	Tipo	Description
Informações do Participante Definir Membros	memberInfos	array of MemberInfosV6	Informações sobre os membros do conjunto de destinatários
Encomenda	order	integer	Índice que indica a posição na qual o grupo de assinatura precisa assinar.
Funções	role	string	As funções atuais do conjunto de participantes (signatário, aprovador, etc.).
Nome do conjunto de participantes	name	string	O nome do conjunto de participantes
Participante Definir Mensagens Privadas	privateMessage	string	Mensagem privada para os participantes do conjunto
Páginas visíveis do conjunto de participantes	visiblePages	array of string	As páginas que são visíveis para o conjunto de participantes

MembroInfosV6

Name	Caminho	Tipo	Description
Email	email	string	O e-mail do participante
Authentication	securityOption.authenticationMethod	string	Autenticação padrão: e-mail (Nenhum)
Palavra-passe	securityOption.password	string	A palavra-passe necessária para o participante
Código do país	securityOption.phoneInfo.countryCode	string	Código do país do telefone do destinatário necessário para visualizar & assinar o documento
N.º de telefone	securityOption.phoneInfo.phone	string	Número de telefone do destinatário necessário para visualizar & assinar o contrato
ID do fornecedor	securityOption.digAuthInfo.providerId	string	ID do Provedor do Gateway de Identidade Digital.

AssinandoUrl

Name	Caminho	Tipo	Description
E-mail para URL de assinatura	email	string	O endereço de e-mail do signatário associado a este URL de assinatura
Assinar URL	esignUrl	string	O endereço URL do signatário associado a este URL de assinatura

SigningUrlResponse

Name	Caminho	Tipo	Description
Matriz de URLs para conjuntos de signatários	signingUrlSetInfos	array of SigningUrlSetInfo	Uma matriz de urls para conjuntos de signatários envolvidos neste contrato

SigningUrlSetInfo

Name	Caminho	Tipo	Description
- Assinatura de URL Array	signingUrls	array of SigningUrl	Uma matriz de urls para o conjunto de signatários atual
- Nome do conjunto de URL de sinal	signingUrlSetName	string	O nome do conjunto de signatários atual

Documento de apoio

Informações sobre o documento comprovativo

Name	Caminho	Tipo	Description
Nome do documento de apoio	displayLabel	string	Nome para apresentação do documento de apoio
Nome do campo do documento de apoio	fieldName	string	O nome do campo do documento de apoio
Tipo de mime de documento de suporte	mimeType	string	O tipo Mime do documento de suporte
Páginas de documentos de apoio	numPages	integer	Número de páginas do documento comprovativo
ID do documento comprovativo	supportingDocumentId	string	ID único que representa o documento comprovativo

SuportandoDocumentV6

Informações sobre o documento comprovativo

Name	Caminho	Tipo	Description
Nome do documento de apoio	displayLabel	string	Nome para apresentação do documento de apoio
Nome do campo do documento de apoio	fieldName	string	O nome do campo do documento de apoio
Tipo de mime de documento de suporte	mimeType	string	O tipo Mime do documento de suporte
Páginas de documentos de apoio	numPages	integer	Número de páginas do documento comprovativo
ID do documento comprovativo	id	string	ID único que representa o documento comprovativo

TransientDocumentResponse

Um JSON que contém a ID do documento carregado

Name	Caminho	Tipo	Description
ID do documento	transientDocumentId	string	O ID do documento carregado

Contrato de Utilizador

Name	Caminho	Tipo	Description
ID do contrato	agreementId	string	Um ID exclusivo que pode ser usado para identificar exclusivamente o contrato
Exibir informações do conjunto de usuários	displayUserSetInfos	array of DisplayUserSetInfo	O conjunto de usuários atuais mais relevante para o contrato. Normalmente, é o próximo signatário se o contrato for do usuário atual, ou o remetente se recebido de outro usuário
Data de exibição	displayDate	date	A data de exibição do contrato
Esign	esign	boolean	True se este for um documento e-sign
ID da versão mais recente	latestVersionId	string	Um ID de versão que identifica exclusivamente a versão atual do contrato
Nome	name	string	Nome do Acordo
Situação	status	string	Situação atual do acordo

Contratos de Utilizador

Um JSON que contém o objeto de matriz de contrato de usuário

Name	Caminho	Tipo	Description
Lista de Acordos	userAgreementList	array of UserAgreement	Uma matriz de itens de contrato

Contrato de usuárioV6

Name	Caminho	Tipo	Description
Exibir informações do conjunto de usuários	displayParticipantSetInfos	array of DisplayUserSetInfo	O conjunto de usuários atuais mais relevante para o contrato. Normalmente, é o próximo signatário se o contrato for do usuário atual, ou o remetente se recebido de outro usuário
Data de exibição	displayDate	string	A data de exibição do contrato
Esign	esign	boolean	True se este for um documento e-sign
Escondido	hidden	boolean	True se o contrato estiver oculto para o usuário
ID do grupo	groupId	string	Identificador exclusivo do grupo
ID da versão mais recente	latestVersionId	string	Um ID de versão que identifica exclusivamente a versão atual do contrato
Nome	name	string	Nome do Acordo
ID do pai	parentId	string	A id pai de um filho megaSign OU a id de origem de uma instância de contrato de formulário da Web
ID do contrato	id	string	O identificador único do contrato
Situação	status	string	Situação atual do acordo
Tipo	type	string	O tipo de acordo

userAgreementListV6

Um JSON que contém o objeto de matriz de contrato de usuário

Name	Caminho	Tipo	Description
página	page	page	Informações de paginação para navegar pela resposta
Lista de Acordos	userAgreementList	array of UserAgreementV6	Uma matriz de itens de contrato

página

Informações de paginação para navegar pela resposta

Name	Caminho	Tipo	Description
próximoCursor	nextCursor	string	Usado para navegar até a próxima página. Se não for devolvido, não há mais páginas.

WebhookPayload

Name	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Tipo pai de contrato	eventResourceParentType	string	Informações sobre o recurso a partir do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso a partir do qual este contrato é criado
Papel do Participante do Evento	participantRole	string	O papel do participante para o evento.
ID do participante do evento	participantUserId	string	O ID do participante do evento.
E-mail do participante do evento	participantUserEmail	string	O e-mail do participante do evento.
ID de usuário de atuação de evento	actingUserId	string	A ID do usuário que criou o evento.
E-mail do usuário que atua no evento	actingUserEmail	string	O e-mail do usuário que criou o evento.
Endereço IP do usuário em ação do evento	actingUserIpAddress	string	O endereço IP do usuário que criou o evento
ID de usuário de início de evento	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário atuante.
E-mail do usuário de início de evento	initiatingUserEmail	string	O e-mail do usuário que iniciou o evento em nome do usuário atuante.
Notificação Utilizadores Aplicáveis	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de utilizadores aos quais esta notificação é aplicável
Agreement	agreement	WebhookAgreementInfo	Informações completas sobre o acordo

AplicávelUtilizadores

As informações sobre os utilizadores aos quais esta notificação é aplicável

Name	Caminho	Tipo	Description
ID de usuário aplicável à notificação	id	string	O ID exclusivo do usuário ao qual esta notificação é aplicável
E-mail do usuário aplicável à notificação	email	string	O e-mail do usuário para o qual esta notificação é aplicável
Função de usuário aplicável à notificação	role	string	A função do usuário no fluxo de trabalho para o qual esta notificação é gerada
A carga útil é aplicável ao utilizador	payloadApplicable	boolean	Se os dados fornecidos nesta notificação são aplicáveis a este utilizador ou não

WebhookPayloadWithoutNextParticipantSet

Name	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Tipo pai de contrato	eventResourceParentType	string	Informações sobre o recurso a partir do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso a partir do qual este contrato é criado
ID do participante do evento	participantUserId	string	O ID do participante do evento.
E-mail do participante do evento	participantUserEmail	string	O e-mail do participante do evento.
ID de usuário de atuação de evento	actingUserId	string	A ID do usuário que criou o evento.
E-mail do usuário que atua no evento	actingUserEmail	string	O e-mail do usuário que criou o evento.
Endereço IP do usuário em ação do evento	actingUserIpAddress	string	O endereço IP do usuário que criou o evento
ID de usuário de início de evento	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário atuante
E-mail do usuário de início de evento	initiatingUserEmail	string	O e-mail do usuário que iniciou o evento em nome do usuário atuante.
Notificação Utilizadores Aplicáveis	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de utilizadores aos quais esta notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithoutNextParticipantSet	Informações completas sobre o acordo

WebhookPayloadWithSignedDocumentForStatusChange

Name	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub Evento	subEvent	string	O subevento que ocorreu em um recurso.
Tipo pai de contrato	eventResourceParentType	string	Informações sobre o recurso a partir do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso a partir do qual este contrato é criado
ID do participante do evento	participantUserId	string	O ID do participante do evento.
E-mail do participante do evento	participantUserEmail	string	O e-mail do participante do evento.
ID de usuário de atuação de evento	actingUserId	string	A ID do usuário que criou o evento.
E-mail do usuário que atua no evento	actingUserEmail	string	O e-mail do usuário que criou o evento.
Endereço IP do usuário em ação do evento	actingUserIpAddress	string	O endereço IP do usuário que criou o evento
Tipo de ação	actionType	string	A ação para a qual o evento ocorreu.
ID de usuário de início de evento	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário atuante
E-mail do usuário de início de evento	initiatingUserEmail	string	O e-mail do usuário que iniciou o evento em nome do usuário atuante.
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Papel do Participante do Evento	participantRole	string	O papel do participante para o evento.
Notificação Utilizadores Aplicáveis	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de utilizadores aos quais esta notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Informações completas sobre o acordo

WebhookPayloadWithSignedDocument

Name	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Tipo pai de contrato	eventResourceParentType	string	Informações sobre o recurso a partir do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso a partir do qual este contrato é criado
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Papel do Participante do Evento	participantRole	string	O papel do participante para o evento.
ID do participante do evento	participantUserId	string	O ID do participante do evento.
E-mail do participante do evento	participantUserEmail	string	O e-mail do participante do evento.
ID de usuário de atuação de evento	actingUserId	string	A ID do usuário que criou o evento.
E-mail do usuário que atua no evento	actingUserEmail	string	O e-mail do usuário que criou o evento.
Endereço IP do usuário em ação do evento	actingUserIpAddress	string	O endereço IP do usuário que criou o evento
ID de usuário de início de evento	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário atuante
E-mail do usuário de início de evento	initiatingUserEmail	string	O e-mail do usuário que iniciou o evento em nome do usuário atuante.
Notificação Utilizadores Aplicáveis	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de utilizadores aos quais esta notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Informações completas sobre o acordo

WebhookPayloadGeneric

Name	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub Evento	subEvent	string	O subevento que ocorreu em um recurso.
Tipo pai de contrato	eventResourceParentType	string	Informações sobre o recurso a partir do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso a partir do qual este contrato é criado
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Papel do Participante do Evento	participantRole	string	O papel do participante para o evento.
ID do participante do evento	participantUserId	string	O ID do participante do evento.
E-mail do participante do evento	participantUserEmail	string	O e-mail do participante do evento.
ID de usuário de atuação de evento	actingUserId	string	A ID do usuário que criou o evento.
E-mail do usuário que atua no evento	actingUserEmail	string	O e-mail do usuário que criou o evento.
ID de usuário de início de evento	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário atuante
E-mail do usuário de início de evento	initiatingUserEmail	string	O e-mail do usuário que iniciou o evento em nome do usuário atuante.
Tipo de ação	actionType	string	A ação para a qual o evento ocorreu.
Endereço IP do usuário em ação do evento	actingUserIpAddress	string	O endereço IP do usuário que criou o evento
Notificação Utilizadores Aplicáveis	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de utilizadores aos quais esta notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Informações completas sobre o acordo
Mega Sinal	megaSign	WebhookMegaSignInfo	A informação completa do mega signo
Formulário Web	widget	WebhookWidgetInfo	As informações completas do formulário web

WebFormWebhookAgreementEventPayload

Name	Caminho	Tipo	Description
Event	event	string	O evento de contrato que ocorreu no formulário da Web.
Data do Evento	eventDate	date	A data do evento. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub Evento	subEvent	string	O evento sub que ocorreu em um formulário da Web.
Tipo pai de contrato - Formulário Web	eventResourceParentType	string	Valor que indica que um contrato é criado a partir do formulário da Web.
ID do formulário Web	eventResourceParentId	string	Um ID exclusivo do formulário da Web a partir do qual este contrato é criado
Tipo de recurso de evento - Contrato	eventResourceType	string	O recurso no qual o evento ocorreu.
Papel do Participante do Evento	participantRole	string	O papel do participante para o evento.
ID do participante do evento	participantUserId	string	O ID do participante do evento.
E-mail do participante do evento	participantUserEmail	string	O e-mail do participante do evento.
ID de usuário de atuação de evento	actingUserId	string	A ID do usuário que criou o evento.
E-mail do usuário que atua no evento	actingUserEmail	string	O e-mail do usuário que criou o evento.
ID de usuário de início de evento	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário atuante
E-mail do usuário de início de evento	initiatingUserEmail	string	O e-mail do usuário que iniciou o evento em nome do usuário atuante.
Tipo de ação	actionType	string	A ação para a qual o evento ocorreu.
Endereço IP do usuário em ação do evento	actingUserIpAddress	string	O endereço IP do usuário que criou o evento
Notificação Utilizadores Aplicáveis	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de utilizadores aos quais esta notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Informações completas sobre o acordo

GroupWebhookEventPayload

Name	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu para um grupo.
Data do Evento	eventDate	date	A data do evento. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub Evento	subEvent	string	O subevento que ocorreu para um grupo.
Tipo pai de contrato - Formulário Web	eventResourceParentType	string	Informações sobre o grupo a partir do qual o acordo é criado.
ID do formulário Web	eventResourceParentId	string	Uma ID exclusiva do grupo a partir do qual este contrato é criado
Tipo de recurso de evento - Contrato	eventResourceType	string	O grupo para o qual o evento ocorreu.
Papel do Participante do Evento	participantRole	string	O papel do participante para o evento.
ID do participante do evento	participantUserId	string	O ID do participante do evento.
E-mail do participante do evento	participantUserEmail	string	O e-mail do participante do evento.
ID de usuário de atuação de evento	actingUserId	string	A ID do usuário que criou o evento.
E-mail do usuário que atua no evento	actingUserEmail	string	O e-mail do usuário que criou o evento.
ID de usuário de início de evento	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário atuante
E-mail do usuário de início de evento	initiatingUserEmail	string	O e-mail do usuário que iniciou o evento em nome do usuário atuante.
Tipo de ação	actionType	string	A ação para a qual o evento ocorreu.
Endereço IP do usuário em ação do evento	actingUserIpAddress	string	O endereço IP do usuário que criou o evento
Notificação Utilizadores Aplicáveis	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de utilizadores aos quais esta notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Informações completas sobre o acordo
Mega Sinal	megaSign	WebhookMegaSignInfo	A informação completa do mega signo
Formulário Web	widget	WebhookWidgetInfo	As informações completas do formulário web

WebhookAgreementInfo

Informações completas sobre o acordo

Name	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do contrato
Nome	name	string	O nome do contrato
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Situação	status	string	Situação atual do acordo
CC	ccs	array of CcInfo	Uma lista de uma ou mais CCs que serão copiadas na transação do contrato.
Data de criação	createdDate	date	Data de criação do contrato
Tempo de expiração	expirationTime	string	Prazo após o qual o Acordo expira e tem de ser assinado antes dele
ID externo	externalId.id	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Grupo Externo	externalId.group	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Primeiro atraso de lembrete	firstReminderDelay	integer	Inteiro que especifica o atraso em horas antes de enviar o primeiro lembrete.
Localidade	locale	string	A localidade associada a este contrato
Message	message	string	Uma mensagem opcional para os participantes, descrevendo o que está sendo enviado ou por que sua assinatura é necessária
Frequência do lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, a frequência padrão definida para a conta será usada
E-mail do remetente	senderEmail	string	E-mail do remetente do contrato
Vaulting ativado?	vaultingInfo.enabled	boolean	Para contas configuradas para compartimentação de documentos e a opção de habilitação por contrato, isso determina se o documento deve ser compartimentado
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está ativada
ID do fluxo de trabalho	workflowId	string	A ID do fluxo de trabalho personalizado que define o caminho de roteamento de um contrato.
Post Sign Redirecionamento Url	postSignOption.redirectUrl	string	Um URL acessível publicamente para o qual o usuário será enviado depois de concluir com êxito o processo de assinatura
Conjuntos de Participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	O participante define informações
Próximos Conjuntos de Participantes	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	O próximo participante define informações
Documents	documentsInfo.documents	array of WebhookDocument	Uma lista de objetos que representam os documentos
Documentos comprovativos	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Lista dos documentos comprovativos

WebhookAgreementInfoWithoutNextParticipantSet

Informações completas sobre o acordo

Name	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do contrato
Nome	name	string	O nome do contrato
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Situação	status	string	Situação atual do acordo
CC	ccs	array of CcInfo	Uma lista de uma ou mais CCs que serão copiadas na transação do contrato.
Data de criação	createdDate	date	Data de criação do contrato
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está ativada
Tempo de expiração	expirationTime	string	Prazo após o qual o Acordo expira e tem de ser assinado antes dele
ID externo	externalId.id	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Grupo Externo	externalId.group	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Primeiro atraso de lembrete	firstReminderDelay	integer	Inteiro que especifica o atraso em horas antes de enviar o primeiro lembrete.
Localidade	locale	string	A localidade associada a este contrato
Message	message	string	Uma mensagem opcional para os participantes, descrevendo o que está sendo enviado ou por que sua assinatura é necessária
Frequência do lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, a frequência padrão definida para a conta será usada
E-mail do remetente	senderEmail	string	E-mail do remetente do contrato
Vaulting ativado?	vaultingInfo.enabled	boolean	Para contas configuradas para compartimentação de documentos e a opção de habilitação por contrato, isso determina se o documento deve ser compartimentado
Post Sign Redirecionamento Url	postSignOption.redirectUrl	string	Um URL acessível publicamente para o qual o usuário será enviado depois de concluir com êxito o processo de assinatura
ID do fluxo de trabalho	workflowId	string	A ID do fluxo de trabalho personalizado que define o caminho de roteamento de um contrato.
Conjuntos de Participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	O participante define informações

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Informações completas sobre o acordo

Name	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do contrato
Nome	name	string	O nome do contrato
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Situação	status	string	Situação atual do acordo
CC	ccs	array of CcInfo	Uma lista de uma ou mais CCs que serão copiadas na transação do contrato.
Data de criação	createdDate	date	Data de criação do contrato
Tempo de expiração	expirationTime	string	Prazo após o qual o Acordo expira e tem de ser assinado antes dele
ID externo	externalId.id	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Grupo Externo	externalId.group	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Primeiro atraso de lembrete	firstReminderDelay	integer	Inteiro que especifica o atraso em horas antes de enviar o primeiro lembrete.
Localidade	locale	string	A localidade associada a este contrato
Message	message	string	Uma mensagem opcional para os participantes, descrevendo o que está sendo enviado ou por que sua assinatura é necessária
Frequência do lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, a frequência padrão definida para a conta será usada
Post Sign Redirecionamento Url	postSignOption.redirectUrl	string	Um URL acessível publicamente para o qual o usuário será enviado depois de concluir com êxito o processo de assinatura
ID do fluxo de trabalho	workflowId	string	A ID do fluxo de trabalho personalizado que define o caminho de roteamento de um contrato.
E-mail do remetente	senderEmail	string	E-mail do remetente do contrato
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está ativada
Vaulting ativado?	vaultingInfo.enabled	boolean	Para contas configuradas para compartimentação de documentos e a opção de habilitação por contrato, isso determina se o documento deve ser compartimentado
Conjuntos de Participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	O participante define informações
Próximos Conjuntos de Participantes	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	O próximo participante define informações
Documents	documentsInfo.documents	array of WebhookDocument	Uma lista de objetos que representam os documentos
Documentos comprovativos	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Lista dos documentos comprovativos Esta só é devolvida se existir algum documento comprovativo no acordo
Informações do documento assinado	signedDocumentInfo.document	string	Uma cadeia de caracteres codificada em base64 do documento assinado

WebhookAgreementInfoWithSignedDocument

Informações completas sobre o acordo

Name	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do contrato
Nome	name	string	O nome do contrato
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Situação	status	string	Situação atual do acordo
CC	ccs	array of CcInfo	Uma lista de uma ou mais CCs que serão copiadas na transação do contrato
Data de criação	createdDate	date	Data de criação do contrato
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está ativada
Tempo de expiração	expirationTime	string	Prazo após o qual o Acordo expira e tem de ser assinado antes dele
ID externo	externalId.id	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Grupo Externo	externalId.group	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Primeiro atraso de lembrete	firstReminderDelay	integer	Inteiro que especifica o atraso em horas antes de enviar o primeiro lembrete.
Localidade	locale	string	A localidade associada a este contrato
Message	message	string	Uma mensagem opcional para os participantes, descrevendo o que está sendo enviado ou por que sua assinatura é necessária
Frequência do lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, a frequência padrão definida para a conta será usada
E-mail do remetente	senderEmail	string	E-mail do remetente do contrato
Vaulting ativado?	vaultingInfo.enabled	boolean	Para contas configuradas para compartimentação de documentos e a opção de habilitação por contrato, isso determina se o documento deve ser compartimentado
Post Sign Redirecionamento Url	postSignOption.redirectUrl	string	Um URL acessível publicamente para o qual o usuário será enviado depois de concluir com êxito o processo de assinatura
ID do fluxo de trabalho	workflowId	string	A ID do fluxo de trabalho personalizado que define o caminho de roteamento de um contrato.
Conjuntos de Participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	O participante define informações
Documents	documentsInfo.documents	array of WebhookDocument	Uma lista de objetos que representam os documentos
Documentos comprovativos	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Lista dos documentos comprovativos Esta só é devolvida se existir algum documento comprovativo no acordo
Informações do documento assinado	signedDocumentInfo.document	string	Uma cadeia de caracteres codificada em base64 do documento assinado

WebhookMegaSignInfo

A informação completa do mega signo

Name	Caminho	Tipo	Description
ID	id	string	A ID única do megasinal
Nome	name	string	O nome do megasinal
Situação	status	string	O status do megasinal
CC	ccs	array of MegaSignCcInfo	Uma lista de um ou mais endereços de e-mail que você deseja copiar neste megasinal.
ID externo	externalId.id	string	Um valor arbitrário do seu sistema, que pode ser especificado no momento do envio e, em seguida, retornado ou consultado posteriormente
Primeiro atraso de lembrete	firstReminderDelay	integer	Inteiro que especifica o atraso em horas antes de enviar o primeiro lembrete.
Localidade	locale	string	A localidade associada a este contrato
Message	message	string	Uma mensagem opcional para os participantes, descrevendo o que está sendo enviado ou por que sua assinatura é necessária
Post Sign Redirecionamento Url	postSignOption.redirectUrl	string	Um URL acessível publicamente para o qual o usuário será enviado depois de concluir com êxito o processo de assinatura
E-mail do remetente	senderEmail	string	E-mail do criador do megasign
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado - Assinatura eletrônica ou Escrita
Vaulting ativado?	vaultingInfo.enabled	boolean	Para contas configuradas para compartimentação de documentos e a opção de habilitação por contrato, isso determina se o documento deve ser compartimentado
Informações do arquivo de contratos filhos	childAgreementsInfo.fileInfo	MegaSignChildAgreementsFileInfo	Informações de arquivo contendo informações de acordo por filho do megaSign.

WebhookWidgetInfo

As informações completas do formulário web

Name	Caminho	Tipo	Description
ID	id	string	O ID exclusivo do formulário Web
Nome	name	string	O nome do formulário Web
Situação	status	string	O estado do formulário Web
Informações sobre falhas de autenticação	authFailureInfo	AuthFailureWidgetRedirectionInfo	URL e propriedades associadas para a página de erro que o signatário do formulário da Web será tomado depois de não conseguir autenticar
CC	ccs	array of WidgetCcInfo	Uma lista de um ou mais endereços de e-mail que você deseja copiar neste formulário da Web.
Data de criação	createdDate	date	Data de criação do formulário Web
Informações de conclusão	completionInfo	WidgetCompletionRedirectionInfo	URL e propriedades associadas para a página de sucesso para a qual o signatário do formulário da Web será levado depois de executar a ação desejada no formulário da Web
E-mail do criador	creatorEmail	string	O e-mail do criador do formulário web
Vaulting ativado?	vaultingInfo.enabled	boolean	Para contas configuradas para compartimentação de documentos e a opção de habilitação por contrato, isso determina se o documento deve ser compartimentado
Informações adicionais sobre conjuntos de participantes	participantSetsInfo.additionalParticipantSets	array of WidgetParticipantSetInfo	Lista de todos os participantes no formulário Web, exceto o signatário do formulário Web
Primeiro Participante Definir Função	participantSetsInfo.widgetParticipantSet.role	string	Papel assumido por todos os participantes do conjunto (signatário, aprovador, etc.)
Primeiro Participante set Order	participantSetsInfo.widgetParticipantSet.order	integer	Índice que indica o grupo de assinatura sequencial (especificado para roteamento híbrido)
Documents	documentsInfo.documents	array of WidgetWebhookDocument	Uma lista de objetos que representam os documentos

AuthFailureWidgetRedirectionInfo

URL e propriedades associadas para a página de erro que o signatário do formulário da Web será tomado depois de não conseguir autenticar

Name	Caminho	Tipo	Description
Atraso de redirecionamento de falha de autenticação	delay	integer	O atraso (em segundos) antes que o usuário seja levado para a página resultante
Deframe de redirecionamento de falha de autenticação	deframe	boolean	Se o deframe for false, a página resultante será mostrada dentro do quadro do formulário da Web
URL de redirecionamento de falha de autenticação	url	string	Um url acessível publicamente para o qual o usuário será enviado após o preenchimento bem-sucedido do formulário da Web

WidgetCompletionRedirectionInfo

URL e propriedades associadas para a página de sucesso para a qual o signatário do formulário da Web será levado depois de executar a ação desejada no formulário da Web

Name	Caminho	Tipo	Description
Atraso de redirecionamento de conclusão	delay	integer	O atraso (em segundos) antes que o usuário seja levado para a página resultante
Deframe de redirecionamento de conclusão	deframe	boolean	Se o deframe for false, a página resultante será mostrada dentro do quadro do formulário da Web
URL de redirecionamento de conclusão	url	string	Um url acessível publicamente para o qual o usuário será enviado após o preenchimento bem-sucedido do formulário da Web

WebhookParticipantSets

Name	Caminho	Tipo	Description
Informações do Membro	memberInfos	array of MemberInfos	As informações sobre os membros participantes
Encomenda	order	integer	Índice que indica a posição na qual o grupo de assinatura precisa assinar.
Funções	role	string	Papel assumido por todos os participantes do conjunto (signatário, aprovador, etc.)
Situação	status	string	Situação atual do acordo na perspetiva do utilizador
ID	id	string	O ID do conjunto de participantes
Nome	name	string	O nome do conjunto de participantes
Mensagem Privada	privateMessage	string	Mensagem privada para os participantes do conjunto

MegaSignChildAgreementsFileInfo

Informações de arquivo contendo informações de acordo por filho do megaSign.

Name	Caminho	Tipo	Description
ID do arquivo de contratos filho	childAgreementsInfoFileId	string	O ID do arquivo que contém informações sobre o childAgreementsInfo existente do megaSign.

WidgetWebhookDocument

As informações sobre o documento do formulário Web

Name	Caminho	Tipo	Description
ID	id	string	O ID exclusivo do documento
Nome	name	string	O nome do documento

WebhookDocument

As informações sobre o documento do acordo

Name	Caminho	Tipo	Description
ID	id	string	O ID exclusivo do documento
Nome	name	string	O nome do documento

WebhookSupportingDocument

Informações sobre o documento comprovativo

Name	Caminho	Tipo	Description
Nome	displayLabel	string	Nome para apresentação do documento de apoio
Nome do campo	fieldName	string	O nome do campo do documento de apoio
ID	id	string	O ID exclusivo que representa o documento comprovativo

WidgetCcInfo

As informações sobre o CC do formulário web

Name	Caminho	Tipo	Description
Email	email	string	E-mail do participante CC do formulário web

MegaSignCcInfo

As informações sobre o CC do mega sinal

Name	Caminho	Tipo	Description
Email	email	string	Email do participante CC do megasinal

CcInfo

As informações sobre o CC do acordo

Name	Caminho	Tipo	Description
Email	email	string	O email do CC do acordo
Etiqueta	label	string	O rótulo da lista CC como retornado na descrição do fluxo de trabalho
Páginas visíveis	visiblePages	array of string	As páginas visíveis para o CC

WidgetParticipantSetInfo

Name	Caminho	Tipo	Description
Funções	role	string	Papel assumido por todos os participantes do conjunto (signatário, aprovador, etc.)
ID	id	string	O identificador único do conjunto de participantes
Informações do Membro	memberInfos	array of MemberInfos	As informações sobre os membros participantes
Encomenda	order	integer	Índice que indica o grupo de assinatura sequencial (especificado para roteamento híbrido)

MemberInfos

Name	Caminho	Tipo	Description
ID	id	string	O ID único do participante
Email	email	string	O e-mail do participante
Empresa	company	string	A companhia do participante
Nome	name	string	O nome do participante
Mensagem Privada	privateMessage	string	A mensagem privada do participante
Situação	status	string	O estatuto do participante

LibraryDocumentCreationResponseV6

Um objeto JSON descrevendo o modelo de biblioteca

Name	Caminho	Tipo	Description
ID do modelo de biblioteca	id	string	A ID exclusiva que pode ser usada para fazer referência ao modelo de biblioteca

BibliotecaDocumento

Name	Caminho	Tipo	Description
ID do modelo de biblioteca	id	string	O identificador exclusivo usado para fazer referência ao modelo de biblioteca
Escondido	hidden	boolean	True se o documento da biblioteca estiver oculto
Tipo(s) de modelo	templateTypes	array of string	Uma lista de um ou mais tipos de modelo de biblioteca
Data de Modificação	modifiedDate	date	O dia em que o modelo de biblioteca foi modificado pela última vez
Nome do modelo de biblioteca	name	string	O nome do modelo de biblioteca
Modo de compartilhamento de modelo	sharingMode	string	O âmbito da visibilidade do modelo de biblioteca
E-mail do criador	creatorEmail	string	Endereço de e-mail do criador do documento da biblioteca.
ID do grupo	groupId	string	O identificador exclusivo do grupo ao qual o modelo de biblioteca pertence.
Situação	status	string	Estado do documento da biblioteca

BibliotecaDocumentos

Um JSON que contém o objeto de matriz de modelo de biblioteca

Name	Caminho	Tipo	Description
página	page	page	Informações de paginação para navegar pela resposta
Lista de Modelos de Biblioteca	libraryDocumentList	array of LibraryDocument	Uma lista de itens de modelo de biblioteca

UserWidgetV6

Name	Caminho	Tipo	Description
ID do formulário Web	id	string	O identificador exclusivo de um formulário Web
Data de Modificação	modifiedDate	string	A data em que o formulário Web foi modificado pela última vez
Escondido	hidden	boolean	True se o contrato estiver oculto para o usuário
ID do grupo	groupId	string	Identificador exclusivo do grupo
Nome	name	string	O nome do formulário Web
Situação	status	string	O estado do formulário Web
Endereço URL	url	string	O url hospedado do formulário da Web
Javascript	javascript	string	O código javascript incorporado do formulário Web

userWidgetListV6

Um JSON que contém o objeto de matriz de formulário da Web do usuário

Name	Caminho	Tipo	Description
página	page	page	Informações de paginação para navegar pela resposta
Lista de formulários Web	userWidgetList	array of UserWidgetV6	Uma matriz de itens de formulário da Web

UserWorkflowV6

Name	Caminho	Tipo	Description
ID do fluxo de trabalho	id	string	O identificador exclusivo de um fluxo de trabalho
Description	description	string	Descrição fornecida para este fluxo de trabalho no momento da sua criação
Data de criação	created	string	A data em que o fluxo de trabalho foi criado. O formato seria aaaa-MM-dd'T'HH:mm:ssZ
Data de Modificação	modified	string	A data em que o fluxo de trabalho foi modificado. O formato seria aaaa-MM-dd'T'HH:mm:ssZ
Nome	name	string	O nome do fluxo de trabalho
Nome de exibição	displayName	string	O nome para exibição do fluxo de trabalho
Situação	status	string	O status do fluxo de trabalho
Scope	scope	string	O escopo do fluxo de trabalho
ID do originador	originatorId	string	Originador inicial do fluxo de trabalho
ID do Âmbito	scopeId	string	Identificador do âmbito. Atualmente é aplicável apenas para o escopo GROUP e o valor será groupId.

userWorkflowListV6

Um JSON que contém o objeto de matriz de fluxo de trabalho do usuário

Name	Caminho	Tipo	Description
Lista de fluxos de trabalho	userWorkflowList	array of UserWorkflowV6	Uma matriz de itens de fluxo de trabalho

WorkflowDefaultParamsV6

Um JSON que contém o objeto params padrão do fluxo de trabalho

Name	Caminho	Tipo	Description
Valor padrão	defaultValue	string	Valor padrão do campo se a entrada para este campo não for fornecida e este campo for obrigatório
Editável	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para este campo for falso, esse campo não deve ser fornecido na solicitação de criação do contrato e o valor padrão desse campo será usado na criação do contrato
Obrigatório	required	boolean	Se este campo é obrigatório ou opcional
Visível	visible	boolean	Se o campo atual é visível ou não. Se o atributo visible para este campo for false, esse campo não deverá estar visível na interface do usuário de criação do contrato usando este fluxo de trabalho para o usuário

CCsListInfoDescriptionV6

Um JSON que contém informações detalhadas sobre o fluxo de trabalho

Name	Caminho	Tipo	Description
Valores Predefinidos	defaultValues	array of string	Uma matriz de e-mails padrão que será usada se nenhuma entrada for fornecida para este elemento de lista
Editável	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para este campo for falso, esse campo não deve ser fornecido na solicitação de criação do contrato e o valor padrão desse campo será usado na criação do contrato
Etiqueta	label	string	Um texto de exibição para o usuário do fluxo de trabalho que pode ser usado para a lista CC atual
Máximo de entradas CC	maxListCount	integer	Número máximo de entradas permitidas na lista CC atual
Entradas Min CC	minListCount	integer	Número mínimo de entradas permitidas na lista CC atual
Nome da Lista CC	name	string	Nome da lista CC atual
Obrigatório	required	boolean	Se este campo é obrigatório ou opcional
Visível	visible	boolean	Se o campo atual é visível ou não. Se o atributo visible para este campo for false, esse campo não deverá ser mostrado na página de criação de contrato usando este fluxo de trabalho

ExpirationFieldInfoDescriptionV6

Um JSON que contém informações sobre expiração

Name	Caminho	Tipo	Description
Valor padrão	defaultValue	string	Valor padrão do campo se a entrada para este campo não for fornecida e este campo for obrigatório
Editável	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para este campo for falso, esse campo não deve ser fornecido na solicitação de criação do contrato e o valor padrão desse campo será usado na criação do contrato
Prazo de validade do contrato Max Days	maxDays	integer	Número máximo de dias para expiração do contrato
Obrigatório	required	boolean	Se este campo é obrigatório ou opcional
Visível	visible	boolean	Se o campo atual é visível ou não. Se o atributo visible para este campo for false, esse campo não deverá ser mostrado na página de criação de contrato usando este fluxo de trabalho

ArquivoInfosDescriçãoV6

Um JSON que contém informações sobre arquivos

Name	Caminho	Tipo	Description
Etiqueta	label	string	Exibir rótulo deste campo para usuários externos
Nome	name	string	Nome do elemento fileInfo
Obrigatório	required	boolean	Se este campo é obrigatório ou opcional
Documentos da biblioteca de fluxo de trabalho	workflowLibraryDocumentSelectorList	array of WorkflowLibraryDocumentV6	Uma lista de documentos da biblioteca de fluxo de trabalho dos quais um documento de biblioteca de fluxo de trabalho pode ser selecionado com este objeto fileInfo

WorkflowLibraryDocumentV6

Um JSON que contém informações sobre o documento da biblioteca de fluxo de trabalho

Name	Caminho	Tipo	Description
Etiqueta	label	string	Um texto de exibição para este formulário para usuários do fluxo de trabalho
Data de Modificação	modifiedDate	string	A data em que o documento da biblioteca foi modificado pela última vez. O formato seria aaaa-MM-dd'T'HH:mm:ssZ. Por exemplo, por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Modo de Partilha	sharingMode	string	Especifica quem deve ter acesso a este documento da biblioteca. O compartilhamento GLOBAL é uma operação restrita
Tipos de modelo	templateTypes	array of	Uma lista de um ou mais tipos de modelo de biblioteca
ID do documento da biblioteca de fluxo de trabalho	workflowLibDoc	string	Uma id do documento da biblioteca de fluxo de trabalho que pode ser fornecido como um arquivo de entrada na solicitação de criação de contrato de fluxo de trabalho personalizado

LocaleFieldInfoDescriptionV6

Um JSON que contém informações detalhadas sobre a localidade do fluxo de trabalho

Name	Caminho	Tipo	Description
Localidades disponíveis	availableLocales	array of string	Quais localidades podem ser escolhidas para esse fluxo de trabalho
Valor padrão	defaultValue	string	Valor padrão do campo se a entrada para este campo não for fornecida e este campo for obrigatório
Editável	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para este campo for falso, esse campo não deve ser fornecido na solicitação de criação do contrato e o valor padrão desse campo será usado na criação do contrato
Obrigatório	required	boolean	Se este campo é obrigatório ou opcional
Visível	visible	boolean	Se o campo atual é visível ou não. Se o atributo visible para este campo for false, esse campo não deverá estar visível na interface do usuário de criação do contrato usando este fluxo de trabalho para o usuário

MergeFieldInfoDescriptionV6

Um JSON que contém informações detalhadas sobre o campo de mesclagem

Name	Caminho	Tipo	Description
Valor padrão	defaultValue	string	Valor padrão do campo se a entrada para este campo não for fornecida e este campo for obrigatório
Nome de exibição	displayName	string	O texto de exibição que pode ser mostrado para este campo personalizado
Editável	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para este campo for falso, esse campo não deve ser fornecido na solicitação de criação do contrato e o valor padrão desse campo será usado na criação do contrato
Nome do campo personalizado	fieldName	string	Nome do campo personalizado neste fluxo de trabalho
Obrigatório	required	boolean	Se este campo é obrigatório ou opcional
Visível	visible	boolean	Se o campo atual deve estar visível na página de criação do contrato. Se o atributo visible para este campo for false, esse campo não deverá ser mostrado na página de criação do contrato usando este fluxo de trabalho

PasswordFieldInfoDescriptionV6

Um JSON que contém informações detalhadas sobre a senha

Name	Caminho	Tipo	Description
Palavra-passe	defaultValue	string	Valor padrão do campo de informações da senha
Editável	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para este campo for falso, esse campo não deve ser fornecido na solicitação de criação do contrato e o valor padrão desse campo será usado na criação do contrato
Etiqueta	label	string	Rótulo do campo de senha
Nome	name	string	Campo Nome da palavra-passe
Obrigatório	required	boolean	Se este campo é obrigatório ou opcional
Visível	visible	boolean	Se o campo de informações de senha está visível na página de criação do contrato

RecipientsListInfoDescriptionV6

Um JSON que contém informações detalhadas sobre a lista de destinatários

Name	Caminho	Tipo	Description
Permitir remetente	allowSender	boolean	Se o remetente é permitido como destinatário
Permitir remetente	allowfax	boolean	Se o fax é permitido ou não
Método de autenticação	authenticationMethod	string	Método de autenticação para que a lista de destinatários atual tenha acesso para visualizar e assinar o documento,
Valor padrão de e-mail/fax	defaultValue	string	Um número de e-mail ou fax padrão
Editável	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para este campo for falso, esse campo não deve ser fornecido na solicitação de criação do contrato e o valor padrão desse campo será usado na criação do contrato
Etiqueta	label	string	Um texto de exibição para o usuário do fluxo de trabalho que pode ser usado para a lista de destinatários atual
Destinatários máximos	maxListCount	integer	Número máximo de entradas permitidas na lista de destinatários atual
Destinatários mínimos	minListCount	integer	Número mínimo de entradas permitidas na lista de destinatários atual
Nome da lista de informações do destinatário	name	string	Nome da lista atual de Informações do Destinatário
Papel do Participante	role	string	O papel atual do participante
Visível	visible	boolean	Se o campo atual está visível. Se o atributo visible para este campo for false, esse campo não deverá ser mostrado na interface do usuário de criação do contrato usando este fluxo de trabalho para o usuário

WorkflowDescriptionV6

Um JSON que contém informações detalhadas sobre o fluxo de trabalho

Name	Caminho	Tipo	Description
agreementNameInfo	agreementNameInfo	WorkflowDefaultParamsV6	Um JSON que contém o objeto params padrão do fluxo de trabalho
authoringInfo	authoringInfo	WorkflowDefaultParamsV6	Um JSON que contém o objeto params padrão do fluxo de trabalho
Informações da lista CC	ccsListInfo	array of CCsListInfoDescriptionV6	Informações sobre o campo de entrada da lista CC na solicitação de criação do contrato
Data de criação do fluxo de trabalho	created	string	O dia em que o fluxo de trabalho foi criado
Descrição do fluxo de trabalho	description	string	Descrição fornecida para este fluxo de trabalho no momento da sua criação
Nome de exibição do fluxo de trabalho	displayName	string	O nome para exibição do fluxo de trabalho
expiraçãoInfo	expirationInfo	ExpirationFieldInfoDescriptionV6	Um JSON que contém informações sobre expiração
Informações sobre arquivos	fileInfos	array of FileInfosDescriptionV6	Informações sobre o campo de entrada de informações do arquivo na solicitação de criação do contrato
localeInfo	localeInfo	LocaleFieldInfoDescriptionV6	Um JSON que contém informações detalhadas sobre a localidade do fluxo de trabalho
Informações sobre mesclar campos	mergeFieldsInfo	array of MergeFieldInfoDescriptionV6	Informações sobre o campo de entrada de informações personalizadas na solicitação de criação de contrato
messageInfo	messageInfo	WorkflowDefaultParamsV6	Um JSON que contém o objeto params padrão do fluxo de trabalho
Data de Modificação	modified	string	O dia em que o fluxo de trabalho foi modificado pela última vez
Nome do fluxo de trabalho	name	string	O nome do fluxo de trabalho
passwordInfo	passwordInfo	PasswordFieldInfoDescriptionV6	Um JSON que contém informações detalhadas sobre a senha
Informações da lista de destinatários	recipientsListInfo	array of RecipientsListInfoDescriptionV6	Informações sobre o campo de entrada de informações de recetivos na solicitação de criação de contrato
Escopo do fluxo de trabalho	scope	string	O escopo do fluxo de trabalho
Status do fluxo de trabalho	status	string	O status do fluxo de trabalho
ID do Originador do Fluxo de Trabalho	originatorId	string	Originador inicial do fluxo de trabalho
ID do escopo do fluxo de trabalho	scopeId	string	Identificador do âmbito. Atualmente é aplicável apenas para o escopo GROUP e o valor será groupId

BooleanSettingInfoV6

Name	Caminho	Tipo	Description
Valor	value	boolean	Valor da configuração
Herdado	inherited	boolean	True se a configuração for herdada de seu grupo ou valor de conta

ConfiguraçõesInfoV6

Name	Caminho	Tipo
libaryDocumentCreationVisible	libaryDocumentCreationVisible	BooleanSettingInfoV6
sendRestrictedToWorkflows	sendRestrictedToWorkflows	BooleanSettingInfoV6
userCanSend	userCanSend	BooleanSettingInfoV6
widgetCriaçãoVisível	widgetCreationVisible	BooleanSettingInfoV6

UserGroupInfoV6

Name	Caminho	Tipo	Description
ID do grupo	id	string	Identificador exclusivo do grupo
É administrador do grupo	isGroupAdmin	boolean	True se o usuário for administrador do grupo
É Grupo Primário	isPrimaryGroup	boolean	True se o grupo for o grupo principal do usuário
Situação	status	string	Estatuto dos membros do grupo
Data de criação	createdDate	date	O grupo de datas foi criado
Nome do Grupo	name	string	Nome do grupo
definições	settings	SettingsInfoV6

UserGroupsInfoV6

Um JSON que contém a lista de grupos para determinado usuário

Name	Caminho	Tipo	Description
Lista de Grupos de Utilizadores	groupInfoList	array of UserGroupInfoV6	Uma matriz de itens de informações do grupo de usuários

AcordoVisões

Lista de pontos de vista do acordo

Name	Caminho	Tipo	Description
Lista de exibição de contrato	agreementViewList	array of AgreementView	Visões do acordo

AcordoVer

Nome da visualização necessária e sua configuração desejada.

Name	Caminho	Tipo	Description
Ver URL	url	string	URL do local do recurso
Código incorporado	embeddedCode	string	Código incorporado de url do recurso
Expiração	expiration	string	Expiração do url do usuário
É Visualização Atual	isCurrent	boolean	True se esta vista for a vista atual

binário

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

objecto

Este é o tipo 'objeto'.

ficheiro

Este é o tipo de dados básicos 'arquivo'.

Partilhar via

Adobe Acrobat Assinar

Adobe Acrobat Assinar

Editora: Adobe, Inc.

Pré-requisitos

Como obter credenciais

Introdução ao conector

Problemas conhecidos e limitações

Erros e soluções comuns

FAQ

Limites de Limitação

Ações

Cancelar um contrato

Parâmetros

Carregar um documento e obter um ID de documento

Parâmetros

Devoluções

Carregue um documento e obtenha um ID de documento (antigo) [PRETERIDO]

Parâmetros

Devoluções

Criar um contrato a partir de um documento carregado e enviar para assinatura

Parâmetros

Devoluções

Criar um contrato a partir de um documento carregado e enviar para assinatura (Antigo) [PRETERIDO]

Parâmetros

Devoluções

Criar um contrato a partir de um fluxo de trabalho e enviar para assinatura

Parâmetros

Devoluções

Criar um contrato a partir de um modelo de biblioteca e enviar para assinatura

Parâmetros

Devoluções

Criar um contrato a partir de um modelo de biblioteca e enviar para assinatura (Antigo) [PRETERIDO]

Parâmetros

Devoluções

Criar um contrato a partir de um URL de documento e enviar para assinatura

Parâmetros

Devoluções

Criar um contrato a partir de um URL de documento e enviar para assinatura (Antigo) [DEPRECATED]

Parâmetros

Devoluções

Criar um contrato a partir do conteúdo de um arquivo e enviar para assinatura

Parâmetros

Devoluções

Criar um modelo de biblioteca a partir de um documento carregado

Parâmetros

Devoluções

Criar um modelo de biblioteca a partir de um documento carregado (Antigo) [PRETERIDO]

Parâmetros

Devoluções

Criar um modelo de biblioteca a partir de um URL de documento

Parâmetros

Devoluções

Criar um modelo de biblioteca a partir de um URL de documento (antigo) [PRETERIDO]

Parâmetros

Devoluções

Obtenha uma lista de todos os contratos

Parâmetros

Devoluções

Obter as informações detalhadas do fluxo de trabalho

Parâmetros

Devoluções

Obter dados de campo de formulário de acordo (Antigo) [PRETERIDO]

Parâmetros

Devoluções

Obter dados de campo de formulário de contrato em formato CSV

Parâmetros

Devoluções

Obter dados de campo de formulário de contrato no formato JSON

Parâmetros

Devoluções

Obter o status de um contrato

Parâmetros

Devoluções

Obter o status de um contrato [DEPRECATED]

Parâmetros

Devoluções

Obter o URL de visualização do contrato

Parâmetros

Devoluções