Sinal sproof (Pré-visualização)

Use o sproof Sign para automatizar fluxos de trabalho seguros de assinatura eletrónica para documentos PDF e DOCX. As organizações podem criar pedidos de assinatura de um ou vários documentos, atribuir destinatários e funções de assinatura, acompanhar o estado, descarregar PDFs concluídos e eliminar documentos. São necessárias uma conta sproof Sign, um plano que suporte as ações e tipos de assinatura selecionados, e um token de API válido.

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

Service	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Publisher	sproof GmbH
Sítio Web	https://www.sproof.com/en/sign/
Política de privacidade	https://www.sproof.com/en/privacy-policy-app/
Categorias	Produtividade; Conteúdo e Ficheiros

Sinal sproof

Descrição geral

O sproof Sign permite às organizações automatizar fluxos de trabalho de assinatura eletrónica para documentos PDF e DOCX. O conector pode criar pedidos de assinatura de documento único ou envelopes multi-documento, atribuir destinatários e funções de assinatura, recuperar o estado dos pedidos, descarregar documentos concluídos e apagar documentos.

Pré-requisitos

Para usar o conector, você precisa:

Uma conta Sproof Sign.
Um plano Sproof Sign com acesso à API e suporte para as ações e tipos de assinatura necessários.
Um token Sign API sproof válido.

Authentication

O conector utiliza autenticação API-token. Crie uma ligação introduzindo um token válido de Sproof Sign API associado à sua conta. Mantém o token seguro e substitui-o se for revogado ou regenerado.

Ações suportadas

Cria um pedido de assinatura — Cria um pedido para um documento ou um envelope contendo vários documentos. Os destinatários, funções de assinatura, ordem de assinatura, posições de assinatura e outras definições de convite podem ser configurados.
Criar pedido de assinatura usando marcadores de posição — Cria um pedido usando reservas armazenadas num documento carregado. A informação dos destinatários e as posições de assinatura são extraídas desses marcadores de posição.
Obter o estado do pedido — Recupera o estado atual e o estado de assinatura de um pedido de assinatura usando o seu ID de membro.
Obter documento — Descarrega um documento como PDF binário ou como PDF codificado em Base64.
Eliminar documento — Apaga um documento ou remove o acesso de um membro, dependendo do ID de membro fornecido, do papel do membro e se o documento pertence a um envelope.

Limitações e requisitos conhecidos

Os documentos de entrada devem ser fornecidos como conteúdo PDF ou DOCX codificado em Base64.
Um envelope pode conter no máximo 25 documentos.
É necessário um nome de envelope quando mais do que um documento é submetido.
Pedidos baseados em marcadores de posição requerem marcadores de posição corretamente formatados no documento carregado.
Para pedidos baseados em marcadores de lugar, os destinatários e as posições de assinatura são obtidos a partir do documento em vez de serem introduzidos manualmente.
As ações disponíveis, tipos de assinatura e fornecedores dependem da conta e do plano sproof Sign conectados.
O comportamento de eliminação de documentos depende se o ID de membro fornecido pertence ao remetente ou ao destinatário e se o documento faz parte de um envelope.

Suporte

Para suporte a conectores ou APIs, contacte support@sproof.com.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
token	securestring	"token" für diese API	Verdade

Ações

Criar pedido de assinatura usando marcadores de posição	Cria um pedido de assinatura usando marcadores de posição armazenados no documento carregado. Os destinatários e as posições de assinatura são extraídos do documento.
Eliminar documento	Elimina um documento ou remove o acesso de um membro a ele, dependendo se o documento `memberId` fornecido pertence ao remetente ou ao destinatário, e se o documento faz parte de um envelope. Documentos num envelope O parâmetro `all` de consulta não tem efeito para documentos num envelope. Com o remetente `memberId`: Um único documento é eliminado para o remetente e para todos os destinatários. O documento é retirado do envelope. Com o destinatário `memberId`: Todos os documentos do envelope são removidos para o destinatário. O destinatário está marcado como `declined` em todos os documentos que foram eliminados para o destinatário. Os documentos permanecem disponíveis para todos os restantes membros do documento. Documentos individuais Com o remetente `memberId` e `all=true`: O documento é eliminado para o remetente e para todos os destinatários. Com o remetente `memberId` e `all=false`: O documento é eliminado apenas para o remetente. O documento permanece disponível para os outros destinatários do documento. Com o destinatário `memberId`: O destinatário está marcado como `declined` no documento. O documento permanece disponível para todos os restantes membros do documento.
Obter documento	Obtenha um documento assinado como binário ou uma cadeia codificada em Base64.
Obter o estado do pedido	Obtenha o estado de um pedido de assinatura. Devolve um documento objeto JSON ou um erro. O parâmetro é devolvido pelo pedido de publicação no documento e está associado ao email do remetente.
Pedido de criação de assinatura	Este é o novo pedido de criação de assinatura. Para além de criar um único convite para um documento, agora suporta a criação de envelopes e o carregamento de vários documentos simultaneamente ao enviar convites.

Criar pedido de assinatura usando marcadores de posição

ID da Operação:: CreateSignatureRequestUsingPlaceholders

Cria um pedido de assinatura usando marcadores de posição armazenados no documento carregado. Os destinatários e as posições de assinatura são extraídos do documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
e-mail	email	True	string	Email do remetente. Deve pertencer a um membro do seu plano.
firstName	firstName	True	string	Primeiro nome do remetente.
lastName	lastName		string	Apelido do remetente.
função	role		string	O papel do remetente em todos os documentos.
e-mail	email		string	Email do destinatário.
firstName	firstName		string	Nome próprio do destinatário.
lastName	lastName		string	Apelido do destinatário.
doNotSendEmails	doNotSendEmails		boolean	Se estiver definido para `true` que não seja enviado nenhum email ao destinatário.
customId	customId		string	A ser usado apenas quando o endereço de email do destinatário for desconhecido no momento do convite. Isto só funciona quando convidas os destinatários (não para as rotas de preparação) e queres usar o fastlane. Permite-lhe `customId` pré-gerar um link de assinatura único para um destinatário antes de enviar um convite. Deve ser uma cadeia alfanumérica única com pelo menos 70 caracteres. Nota: O customId só pode ser usado para construir o link destinatário para um documento. Não pode ser usado para outros pedidos em vez do memberId. Para detalhes sobre a construção de URLs, veja Abrir um documento com um ID Personalizado
useFastlane	useFastlane		boolean	Se definido como `true` definido, o signatário recebe um link Fastlane no email de convite.
phoneNumber	phoneNumber		string	O número de telefone deste destinatário. Isto é usado para verificação por SMS. (ex: +43 699 1234 1234).
privateMessage	privateMessage		string	Uma mensagem privada para este destinatário específico.
inPersonMode	inPersonMode		boolean	Quando esta opção está ativada, o destinatário do pedido de assinatura terá de assinar o documento pessoalmente e não será enviado nenhum email. Este modo só está disponível usando o tipo de assinatura SES
Tipos de assinatura	signatureTypes		array of string	Os tipos de assinaturas permitidas para este destinatário. Opções: ['avançado', 'avançadoPlus', 'qualificado', 'PlusIdent' qualificado, 'simples']
etiqueta	tag		string	Esta etiqueta determina o fornecedor de identidade que será utilizado no processo de assinatura. Escolha entre um conjunto pré-definido de fornecedores suportados. Nota1: Alguns fornecedores só estão disponíveis para certos TypeSignature, por exemplo `onetimeqes` , exigirão `"signatureType" : ["qualifiedPlusIdent"]` Nota2: Ao usar `sproof-qualified` como fornecedor predefinido, o destinatário tem de ter uma conta sproof ativa com uma licença User+ ativa.
canChange	canChange		boolean	Booleano para indicar se o destinatário convidado deve conseguir alterar o fornecedor de assinatura
country	country		string	O país predefinido, se estiver em branco está definido para todos, será devolto um erro com os países disponíveis para a etiqueta de fornecedor escolhida
data de vencimento	dueDate		YYYY-MM-DD	A data até à qual o documento pode ser assinado. Esta data de vencimento é apresentada ao destinatário no email de convite e também é visível na secção de detalhes do documento no painel de controlo. Serve como prazo para concluir o processo de assinatura.
reminderIntervalo	reminderInterval		number	Especifica o número de dias entre os emails de lembrete.
começarEnviarLembretes	startSendingReminders		YYYY-MM-DD HH:MM	Data a partir da qual os lembretes devem ser enviados
convideLanguage	inviteLanguage		string	Especifica a linguagem dos emails enviados a utilizadores anónimos que não têm conta. Para utilizadores com conta, será utilizado o idioma que selecionaram no seu perfil.
mensagem	message		string	Uma mensagem personalizada enviada aos destinatários dentro do email.
subject	subject		string	A linha de assunto do email enviada aos destinatários.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Se definido como verdadeiro, o pdf é enviado como anexo a todos os destinatários no documento (se for inferior a 5MB).
ModoAssinaturado Focado	focusedSigningMode		boolean	Quando esta opção está ativada, o destinatário do pedido de assinatura estará limitado a assinar ou recusar o documento, e não poderá sair da página.
allowEncaminhamento	allowForwarding		boolean	Permitir o encaminhamento do convite.
collabSigningMode	collabSigningMode		object	Um objeto onde cada chave representa uma ronda de assinatura, e o seu valor correspondente indica se a assinatura colaborativa está ativada nessa ronda. Se o valor for verdadeiro, é necessária apenas uma assinatura para completar a ronda de assinaturas especificada e avançar para a ronda seguinte. Por exemplo, { '1': verdadeiro } significa que na ronda de assinatura '1', é necessária apenas uma assinatura.
inPersonSigning	inPersonSigning		boolean	Quando é verdade, o destinatário recebe um popup onde precisa de desenhar manualmente uma assinatura
folderName	folderName		string	Se for dado, será criado um envelope contendo todos os documentos do documentDataArray. (Obrigatório se forem enviados mais do que um documento)
callbackUrl	callbackUrl		string	Um pedido POST, incluindo o documento, será enviado para esta URL quando uma nova assinatura for criada ou quando um destinatário recusar o documento. Em caso de falha, existe um mecanismo de retentativa para garantir que o pedido é retentado.
returnUrl	returnUrl		string	O link do botão de devolução após assinar um documento
returnBtnText	returnBtnText		string	O texto do botão de devolução após assinar um documento
dados	data	True	string	Os dados do documento (PDF ou DOCX) estão em formato base64.
mimetype	mimetype		string	Tipo MIME de dados codificados em base64 PDF ou DOCX, exigido se o documento não for um pdf
nomeDoFicheiro	fileName	True	string	Nome do ficheiro
etiqueta	label		string	Uma etiqueta personalizada que pode ser enviada para organizar documentos.
página	page	True	integer	Número da página onde a caixa está, sendo a primeira página 0.
Largura da página	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. Numa página A4, temos 478 como valor padrão.
Página Altura	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. Numa página A4, temos 676 como valor padrão.
x	x	True	float	Representa a posição horizontal da caixa como percentagem da largura da página. A origem (0,0) está no canto superior esquerdo da página. Um valor de 0,1 significa que a caixa está posicionada a 10% da largura da página a partir da esquerda.
y	y	True	float	Representa a posição vertical da caixa como percentagem da altura da página. A origem (0,0) está no canto superior esquerdo da página. Um valor de 0,1 significa que a caixa está posicionada a 10% da altura da página em relação ao topo.
width	width	True	float	Largura da caixa baseada nas dimensões da página, semelhante às coordenadas x e y. É um float que representa uma percentagem da largura da página.
altura	height	True	float	Altura da caixa baseada nas dimensões da página, semelhante às coordenadas x e y. É um float que representa uma percentagem da páginaAltura.
id	id	True	string	Um ID único para esta caixa, gerado da forma que desejar.
etiqueta	label		string	Texto provisório, como o nome do campo, por exemplo, "Data de Nascimento.".
valor	value		string	Valor padrão para a caixa. Pode ser null. Se a caixa for do tipo 'chooseBox', o valor pode ser nulo ou uma das cadeias definidas nas opções.
só de leitura	readonly		boolean	Se definido como verdadeiro, a pessoa convidada não pode modificar o valor desta caixa.
required	required		boolean	Se definido como verdadeiro, a pessoa convidada não pode assinar o documento sem preencher esta caixa.
tipo	type	True	string
multilinha	multiline		boolean	Se são permitidas múltiplas linhas.
displayValue	displayValue	True	string
exportValor	exportValue	True	string
agrupar	group		number	Cada caixa de rádio pode ser atribuída a um grupo.
Tipos de assinatura	signatureTypes		array of string	Os tipos de assinaturas permitidos para este destinatário podem ser sobrescritos pelos tipos de assinatura do destinatário. Opções: ['avançado', 'avançadoPlus', 'qualificado', 'simples', 'PlusIdent qualificado']
refId	refId		string	O refId é um campo opcional usado para cruzar o documento carregado. Se for, permite-lhe atribuir um identificador de referência personalizado ao documento, que será devolvido como parte do objeto documento em futuras respostas da API. Isto pode ser útil para acompanhar ou organizar documentos através de um sistema ou fluxo de trabalho externo.
linguagem	language		string	A linguagem do documento.
folderId	folderId		string	O ID de uma pasta onde os documentos devem ser inseridos. Isto só é possível quando tanto o inviteData como o folderName não estão definidos.
isAttachment	isAttachment		boolean	neste caso, o apego não é necessário.
useFastlane	useFastlane		boolean	Se definido como `true` definido, o signatário recebe um link Fastlane no email de convite.
fastlaneProfileId	fastlaneProfileId		uuid	Especifique o perfil Fastlane que deve ser usado com este documento. (useFastlane tem de ser definido como verdadeiro).

Devoluções

Body: EnvelopeResponse

Eliminar documento

ID da Operação:: DeleteDocument

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

Documentos num envelope

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

Com o remetente memberId:

Um único documento é eliminado para o remetente e para todos os destinatários.
O documento é retirado do envelope.

Com o destinatário memberId:

Todos os documentos do envelope são removidos para o destinatário.
O destinatário está marcado como declined em todos os documentos que foram eliminados para o destinatário.
Os documentos permanecem disponíveis para todos os restantes membros do documento.

Documentos individuais

Com o remetente memberId e all=true:

O documento é eliminado para o remetente e para todos os destinatários.

Com o remetente memberId e all=false:

O documento é eliminado apenas para o remetente.
O documento permanece disponível para os outros destinatários do documento.

Com o destinatário memberId:

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

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de Membro	memberId	True	string	ID de Membro
Eliminar para todos os destinatários	all		boolean	Só relevante para documentos individuais quando o fornecido `memberId` pertence ao remetente. Se definido para `true`, o documento é eliminado para o remetente e para todos os destinatários. Se definido para `false`, o documento é eliminado apenas para o remetente e permanece disponível para os outros destinatários. Este parâmetro não tem efeito para documentos num envelope (padrão = `true`) ou quando o fornecido `memberId` pertence a um destinatário.

Devoluções

response: DeleteDocumentResponse

Obter documento

ID da Operação:: GetDocument

Obtenha um documento assinado como binário ou uma cadeia codificada em Base64.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de Membro	memberId	True	string	ID de Membro
Formato de download	format		string	Especifica o formato da resposta. Use `pdf` para PDF binário e `base64` para uma resposta codificada em Base64. Exemplo `base64` de resposta: `json { "base64": "JVBERi0xLjQKJe..." }`

Devoluções

Name	Caminho	Tipo	Descrição
base64	base64	string	Conteúdo PDF codificado em Base64

Obter o estado do pedido

ID da Operação:: GetSignatureStatus

Obtenha o estado de um pedido de assinatura. Devolve um documento objeto JSON ou um erro. O parâmetro é devolvido pelo pedido de publicação no documento e está associado ao email do remetente.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de Membro	memberId	True	string	ID de Membro

Devoluções

Body: DocumentStatusForFlow

Pedido de criação de assinatura

ID da Operação:: CreateSignatureRequest

Este é o novo pedido de criação de assinatura. Para além de criar um único convite para um documento, agora suporta a criação de envelopes e o carregamento de vários documentos simultaneamente ao enviar convites.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
e-mail	email	True	string	Email do remetente. Deve pertencer a um membro do seu plano.
firstName	firstName	True	string	Primeiro nome do remetente.
lastName	lastName		string	Apelido do remetente.
função	role		string	O papel do remetente em todos os documentos.
e-mail	email		string	Email do destinatário.
firstName	firstName		string	Nome próprio do destinatário.
lastName	lastName		string	Apelido do destinatário.
doNotSendEmails	doNotSendEmails		boolean	Se estiver definido para `true` que não seja enviado nenhum email ao destinatário.
customId	customId		string	A ser usado apenas quando o endereço de email do destinatário for desconhecido no momento do convite. Isto só funciona quando convidas os destinatários (não para as rotas de preparação) e queres usar o fastlane. Permite-lhe `customId` pré-gerar um link de assinatura único para um destinatário antes de enviar um convite. Deve ser uma cadeia alfanumérica única com pelo menos 70 caracteres. Nota: O customId só pode ser usado para construir o link destinatário para um documento. Não pode ser usado para outros pedidos em vez do memberId. Para detalhes sobre a construção de URLs, veja Abrir um documento com um ID Personalizado
useFastlane	useFastlane		boolean	Se definido como `true` definido, o signatário recebe um link Fastlane no email de convite.
phoneNumber	phoneNumber		string	O número de telefone deste destinatário. Isto é usado para verificação por SMS. (ex: +43 699 1234 1234).
privateMessage	privateMessage		string	Uma mensagem privada para este destinatário específico.
inPersonMode	inPersonMode		boolean	Quando esta opção está ativada, o destinatário do pedido de assinatura terá de assinar o documento pessoalmente e não será enviado nenhum email. Este modo só está disponível usando o tipo de assinatura SES
Tipos de assinatura	signatureTypes		array of string	Os tipos de assinaturas permitidas para este destinatário. Opções: ['avançado', 'avançadoPlus', 'qualificado', 'PlusIdent' qualificado, 'simples']
etiqueta	tag		string	Esta etiqueta determina o fornecedor de identidade que será utilizado no processo de assinatura. Escolha entre um conjunto pré-definido de fornecedores suportados. Nota1: Alguns fornecedores só estão disponíveis para certos TypeSignature, por exemplo `onetimeqes` , exigirão `"signatureType" : ["qualifiedPlusIdent"]` Nota2: Ao usar `sproof-qualified` como fornecedor predefinido, o destinatário tem de ter uma conta sproof ativa com uma licença User+ ativa.
canChange	canChange		boolean	Booleano para indicar se o destinatário convidado deve conseguir alterar o fornecedor de assinatura
country	country		string	O país predefinido, se estiver em branco está definido para todos, será devolto um erro com os países disponíveis para a etiqueta de fornecedor escolhida
data de vencimento	dueDate		YYYY-MM-DD	A data até à qual o documento pode ser assinado. Esta data de vencimento é apresentada ao destinatário no email de convite e também é visível na secção de detalhes do documento no painel de controlo. Serve como prazo para concluir o processo de assinatura.
reminderIntervalo	reminderInterval		number	Especifica o número de dias entre os emails de lembrete.
começarEnviarLembretes	startSendingReminders		YYYY-MM-DD HH:MM	Data a partir da qual os lembretes devem ser enviados
convideLanguage	inviteLanguage		string	Especifica a linguagem dos emails enviados a utilizadores anónimos que não têm conta. Para utilizadores com conta, será utilizado o idioma que selecionaram no seu perfil.
mensagem	message		string	Uma mensagem personalizada enviada aos destinatários dentro do email.
subject	subject		string	A linha de assunto do email enviada aos destinatários.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Se definido como verdadeiro, o pdf é enviado como anexo a todos os destinatários no documento (se for inferior a 5MB).
ModoAssinaturado Focado	focusedSigningMode		boolean	Quando esta opção está ativada, o destinatário do pedido de assinatura estará limitado a assinar ou recusar o documento, e não poderá sair da página.
allowEncaminhamento	allowForwarding		boolean	Permitir o encaminhamento do convite.
collabSigningMode	collabSigningMode		object	Um objeto onde cada chave representa uma ronda de assinatura, e o seu valor correspondente indica se a assinatura colaborativa está ativada nessa ronda. Se o valor for verdadeiro, é necessária apenas uma assinatura para completar a ronda de assinaturas especificada e avançar para a ronda seguinte. Por exemplo, { '1': verdadeiro } significa que na ronda de assinatura '1', é necessária apenas uma assinatura.
usePlaceholders	usePlaceholders		boolean	Se for verdade, os marcadores de lugar/formulários de texto armazenados no documento serão usados para convidar destinatários.
inPersonSigning	inPersonSigning		boolean	Quando é verdade, o destinatário recebe um popup onde precisa de desenhar manualmente uma assinatura
folderName	folderName		string	Se for dado, será criado um envelope contendo todos os documentos do documentDataArray. (Obrigatório se forem enviados mais do que um documento)
callbackUrl	callbackUrl		string	Um pedido POST, incluindo o documento, será enviado para esta URL quando uma nova assinatura for criada ou quando um destinatário recusar o documento. Em caso de falha, existe um mecanismo de retentativa para garantir que o pedido é retentado.
returnUrl	returnUrl		string	O link do botão de devolução após assinar um documento
returnBtnText	returnBtnText		string	O texto do botão de devolução após assinar um documento
dados	data	True	string	Os dados do documento (PDF ou DOCX) estão em formato base64.
mimetype	mimetype		string	Tipo MIME de dados codificados em base64 PDF ou DOCX, exigido se o documento não for um pdf
nomeDoFicheiro	fileName	True	string	Nome do ficheiro
etiqueta	label		string	Uma etiqueta personalizada que pode ser enviada para organizar documentos.
página	page	True	integer	Número da página onde a caixa está, sendo a primeira página 0.
Largura da página	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. Numa página A4, temos 478 como valor padrão.
Página Altura	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. Numa página A4, temos 676 como valor padrão.
x	x	True	float	Representa a posição horizontal da caixa como percentagem da largura da página. A origem (0,0) está no canto superior esquerdo da página. Um valor de 0,1 significa que a caixa está posicionada a 10% da largura da página a partir da esquerda.
y	y	True	float	Representa a posição vertical da caixa como percentagem da altura da página. A origem (0,0) está no canto superior esquerdo da página. Um valor de 0,1 significa que a caixa está posicionada a 10% da altura da página em relação ao topo.
width	width	True	float	Largura da caixa baseada nas dimensões da página, semelhante às coordenadas x e y. É um float que representa uma percentagem da largura da página.
altura	height	True	float	Altura da caixa baseada nas dimensões da página, semelhante às coordenadas x e y. É um float que representa uma percentagem da páginaAltura.
id	id	True	string	Um ID único para esta caixa, gerado da forma que desejar.
etiqueta	label		string	Texto provisório, como o nome do campo, por exemplo, "Data de Nascimento.".
valor	value		string	Valor padrão para a caixa. Pode ser null. Se a caixa for do tipo 'chooseBox', o valor pode ser nulo ou uma das cadeias definidas nas opções.
só de leitura	readonly		boolean	Se definido como verdadeiro, a pessoa convidada não pode modificar o valor desta caixa.
required	required		boolean	Se definido como verdadeiro, a pessoa convidada não pode assinar o documento sem preencher esta caixa.
tipo	type	True	string
multilinha	multiline		boolean	Se são permitidas múltiplas linhas.
displayValue	displayValue	True	string
exportValor	exportValue	True	string
agrupar	group		number	Cada caixa de rádio pode ser atribuída a um grupo.
Tipos de assinatura	signatureTypes		array of string	Os tipos de assinaturas permitidos para este destinatário podem ser sobrescritos pelos tipos de assinatura do destinatário. Opções: ['avançado', 'avançadoPlus', 'qualificado', 'simples', 'PlusIdent qualificado']
refId	refId		string	O refId é um campo opcional usado para cruzar o documento carregado. Se for, permite-lhe atribuir um identificador de referência personalizado ao documento, que será devolvido como parte do objeto documento em futuras respostas da API. Isto pode ser útil para acompanhar ou organizar documentos através de um sistema ou fluxo de trabalho externo.
linguagem	language		string	A linguagem do documento.
folderId	folderId		string	O ID de uma pasta onde os documentos devem ser inseridos. Isto só é possível quando tanto o inviteData como o folderName não estão definidos.
isAttachment	isAttachment		boolean	neste caso, o apego não é necessário.
Detalhes do destinatário	recipientDetails	True	object	Detalhes do destinatário indicados 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` definido, o signatário recebe um link Fastlane no email de convite.
fastlaneProfileId	fastlaneProfileId		uuid	Especifique o perfil Fastlane que deve ser usado com este documento. (useFastlane tem de ser definido como verdadeiro).

Devoluções

Body: EnvelopeResponse

Definições

DeleteDocumentResponse

Apagar Resposta ao Documento: string

EnvelopeResponse

Name	Caminho	Tipo	Descrição
folderId	folderId	string
folderName	folderName	string
Documentação	documents	array of object
id	documents.id	string
Nome	documents.name	string
linguagem	documents.language	string
começarEnviarLembretes	documents.startSendingReminders	date-time	Data e hora em que os lembretes começam a ser enviados (cadeia de data e hora ISO 8601)
enviarLembrete	documents.sendReminder	boolean
lembreteEnviado	documents.reminderSent	boolean
reminderIntervalo	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	Data e hora em que o documento foi criado (cadeia de datas ISO 8601)
callbackUrl	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
Ronda de assinaturas	documents.signingRound	number
isTemplate	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
linkExpiresAt	documents.linkExpiresAt	string
derivedFromLink	documents.derivedFromLink	boolean
state	documents.state	string
complianceLevel	documents.complianceLevel	string
allowEncaminhamento	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
data de vencimento	documents.dueDate	date-time	Data de vencimento do documento (cadeia de data-hora ISO 8601)
ModoAssinaturado Focado	documents.focusedSigningMode	boolean
linkMaxAssinaturasAtivado	documents.linkMaxSignaturesEnabled	boolean
linkMaxAssinaturas	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
sendOutFinishedPdf	documents.sendOutFinishedPdf	boolean
Tipos de assinatura	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. Isto só é devolvido se o documento tiver campos de formulário. Se o documento for assinado, devolverá caixas com os valores preenchidos.
em atraso	documents.overdue	boolean

DocumentResponseBox

Name	Caminho	Tipo	Descrição
id	id	string
tipo	type	string
valor	value	string	O valor do campo da caixa. Pode ser uma cadeia (incluindo cadeia vazia), booleana ou nula, dependendo do tipo de caixa.
etiqueta	label	string

MemberResponseSchema

Name	Caminho	Tipo	Descrição
id	id	string
documentId	documentId	string
e-mail	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 data e hora ISO 8601)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Data e hora em que a notificação de eliminação foi enviada (cadeia de data-hora ISO 8601)
manualmenteÚltimoEmailEnviado	manuallyLastEmailSent	date-time	Data e hora em que o último email manual foi enviado (cadeia de data e hora ISO 8601)
assinaturaPosição	signaturePosition	MemberSignaturePositionResponse	Dados de posição de assinatura com campos adicionais específicos de resposta. Os campos cardStyle, pageWidth e pageHeight são opcionais e podem não estar presentes em todas as respostas da API.
doNotSendEmails	doNotSendEmails	boolean
recusadoAt	declinedAt	date-time	Data e hora em que o membro recusou (cadeia de data e hora ISO 8601)
Ordem de assinatura	signingOrder	number
onDemand	onDemand	string
recipientId	recipientId	string
Tipos de assinatura	signatureTypes	array of string
assinaturaTiposAtivo	signatureTypesActive	boolean
privateMessage	privateMessage	string
customId	customId	string
useFastlane	useFastlane	boolean
função	role	string
aprovadoAt	approvedAt	date-time	Data e hora em que o membro foi aprovado (cadeia de data-hora ISO 8601)
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
Assinaturas	signatures	array of string
assinadoEm	signedAt	date-time	Data e hora em que o membro assinou (cadeia de data-hora ISO 8601)

MembroAssinaturaPosiçãoResposta

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

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

AssinaturaPosiçãoResposta

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

Name	Caminho	Tipo	Descrição
página	page	integer	Número de página, começando por 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.
altura	height	number	Altura da assinatura.
cardStyle	cardStyle	string	O estilo visual do cartão de assinatura. Este campo é opcional e não pode ser devolvido em todas as respostas.
Largura da página	pageWidth	number	A largura da página em píxeis. Este campo é opcional e não pode ser devolvido em todas as respostas.
Página Altura	pageHeight	number	A altura da página em pixels. Este campo é opcional e não pode ser devolvido em todas as respostas.

DocumentStatusForFlow

Name	Caminho	Tipo	Descrição
id	id	string
Nome	name	string
state	state	string	O estado atual do documento. Os valores possíveis são: rascunho, pendente, recusado, concluído, anexo, manualmentePendente, manualmenteConcluído
createdAt	createdAt	date
atualizado em	updatedAt	date
todosAssinadosAssinados	allSignersSigned	boolean
todosMembrosAssinados	allMembersSigned	boolean
ModoAssinaturado Focado	focusedSigningMode	boolean