Sinal à prova de s (versão prévia)

Use o sinal à prova de segurança para automatizar fluxos de trabalho de assinatura eletrônica seguras para documentos PDF e DOCX. As organizações podem criar solicitações de assinatura de documentos únicos ou múltiplos, atribuir destinatários e funções de assinatura, acompanhar status, baixar PDFs concluídos e excluir documentos. Uma conta de Sinal à prova de falhas, um plano que dá suporte às ações selecionadas e tipos de assinatura e um token de API válido são necessários.

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

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

Contato
Nome	Suporte à API
URL	https://sproof.com
Email	support@sproof.com

Metadados do conector
Publicador	sproof GmbH
Site	https://www.sproof.com/en/sign/
Política de privacidade	https://www.sproof.com/en/privacy-policy-app/
Categories	Produtividade; Conteúdo e arquivos

Sinal à prova de sproof

Visão geral

o sproof Sign permite que as organizações automatizem fluxos de trabalho de assinatura eletrônica para documentos PDF e DOCX. O conector pode criar solicitações de assinatura de documento único ou envelopes de vários documentos, atribuir destinatários e funções de assinatura, recuperar o status da solicitação, baixar documentos concluídos e excluir documentos.

Pré-requisitos

Para usar o conector, você precisa:

• Uma conta de sinal à prova de falhas.
• Um plano de sinal à prova com acesso à API e suporte para as ações e tipos de assinatura necessários.
• Um token de API de Sinal à prova de falhas válido.

Authentication

O conector usa a autenticação de token de API. Crie uma conexão inserindo um token de API de Sinal à prova de falhas válido associado à sua conta. Mantenha o token seguro e substitua-o se ele for revogado ou regenerado.

Ações suportadas

• Criar solicitação de assinatura – Cria uma solicitação para um documento ou um envelope que contém vários documentos. Destinatários, funções de assinatura, ordem de assinatura, posições de assinatura e outras configurações de convite podem ser configurados.
• Criar solicitação de assinatura usando espaços reservados – Cria uma solicitação usando espaços reservados armazenados em um documento carregado. As informações do destinatário e as posições de assinatura são extraídas desses espaços reservados.
• Obter o status da solicitação — recupera o estado atual e o status de assinatura de uma solicitação de assinatura usando sua ID de membro.
• Obter documento – Baixa um documento como um PDF binário ou como um PDF codificado em Base64.
• Excluir documento — exclui um documento ou remove o acesso de um membro, dependendo da ID do membro fornecida, da função do membro e se o documento pertence a um envelope.

Limitações e requisitos conhecidos

• Documentos de entrada devem ser fornecidos como conteúdo PDF ou DOCX codificado em Base64.
• Um envelope pode conter no máximo 25 documentos.
• Um nome de envelope é necessário quando mais de um documento é enviado.
• As solicitações baseadas em espaço reservado exigem espaços reservados formatados corretamente no documento carregado.
• Para solicitações baseadas em espaço reservado, destinatários e posições de assinatura são obtidos do documento em vez de inseridos manualmente.
• As ações disponíveis, os tipos de assinatura e os provedores dependem da conta e do plano de sinal à prova de conexão.
• O comportamento de exclusão do documento depende se a ID de membro fornecida pertence ao remetente ou a um destinatário e se o documento faz parte de um envelope.

Support

Para obter suporte ao conector ou à API, entre em contato support@sproof.com.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
símbolo	secureString	API de "token" für diese	Verdade

Ações

Criar solicitação de assinatura	Essa é a nova solicitação de criação de assinatura. Além de criar um único convite de documento, ele agora dá suporte à criação de envelopes e ao carregar vários documentos ao enviar convites.
Criar solicitação de assinatura usando espaços reservados	Cria uma solicitação de assinatura usando espaços reservados armazenados no documento carregado. Destinatários e posições de assinatura são extraídos do documento.
Excluir documento	Exclui um documento ou remove o acesso de um membro a ele, dependendo se o fornecido memberId pertence ao remetente ou a um destinatário e se o documento faz parte de um envelope. Documentos em um envelope O parâmetro all de consulta não tem efeito para documentos em um envelope. Com o remetente memberId: Um único documento é excluído para o remetente e todos os destinatários. O documento é removido do envelope. Com o destinatário memberId: Todos os documentos no envelope são removidos para o destinatário. O destinatário é marcado como declined em todos os documentos que foram excluídos para o destinatário. Os documentos permanecem disponíveis para todos os outros membros no documento. Documentos únicos Com o remetente memberId e all=true: O documento é excluído para o remetente e todos os destinatários. Com o remetente memberId e all=false: O documento é excluído somente para o remetente. O documento permanece disponível para os outros destinatários no documento. Com o destinatário memberId: O destinatário está marcado como declined no documento. O documento permanece disponível para todos os outros membros no documento.
Obter documento	Obtenha o documento assinado como cadeia de caracteres binária ou codificada em Base64.
Obter o status da solicitação	Obtenha o status de uma solicitação de assinatura. Retorna um objeto JSON de documento ou um erro. O parâmetro é retornado pela solicitação de postagem no documento e está associado ao email dos remetentes.

Criar solicitação de assinatura

ID da operação:

CreateSignatureRequest

Essa é a nova solicitação de criação de assinatura. Além de criar um único convite de documento, ele agora dá suporte à criação de envelopes e ao carregar vários documentos ao enviar convites.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
email	email	True	string	Email do remetente. Ele deve pertencer a um membro do seu plano.
firstName	firstName	True	string	Nome do remetente.
lastName	lastName		string	Sobrenome do remetente.
função	role		string	A função do remetente em todos os documentos.
email	email		string	Email do destinatário.
firstName	firstName		string	Nome do destinatário.
lastName	lastName		string	Sobrenome do destinatário.
doNotSendEmails	doNotSendEmails		boolean	Se definido como true nenhum email for enviado para o destinatário.
customId	customId		string	Para ser usado somente quando o endereço de email do destinatário for desconhecido no momento do convite. Isso só funciona quando você convida os destinatários (não para preparar rotas) e deseja usar fastlane. Permite customId que você gere previamente um link de assinatura exclusivo para um destinatário antes de enviar um convite. Deve ser uma cadeia de caracteres alfanumérica exclusiva de pelo menos 70 caracteres. Observação: a customId só pode ser usada para criar o link do destinatário para um documento. Ele não pode ser usado para outras solicitações em vez da memberId. Para obter detalhes sobre a construção da URL, consulte Abrir um documento com uma ID Personalizada
useFastlane	useFastlane		boolean	Se definido como true o signatário receber um link do Fastlane no email de convite.
phoneNumber	phoneNumber		string	O número de telefone desse destinatário. Isso é usado para verificação de SMS. (por exemplo: +43 699 1234 1234).
privateMessage	privateMessage		string	Uma mensagem privada para esse destinatário específico.
inPersonMode	inPersonMode		boolean	Quando essa opção estiver habilitada, o destinatário da solicitação de assinatura será necessário para assinar o documento pessoalmente e nenhum email será enviado. Esse modo só está disponível usando o tipo de assinatura SES
signatureTypes	signatureTypes		array of string	Os tipos de assinaturas permitidas para esse destinatário. Opções: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
marca	tag		string	Essa marca determina o provedor de identidade que será usado para o processo de assinatura. Escolha entre um conjunto predefinido de provedores com suporte. Observação1: Alguns provedores só estão disponíveis para determinados signatureTypes, por exemplo onetimeqes , exigirão "signatureType" : ["qualifiedPlusIdent"] Observação2: Ao usar sproof-qualified como provedor padrão, o destinatário precisa ter uma conta à prova de ativos com uma licença ativa do User+.
canChange	canChange		boolean	Booliano para indicar se o destinatário convidado deve ser capaz de alterar o provedor de assinatura
country	country		string	O país padrão, se estiver em branco definido como todos, um erro será retornado com quais países estão disponíveis para a marca de provedor escolhida
data de vencimento	dueDate		YYYY-MM-DD	A data até a qual o documento pode ser assinado. Essa data de conclusão é exibida para o destinatário no email de convite e também está visível na seção de detalhes do documento do painel. Ele serve como um prazo para concluir o processo de assinatura.
reminderInterval	reminderInterval		number	Especifica o número de dias entre emails de lembrete.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Data da qual os lembretes devem ser enviados
inviteLanguage	inviteLanguage		string	Especifica o idioma dos emails enviados a usuários anônimos que não têm uma conta. Para usuários com uma conta, o idioma selecionado em seu perfil será usado.
mensagem	message		string	Uma mensagem personalizada enviada aos destinatários no email.
subject	subject		string	A linha de assunto do email enviado aos destinatários.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Se definido como true, o pdf será enviado como um anexo a todos os destinatários no documento (se for menor que 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Quando essa opção estiver habilitada, o destinatário da solicitação de assinatura será limitado a assinar ou recusar o documento e não poderá navegar para longe da página.
allowForwarding	allowForwarding		boolean	Permitir o encaminhamento do convite.
collabSigningMode	collabSigningMode		object	Um objeto em que cada chave representa uma rodada de assinatura e seu valor correspondente indica se a assinatura colaborativa está habilitada para essa rodada. Se o valor for true, apenas uma assinatura será necessária para concluir a rodada de assinatura especificada e prosseguir para a próxima rodada. Por exemplo, { '1': true } significa que, na rodada de assinatura '1', apenas uma assinatura é necessária.
usePlaceholders	usePlaceholders		boolean	Se verdadeiro, espaços reservados de texto/formFields armazenados no documento serão usados para convidar destinatários.
inPersonSigning	inPersonSigning		boolean	Quando verdadeiro, o destinatário obtém um pop-up onde ele precisa desenhar manualmente uma assinatura
folderName	folderName		string	Se for dado, um envelope será criado contendo todos os documentos em documentDataArray. (Obrigatório se mais de um documento for enviado)
callbackUrl	callbackUrl		string	Uma solicitação POST, incluindo o documento, será enviada para essa URL quando uma nova assinatura for criada ou quando um destinatário recusar o documento. Em caso de falha, um mecanismo de repetição está em vigor para garantir que a solicitação seja repetida.
Returnurl	returnUrl		string	O link do botão retornar depois de assinar um documento
returnBtnText	returnBtnText		string	O texto do botão retornar depois de assinar um documento
dados	data	True	string	Os dados do documento (PDF ou DOCX) no formato base64.
mimetype	mimetype		string	Tipo MIME de dados codificados em base64 PDF ou DOCX, necessário se o documento não for um pdf
fileName	fileName	True	string	Nome do arquivo
etiqueta	label		string	Um rótulo personalizado que pode ser enviado para organizar documentos.
página	page	True	integer	Número da página em que a caixa está, com a primeira página sendo 0.
Pagewidth	pageWidth		integer	Qualquer valor inteiro que descreva a largura da página. Quanto maior o número, melhor a precisão ao posicionar a caixa no espaço x y. Em uma página A4, temos 478 como valor padrão.
pageHeight	pageHeight		integer	Qualquer valor inteiro que descreva a altura da página. Quanto maior o número, melhor a precisão ao posicionar a caixa no espaço x y. Em uma página A4, temos 676 como valor padrão.
x	x	True	float	Representa a posição horizontal da caixa como um percentual da largura da página. A origem (0,0) está na parte superior esquerda da página. Um valor de 0,1 significa que a caixa está posicionada em 10% da largura da página da esquerda.
y	y	True	float	Representa a posição vertical da caixa como um percentual da altura da página. A origem (0,0) está na parte superior esquerda da página. Um valor de 0,1 significa que a caixa está posicionada em 10% da altura da página da parte superior.
width	width	True	float	Largura da caixa com base em dimensões de página, semelhante às coordenadas x e y. É um float que representa uma porcentagem da pageWidth.
height	height	True	float	Altura da caixa com base em dimensões de página, semelhante às coordenadas x e y. É um float que representa uma porcentagem do pageHeight.
id	id	True	string	Uma ID exclusiva para essa caixa, gerada da maneira desejada.
etiqueta	label		string	Texto de espaço reservado, como o nome do campo, por exemplo, "Data de Nascimento".
value	value		string	Valor padrão para a caixa. Pode ser nulo. Se a caixa for do tipo 'chooseBox', o valor poderá ser nulo ou uma das cadeias de caracteres definidas nas opções.
readonly	readonly		boolean	Se definido como true, a pessoa convidada não poderá modificar o valor dessa caixa.
required	required		boolean	Se definido como true, a pessoa convidada não poderá assinar o documento sem preencher essa caixa.
tipo	type	True	string
multilinha	multiline		boolean	Se várias linhas são permitidas.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
agrupar	group		number	Cada caixa de rádio pode ser atribuída a um grupo.
signatureTypes	signatureTypes		array of string	Os tipos de assinaturas permitidas para esse destinatário podem ser substituídos por tipos de assinatura de destinatário. Opções: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	A refId é um campo opcional usado para fazer referência cruzada ao documento carregado. Se fornecido, ele permite que você atribua um identificador de referência personalizado ao documento, que será retornado como parte do objeto do documento em respostas futuras à API. Isso pode ser útil para rastrear ou organizar documentos por um sistema ou fluxo de trabalho externo.
linguagem	language		string	O idioma do documento.
folderId	folderId		string	A ID de uma pasta na qual os documentos devem ser inseridos. Isso só é possível quando inviteData e folderName são indefinidos.
isAttachment	isAttachment		boolean	isAttachment não é necessário neste caso.
Detalhes do destinatário	recipientDetails	True	object	Detalhes do destinatário chaveados por email do destinatário. Exemplo: {"mail@test.com":{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}.
useFastlane	useFastlane		boolean	Se definido como true o signatário receber um link do Fastlane no email de convite.
fastlaneProfileId	fastlaneProfileId		uuid	Especifique o perfil fastlane que deve ser usado com este documento. (useFastlane deve ser definido como true).

Retornos

Corpo

EnvelopeResponse

Criar solicitação de assinatura usando espaços reservados

ID da operação:

CreateSignatureRequestUsingPlaceholders

Cria uma solicitação de assinatura usando espaços reservados armazenados no documento carregado. Destinatários e posições de assinatura são extraídos do documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
email	email	True	string	Email do remetente. Ele deve pertencer a um membro do seu plano.
firstName	firstName	True	string	Nome do remetente.
lastName	lastName		string	Sobrenome do remetente.
função	role		string	A função do remetente em todos os documentos.
email	email		string	Email do destinatário.
firstName	firstName		string	Nome do destinatário.
lastName	lastName		string	Sobrenome do destinatário.
doNotSendEmails	doNotSendEmails		boolean	Se definido como true nenhum email for enviado para o destinatário.
customId	customId		string	Para ser usado somente quando o endereço de email do destinatário for desconhecido no momento do convite. Isso só funciona quando você convida os destinatários (não para preparar rotas) e deseja usar fastlane. Permite customId que você gere previamente um link de assinatura exclusivo para um destinatário antes de enviar um convite. Deve ser uma cadeia de caracteres alfanumérica exclusiva de pelo menos 70 caracteres. Observação: a customId só pode ser usada para criar o link do destinatário para um documento. Ele não pode ser usado para outras solicitações em vez da memberId. Para obter detalhes sobre a construção da URL, consulte Abrir um documento com uma ID Personalizada
useFastlane	useFastlane		boolean	Se definido como true o signatário receber um link do Fastlane no email de convite.
phoneNumber	phoneNumber		string	O número de telefone desse destinatário. Isso é usado para verificação de SMS. (por exemplo: +43 699 1234 1234).
privateMessage	privateMessage		string	Uma mensagem privada para esse destinatário específico.
inPersonMode	inPersonMode		boolean	Quando essa opção estiver habilitada, o destinatário da solicitação de assinatura será necessário para assinar o documento pessoalmente e nenhum email será enviado. Esse modo só está disponível usando o tipo de assinatura SES
signatureTypes	signatureTypes		array of string	Os tipos de assinaturas permitidas para esse destinatário. Opções: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
marca	tag		string	Essa marca determina o provedor de identidade que será usado para o processo de assinatura. Escolha entre um conjunto predefinido de provedores com suporte. Observação1: Alguns provedores só estão disponíveis para determinados signatureTypes, por exemplo onetimeqes , exigirão "signatureType" : ["qualifiedPlusIdent"] Observação2: Ao usar sproof-qualified como provedor padrão, o destinatário precisa ter uma conta à prova de ativos com uma licença ativa do User+.
canChange	canChange		boolean	Booliano para indicar se o destinatário convidado deve ser capaz de alterar o provedor de assinatura
country	country		string	O país padrão, se estiver em branco definido como todos, um erro será retornado com quais países estão disponíveis para a marca de provedor escolhida
data de vencimento	dueDate		YYYY-MM-DD	A data até a qual o documento pode ser assinado. Essa data de conclusão é exibida para o destinatário no email de convite e também está visível na seção de detalhes do documento do painel. Ele serve como um prazo para concluir o processo de assinatura.
reminderInterval	reminderInterval		number	Especifica o número de dias entre emails de lembrete.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Data da qual os lembretes devem ser enviados
inviteLanguage	inviteLanguage		string	Especifica o idioma dos emails enviados a usuários anônimos que não têm uma conta. Para usuários com uma conta, o idioma selecionado em seu perfil será usado.
mensagem	message		string	Uma mensagem personalizada enviada aos destinatários no email.
subject	subject		string	A linha de assunto do email enviado aos destinatários.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Se definido como true, o pdf será enviado como um anexo a todos os destinatários no documento (se for menor que 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Quando essa opção estiver habilitada, o destinatário da solicitação de assinatura será limitado a assinar ou recusar o documento e não poderá navegar para longe da página.
allowForwarding	allowForwarding		boolean	Permitir o encaminhamento do convite.
collabSigningMode	collabSigningMode		object	Um objeto em que cada chave representa uma rodada de assinatura e seu valor correspondente indica se a assinatura colaborativa está habilitada para essa rodada. Se o valor for true, apenas uma assinatura será necessária para concluir a rodada de assinatura especificada e prosseguir para a próxima rodada. Por exemplo, { '1': true } significa que, na rodada de assinatura '1', apenas uma assinatura é necessária.
inPersonSigning	inPersonSigning		boolean	Quando verdadeiro, o destinatário obtém um pop-up onde ele precisa desenhar manualmente uma assinatura
folderName	folderName		string	Se for dado, um envelope será criado contendo todos os documentos em documentDataArray. (Obrigatório se mais de um documento for enviado)
callbackUrl	callbackUrl		string	Uma solicitação POST, incluindo o documento, será enviada para essa URL quando uma nova assinatura for criada ou quando um destinatário recusar o documento. Em caso de falha, um mecanismo de repetição está em vigor para garantir que a solicitação seja repetida.
Returnurl	returnUrl		string	O link do botão retornar depois de assinar um documento
returnBtnText	returnBtnText		string	O texto do botão retornar depois de assinar um documento
dados	data	True	string	Os dados do documento (PDF ou DOCX) no formato base64.
mimetype	mimetype		string	Tipo MIME de dados codificados em base64 PDF ou DOCX, necessário se o documento não for um pdf
fileName	fileName	True	string	Nome do arquivo
etiqueta	label		string	Um rótulo personalizado que pode ser enviado para organizar documentos.
página	page	True	integer	Número da página em que a caixa está, com a primeira página sendo 0.
Pagewidth	pageWidth		integer	Qualquer valor inteiro que descreva a largura da página. Quanto maior o número, melhor a precisão ao posicionar a caixa no espaço x y. Em uma página A4, temos 478 como valor padrão.
Pageheight	pageHeight		integer	Qualquer valor inteiro que descreva a altura da página. Quanto maior o número, melhor a precisão ao posicionar a caixa no espaço x y. Em uma página A4, temos 676 como valor padrão.
x	x	True	float	Representa a posição horizontal da caixa como um percentual da largura da página. A origem (0,0) está na parte superior esquerda da página. Um valor de 0,1 significa que a caixa está posicionada em 10% da largura da página da esquerda.
y	y	True	float	Representa a posição vertical da caixa como um percentual da altura da página. A origem (0,0) está na parte superior esquerda da página. Um valor de 0,1 significa que a caixa está posicionada em 10% da altura da página da parte superior.
width	width	True	float	Largura da caixa com base em dimensões de página, semelhante às coordenadas x e y. É um float que representa uma porcentagem da pageWidth.
height	height	True	float	Altura da caixa com base em dimensões de página, semelhante às coordenadas x e y. É um float que representa uma porcentagem do pageHeight.
id	id	True	string	Uma ID exclusiva para essa caixa, gerada da maneira desejada.
etiqueta	label		string	Texto de espaço reservado, como o nome do campo, por exemplo, "Data de Nascimento".
value	value		string	Valor padrão para a caixa. Pode ser nulo. Se a caixa for do tipo 'chooseBox', o valor poderá ser nulo ou uma das cadeias de caracteres definidas nas opções.
readonly	readonly		boolean	Se definido como true, a pessoa convidada não poderá modificar o valor dessa caixa.
required	required		boolean	Se definido como true, a pessoa convidada não poderá assinar o documento sem preencher essa caixa.
tipo	type	True	string
multilinha	multiline		boolean	Se várias linhas são permitidas.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
agrupar	group		number	Cada caixa de rádio pode ser atribuída a um grupo.
signatureTypes	signatureTypes		array of string	Os tipos de assinaturas permitidas para esse destinatário podem ser substituídos por tipos de assinatura de destinatário. Opções: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	A refId é um campo opcional usado para fazer referência cruzada ao documento carregado. Se fornecido, ele permite que você atribua um identificador de referência personalizado ao documento, que será retornado como parte do objeto do documento em respostas futuras à API. Isso pode ser útil para rastrear ou organizar documentos por um sistema ou fluxo de trabalho externo.
linguagem	language		string	O idioma do documento.
folderId	folderId		string	A ID de uma pasta na qual os documentos devem ser inseridos. Isso só é possível quando inviteData e folderName são indefinidos.
isAttachment	isAttachment		boolean	isAttachment não é necessário neste caso.
useFastlane	useFastlane		boolean	Se definido como true o signatário receber um link do Fastlane no email de convite.
fastlaneProfileId	fastlaneProfileId		uuid	Especifique o perfil fastlane que deve ser usado com este documento. (useFastlane deve ser definido como true).

Retornos

Corpo

EnvelopeResponse

Excluir documento

ID da operação:

DeleteDocument

Exclui um documento ou remove o acesso de um membro a ele, dependendo se o fornecido memberId pertence ao remetente ou a um destinatário e se o documento faz parte de um envelope.

Documentos em um envelope

O parâmetro all de consulta não tem efeito para documentos em um envelope.

Com o remetente memberId:

• Um único documento é excluído para o remetente e todos os destinatários.
• O documento é removido do envelope.

Com o destinatário memberId:

• Todos os documentos no envelope são removidos para o destinatário.
• O destinatário é marcado como declined em todos os documentos que foram excluídos para o destinatário.
• Os documentos permanecem disponíveis para todos os outros membros no documento.

Documentos únicos

Com o remetente memberId e all=true:

• O documento é excluído para o remetente e todos os destinatários.

Com o remetente memberId e all=false:

• O documento é excluído somente para o remetente.
• O documento permanece disponível para os outros destinatários no documento.

Com o destinatário memberId:

• O destinatário está marcado como declined no documento.
• O documento permanece disponível para todos os outros membros no documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de membro	memberId	True	string	ID de membro
Excluir para todos os destinatários	all		boolean	Relevante somente para documentos individuais quando o fornecido memberId pertence ao remetente. Se definido como true, o documento será excluído para o remetente e todos os destinatários. Se definido como false, o documento será excluído apenas para o remetente e permanecerá disponível para os outros destinatários. Esse parâmetro não tem efeito para documentos em um envelope (padrão = true) ou quando o fornecido memberId pertence a um destinatário.

Retornos

response

DeleteDocumentResponse

Obter documento

ID da operação:

GetDocument

Obtenha o documento assinado como cadeia de caracteres binária ou codificada em Base64.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de membro	memberId	True	string	ID de membro
Formato de download	format		string	Especifica o formato de resposta. Use pdf para PDF binário e base64 para uma resposta codificada em Base64. Exemplo base64 de resposta: json { "base64": "JVBERi0xLjQKJe..." }

Retornos

Nome	Caminho	Tipo	Description
base64	base64	string	Conteúdo PDF codificado em Base64

Obter o status da solicitação

ID da operação:

GetSignatureStatus

Obtenha o status de uma solicitação de assinatura. Retorna um objeto JSON de documento ou um erro. O parâmetro é retornado pela solicitação de postagem no documento e está associado ao email dos remetentes.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de membro	memberId	True	string	ID de membro

Retornos

Corpo

DocumentStatusForFlow

Definições

DeleteDocumentResponse

Excluir resposta do documento

string

EnvelopeResponse

Nome	Caminho	Tipo	Description
folderId	folderId	string
folderName	folderName	string
Documentos	documents	array of object
id	documents.id	string
nome	documents.name	string
linguagem	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Data e hora em que os lembretes começam a ser enviados (cadeia de caracteres de datetime ISO 8601)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	Data e hora em que o documento foi criado (cadeia de caracteres de datetime ISO 8601)
callbackUrl	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
signingRound	documents.signingRound	number
isTemplate	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
linkExpiresAt	documents.linkExpiresAt	string
derivedFromLink	documents.derivedFromLink	boolean
estado	documents.state	string
complianceLevel	documents.complianceLevel	string
allowForwarding	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
data de vencimento	documents.dueDate	date-time	Data de conclusão do documento (cadeia de caracteres de datetime ISO 8601)
focusedSigningMode	documents.focusedSigningMode	boolean
linkMaxSignaturesEnabled	documents.linkMaxSignaturesEnabled	boolean
linkMaxSignatures	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
sendOutFinishedPdf	documents.sendOutFinishedPdf	boolean
signatureTypes	documents.signatureTypes	array of string
members	documents.members	array of MemberResponseSchema
membro	documents.member	MemberResponseSchema
Caixas	documents.boxes	array of DocumentResponseBox	Uma caixa de campo de formulário na resposta do documento. Isso só será retornado se o documento tiver campos de formulário. Se o documento for assinado, o documento retornará caixas com os valores que foram preenchidos.
em atraso	documents.overdue	boolean

DocumentResponseBox

Nome	Caminho	Tipo	Description
id	id	string
tipo	type	string
value	value	string	O valor do campo de caixa. Pode ser uma cadeia de caracteres (incluindo cadeia de caracteres vazia), booliana ou nula, dependendo do tipo de caixa.
etiqueta	label	string

MemberResponseSchema

Nome	Caminho	Tipo	Description
id	id	string
documentId	documentId	string
email	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	Data e hora em que o membro foi criado (cadeia de caracteres de datetime ISO 8601)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Data e hora em que a notificação de exclusão foi enviada (cadeia de caracteres de datetime ISO 8601)
manuallyLastEmailSent	manuallyLastEmailSent	date-time	Data e hora em que o último email manual foi enviado (cadeia de caracteres de datetime ISO 8601)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Dados de posição de assinatura com campos específicos de resposta adicionais. Os campos cardStyle, pageWidth e pageHeight são opcionais e podem não estar presentes em todas as respostas de API.
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	Data e hora em que o membro recusou (cadeia de caracteres de datetime ISO 8601)
signingOrder	signingOrder	number
onDemand	onDemand	string
recipientId	recipientId	string
signatureTypes	signatureTypes	array of string
signatureTypesActive	signatureTypesActive	boolean
privateMessage	privateMessage	string
customId	customId	string
useFastlane	useFastlane	boolean
função	role	string
approvedAt	approvedAt	date-time	Data e hora em que o membro foi aprovado (cadeia de caracteres de datetime ISO 8601)
config verificação	verificationConfig
phoneNumber	phoneNumber	string
assinaturas	signatures	array of string
signedAt	signedAt	date-time	Data e hora em que o membro assinou (cadeia de caracteres de datetime ISO 8601)

MemberSignaturePositionResponse

Dados de posição de assinatura com campos específicos de resposta adicionais. Os campos cardStyle, pageWidth e pageHeight são opcionais e podem não estar presentes em todas as respostas de API.

Nome	Caminho	Tipo	Description
Itens		SignaturePositionResponse	Dados de posição de assinatura com campos específicos de resposta adicionais. Os campos cardStyle, pageWidth e pageHeight são opcionais e podem não estar presentes em todas as respostas de API.

SignaturePositionResponse

Dados de posição de assinatura com campos específicos de resposta adicionais. Os campos cardStyle, pageWidth e pageHeight são opcionais e podem não estar presentes em todas as respostas de API.

Nome	Caminho	Tipo	Description
página	page	integer	Número da página, começando com 0.
x	x	number	coordenada x da posição superior esquerda das assinaturas
y	y	number	coordenada y da posição superior esquerda das assinaturas
width	width	number	Largura da assinatura.
height	height	number	Altura da assinatura.
cardStyle	cardStyle	string	O estilo visual do cartão de assinatura. Esse campo é opcional e pode não ser retornado em todas as respostas.
Pagewidth	pageWidth	number	A largura da página em pixels. Esse campo é opcional e pode não ser retornado em todas as respostas.
pageHeight	pageHeight	number	A altura da página em pixels. Esse campo é opcional e pode não ser retornado em todas as respostas.

DocumentStatusForFlow

Nome	Caminho	Tipo	Description
id	id	string
nome	name	string
estado	state	string	O estado atual do documento. Os valores possíveis são: rascunho, pendente, recusado, concluído, anexo, manualmentePending, manualmenteCompleted
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean