Assinatura do Adobe Acrobat

A Adobe é o serviço de entrada de documento digital 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.

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

Service	Class	Regions
Copilot Studio	Standard	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	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)
Power Automate	Standard	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

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

Assinatura do Adobe Acrobat

Publisher: 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 e limitações conhecidos

N/A

Erros e soluções comuns

N/A

perguntas frequentes

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

Limitações

Nome	Chamadas	Período de renovação
Chamadas à 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 uma ID de documento	Esta operação carrega um documento em 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.
Carregar um documento e obter uma ID de documento (Antiga) [PRETERIDA]	Esta operação carrega um documento em 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 uma URL de documento e enviar para assinatura	Esta operação cria um contrato de um documento carregado no Adobe Acrobat Sign e o envia para assinatura.
Criar um contrato a partir de uma URL de documento e enviar para assinatura (Antiga) [PRETERIDA]	Esta operação cria um contrato de um documento carregado no Adobe Acrobat Sign e o envia para assinatura.
Criar um contrato com base em um conteúdo de arquivo e enviar para assinatura	Esta operação cria um contrato de um arquivo no Adobe Acrobat Sign e o envia para assinatura.
Criar um contrato com base em um documento carregado e enviar para assinatura	Esta operação cria um contrato de um documento carregado no Adobe Acrobat Sign e o envia para assinatura.
Criar um contrato com base em um modelo de biblioteca e enviar para assinatura	Essa operação cria um contrato com base em um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.
Criar um contrato com base em um modelo de biblioteca e enviar para assinatura (Antiga) [PRETERIDO]	Essa operação cria um contrato com base em um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.
Criar um contrato de um documento carregado e enviar para assinatura (Antiga) [PRETERIDO]	Esta operação cria um contrato de um documento carregado no Adobe Acrobat Sign e o envia para assinatura.
Criar um contrato de um fluxo de trabalho e enviar para assinatura	Esta operação cria um contrato de um fluxo de trabalho no Adobe Acrobat Sign e o envia para assinatura.
Criar um modelo de biblioteca a partir de uma URL de documento	Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de uma URL de documento. Use este modelo para enviar contratos
Criar um modelo de biblioteca a partir de uma URL de documento (Antiga) [PRETERIDA]	Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de uma URL de documento. Use este modelo para enviar contratos
Criar um modelo de biblioteca com base em um documento carregado	Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de um documento carregado. Use este modelo para enviar contratos.
Criar um modelo de biblioteca de um documento carregado (Antigo) [PRETERIDO]	Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de um documento carregado. Use este modelo para enviar contratos.
Obter a URL de exibição do contrato	Recupera a url de exibição de estado mais recente do contrato.
Obter as informações detalhadas do fluxo de trabalho	Esta operação busca informações detalhadas sobre o fluxo de trabalho.
Obter dados de campo de formulário do contrato (Antigo) [PRETERIDO]	Recupera os dados inseridos nos campos de formulário interativos do contrato.
Obter dados de campo de formulário do contrato no formato CSV	Recupera os dados inseridos nos campos de formulário interativos do contrato.
Obter dados de campo de formulário do contrato no formato JSON	Recupera os dados inseridos nos campos de formulário interativos do contrato.
Obter o status de um contrato	Essa operação busca todas as informações atuais de um contrato, como o status.
Obter o status de um contrato [PRETERIDO]	Esta ação foi preterida. Em vez disso, use Obter o status de um contrato . ~~Essa operação busca todas as informações atuais de um contrato, como o status.~~
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 [PRETERIDO]	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 trilha de auditoria do contrato	Essa operação busca o fluxo de arquivos PDF da trilha de auditoria do contrato. Observe que o fluxo de arquivos deve ser armazenado com um nome de arquivo terminando em .pdf extensão de arquivo.
Obter um PDF de um contrato assinado	Essa 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 terminando em .pdf extensão de arquivo.
Obter um PDF de um contrato assinado [PRETERIDO]	Esta ação foi preterida. Em vez disso, use Obter um PDF de um contrato assinado . ~~Essa 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 terminando em .pdf extensão de arquivo.~~
Obter uma lista de todas as IDs de documento de um contrato	Esta operação busca as IDs de todos os documentos e documentos de suporte de um contrato.
Obter uma lista de todas as IDs de documento de um contrato [PRETERIDO]	Esta ação foi preterida. Em vez disso, use Obter uma lista de todas as IDs de documento de um contrato . ~~Esta operação busca as IDs de todos os documentos e documentos de suporte de um contrato.~~
Obter uma lista de todos os contratos	Esta operação busca a lista de todos os contratos do usuário.
Obter uma lista de todos os contratos (Antigo) [PRETERIDO]	Esta operação busca a lista de todos os contratos do usuário.
Obter uma lista de todos os contratos com base nos critérios de pesquisa	Essa operação pesquisa contratos por critérios como ID de fluxo de trabalho etc.
Obter uma lista de todos os fluxos de trabalho	Essa operação busca a lista de todos os fluxos de trabalho do usuário.
Obter uma lista de todos os formulários da Web	Essa 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	Essa operação busca a lista de todos os grupos aos quais o usuário pertence.
Obter uma lista de todos os modelos de biblioteca	Esta operação busca a lista de todos os documentos armazenados como modelos na biblioteca 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 Adobe Acrobat Sign do usuário.
Recuperar a URL de Assinatura	Essa operação recupera a URL da página de sinal eletrônico para os signatários atuais de um contrato.

Cancelar um contrato

ID da operação:: CancelAgreement

Cancela o contrato identificado por agreementId no caminho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato que deve ser cancelada.
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
Estado de entrada	state		string	O estado em que o acordo deve desembarcar.
Comment	comment		string	Um comentário opcional que descreve o motivo do cancelamento para os destinatários.
Outros	notifyOthers		boolean	Quer você queira ou não que os destinatários sejam notificados.

Carregar um documento e obter uma ID de documento

ID da operação:: CreateTransientDocument_V2

Esta operação carrega um documento em 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

Nome	Chave	Obrigatório	Tipo	Description
Nome do Arquivo	File-Name	True	string	O nome do documento a ser carregado, com extensão
Conteúdo do arquivo	File	True	contentOnly	O fluxo de arquivos do documento a ser carregado
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

Um JSON que contém a ID do documento carregado

Corpo: TransientDocumentResponse

Carregar um documento e obter uma ID de documento (Antiga) [PRETERIDA]

ID da operação:: CreateTransientDocument

Parâmetros

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

Retornos

Um JSON que contém a ID do documento carregado

Corpo: TransientDocumentResponse

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

ID da operação:: CreateAgreementByUrl_V2

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
Nome do Contrato	name	True	string	O nome do contrato
URL	url	True	string	Uma URL acessível publicamente para recuperar o conteúdo bruto do arquivo
Nome	name	True	string	O nome do arquivo do sistema original do documento que está sendo enviado
Tipo	mimeType	True	string	O tipo mime do arquivo referenciado, por exemplo, aplicativo/pdf
Tipo de assinatura	signatureType	True	string	Especifica o tipo de assinatura que foi solicitado – Assinatura E ou Escrita
Email	email	True	string	O email do participante
Authentication	authenticationMethod		string	Autenticação padrão: email (Nenhum)
Senha	password		string	A senha necessária para o participante
Código do país	countryCode		string	Código do país de telefone do destinatário necessário para exibir e assinar o documento
Telefone Nº.	phone		string	Número de telefone do destinatário necessário para exibir e assinar o contrato
ID do provedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Pedido	order	True	integer	Índice começando com 1, indicando a posição na qual o grupo de assinatura precisa assinar.
Função	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 'In The Name Of' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários que solicitam sua ação
Tipo de Envio	sendType		string	O tipo de experiência usado pelo originador para enviar um contrato
Email	email		string	O email do CC do contrato
Hora de expiração	expirationTime		string	Hora após a expiração do Contrato. Exemplo: 2020-12-31T23:59:00Z
ID externa	externalId		string	Um valor arbitrário do seu sistema
Frequência de lembrete	reminderFrequency		string	Com que frequência você deseja enviar lembretes?
Senha do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Value	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 a ser redirecionada após concluir o processo de assinatura, por exemplo, https://adobe.com
Emails iniciais	initEmails		string	Controlar emails de notificação para eventos de iniciação de contrato.
Estado	state	True	string	O estado em que o acordo deve desembarcar.

Retornos

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

Corpo: AgreementCreationResponseV6

Criar um contrato a partir de uma URL de documento e enviar para assinatura (Antiga) [PRETERIDA]

ID da operação:: CreateAgreementByUrl

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do Contrato	name	True	string	O nome do contrato
URL	url	True	string	Uma 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 você deseja solicitar – Assinatura E ou Escrita
Email do destinatário	email	True	string	Email 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 de destinatário	recipientSetRole	True	string	Especificar a função do destinatário
Message	message		string	Uma mensagem opcional para os destinatários que solicitam sua ação
Dias a prazo	daysUntilSigningDeadline		integer	O número de dias que permanecem antes do documento expirar
Frequência de lembrete	reminderFrequency		string	Com que frequência você deseja enviar lembretes?
Senha do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
URL (2)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (2)	name		string	O nome do documento referenciado, com extensão
URL (3)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (3)	name		string	O nome do documento referenciado, com extensão
URL (4)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (4)	name		string	O nome do documento referenciado, com extensão
URL (5)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (5)	name		string	O nome do documento referenciado, com extensão
URL (6)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (6)	name		string	O nome do documento referenciado, com extensão
URL (7)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (7)	name		string	O nome do documento referenciado, com extensão
URL (8)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (8)	name		string	O nome do documento referenciado, com extensão
URL (9)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (9)	name		string	O nome do documento referenciado, com extensão
URL (10)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (10)	name		string	O nome do documento referenciado, com extensão
Email do destinatário (2)	email	True	string	Email 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
Email do destinatário (3)	email	True	string	Email 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
Email do destinatário (4)	email	True	string	Email 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
Email do destinatário (5)	email	True	string	Email 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
Email do destinatário (6)	email	True	string	Email 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
Email do destinatário (7)	email	True	string	Email 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
Email do destinatário (8)	email	True	string	Email 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
Email do destinatário (9)	email	True	string	Email 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
Email do destinatário (10)	email	True	string	Email 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
Email do destinatário (11)	email	True	string	Email 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 de destinatário (11)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (12)	email	True	string	Email 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
Email do destinatário (13)	email	True	string	Email 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 de destinatário (13)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (14)	email	True	string	Email 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
Email do destinatário (15)	email	True	string	Email 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
Email do destinatário (16)	email	True	string	Email 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 de destinatário (16)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (17)	email	True	string	Email 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
Email do destinatário (18)	email	True	string	Email 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
Email do destinatário (19)	email	True	string	Email 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
Email do destinatário (20)	email	True	string	Email 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
Email do destinatário (21)	email	True	string	Email 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
Email do destinatário (22)	email	True	string	Email 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
Email do destinatário (23)	email	True	string	Email 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
Email do destinatário (24)	email	True	string	Email 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
Email do destinatário (25)	email	True	string	Email 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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

Retornos

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

Corpo: AgreementCreationResponse

Criar um contrato com base em um conteúdo de arquivo e enviar para assinatura

ID da operação:: CreateAgreementByFileStream

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de 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 você gostaria de solicitar – assinatura ou gravação
Email	email	True	string	O email do participante
Authentication	authenticationMethod		string	Autenticação padrão: email (Nenhum)
Senha	password		string	A senha necessária para o participante
Código do país	countryCode		string	Código do país de telefone do destinatário necessário para exibir e assinar o documento
Telefone Nº.	phone		string	Número de telefone do destinatário necessário para exibir e assinar o contrato
ID do provedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Pedido	order	True	integer	Índice começando com 1, indicando a posição na qual o grupo de assinatura precisa assinar.
Função	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 'In The Name Of' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários que solicitam sua ação
Tipo de Envio	sendType		string	O tipo de experiência usado pelo originador para enviar um contrato
Email	email		string	O email do CC do contrato
Hora de expiração	expirationTime		string	Hora após a expiração do Contrato. Exemplo: 2020-12-31T23:59:00Z
ID externa	externalId		string	Um valor arbitrário do seu sistema
Frequência de lembrete	reminderFrequency		string	Com que frequência você deseja enviar lembretes?
Senha do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Value	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 a ser redirecionada após concluir o processo de assinatura, por exemplo, https://adobe.com
Emails iniciais	initEmails		string	Controlar emails de notificação para eventos de iniciação de contrato.
Estado	state	True	string	O estado em que o acordo deve desembarcar.

Retornos

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

Corpo: AgreementCreationResponseV6

Criar um contrato com base em um documento carregado e enviar para assinatura

ID da operação:: CreateAgreementById_V2

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
Nome do Contrato	name	True	string	O nome do contrato
ID	transientDocumentId	True	string	A ID do documento recebida carregando um documento transitório
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que você gostaria de solicitar – assinatura ou gravação
Email	email	True	string	O email do participante
Authentication	authenticationMethod		string	Autenticação padrão: email (Nenhum)
Senha	password		string	A senha necessária para o participante
Código do país	countryCode		string	Código do país de telefone do destinatário necessário para exibir e assinar o documento
Telefone Nº.	phone		string	Número de telefone do destinatário necessário para exibir e assinar o contrato
ID do provedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Pedido	order	True	integer	Índice começando com 1, indicando a posição na qual o grupo de assinatura precisa assinar.
Função	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 'In The Name Of' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários que solicitam sua ação
Tipo de Envio	sendType		string	O tipo de experiência usado pelo originador para enviar um contrato
Email	email		string	O email do CC do contrato
Hora de expiração	expirationTime		string	Hora após a expiração do Contrato. Exemplo: 2020-12-31T23:59:00Z
ID externa	externalId		string	Um valor arbitrário do seu sistema
Frequência de lembrete	reminderFrequency		string	Com que frequência você deseja enviar lembretes?
Senha do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Value	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 a ser redirecionada após concluir o processo de assinatura, por exemplo, https://adobe.com
Emails iniciais	initEmails		string	Controlar emails de notificação para eventos de iniciação de contrato.
Estado	state	True	string	O estado em que o acordo deve desembarcar.

Retornos

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

Corpo: AgreementCreationResponseV6

Criar um contrato com base em um modelo de biblioteca e enviar para assinatura

ID da operação:: CreateAgreementByTemplate_V2

Essa operação cria um contrato com base em um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
Nome do Contrato	name	True	string	O nome do contrato
Template	libraryDocumentId	True	string	Escolha um documento dos modelos armazenados em sua biblioteca
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que você gostaria de solicitar – assinatura ou gravação
Email	email	True	string	O email do participante
Authentication	authenticationMethod		string	Autenticação padrão: email (Nenhum)
Senha	password		string	A senha necessária para o participante
Código do país	countryCode		string	Código do país de telefone do destinatário necessário para exibir e assinar o documento
Telefone Nº.	phone		string	Número de telefone do destinatário necessário para exibir e assinar o contrato
ID do provedor	providerId		string	ID do Provedor do Gateway de Identidade Digital.
Pedido	order	True	integer	Índice começando com 1, indicando a posição na qual o grupo de assinatura precisa assinar.
Função	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 'In The Name Of' precisa ser selecionado
Message	message		string	Uma mensagem opcional para os destinatários que solicitam sua ação
Tipo de Envio	sendType		string	O tipo de experiência usado pelo originador para enviar um contrato
Email	email		string	O email do CC do contrato
Hora de expiração	expirationTime		string	Hora após a expiração do Contrato. Exemplo: 2020-12-31T23:59:00Z
ID externa	externalId		string	Um valor arbitrário do seu sistema
Frequência de lembrete	reminderFrequency		string	Com que frequência você deseja enviar lembretes?
Senha do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
Nome	fieldName		string	O nome do campo
Value	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 a ser redirecionada após concluir o processo de assinatura, por exemplo, https://adobe.com
Emails iniciais	initEmails		string	Controlar emails de notificação para eventos de iniciação de contrato.
Estado	state	True	string	O estado em que o acordo deve desembarcar.

Retornos

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

Corpo: AgreementCreationResponseV6

Criar um contrato com base em um modelo de biblioteca e enviar para assinatura (Antiga) [PRETERIDO]

ID da operação:: CreateAgreementByTemplate

Essa operação cria um contrato com base em um modelo armazenado na biblioteca do Adobe Acrobat Sign do usuário e o envia para assinatura.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do Contrato	name	True	string	O nome do contrato
Modelo de Biblioteca de Documentos	libraryDocumentId	True	string	Escolha um documento dos modelos armazenados em sua biblioteca
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que você deseja solicitar – Assinatura E ou Escrita
Email do destinatário	email	True	string	Email 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 de destinatário	recipientSetRole	True	string	Especificar a função do destinatário
Message	message		string	Uma mensagem opcional para os destinatários que solicitam sua ação
Dias a prazo	daysUntilSigningDeadline		integer	O número de dias que permanecem antes do documento expirar
Frequência de lembrete	reminderFrequency		string	Com que frequência você deseja enviar lembretes?
Senha 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 dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (3)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (4)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (5)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (6)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (7)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (8)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (9)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Modelo de Biblioteca de Documentos (10)	libraryDocumentId		string	Escolha um documento dos modelos armazenados em sua biblioteca
Email do destinatário (2)	email	True	string	Email 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
Email do destinatário (3)	email	True	string	Email 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
Email do destinatário (4)	email	True	string	Email 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
Email do destinatário (5)	email	True	string	Email 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
Email do destinatário (6)	email	True	string	Email 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
Email do destinatário (7)	email	True	string	Email 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
Email do destinatário (8)	email	True	string	Email 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
Email do destinatário (9)	email	True	string	Email 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
Email do destinatário (10)	email	True	string	Email 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
Email do destinatário (11)	email	True	string	Email 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 de destinatário (11)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (12)	email	True	string	Email 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
Email do destinatário (13)	email	True	string	Email 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 de destinatário (13)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (14)	email	True	string	Email 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
Email do destinatário (15)	email	True	string	Email 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
Email do destinatário (16)	email	True	string	Email 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 de destinatário (16)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (17)	email	True	string	Email 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
Email do destinatário (18)	email	True	string	Email 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
Email do destinatário (19)	email	True	string	Email 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
Email do destinatário (20)	email	True	string	Email 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
Email do destinatário (21)	email	True	string	Email 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
Email do destinatário (22)	email	True	string	Email 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
Email do destinatário (23)	email	True	string	Email 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
Email do destinatário (24)	email	True	string	Email 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
Email do destinatário (25)	email	True	string	Email 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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

Retornos

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

Corpo: AgreementCreationResponse

Criar um contrato de um documento carregado e enviar para assinatura (Antiga) [PRETERIDO]

ID da operação:: CreateAgreementById

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do Contrato	name	True	string	O nome do contrato
ID do documento	transientDocumentId	True	string	A ID do documento recebida carregando um documento
Tipo de assinatura	signatureType	True	string	O tipo de assinatura que você deseja solicitar – Assinatura E ou Escrita
Email do destinatário	email	True	string	Email 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 de destinatário	recipientSetRole	True	string	Especificar a função do destinatário
Message	message		string	Uma mensagem opcional para os destinatários que solicitam sua ação
Dias a prazo	daysUntilSigningDeadline		integer	O número de dias que permanecem antes do documento expirar
Frequência de lembrete	reminderFrequency		string	Com que frequência você deseja enviar lembretes?
Senha do documento	openPassword		string	A senha que deve ser usada para criptografar o PDF do contrato assinado
ID do documento (2)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (3)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (4)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (5)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (6)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (7)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (8)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (9)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (10)	transientDocumentId		string	A ID do documento recebida carregando um documento
Email do destinatário (2)	email	True	string	Email 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
Email do destinatário (3)	email	True	string	Email 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
Email do destinatário (4)	email	True	string	Email 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
Email do destinatário (5)	email	True	string	Email 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
Email do destinatário (6)	email	True	string	Email 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
Email do destinatário (7)	email	True	string	Email 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
Email do destinatário (8)	email	True	string	Email 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
Email do destinatário (9)	email	True	string	Email 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
Email do destinatário (10)	email	True	string	Email 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
Email do destinatário (11)	email	True	string	Email 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 de destinatário (11)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (12)	email	True	string	Email 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
Email do destinatário (13)	email	True	string	Email 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 de destinatário (13)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (14)	email	True	string	Email 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
Email do destinatário (15)	email	True	string	Email 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
Email do destinatário (16)	email	True	string	Email 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 de destinatário (16)	recipientSetRole	True	string	Especificar a função do destinatário
Email do destinatário (17)	email	True	string	Email 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
Email do destinatário (18)	email	True	string	Email 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
Email do destinatário (19)	email	True	string	Email 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
Email do destinatário (20)	email	True	string	Email 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
Email do destinatário (21)	email	True	string	Email 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
Email do destinatário (22)	email	True	string	Email 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
Email do destinatário (23)	email	True	string	Email 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
Email do destinatário (24)	email	True	string	Email 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
Email do destinatário (25)	email	True	string	Email 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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 de 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

Retornos

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

Corpo: AgreementCreationResponse

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

ID da operação:: CreateAgreementFromWorkflow

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user	True	string	O email do chamador de API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	True	string	ID do grupo. Para usar isso , o campo 'In The Name Of' precisa ser selecionado
Nome/ID do fluxo de trabalho	workflowIdParam	True	string	Selecione o fluxo de trabalho personalizado na lista ou insira a ID do fluxo de trabalho personalizado.
agreementWorkflowSchema	agreementWorkflowSchema	True	dynamic	Detalhes do evento selecionado.

Retornos

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

Corpo: AgreementCreationResponseV6

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

ID da operação:: CreateLibraryDocumentByUrl_V2

Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de uma URL de documento. Use este modelo para enviar contratos

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de 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 Compartilhamento	sharingMode	True	string	Especifica quem deve ter acesso a este documento de biblioteca
URL	url	True	string	Uma URL acessível publicamente para recuperar o conteúdo bruto do arquivo
Nome	name	True	string	O nome do arquivo do sistema original do documento que está sendo enviado
Tipo	mimeType	True	string	O tipo mime do arquivo referenciado, por exemplo, aplicativo/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 'In The Name Of' precisa ser selecionado

Retornos

Um objeto JSON que descreve o modelo de biblioteca

Corpo: LibraryDocumentCreationResponseV6

Criar um modelo de biblioteca a partir de uma URL de documento (Antiga) [PRETERIDA]

ID da operação:: CreateLibraryDocumentByUrl

Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de uma URL de documento. Use este modelo para enviar contratos

Parâmetros

Nome	Chave	Obrigató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
Compartilhar com	librarySharingMode	True	string	Especifica quem deve ter acesso a este documento de biblioteca
URL	url	True	string	Uma URL acessível publicamente para recuperar o documento
Nome	name	True	string	O nome do documento referenciado, com extensão
URL (2)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (2)	name		string	O nome do documento referenciado, com extensão
URL (3)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (3)	name		string	O nome do documento referenciado, com extensão
URL (4)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (4)	name		string	O nome do documento referenciado, com extensão
URL (5)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (5)	name		string	O nome do documento referenciado, com extensão
URL (6)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (6)	name		string	O nome do documento referenciado, com extensão
URL (7)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (7)	name		string	O nome do documento referenciado, com extensão
URL (8)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (8)	name		string	O nome do documento referenciado, com extensão
URL (9)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (9)	name		string	O nome do documento referenciado, com extensão
URL (10)	url		string	Uma URL acessível publicamente para recuperar o documento
Nome (10)	name		string	O nome do documento referenciado, com extensão

Retornos

Um objeto JSON que descreve o modelo de biblioteca

Corpo: LibraryDocumentCreationResponse

Criar um modelo de biblioteca com base em um documento carregado

ID da operação:: CreateLibraryDocumentById_V2

Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de um documento carregado. Use este modelo para enviar contratos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de 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 Compartilhamento	sharingMode	True	string	Especifica quem deve ter acesso a este documento de biblioteca
ID	transientDocumentId	True	string	A ID do documento recebida carregando 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 'In The Name Of' precisa ser selecionado

Retornos

Um objeto JSON que descreve o modelo de biblioteca

Corpo: LibraryDocumentCreationResponseV6

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

ID da operação:: CreateLibraryDocumentById

Esta operação cria um modelo na biblioteca adobe acrobat sign a partir de um documento carregado. Use este modelo para enviar contratos.

Parâmetros

Nome	Chave	Obrigató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
Compartilhar com	librarySharingMode	True	string	Especifica quem deve ter acesso a este documento de biblioteca
ID do documento	transientDocumentId	True	string	A ID do documento recebida carregando um documento
ID do documento (2)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (3)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (4)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (5)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (6)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (7)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (8)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (9)	transientDocumentId		string	A ID do documento recebida carregando um documento
ID do documento (10)	transientDocumentId		string	A ID do documento recebida carregando um documento

Retornos

Um objeto JSON que descreve o modelo de biblioteca

Corpo: LibraryDocumentCreationResponse

Obter a URL de exibição do contrato

ID da operação:: PostAgreementViews

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujas informações são necessárias
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
Exibir Nome	name	True	string	Nome do modo de exibição do contrato solicitado
LogIn Automático	autoLoginUser		boolean	Se for true, a URL retornada registrará automaticamente o usuário em log
Sem sinalizador chrome	noChrome		boolean	Se for true, a página inserida será mostrada sem um cabeçalho ou rodapé
Pai do quadro	frameParent		string	Lista separada por vírgulas de urls de domínio em que as URLs podem ser iframed

Retornos

Lista de exibições de contrato

Corpo: AgreementViews

Obter as informações detalhadas do fluxo de trabalho

ID da operação:: GetWorkflowInfo

Esta operação busca informações detalhadas sobre o fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Fluxo de Trabalho	workflowId	True	string	A ID do fluxo de trabalho cujas informações são necessárias
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId		string	ID do grupo. Para usar isso , o campo 'In The Name Of' precisa ser selecionado

Retornos

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

Corpo: WorkflowDescriptionV6

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

ID da operação:: GetAgreementFormFieldData

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujas informações são necessárias

Retornos

response: file

Obter dados de campo de formulário do contrato no formato CSV

ID da operação:: GetAgreementFormFieldData_V2

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujas informações são necessárias
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

O conteúdo dos dados do formulário

Conteúdo de Dados de Formulário: binary

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

ID da operação:: GetAgreementFormFieldData_V3

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujas informações são necessárias
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

O conteúdo dos dados do formulário

Conteúdo de Dados de Formulário: object

Obter o status de um contrato

ID da operação:: GetAgreementInfo_V2

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujas informações são necessárias
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

Detalhes completos do contrato

Corpo: AgreementInfoV6

Obter o status de um contrato [PRETERIDO]

ID da operação:: GetAgreementInfo

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

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujas informações são necessárias

Retornos

Os detalhes completos sobre o contrato

Corpo: AgreementInfo

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

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujo documento é necessário
ID do documento	documentId	True	string	A ID do documento específico do contrato
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

O fluxo de arquivos do documento

response: DocumentResponse

Obter um documento de um contrato [PRETERIDO]

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

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujo documento é necessário
ID do documento	documentId	True	string	A ID do documento específico do contrato

Retornos

O fluxo de arquivos do documento

response: DocumentResponse

Obter um PDF da trilha de auditoria do contrato

ID da operação:: GetAgreementAuditTrail

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
ID do contrato	agreementId	True	string	A ID do contrato cujas informações são necessárias

Retornos

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

Essa 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 terminando em .pdf extensão de arquivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato, conforme fornecido pela ação que cria o contrato
Anexar documentos de suporte?	attachSupportingDocuments		boolean	Se for true, anexe documentos de suporte ao PDF do contrato assinado
Anexar relatório de auditoria?	attachAuditReport		boolean	Se for true, anexe um relatório de auditoria ao PDF do contrato assinado
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

O fluxo de arquivos do documento

response: CombinedDocumentResponse

Obter um PDF de um contrato assinado [PRETERIDO]

ID da operação:: GetCombinedDocument

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

~~Essa 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 terminando em .pdf extensão de arquivo.~~

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato, conforme fornecido pela ação que cria o contrato
Anexar documentos de suporte?	attachSupportingDocuments		boolean	Se for true, anexe documentos de suporte ao PDF do contrato assinado
Anexar relatório de auditoria?	auditReport		boolean	Se for true, anexe um relatório de auditoria ao PDF do contrato assinado

Retornos

O fluxo de arquivos do documento

response: CombinedDocumentResponse

Obter uma lista de todas as IDs de documento de um contrato

ID da operação:: GetAllDocumentsofAnAgreement_V2

Esta operação busca as IDs de todos os documentos e documentos de suporte de um contrato.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujos documentos são necessários
Documentos de suporte – Tipo de Conteúdo	supportingDocumentContentFormat		string	Tipo de conteúdo dos documentos de suporte do contrato
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

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

Corpo: AgreementDocumentsV6

Obter uma lista de todas as IDs de documento de um contrato [PRETERIDO]

ID da operação:: GetAllDocumentsofAnAgreement

Esta ação foi preterida. Em vez disso, use Obter uma lista de todas as IDs de documento de um contrato .

~~Esta operação busca as IDs de todos os documentos e documentos de suporte de um contrato.~~

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato cujos documentos são necessários
Documentos de suporte – Tipo de Conteúdo	supportingDocumentContentFormat		string	Tipo de conteúdo dos documentos de suporte do contrato

Retornos

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

Corpo: AgreementDocuments

Obter 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

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

Retornos

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

Corpo: userAgreementListV6

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

ID da operação:: GetAllAgreements

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

Retornos

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

Corpo: UserAgreements

Obter uma lista de todos os contratos com base nos critérios de pesquisa

ID da operação:: SearchAgreements

Essa operação pesquisa contratos por critérios como ID de fluxo de trabalho etc.

Parâmetros

Nome	Chave	Tipo	Description
No nome de	x-api-user	string	O email do chamador de API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	string	ID do grupo. Para usar isso , o campo 'In The Name Of' precisa ser selecionado
Nome/ID do fluxo de trabalho	workflowId	string	Selecione o fluxo de trabalho personalizado na lista ou insira a ID do fluxo de trabalho personalizado.
Criado após	gt	string	A data e hora mínima permitidas. Exemplo: 2020-12-31T23:59:00Z
Criado antes	lt	string	A data e hora máxima permitidas. 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áximo: 500
Índice de Início	startIndex	integer	Primeira linha baseada em 0 (deslocamento) dos resultados da pesquisa a serem retornados.

Retornos

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

Corpo: userAgreementListV6

Obter uma lista de todos os fluxos de trabalho

ID da operação:: GetAllWorkflows

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

Parâmetros

Nome	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
No nome de	x-api-user	string	O email do chamador de API no formato: email:adobesignuser@domain.com
Nome/ID do Grupo	groupId	string	ID do grupo. Para usar isso , o campo 'In The Name Of' precisa ser selecionado

Retornos

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

Corpo: userWorkflowListV6

Obter uma lista de todos os formulários da Web

ID da operação:: GetAllWebForms

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

Parâmetros

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

Retornos

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

Corpo: userWidgetListV6

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

ID da operação:: GetAllUserGroups

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com
ID do Usuário	userId	True	string	Para obter o resultado para o usuário autorizado, a ID do usuário pode ser substituída por 'me' sem aspas.

Retornos

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

Corpo: UserGroupsInfoV6

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 Adobe Acrobat Sign do usuário.

Parâmetros

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

Retornos

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

Corpo: 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 Adobe Acrobat Sign do usuário.

Retornos

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

Corpo: DocumentLibraryItems

Recuperar a URL de Assinatura

ID da operação:: GetSigningUrls

Essa operação recupera a URL da página de sinal eletrônico para os signatários atuais de um contrato.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do contrato	agreementId	True	string	A ID do contrato, conforme fornecido pela ação que cria o contrato
No nome de	x-api-user		string	O email do chamador de API no formato: email:adobesignuser@domain.com

Retornos

Corpo: SigningUrlResponse

Gatilhos

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

Quando o estado de um contrato é alterado

ID da operação:: CreateWebhookForAgreementStatusUpdated

Dispara um novo fluxo quando o status de um contrato é alterado. Aborda a maioria dos eventos comuns do Contrato, como criação, conclusão etc.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O escopo do gatilho
Nome/ID do Contrato	resourceId		string	Especifique somente quando "Escopo" for "Um contrato específico". Selecione um contrato na lista ou insira a ID do contrato.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser disparado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do contrato devem ser enviadas na notificação?
Incluir informações do participante do contrato?	includeParticipantsInfo		boolean	As informações do participante do contrato devem ser enviadas na 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	Uma cópia final do documento assinado deve ser enviada na notificação de conclusão do contrato?

Retornos

Corpo: WebhookPayloadWithSignedDocumentForStatusChange

Quando ocorre um evento de contrato de formulário web

ID da operação:: CreateWebhookForWebFormAgreementEvent

Dispara um novo fluxo quando ocorre um evento de contrato de formulário da Web. Aborda a maioria dos eventos comuns do Contrato, como criação, conclusão etc.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome do gatilho
Tamanho da Página de Formulários da Web	pageSize		integer	Selecione o número de formulários da Web a serem exibidos na lista suspensa
Nome/ID do Formulário da Web	resourceId	True	string	Selecione o formulário da Web na lista ou insira a ID do formulário da Web.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser disparado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do contrato devem ser enviadas na notificação?
Incluir informações do participante do contrato?	includeParticipantsInfo		boolean	As informações do participante do contrato devem ser enviadas na 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	Uma cópia final do documento assinado deve ser enviada na notificação de conclusão do contrato?

Retornos

Corpo: WebFormWebhookAgreementEventPayload

Quando um contrato é enviado a um participante

ID da operação:: CreateWebhookForAgreementSignatureRequestedEvent

Dispara um novo fluxo quando um contrato é enviado a um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O escopo do gatilho
Nome/ID do Contrato	resourceId		string	Especifique somente quando "Escopo" for "Um contrato específico". Selecione um contrato na lista ou insira a ID do contrato.
Subscription	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser disparado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do contrato devem ser enviadas na notificação?
Incluir informações do participante do contrato?	includeParticipantsInfo		boolean	As informações do participante do contrato devem ser enviadas na notificação?
Incluir informações do documento do contrato?	includeDocumentsInfo		boolean	As informações do documento do contrato devem ser enviadas na notificação?

Retornos

Corpo: WebhookPayload

Quando um evento de grupo ocorre

ID da operação:: CreateWebhookForGroupEvent

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

Parâmetros

Nome	Chave	Obrigató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 disparado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do contrato devem ser enviadas na notificação?
Incluir informações do participante do contrato?	includeParticipantsInfo		boolean	As informações do participante do contrato devem ser enviadas na 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	Uma cópia final do documento assinado na conclusão do contrato deve ser enviada na notificação?
Incluir informações do MegaSign?	includeDetailedInfo		boolean	As informações detalhadas do mega sign devem ser enviadas na notificação?
Incluir informações de formulário da Web?	includeDetailedInfo		boolean	As informações detalhadas do formulário da Web devem ser enviadas na notificação?
Incluir informações do participante do formulário da Web?	includeParticipantsInfo		boolean	As informações do participante do formulário da Web devem ser enviadas na notificação?
Incluir informações de documentos de formulário da Web?	includeDocumentsInfo		boolean	As informações do documento do formulário da Web devem ser enviadas na notificação?

Retornos

Corpo: GroupWebhookEventPayload

Quando um evento ocorre

ID da operação:: CreateWebhookGeneric

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O escopo do gatilho
Tipo de recurso	resourceType		string	Especifique somente quando "Escopo" for "Um recurso específico". Selecione o tipo de recurso para o qual o fluxo deve ser disparado.
ID de Recurso	resourceId		string	Especifique somente quando "Escopo" for "Um recurso específico". Insira o contrato ou mega sign ou web form ou ID de grupo para o qual o fluxo deve ser disparado.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser disparado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do contrato devem ser enviadas na notificação?
Incluir informações do participante do contrato?	includeParticipantsInfo		boolean	As informações do participante do contrato devem ser enviadas na 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	Uma cópia final do documento assinado na conclusão do contrato deve ser enviada na notificação?
Incluir informações do MegaSign?	includeDetailedInfo		boolean	As informações detalhadas do mega sign devem ser enviadas na notificação?
Incluir informações de formulário da Web?	includeDetailedInfo		boolean	As informações detalhadas do formulário da Web devem ser enviadas na notificação?
Incluir informações do participante do formulário da Web?	includeParticipantsInfo		boolean	As informações do participante do formulário da Web devem ser enviadas na notificação?
Incluir informações de documentos de formulário da Web?	includeDocumentsInfo		boolean	As informações do documento do formulário da Web devem ser enviadas na notificação?

Retornos

Corpo: WebhookPayloadGeneric

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

ID da operação:: CreateWebhookForAgreementSignedEvent

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O escopo do gatilho
Nome/ID do Contrato	resourceId		string	Especifique somente quando "Escopo" for "Um contrato específico". Selecione um contrato na lista ou insira a ID do contrato.
Subscription	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser disparado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do contrato devem ser enviadas na notificação?
Incluir informações do participante do contrato?	includeParticipantsInfo		boolean	As informações do participante do contrato devem ser enviadas na 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	Uma cópia final do documento assinado na conclusão do contrato deve ser enviada na notificação?

Retornos

Corpo: WebhookPayloadWithSignedDocument

Quando um novo contrato é criado

ID da operação:: CreateWebhookForAgreementCreatedEvent

Dispara um novo fluxo quando um novo contrato é criado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome do gatilho
Scope	scope	True	string	O escopo do gatilho
Subscription	webhookSubscriptionEvents	True	array of string	Os eventos para os quais o fluxo deve ser disparado
Incluir informações do contrato?	includeDetailedInfo		boolean	As informações detalhadas do contrato devem ser enviadas na notificação?
Incluir informações do participante do contrato?	includeParticipantsInfo		boolean	As informações do participante do contrato devem ser enviadas na notificação?

Retornos

Corpo: WebhookPayloadWithoutNextParticipantSet

Definições

AgreementCreationResponse

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

Nome	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

Nome	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

AgreementDocuments

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

Nome	Caminho	Tipo	Description
Documentos	documents	array of Document	Uma lista de objetos que representam os documentos
Documentos de suporte	supportingDocuments	array of SupportingDocument	Uma lista de documentos de suporte. Isso será retornado somente se houver algum documento de suporte no contrato

AgreementDocumentsV6

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

Nome	Caminho	Tipo	Description
Documentos	documents	array of DocumentV6	Uma lista de objetos que representam os documentos
Documentos de suporte	supportingDocuments	array of SupportingDocumentV6	Uma lista de documentos de suporte. Isso será retornado somente se houver algum documento de suporte no contrato

AgreementInfo

Os detalhes completos sobre o contrato

Nome	Caminho	Tipo	Description
ID do contrato	agreementId	string	Uma ID exclusiva que pode ser usada para identificar exclusivamente o contrato
Eventos	events	array of DocumentHistoryEvent	Uma lista ordenada dos eventos na trilha de auditoria deste documento
Data de Validade	expiration	date	A data após a qual o contrato não pode mais ser assinado
ID da versão mais recente	latestVersionId	string	Uma ID exclusiva 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 precisa agir em seguida para este contrato
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 E ou Escrita
Proteção de Documentos	securityOptions	string	Informações de segurança sobre o documento que especifica se uma senha é necessária ou não para exibi-la e assiná-la
Situação	status	string	O status atual do contrato

AgreementInfoV6

Detalhes completos do contrato

Nome	Caminho	Tipo	Description
ID do contrato	id	string	Uma ID exclusiva que pode ser usada para identificar exclusivamente o contrato
Data de criação	createdDate	date	Data em que o contrato foi criado
Primeiro atraso de lembrete	firstReminderDelay	integer	Inteiro que especifica o atraso em horas antes de enviar o primeiro lembrete.
Frequência de lembrete	reminderFrequency	string	Com que frequência você deseja enviar lembretes?
Data de Validade	expiration	date	A data após a qual o contrato não pode mais ser assinado
Local	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á habilitada?
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 E ou Escrita
Opções de segurança	securityOptions	string	Informações de segurança sobre o documento que especifica se uma senha é necessária ou não para exibi-la e assiná-la
Situação	status	string	O status atual do contrato
Email do remetente	senderEmail	string	O email 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.
Ccs	ccs	array of CcInfo	Uma lista de um ou mais CCs que serão copiados 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 arquivo: binary

AgreementAuditTrailResponse

O fluxo de arquivos da trilha de auditoria do contrato

Conteúdo da trilha de auditoria do contrato: binary

DisplayUserInfo

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

DisplayUserSetInfo

Nome	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

Nome	Caminho	Tipo	Description
ID do documento	documentId	string	A ID exclusiva do documento
Tipo mime	mimeType	string	O tipo Mime do documento
Nome	name	string	O nome do documento
Páginas num	numPages	integer	Número de páginas no documento

DocumentV6

As informações sobre o documento

Nome	Caminho	Tipo	Description
ID do documento	id	string	A ID exclusiva do documento
Tipo mime	mimeType	string	O tipo Mime do documento
Nome	name	string	O nome do documento
Páginas num	numPages	integer	Número de páginas no documento

DocumentHistoryEvent

Nome	Caminho	Tipo	Description
Iniciador de Eventos	actingUserEmail	string	Endereço de email do usuário que iniciou o evento
Data do Evento	date	date	A data do evento de auditoria
Descrição do Evento	description	string	Uma descrição do evento de auditoria
Email do participante	participantEmail	string	Endereço de email do usuário que iniciou o evento
Tipo de evento	type	string	Tipo de evento de contrato

DocumentLibraryItem

Nome	Caminho	Tipo	Description
ID do modelo de biblioteca	libraryDocumentId	string	A ID exclusiva do documento de 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 modificada	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 escopo da visibilidade do modelo de biblioteca

DocumentLibraryItems

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

Nome	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 arquivo: binary

LibraryDocumentCreationResponse

Um objeto JSON que descreve o modelo de biblioteca

Nome	Caminho	Tipo	Description
ID do modelo de biblioteca	libraryDocumentId	string	A ID exclusiva que pode ser usada para se referir ao modelo de biblioteca

NextParticipantInfo

Nome	Caminho	Tipo	Description
Email	email	string	O endereço de email do próximo participante
Nome	name	string	O nome do próximo participante, se disponível
Aguardando desde então	waitingSince	date	A data desde a qual o documento aguarda a ação do participante

NextParticipantSetInfo

Nome	Caminho	Tipo	Description
Próximas informações de membro do conjunto de participantes	nextParticipantSetMemberInfos	array of NextParticipantInfo	Informações sobre os membros do próximo conjunto de participantes

ParticipantInfo

Nome	Caminho	Tipo	Description
Empresa	company	string	A empresa do participante, se disponível
Email	email	string	O endereço de email do participante
Nome	name	string	O nome do participante, se disponível
ID do participante	participantId	string	A ID exclusiva 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

Nome	Caminho	Tipo	Description
ID do conjunto de participantes	participantSetId	string	A ID exclusiva do conjunto de participantes
Informações do membro do conjunto de participantes	participantSetMemberInfos	array of ParticipantInfo	Informações sobre os membros do conjunto de destinatários
Mensagem Privada	privateMessage	string	Mensagem privada para os participantes no conjunto
Função	roles	array of string	As funções atuais do conjunto de participantes. Um conjunto de participantes pode ter uma ou mais funções
securityOptions	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 status do conjunto de participantes em relação ao documento

ParticipantSetInfoV6

Nome	Caminho	Tipo	Description
Informações do membro do conjunto de participantes	memberInfos	array of MemberInfosV6	Informações sobre os membros do conjunto de destinatários
Pedido	order	integer	Índice que indica a posição na qual o grupo de assinatura precisa assinar.
Função	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
Conjunto de Participantes Desarmes Privados	privateMessage	string	Mensagem privada para os participantes no conjunto
Páginas Visíveis do Conjunto de Participantes	visiblePages	array of string	As páginas visíveis para o conjunto de participantes

MemberInfosV6

Nome	Caminho	Tipo	Description
Email	email	string	O email do participante
Authentication	securityOption.authenticationMethod	string	Autenticação padrão: email (Nenhum)
Senha	securityOption.password	string	A senha necessária para o participante
Código do país	securityOption.phoneInfo.countryCode	string	Código do país de telefone do destinatário necessário para exibir e assinar o documento
Telefone Nº.	securityOption.phoneInfo.phone	string	Número de telefone do destinatário necessário para exibir e assinar o contrato
ID do provedor	securityOption.digAuthInfo.providerId	string	ID do Provedor do Gateway de Identidade Digital.

SigningUrl

Nome	Caminho	Tipo	Description
E-mail para URL de Sinal	email	string	O endereço de email do signatário associado a essa URL de assinatura
URL de Sinal	esignUrl	string	O endereço de URL do signatário associado a essa URL de assinatura

SigningUrlResponse

Nome	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

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

SupportingDocument

As informações sobre o documento de suporte

Nome	Caminho	Tipo	Description
Nome do documento de suporte	displayLabel	string	Nome de exibição do documento de suporte
Como dar suporte ao nome do campo do documento	fieldName	string	O nome do campo de documento de suporte
Suporte ao tipo mime de documento	mimeType	string	O tipo Mime do documento de suporte
Suporte a páginas de documentos	numPages	integer	Número de páginas no documento de suporte
Como dar suporte à ID do documento	supportingDocumentId	string	ID exclusiva que representa o documento de suporte

SupportingDocumentV6

As informações sobre o documento de suporte

Nome	Caminho	Tipo	Description
Nome do documento de suporte	displayLabel	string	Nome de exibição do documento de suporte
Como dar suporte ao nome do campo do documento	fieldName	string	O nome do campo de documento de suporte
Suporte ao tipo mime de documento	mimeType	string	O tipo Mime do documento de suporte
Suporte a páginas de documentos	numPages	integer	Número de páginas no documento de suporte
Como dar suporte à ID do documento	id	string	ID exclusiva que representa o documento de suporte

TransientDocumentResponse

Um JSON que contém a ID do documento carregado

Nome	Caminho	Tipo	Description
ID do documento	transientDocumentId	string	A ID do documento carregado

UserAgreement

Nome	Caminho	Tipo	Description
ID do contrato	agreementId	string	Uma ID exclusiva que pode ser usada para identificar exclusivamente o contrato
Exibir informações de conjunto de usuários	displayUserSetInfos	array of DisplayUserSetInfo	O conjunto de usuários atual mais relevante para o contrato. Normalmente, ele será o próximo signatário se o contrato for do usuário atual ou do 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 de sinal eletrônico
ID da versão mais recente	latestVersionId	string	Uma ID de versão que identifica exclusivamente a versão atual do contrato
Nome	name	string	Nome do Contrato
Situação	status	string	O status atual do contrato

UserAgreements

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

Nome	Caminho	Tipo	Description
Lista de Contratos	userAgreementList	array of UserAgreement	Uma matriz de itens de contrato

UserAgreementV6

Nome	Caminho	Tipo	Description
Exibir informações de conjunto de usuários	displayParticipantSetInfos	array of DisplayUserSetInfo	O conjunto de usuários atual mais relevante para o contrato. Normalmente, ele será o próximo signatário se o contrato for do usuário atual ou do 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 de sinal eletrônico
Oculto	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	Uma ID de versão que identifica exclusivamente a versão atual do contrato
Nome	name	string	Nome do Contrato
ID Principal	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 exclusivo do contrato
Situação	status	string	O status atual do contrato
Tipo	type	string	O tipo de acordo

userAgreementListV6

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

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

página

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

Nome	Caminho	Tipo	Description
nextCursor	nextCursor	string	Usado para navegar até a próxima página. Se não for retornado, não haverá mais páginas.

WebhookPayload

Nome	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria yyyy-MM-dd'T'HH:mm:ssZ. 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 do contrato	eventResourceParentType	string	Informações sobre o recurso do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso do qual este contrato é criado
Função participante do evento	participantRole	string	A função do participante do evento.
ID do participante do evento	participantUserId	string	A ID do participante do evento.
Email do participante do evento	participantUserEmail	string	O email do participante para o evento.
ID do usuário em ação do evento	actingUserId	string	A ID do usuário que criou o evento.
Email do usuário em ação do evento	actingUserEmail	string	O email 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 do usuário de iniciação de eventos	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário interino.
Email do usuário de iniciação de eventos	initiatingUserEmail	string	O email do usuário que iniciou o evento em nome do usuário interino.
Usuários aplicáveis à notificação	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de usuários para os quais essa notificação é aplicável
Agreement	agreement	WebhookAgreementInfo	As informações completas do contrato

ApplicableUsers

As informações sobre os usuários para os quais essa notificação é aplicável

Nome	Caminho	Tipo	Description
ID do usuário aplicável à notificação	id	string	A ID exclusiva do usuário para quem essa notificação é aplicável
Email do usuário aplicável à notificação	email	string	O email do usuário para o qual essa 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 quem essa notificação é gerada
O usuário aplicável ao conteúdo	payloadApplicable	boolean	Se os dados fornecidos nesta notificação são aplicáveis a este usuário ou não

WebhookPayloadWithoutNextParticipantSet

Nome	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria yyyy-MM-dd'T'HH:mm:ssZ. 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 do contrato	eventResourceParentType	string	Informações sobre o recurso do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso do qual este contrato é criado
ID do participante do evento	participantUserId	string	A ID do participante do evento.
Email do participante do evento	participantUserEmail	string	O email do participante para o evento.
ID do usuário em ação do evento	actingUserId	string	A ID do usuário que criou o evento.
Email do usuário em ação do evento	actingUserEmail	string	O email 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 do usuário de iniciação de eventos	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário interino
Email do usuário de iniciação de eventos	initiatingUserEmail	string	O email do usuário que iniciou o evento em nome do usuário interino.
Usuários aplicáveis à notificação	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de usuários para os quais essa notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithoutNextParticipantSet	As informações completas do contrato

WebhookPayloadWithSignedDocumentForStatusChange

Nome	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria yyyy-MM-dd'T'HH:mm:ssZ. Por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub-evento	subEvent	string	O subconjunto que ocorreu em um recurso.
Tipo pai do contrato	eventResourceParentType	string	Informações sobre o recurso do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso do qual este contrato é criado
ID do participante do evento	participantUserId	string	A ID do participante do evento.
Email do participante do evento	participantUserEmail	string	O email do participante para o evento.
ID do usuário em ação do evento	actingUserId	string	A ID do usuário que criou o evento.
Email do usuário em ação do evento	actingUserEmail	string	O email 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 do usuário de iniciação de eventos	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário interino
Email do usuário de iniciação de eventos	initiatingUserEmail	string	O email do usuário que iniciou o evento em nome do usuário interino.
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Função participante do evento	participantRole	string	A função do participante do evento.
Usuários aplicáveis à notificação	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de usuários para os quais essa notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	As informações completas do contrato

WebhookPayloadWithSignedDocument

Nome	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria yyyy-MM-dd'T'HH:mm:ssZ. Por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Tipo pai do contrato	eventResourceParentType	string	Informações sobre o recurso do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso do qual este contrato é criado
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Função participante do evento	participantRole	string	A função do participante do evento.
ID do participante do evento	participantUserId	string	A ID do participante do evento.
Email do participante do evento	participantUserEmail	string	O email do participante para o evento.
ID do usuário em ação do evento	actingUserId	string	A ID do usuário que criou o evento.
Email do usuário em ação do evento	actingUserEmail	string	O email 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 do usuário de iniciação de eventos	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário interino
Email do usuário de iniciação de eventos	initiatingUserEmail	string	O email do usuário que iniciou o evento em nome do usuário interino.
Usuários aplicáveis à notificação	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de usuários para os quais essa notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	As informações completas do contrato

WebhookPayloadGeneric

Nome	Caminho	Tipo	Description
Event	event	string	O evento que ocorreu no recurso.
Data do Evento	eventDate	date	A data do evento. O formato seria yyyy-MM-dd'T'HH:mm:ssZ. Por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub-evento	subEvent	string	O subconjunto que ocorreu em um recurso.
Tipo pai do contrato	eventResourceParentType	string	Informações sobre o recurso do qual o contrato é criado. Valores possíveis: Web Form ou Mega Sign
ID pai do contrato	eventResourceParentId	string	Uma ID exclusiva do recurso do qual este contrato é criado
Tipo de recurso de evento	eventResourceType	string	O recurso no qual o evento ocorreu.
Função participante do evento	participantRole	string	A função do participante do evento.
ID do participante do evento	participantUserId	string	A ID do participante do evento.
Email do participante do evento	participantUserEmail	string	O email do participante para o evento.
ID do usuário em ação do evento	actingUserId	string	A ID do usuário que criou o evento.
Email do usuário em ação do evento	actingUserEmail	string	O email do usuário que criou o evento.
ID do usuário de iniciação de eventos	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário interino
Email do usuário de iniciação de eventos	initiatingUserEmail	string	O email do usuário que iniciou o evento em nome do usuário interino.
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
Usuários aplicáveis à notificação	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de usuários para os quais essa notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	As informações completas do contrato
Mega Sign	megaSign	WebhookMegaSignInfo	As informações completas do mega signo
Formulário da Web	widget	WebhookWidgetInfo	As informações completas do formulário da Web

WebFormWebhookAgreementEventPayload

Nome	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 yyyy-MM-dd'T'HH:mm:ssZ. Por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub-evento	subEvent	string	O subconjunto que ocorreu em um formulário da Web.
Tipo pai do contrato – Formulário da Web	eventResourceParentType	string	Valor que indica que um contrato é criado a partir do formulário da Web.
ID do Formulário da Web	eventResourceParentId	string	Uma ID exclusiva do formulário web do qual este contrato é criado
Tipo de Recurso de Evento – Contrato	eventResourceType	string	O recurso no qual o evento ocorreu.
Função participante do evento	participantRole	string	A função do participante do evento.
ID do participante do evento	participantUserId	string	A ID do participante do evento.
Email do participante do evento	participantUserEmail	string	O email do participante para o evento.
ID do usuário em ação do evento	actingUserId	string	A ID do usuário que criou o evento.
Email do usuário em ação do evento	actingUserEmail	string	O email do usuário que criou o evento.
ID do usuário de iniciação de eventos	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário interino
Email do usuário de iniciação de eventos	initiatingUserEmail	string	O email do usuário que iniciou o evento em nome do usuário interino.
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
Usuários aplicáveis à notificação	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de usuários para os quais essa notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	As informações completas do contrato

GroupWebhookEventPayload

Nome	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 yyyy-MM-dd'T'HH:mm:ssZ. Por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Sub-evento	subEvent	string	O subconjunto que ocorreu para um grupo.
Tipo pai do contrato – Formulário da Web	eventResourceParentType	string	Informações sobre o grupo do qual o contrato é criado.
ID do Formulário da Web	eventResourceParentId	string	Uma ID exclusiva do grupo do qual este contrato é criado
Tipo de Recurso de Evento – Contrato	eventResourceType	string	O grupo para o qual o evento ocorreu.
Função participante do evento	participantRole	string	A função do participante do evento.
ID do participante do evento	participantUserId	string	A ID do participante do evento.
Email do participante do evento	participantUserEmail	string	O email do participante para o evento.
ID do usuário em ação do evento	actingUserId	string	A ID do usuário que criou o evento.
Email do usuário em ação do evento	actingUserEmail	string	O email do usuário que criou o evento.
ID do usuário de iniciação de eventos	initiatingUserId	string	A ID do usuário que iniciou o evento em nome do usuário interino
Email do usuário de iniciação de eventos	initiatingUserEmail	string	O email do usuário que iniciou o evento em nome do usuário interino.
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
Usuários aplicáveis à notificação	webhookNotificationApplicableUsers	array of ApplicableUsers	Uma lista de usuários para os quais essa notificação é aplicável
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	As informações completas do contrato
Mega Sign	megaSign	WebhookMegaSignInfo	As informações completas do mega signo
Formulário da Web	widget	WebhookWidgetInfo	As informações completas do formulário da Web

WebhookAgreementInfo

As informações completas do contrato

Nome	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 E ou Escrita
Situação	status	string	O status atual do contrato
Ccs	ccs	array of CcInfo	Uma lista de um ou mais CCs que serão copiados na transação do contrato.
Data de Criação	createdDate	date	Data em que o contrato foi criado
Hora de expiração	expirationTime	string	Hora após o qual o Contrato expira e precisa ser assinado antes dele
ID externa	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.
Local	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 de lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, o conjunto de frequências padrão para a conta será usado
Email do remetente	senderEmail	string	Email do remetente do contrato
Cofre habilitado?	vaultingInfo.enabled	boolean	Para contas configuradas para o cofre de documentos e a opção para habilitar por contrato, isso determina se o documento deve ser abobadado
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está habilitada
ID do Fluxo de Trabalho	workflowId	string	A ID do fluxo de trabalho personalizado que define o caminho de roteamento de um contrato.
URL de Redirecionamento do Post Sign	postSignOption.redirectUrl	string	Uma URL acessível publicamente para a qual o usuário será enviado após 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
Documentos	documentsInfo.documents	array of WebhookDocument	Uma lista de objetos que representam os documentos
Documentos de suporte	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Uma lista de documentos de suporte

WebhookAgreementInfoWithoutNextParticipantSet

As informações completas do contrato

Nome	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 E ou Escrita
Situação	status	string	O status atual do contrato
Ccs	ccs	array of CcInfo	Uma lista de um ou mais CCs que serão copiados na transação do contrato.
Data de Criação	createdDate	date	Data em que o contrato foi criado
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está habilitada
Hora de expiração	expirationTime	string	Hora após o qual o Contrato expira e precisa ser assinado antes dele
ID externa	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.
Local	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 de lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, o conjunto de frequências padrão para a conta será usado
Email do remetente	senderEmail	string	Email do remetente do contrato
Cofre habilitado?	vaultingInfo.enabled	boolean	Para contas configuradas para o cofre de documentos e a opção para habilitar por contrato, isso determina se o documento deve ser abobadado
URL de Redirecionamento do Post Sign	postSignOption.redirectUrl	string	Uma URL acessível publicamente para a qual o usuário será enviado após 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

As informações completas do contrato

Nome	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 E ou Escrita
Situação	status	string	O status atual do contrato
Ccs	ccs	array of CcInfo	Uma lista de um ou mais CCs que serão copiados na transação do contrato.
Data de Criação	createdDate	date	Data em que o contrato foi criado
Hora de expiração	expirationTime	string	Hora após o qual o Contrato expira e precisa ser assinado antes dele
ID externa	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.
Local	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 de lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, o conjunto de frequências padrão para a conta será usado
URL de Redirecionamento do Post Sign	postSignOption.redirectUrl	string	Uma URL acessível publicamente para a qual o usuário será enviado após 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.
Email do remetente	senderEmail	string	Email do remetente do contrato
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está habilitada
Cofre habilitado?	vaultingInfo.enabled	boolean	Para contas configuradas para o cofre de documentos e a opção para habilitar por contrato, isso determina se o documento deve ser abobadado
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
Documentos	documentsInfo.documents	array of WebhookDocument	Uma lista de objetos que representam os documentos
Documentos de suporte	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Uma lista de documentos de suporte retornada somente se houver algum documento de suporte no contrato
Informações do documento assinado	signedDocumentInfo.document	string	Uma cadeia de caracteres codificada em base64 do documento assinado

WebhookAgreementInfoWithSignedDocument

As informações completas do contrato

Nome	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 E ou Escrita
Situação	status	string	O status atual do contrato
Ccs	ccs	array of CcInfo	Uma lista de um ou mais CCs que serão copiados na transação de contrato
Data de Criação	createdDate	date	Data em que o contrato foi criado
Visibilidade do documento?	documentVisibilityEnabled	boolean	A visibilidade do documento está habilitada
Hora de expiração	expirationTime	string	Hora após o qual o Contrato expira e precisa ser assinado antes dele
ID externa	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.
Local	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 de lembrete	reminderFrequency	string	Parâmetro opcional que define a frequência com que você deseja enviar lembretes aos participantes. Se não for especificado, o conjunto de frequências padrão para a conta será usado
Email do remetente	senderEmail	string	Email do remetente do contrato
Cofre habilitado?	vaultingInfo.enabled	boolean	Para contas configuradas para o cofre de documentos e a opção para habilitar por contrato, isso determina se o documento deve ser abobadado
URL de Redirecionamento do Post Sign	postSignOption.redirectUrl	string	Uma URL acessível publicamente para a qual o usuário será enviado após 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
Documentos	documentsInfo.documents	array of WebhookDocument	Uma lista de objetos que representam os documentos
Documentos de suporte	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Uma lista de documentos de suporte retornada somente se houver algum documento de suporte no contrato
Informações do documento assinado	signedDocumentInfo.document	string	Uma cadeia de caracteres codificada em base64 do documento assinado

WebhookMegaSignInfo

As informações completas do mega signo

Nome	Caminho	Tipo	Description
ID	id	string	A ID exclusiva da megasign
Nome	name	string	O nome da megasign
Situação	status	string	O status da megasign
Ccs	ccs	array of MegaSignCcInfo	Uma lista de um ou mais endereços de email que você deseja copiar neste megasign.
ID externa	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.
Local	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
URL de Redirecionamento do Post Sign	postSignOption.redirectUrl	string	Uma URL acessível publicamente para a qual o usuário será enviado após concluir com êxito o processo de assinatura
Email do remetente	senderEmail	string	Email do criador de megasign
Tipo de assinatura	signatureType	string	Especifica o tipo de assinatura que foi solicitado – Assinatura E ou Escrita
Cofre habilitado?	vaultingInfo.enabled	boolean	Para contas configuradas para o cofre de documentos e a opção para habilitar por contrato, isso determina se o documento deve ser abobadado
Informações de arquivo de contratos filho	childAgreementsInfo.fileInfo	MegaSignChildAgreementsFileInfo	Informações de arquivo que contêm informações de contrato por filho do megaSign.

WebhookWidgetInfo

As informações completas do formulário da Web

Nome	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do formulário da Web
Nome	name	string	O nome do formulário da Web
Situação	status	string	O status do formulário da Web
Informações de falha de autenticação	authFailureInfo	AuthFailureWidgetRedirectionInfo	URL e propriedades associadas para a página de erro, o signatário do formulário da Web será tomado após não conseguir autenticar
Ccs	ccs	array of WidgetCcInfo	Uma lista de um ou mais endereços de email que você deseja copiar neste formulário da Web.
Data de Criação	createdDate	date	Data em que o formulário da Web foi criado
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 após executar a ação desejada no formulário da Web
Email do Criador	creatorEmail	string	O email do criador do formulário da Web
Cofre habilitado?	vaultingInfo.enabled	boolean	Para contas configuradas para o cofre de documentos e a opção para habilitar por contrato, isso determina se o documento deve ser abobadado
Informações adicionais sobre conjuntos de participantes	participantSetsInfo.additionalParticipantSets	array of WidgetParticipantSetInfo	Lista de todos os participantes no formulário da Web, exceto o signatário do formulário da Web
Função Primeiro Conjunto de Participantes	participantSetsInfo.widgetParticipantSet.role	string	Função assumida por todos os participantes no conjunto (signatário, aprovador etc.)
Ordem do Primeiro Conjunto de Participantes	participantSetsInfo.widgetParticipantSet.order	integer	Índice que indica grupo de assinatura sequencial (especificado para roteamento híbrido)
Documentos	documentsInfo.documents	array of WidgetWebhookDocument	Uma lista de objetos que representam os documentos

AuthFailureWidgetRedirectionInfo

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

Nome	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
Desframe de Redirecionamento de Falha de Autenticação	deframe	boolean	Se o desframe 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	Uma URL acessível publicamente para a qual o usuário será enviado após concluir com êxito o 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 após executar a ação desejada no formulário da Web

Nome	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
Desframe de Redirecionamento de Conclusão	deframe	boolean	Se o desframe for false, a página resultante será mostrada dentro do quadro do formulário da Web
URL de Redirecionamento de Conclusão	url	string	Uma URL acessível publicamente para a qual o usuário será enviado após concluir com êxito o formulário da Web

WebhookParticipantSets

Nome	Caminho	Tipo	Description
Informações do membro	memberInfos	array of MemberInfos	As informações sobre os membros participantes
Pedido	order	integer	Índice que indica a posição na qual o grupo de assinatura precisa assinar.
Função	role	string	Função assumida por todos os participantes no conjunto (signatário, aprovador etc.)
Situação	status	string	Status atual do contrato da perspectiva do usuário
ID	id	string	A ID do conjunto de participantes
Nome	name	string	O nome do conjunto de participantes
Mensagem Privada	privateMessage	string	Mensagem privada para os participantes no conjunto

MegaSignChildAgreementsFileInfo

Informações de arquivo que contêm informações de contrato por filho do megaSign.

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

WidgetWebhookDocument

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

Nome	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do documento
Nome	name	string	O nome do documento

WebhookDocument

As informações sobre o documento do contrato

Nome	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do documento
Nome	name	string	O nome do documento

WebhookSupportingDocument

As informações sobre o documento de suporte

Nome	Caminho	Tipo	Description
Nome	displayLabel	string	Nome de exibição do documento de suporte
Nome do campo	fieldName	string	O nome do campo de documento de suporte
ID	id	string	A ID exclusiva que representa o documento de suporte

WidgetCcInfo

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

Nome	Caminho	Tipo	Description
Email	email	string	Email do participante cc do formulário da Web

MegaSignCcInfo

As informações sobre o CC do mega signo

Nome	Caminho	Tipo	Description
Email	email	string	Email do participante cc da megasign

CcInfo

As informações sobre o CC do contrato

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

WidgetParticipantSetInfo

Nome	Caminho	Tipo	Description
Função	role	string	Função assumida por todos os participantes no conjunto (signatário, aprovador etc.)
ID	id	string	O identificador exclusivo do conjunto de participantes
Informações do membro	memberInfos	array of MemberInfos	As informações sobre os membros participantes
Pedido	order	integer	Índice que indica grupo de assinatura sequencial (especificado para roteamento híbrido)

MemberInfos

Nome	Caminho	Tipo	Description
ID	id	string	A ID exclusiva do participante
Email	email	string	O email do participante
Empresa	company	string	A empresa do participante
Nome	name	string	O nome do participante
Mensagem Privada	privateMessage	string	A mensagem privada do participante
Situação	status	string	O status do participante

LibraryDocumentCreationResponseV6

Um objeto JSON que descreve o modelo de biblioteca

Nome	Caminho	Tipo	Description
ID do modelo de biblioteca	id	string	A ID exclusiva que pode ser usada para se referir ao modelo de biblioteca

LibraryDocument

Nome	Caminho	Tipo	Description
ID do modelo de biblioteca	id	string	O identificador exclusivo usado para se referir ao modelo de biblioteca
Oculto	hidden	boolean	True se o Documento da Biblioteca estiver oculto
Tipos de modelo	templateTypes	array of string	Uma lista de um ou mais tipos de modelo de biblioteca
Data modificada	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 escopo da visibilidade do modelo de biblioteca
Email do Criador	creatorEmail	string	Endereço de email 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	Status do documento da biblioteca

LibraryDocuments

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

Nome	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

Nome	Caminho	Tipo	Description
ID do Formulário da Web	id	string	O identificador exclusivo de um formulário da Web
Data modificada	modifiedDate	string	A data em que o formulário da Web foi modificado pela última vez
Oculto	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 da Web
Situação	status	string	O status do formulário da Web
URL	url	string	A URL hospedada do formulário da Web
Javascript	javascript	string	O código javascript inserido do formulário web

userWidgetListV6

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

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

UserWorkflowV6

Nome	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 esse fluxo de trabalho no momento de sua criação
Data de criação	created	string	A data em que o fluxo de trabalho foi criado. O formato seria yyyy-MM-dd'T'HH:mm:ssZ
Data modificada	modified	string	A data em que o fluxo de trabalho foi modificado. O formato seria yyyy-MM-dd'T'HH:mm:ssZ
Nome	name	string	O nome do fluxo de trabalho
Nome de Exibição	displayName	string	O nome de 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 Escopo	scopeId	string	Identificador do escopo. Atualmente, ele é aplicável somente para GROUP de escopo e o valor será groupId.

userWorkflowListV6

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

Nome	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 de parâmetros padrão do fluxo de trabalho

Nome	Caminho	Tipo	Description
Valor Padrão	defaultValue	string	Valor padrão do campo se a entrada para este campo não for fornecida e esse campo for necessário
Editáveis	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para esse campo for falso, esse campo não deverá 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 esse campo é necessário ou opcional
Visível	visible	boolean	Se o campo atual está visível ou não. Se o atributo visível para esse campo for false, esse campo não deverá estar visível na interface do usuário de criação do contrato usando esse fluxo de trabalho para o usuário

CCsListInfoDescriptionV6

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

Nome	Caminho	Tipo	Description
Valores padrão	defaultValues	array of string	Uma matriz de emails padrão que será usada se nenhuma entrada for fornecida para este elemento de lista
Editáveis	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para esse campo for falso, esse campo não deverá 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 de 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 mínimas de 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 esse campo é necessário ou opcional
Visível	visible	boolean	Se o campo atual está visível ou não. Se o atributo visível para esse campo for falso, esse campo não deverá ser mostrado na página de criação do contrato usando esse fluxo de trabalho

ExpirationFieldInfoDescriptionV6

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

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

FileInfosDescriptionV6

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

Nome	Caminho	Tipo	Description
Etiqueta	label	string	Exibir o rótulo desse campo para usuários externos
Nome	name	string	Nome do elemento fileInfo
Obrigatório	required	boolean	Se esse campo é necessá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

Nome	Caminho	Tipo	Description
Etiqueta	label	string	Um texto de exibição para este formulário para usuários de fluxo de trabalho
Data modificada	modifiedDate	string	A data em que o documento da biblioteca foi modificado pela última vez. O formato seria yyyy-MM-dd'T'HH:mm:ssZ. Por exemplo, 2016-02-25T18:46:19Z representa a hora UTC
Modo de Compartilhamento	sharingMode	string	Especifica quem deve ter acesso a este documento de 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 fornecida como um arquivo de entrada na solicitação de criação do contrato de fluxo de trabalho personalizado

LocaleFieldInfoDescriptionV6

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

Nome	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 esse campo for necessário
Editáveis	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para esse campo for falso, esse campo não deverá 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 esse campo é necessário ou opcional
Visível	visible	boolean	Se o campo atual está visível ou não. Se o atributo visível para esse campo for false, esse campo não deverá estar visível na interface do usuário de criação do contrato usando esse fluxo de trabalho para o usuário

MergeFieldInfoDescriptionV6

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

Nome	Caminho	Tipo	Description
Valor Padrão	defaultValue	string	Valor padrão do campo se a entrada para este campo não for fornecida e esse campo for necessário
Nome de Exibição	displayName	string	O texto de exibição que pode ser mostrado para este campo personalizado
Editáveis	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para esse campo for falso, esse campo não deverá 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 esse campo é necessá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 visível para esse campo for falso, esse campo não deverá ser mostrado na página de criação do contrato usando esse fluxo de trabalho

PasswordFieldInfoDescriptionV6

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

Nome	Caminho	Tipo	Description
Senha	defaultValue	string	Valor padrão do campo informações de senha
Editáveis	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para esse campo for falso, esse campo não deverá 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 senha
Nome	name	string	Nome do campo senha
Obrigatório	required	boolean	Se esse campo é necessá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

Nome	Caminho	Tipo	Description
Permitir Remetente	allowSender	boolean	Se o remetente é permitido como um 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 exibir e assinar o documento,
Valor padrão de email/fax	defaultValue	string	Um número de email ou fax padrão
Editáveis	editable	boolean	Se o campo atual pode ser editado. Se o atributo editável para esse campo for falso, esse campo não deverá 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 de fluxo de trabalho que pode ser usado para a lista de destinatários atual
Máximo de destinatários	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 de informações do destinatário atual
Função participante	role	string	A função atual do participante
Visível	visible	boolean	Se o campo atual está visível. Se o atributo visível para esse campo for falso, esse campo não deverá ser mostrado na interface do usuário de criação do contrato usando esse fluxo de trabalho para o usuário

WorkflowDescriptionV6

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

Nome	Caminho	Tipo	Description
agreementNameInfo	agreementNameInfo	WorkflowDefaultParamsV6	Um JSON que contém o objeto de parâmetros padrão do fluxo de trabalho
authoringInfo	authoringInfo	WorkflowDefaultParamsV6	Um JSON que contém o objeto de parâmetros 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 esse fluxo de trabalho no momento de sua criação
Nome de exibição do fluxo de trabalho	displayName	string	O nome de exibição do fluxo de trabalho
expirationInfo	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 de 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 de campos de mesclagem	mergeFieldsInfo	array of MergeFieldInfoDescriptionV6	Informações sobre o campo de entrada de informações personalizadas na solicitação de criação do contrato
messageInfo	messageInfo	WorkflowDefaultParamsV6	Um JSON que contém o objeto de parâmetros padrão do fluxo de trabalho
Data modificada	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 recepientes na solicitação de criação do 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 de Fluxo de Trabalho	originatorId	string	Originador inicial do fluxo de trabalho
ID do escopo do fluxo de trabalho	scopeId	string	Identificador do escopo. Atualmente, ele é aplicável somente para GROUP de escopo e o valor será groupId

BooleanSettingInfoV6

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

SettingsInfoV6

Nome	Caminho	Tipo
libaryDocumentCreationVisible	libaryDocumentCreationVisible	BooleanSettingInfoV6
sendRestrictedToWorkflows	sendRestrictedToWorkflows	BooleanSettingInfoV6
userCanSend	userCanSend	BooleanSettingInfoV6
widgetCreationVisible	widgetCreationVisible	BooleanSettingInfoV6

UserGroupInfoV6

Nome	Caminho	Tipo	Description
ID do grupo	id	string	Identificador exclusivo do grupo
É administrador de grupo	isGroupAdmin	boolean	True se o usuário for administrador de grupo
É o grupo primário	isPrimaryGroup	boolean	True se o grupo for o grupo primário do usuário
Situação	status	string	Status da associação ao grupo
Data de criação	createdDate	date	O grupo de datas foi criado
Nome de Grupo	name	string	Nome do grupo
configurações	settings	SettingsInfoV6

UserGroupsInfoV6

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

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

AgreementViews

Lista de exibições de contrato

Nome	Caminho	Tipo	Description
Lista de exibição de contrato	agreementViewList	array of AgreementView	Exibições do contrato

AgreementView

Nome do modo de exibição necessário e sua configuração desejada.

Nome	Caminho	Tipo	Description
Exibir URL	url	string	Url do local do recurso
Código inserido	embeddedCode	string	Código inserido da URL do recurso
Vencimento	expiration	string	Expiração da URL do usuário
É o Modo de Exibição Atual	isCurrent	boolean	True se essa exibição for a exibição atual

binário

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

objeto

Esse é o tipo 'object'.

arquivo

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

Compartilhar via

Assinatura do Adobe Acrobat

Assinatura do Adobe Acrobat

Publisher: Adobe, Inc.

Pré-requisitos

Como obter credenciais

Introdução ao conector

Problemas e limitações conhecidos

Erros e soluções comuns

perguntas frequentes

Limitações

Ações

Cancelar um contrato

Parâmetros

Carregar um documento e obter uma ID de documento

Parâmetros

Retornos

Carregar um documento e obter uma ID de documento (Antiga) [PRETERIDA]

Parâmetros

Retornos

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

Parâmetros

Retornos

Criar um contrato a partir de uma URL de documento e enviar para assinatura (Antiga) [PRETERIDA]

Parâmetros

Retornos

Criar um contrato com base em um conteúdo de arquivo e enviar para assinatura

Parâmetros

Retornos

Criar um contrato com base em um documento carregado e enviar para assinatura

Parâmetros

Retornos

Criar um contrato com base em um modelo de biblioteca e enviar para assinatura

Parâmetros

Retornos

Criar um contrato com base em um modelo de biblioteca e enviar para assinatura (Antiga) [PRETERIDO]

Parâmetros

Retornos

Criar um contrato de um documento carregado e enviar para assinatura (Antiga) [PRETERIDO]

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros

Retornos

Criar um modelo de biblioteca a partir de uma URL de documento (Antiga) [PRETERIDA]

Parâmetros

Retornos

Criar um modelo de biblioteca com base em um documento carregado

Parâmetros

Retornos

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

Parâmetros

Retornos

Obter a URL de exibição do contrato

Parâmetros

Retornos

Obter as informações detalhadas do fluxo de trabalho

Parâmetros

Retornos

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

Parâmetros

Retornos

Obter dados de campo de formulário do contrato no formato CSV

Parâmetros

Retornos

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

Parâmetros

Retornos

Obter o status de um contrato

Parâmetros

Retornos

Obter o status de um contrato [PRETERIDO]

Parâmetros

Retornos

Obter um documento de um contrato

Parâmetros

Retornos