Partilhar via


SignNow EU (Pré-visualização)

O SignNow permite fluxos de trabalho de assinatura eletrônica seguros, compatíveis e prontos para auditoria para empresas, equipes jurídicas, de RH, de saúde e financeiras. Envie e acompanhe solicitações de assinatura em ordem baseada em função, preencha campos de documento previamente preenchendo e gerencie grupos de documentos usando o conector SignNow.

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

Serviço 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)
Aplicações Power Premium Todas as regiões do 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)
Automatize o poder 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)
Contato
Nome Centro de Ajuda
URL https://support.signnow.com/
Email integrations@pdffiller.com
Metadados do conector
Editora DaDaDocs
Sítio Web https://signnow.com
Política de privacidade https://www.signnow.com/privacy_policy
Categorias Produtividade; Recursos Humanos

SignNow Conector UE

O SignNow permite fluxos de trabalho de assinatura eletrônica seguros, compatíveis e prontos para auditoria para empresas, equipes jurídicas, de RH, de saúde e financeiras. Envie e acompanhe solicitações de assinatura em ordem baseada em função, preencha campos de documento previamente preenchendo e gerencie grupos de documentos usando o conector SignNow.

Pre-requisites

Você precisará de uma conta SignNow EU (escolha EU Server na tela de login) e uma assinatura da API SignNow para continuar.

Implantando o exemplo

Primeiro, atualize o valor clientId no apiProperties.json com o seu próprio.

Execute os seguintes comandos e siga os prompts:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Ações e gatilhos suportados

Consulte a documentação para obter mais detalhes.

Limites de Limitação

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

Ações

Cancelar convite

Cancelamento de convite de assinatura

Carregar documento

Carregar um documento para o SignNow

Convidar para assinar documento

Esta ação cria e envia um convite de campo para que um documento seja assinado

Convidar para assinar o grupo de documentos

Esta ação cria um convite para assinar um grupo de documentos. Você pode configurar um fluxo de trabalho de várias etapas, onde diferentes destinatários atuam no grupo de documentos em diferentes estágios

Criar convite incorporado de documento

Esta ação cria um convite de assinatura incorporado para um documento. Depois que o convite for criado, gere um link de assinatura incorporado

Criar Convite Incorporado de Grupo de Documentos

Esta ação cria um convite de assinatura incorporado para um grupo de documentos. Depois que o convite for criado, gere um link de assinatura incorporado

Criar documento a partir do modelo

Gerar um documento a partir de um modelo selecionado

Criar grupo de documentos a partir de vários arquivos

Criar um grupo de documentos carregando vários arquivos como cadeias de caracteres codificadas em base64

Criar Grupo de Documentos a partir do Modelo de Grupo

Criar o grupo de documentos a partir de um modelo de grupo selecionado

Criar link de assinatura

Gere um link para o documento e compartilhe-o para que o documento seja assinado

Criar link de envio incorporado de documento

Esta ação gera um link de envio incorporado para um documento específico, permitindo que usuários terceirizados preparem e enviem o documento para assinatura

Criar Link de Envio Incorporado do Grupo de Documentos

Essa ação gera um link de envio incorporado para um grupo de documentos específico, permitindo que usuários de terceiros preparem e enviem o grupo de documentos para assinatura

Descarregar documento

Baixe um documento do SignNow

Excluir convite incorporado de documento

Esta ação exclui um convite incorporado para um documento

Excluir convite incorporado do grupo de documentos

Esta ação exclui um convite incorporado para um grupo de documentos específico

Excluir documento

Excluir um documento do SignNow

Gerar link de convite incorporado de documento

Esta ação gera um link para o convite incorporado do documento

Gerar Link de Convite Incorporado do Grupo de Documentos

Esta ação gera um link para o convite incorporado do grupo de documentos

Obter campos do documento (visualização)

Recuperar valores dos campos preenchíveis no documento

Obter campos do documento [DEPRECATED]

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

Obter valores de campo de documento.

Obter esquema de documento [DEPRECATED]

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

Obter esquema de documento OpenAPI

Obter Grupo de Documentos

Recuperar uma lista de grupos de documentos do usuário

Obter grupos de documentos

Recuperar uma lista de grupos de documentos do usuário

Obter informações do documento

Obtenha propriedades do documento como nome, id, datas de criação/atualização, etc.

Obter lista de documentos

Recuperar uma lista de documentos do usuário

Obter status de convite de documento

Esta ação recupera informações sobre um convite de documento, incluindo o status de cada etapa e ação

Obter Status de Convite de Grupo de Documentos

Esta ação recupera informações sobre um convite de grupo de documentos, incluindo o status de cada etapa e ação

Preterido - Convidar para assinar

A ação foi preterida. Convidar outras pessoas para preencher e assinar o documento

Preterido - Convidar para assinar o Grupo de Documentos

A ação foi preterida. Convidar outras pessoas para preencher e assinar o grupo de documentos

Preterido - Convite de documento avançado

A ação foi preterida. Solicitação de convite com esquema definido manualmente. Ele permite configurar o convite para um documento que será gerado no futuro

Pré-preencher valores de campo do documento (visualização)

Preencher automaticamente campos preenchíveis no documento com valores específicos

Pré-preencher valores de campo do grupo de documentos

Preencher automaticamente campos preenchíveis nos documentos com valores específicos

Pré-preenchimento de valores de campo do documento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Valores de Campo de Documento de Pré-preenchimento .

Valores e propriedades do campo de pré-preenchimento.

Pré-preenchimento de valores de campo inteligente

Pré-preencher valores de Campo Inteligente para o documento especificado

Pré-preenchimento de Valores de Campo Inteligente do Grupo de Documentos

Preencher automaticamente campos inteligentes nos documentos com valores específicos

Substituir destinatários no convite de documento

Essa ação substitui os destinatários no convite de documento com base em suas funções. Ele também permite atualizar as configurações de convite, como tipo de autenticação, dias de expiração e outros parâmetros avançados para cada função

Substituir destinatários no convite do grupo de documentos

Esta ação substitui os destinatários em um convite de grupo de documentos por sua ID de convite. Você também pode definir uma expiração de convite, lembretes, reatribuir permissões e recusar opções para cada documento

Cancelar convite

Cancelamento de convite de assinatura

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
doc_id True string

Especificar ID do documento para cancelamento de convite de assinatura

Devoluções

response
object

Carregar documento

Carregar um documento para o SignNow

Parâmetros

Name Chave Necessário Tipo Description
Ficheiro
file True file

Ficheiro a carregar

Devoluções

Name Caminho Tipo Description
ID do documento
id DocumentId

ID de documento exclusivo

Convidar para assinar documento

Esta ação cria e envia um convite de campo para que um documento seja assinado

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
id True string

ID do documento

Email
email string

Endereço de e-mail do destinatário

Grupo de e-mail
email_group string

Um grupo de usuários que deve receber o convite. Quando um dos usuários assina o documento, ele é considerado concluído. Deve ser usado com o parâmetro avançado 'grupos de e-mail'. Obrigatório se 'Email' ou 'Phone Invite' não for adicionado, mas não puder ser usado ao mesmo tempo com qualquer um destes parâmetros

Telefone Convidar
phone_invite string

Número de telefone do destinatário. Necessário para convidar via SMS

Funções
role True string

Nome da função do destinatário. por exemplo, signatário 1, signatário 2

Encomenda
order True integer

Ordem de assinatura. A ordem de assinatura define a sequência na qual os destinatários devem assinar ou preencher um documento. Uma vez que todos os destinatários em uma etapa de ordem concluam a assinatura, o documento prossegue para a próxima etapa de pedido (por exemplo, 2, 3). Vários destinatários podem compartilhar a mesma ordem de assinatura

Funções
role True string

Nome da função de destinatário, usado para mapear parâmetros avançados

Nome da assinatura de pré-preenchimento
prefill_signature_name string

Texto pré-preenchido no campo de assinatura, disponível para edição pelo signatário

Nome da assinatura predefinida necessária
required_preset_signature_name string

Texto pré-preenchido para o campo de assinatura, bloqueado para edição pelo destinatário. Não pode ser usado com 'Nome da assinatura de pré-preenchimento' ou 'Exigir nova assinatura'

Exigir nova assinatura
force_new_signature boolean

Define se o signatário pode usar uma assinatura salva. Falso – o signatário pode usar uma assinatura salva; True – o signatário deve criar uma nova assinatura

Permitir encaminhamento
reassign boolean

Define se o destinatário pode encaminhar o convite para outro endereço de email. 'true': o destinatário pode encaminhar o convite; 'false': o destinatário não pode encaminhar o convite

Permitir recusa por assinatura
decline_by_signature boolean

Define se a opção Recusar para assinar deve ser exibida nos campos de assinatura. Verdadeiro – mostrar a opção de declínio; false – ocultar a opção de recusa

Enviar lembrete em X Dias
remind_after integer

X dias após o convite, um recepient recebe um e-mail de lembrete (de 1 a 179 dias). Deve ser inferior a 'Dias até à expiração'

Enviar lembrete em X dias antes da expiração
remind_before integer

X dias antes do vencimento, um recepient recebe um e-mail de lembrete (de 1 a 179 dias). Deve ser inferior a 'Dias até à expiração'

Enviar lembrete a cada X Dias
remind_repeat integer

Um recepient recebe um e-mail de lembrete a cada x dias após o convite ser enviado (de 1 a 7 dias)

Dias até à expiração
expiration_days integer

Em X dias, o convite expira (de 3 a 180 dias)

Tipo de autenticação
authentication_type string

Tipo de autenticação usado para autenticação de destinatário durante a sessão de assinatura. Valores permitidos: 'Senha', 'Chamada telefônica' e 'Sms'

Senha de autenticação
password string

Senha definida para a autenticação do signatário. Necessário para o tipo de autenticação 'Senha'

Telefone de autenticação
phone string

Número de telefone usado para autenticar o signatário. Necessário para o tipo de autenticação 'Chamada telefónica' e 'Sms'. Exemplo: +1XXXXXXXXX

Mensagem SMS de autenticação
authentication_sms_message string

Mensagem sms personalizada enviada ao signatário, contendo o espaço reservado {password}. Usado com o tipo de autenticação 'Sms'. Sem este parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) - 'SignNow document invite unlock code: 123456'. Exemplo: Introduza a palavra-passe {password} para desbloquear o documento

Assunto
subject string

Assunto de e-mail personalizado para o destinatário

Message
message string

Mensagem de e-mail personalizada para o destinatário

Redirecionar Uri
redirect_uri string

Quando todos os campos solicitados são preenchidos e assinados, o signatário é redirecionado para este URI

Destino de redirecionamento
redirect_target string

Determina se o URI de redirecionamento deve ser aberto em uma nova guia no navegador ou na mesma guia após a sessão de assinatura. Valores possíveis: 'No novo separador' – abre o link num novo separador, 'No mesmo separador' – abre o link no mesmo separador

Recusar Uri de redirecionamento
decline_redirect_uri string

O link que é aberto após o documento ter sido recusado pelo destinatário

Fechar Uri de Redirecionamento
close_redirect_uri string

O link que é aberto quando o destinatário clica em Salvar progresso e Concluir mais tarde durante uma sessão de assinatura ou em Fechar no modo de exibição

O redirecionamento Finish foi cancelado
is_finish_redirect_canceled boolean

Especifica se a configuração de redirecionamento de conclusão é cancelada para a organização. True – o redirecionamento é cancelado; Falso – o redirecionamento permanece ativo

O redirecionamento fechado foi cancelado
is_close_redirect_canceled boolean

Especifica se a configuração de redirecionamento de progresso de salvamento é cancelada para a organização. True – o redirecionamento é cancelado; Falso – o redirecionamento permanece ativo

O redirecionamento de recusa é cancelado
is_decline_redirect_canceled boolean

Especifica se a configuração de redirecionamento de recusa é cancelada para a organização. True – o redirecionamento é cancelado; Falso – o redirecionamento permanece ativo

Linguagem
language string

Especifica o idioma da sessão de assinatura e os e-mails de notificação para o signatário. Valores possíveis: En para inglês, Es para espanhol e Fr para francês. Se não estiver definido, o idioma é determinado pelo idioma da sua conta SignNow

Email
email True string

Endereço de e-mail do visualizador

Funções
role True string

Nome da função do visualizador

Encomenda
order True integer

Inteiro: a ordem de envio, a partir de 1

Funções
role True string

Nome da função de visualizador. Usado para mapear parâmetros avançados

Assunto
subject string

Assunto de e-mail personalizado para o visualizador

Message
message string

Mensagem de e-mail personalizada para o visualizador

Email
email True string

Endereço de e-mail do aprovador

Funções
role True string

Nome da função de aprovador

Encomenda
order True integer

A ordem de receção do pedido de aprovação

Funções
role True string

Nome da função de aprovador. Usado para mapear parâmetros avançados

Dias de Validade
expiration_days integer

Número de dias antes de o convite expirar

Message
message string

Mensagem de e-mail personalizada para o aprovador

Assunto
subject string

Assunto de e-mail personalizado para o aprovador

Tipo de autenticação
authentication_type string

Tipo de autenticação usado para autenticação de destinatário durante a sessão de assinatura. Valores permitidos: 'Senha', 'Chamada telefônica' e 'Sms'

Palavra-passe
password string

Senha definida para a autenticação do signatário. Necessário para o tipo de autenticação 'Senha'

Telemóvel
phone string

Número de telefone usado para autenticar o signatário. Necessário para o tipo de autenticação 'Chamada telefónica' e 'Sms'. Exemplo: +1XXXXXXXXX

Mensagem SMS de autenticação
authentication_sms_message string

Mensagem sms personalizada enviada ao signatário, contendo o espaço reservado {password}. Usado com o tipo de autenticação 'Sms'. Sem este parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) - 'SignNow document invite unlock code: 123456'. Exemplo: Introduza a palavra-passe {password} para desbloquear o documento

Redirecionar Uri
redirect_uri string

A URL que é aberta depois que o aprovador aprova o documento

Destino de redirecionamento
redirect_target string

Determina se o URI de redirecionamento deve ser aberto em uma nova guia no navegador ou na mesma guia após a sessão de assinatura. Valores possíveis: 'No novo separador' – abre o link num novo separador, 'No mesmo separador' – abre o link no mesmo separador

De
from string

Endereço de e-mail do remetente. Apenas o e-mail associado à sua conta SignNow (e-mail de login) pode ser usado. Se deixado em branco, é definido automaticamente

ID
id string

ID de um grupo de e-mail. Um identificador exclusivo de 40 caracteres que deve ser criado previamente

Nome
name string

Um nome do grupo. Use-o no campo Grupo de e-mail dos signatários >

Email
email string

Endereço de e-mail que deve receber um convite

Email
email string

Endereço de e-mail que deve receber um convite

Nome
name string

Nome da etapa

Email
email string

Endereço de e-mail do destinatário da CC

Step
step integer

A ordem de envio, a partir de 1

Assunto
subject string

Assunto do e-mail para todos os destinatários

Message
message string

Mensagem de e-mail para todos os destinatários

Assunto CC
cc_subject string

Assunto do e-mail CC para todos os destinatários CC

Mensagem CC
cc_message string

Mensagem de e-mail CC para todos os destinatários CC

Assinatura QES
signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas QES dos signatários. Todos os signatários no convite devem usar o mesmo tipo de assinatura. Para criar um convite com o QES, o usuário deve pertencer a uma organização com o QES habilitado

Devoluções

Name Caminho Tipo Description
Situação
status string

Situação

Convidar para assinar o grupo de documentos

Esta ação cria um convite para assinar um grupo de documentos. Você pode configurar um fluxo de trabalho de várias etapas, onde diferentes destinatários atuam no grupo de documentos em diferentes estágios

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo de Documentos
id True string

ID do grupo de documentos

Encomenda
order True integer

Ordem de assinatura passo: 1 - o(s) destinatário(s) assina(m) o grupo de documentos primeiro, depois o grupo de documentos é enviado para 2,3 etc. Vários destinatários podem manter a mesma ordem de assinatura

Email
email string

Endereço de e-mail do destinatário

Grupo de e-mail
email_group string

Um grupo de contactos de destinatários

Nome do Direito de Acesso
role_name True string

Nome da função de destinatário no documento (pode ser usado para identificar campos no documento atribuído a esse destinatário específico)

Ação
action True string

Ação permitida com um documento. Valores possíveis: Ver, Assinar, Aprovar

ID do documento
document_id True string

ID do documento no qual as ações são exigidas deste destinatário

Nome da assinatura predefinida necessária
required_preset_signature_name string

Texto pré-preenchido para o campo de assinatura, bloqueado para edição pelo destinatário

Permitir encaminhamento
allow_reassign boolean

Define se o destinatário pode encaminhar o convite para outro endereço de email. 'true': o destinatário pode encaminhar o convite; 'false': o destinatário não pode encaminhar o convite

Permitir recusa por assinatura
decline_by_signature boolean

Define se a opção Recusar para assinar deve ser exibida nos campos de assinatura. Verdadeiro: mostrar a opção de recusa; Falso: ocultar a opção de recusa

Tipo de autenticação
type string

Tipo de autenticação usado para autenticação de destinatário durante a sessão de assinatura. Valores permitidos: 'Senha', 'Chamada telefônica' e 'Sms'

Palavra-passe
value string

Senha definida para a autenticação do signatário. Necessário para o tipo de autenticação 'Senha'

Telemóvel
phone string

Número de telefone usado para autenticar o signatário. Necessário para o tipo de autenticação 'Chamada telefónica' e 'Sms'. Exemplo: +1XXXXXXXXX

Message
message string

Mensagem sms personalizada enviada ao signatário, contendo o espaço reservado {password}. Usado com o tipo de autenticação 'Sms'. Sem este parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) - 'SignNow documento convidar código de desbloqueio: 123456'

MerchantId
merchant_id string

O ID da conta de comerciante adicionada à sua Organização

Moeda
currency string

A moeda de pagamento solicitada

Montante
amount string

O valor do pagamento solicitado

Uri
redirect_uri string

Quando todos os campos solicitados são preenchidos e assinados, o signatário é redirecionado para este URI

Destino de redirecionamento
redirect_target string

Determina se o URI de redirecionamento deve ser aberto em uma nova guia no navegador ou na mesma guia após a sessão de assinatura. Valores possíveis: 'No novo separador' – abre o link num novo separador, 'No mesmo separador' – abre o link no mesmo separador

Recusar Uri de redirecionamento
decline_redirect_uri string

O link que é aberto após o documento ter sido recusado pelo destinatário

Fechar Uri de Redirecionamento
close_redirect_uri string

O link que é aberto quando um signatário clica em Salvar progresso e concluir mais tarde durante uma sessão de assinatura ou Fechar no modo de exibição

O redirecionamento Finish foi cancelado
is_finish_redirect_canceled boolean

Especifica se a configuração de redirecionamento de conclusão é cancelada para a organização. True – o redirecionamento é cancelado; Falso – o redirecionamento permanece ativo

O redirecionamento fechado foi cancelado
is_close_redirect_canceled boolean

Especifica se a configuração de redirecionamento de progresso de salvamento é cancelada para a organização. True – o redirecionamento é cancelado; Falso – o redirecionamento permanece ativo

O redirecionamento de recusa é cancelado
is_decline_redirect_canceled boolean

Especifica se a configuração de redirecionamento de recusa é cancelada para a organização. True – o redirecionamento é cancelado; Falso – o redirecionamento permanece ativo

Linguagem
language string

Especifica o idioma da sessão de assinatura e os e-mails de notificação para o signatário. Valores possíveis: En para inglês, Es para espanhol e Fr para francês. Se não estiver definido, o idioma é determinado pelo idioma da sua conta SignNow

Encomenda
order True integer

Ordem de assinatura passo: 1 - o(s) destinatário(s) assina(m) o grupo de documentos primeiro, depois o grupo de documentos é enviado para 2,3 etc. Vários destinatários podem manter a mesma ordem de assinatura

Email
email True string

Endereço de e-mail do destinatário

Grupo de e-mail
email_group string

Um grupo de contactos de destinatários

Assunto
subject string

Assunto de e-mail personalizado para o destinatário

Message
message string

Mensagem de e-mail personalizada para o destinatário

Dias até à expiração
expiration_days integer

Em x dias, o convite expira (de 3 a 180 dias)

Enviar lembrete em X Dias
remind_after integer

X dias após o convite, um recepient recebe um e-mail de lembrete (de 1 a 179 dias). Deve ser inferior a Dias de Expiração

Enviar lembrete em X dias antes da expiração
remind_before integer

X dias antes do vencimento, um recepient recebe um e-mail de lembrete (de 1 a 179 dias). Deve ser inferior a Dias de Expiração

Enviar lembrete a cada X Dias
remind_repeat integer

Um recepient recebe um e-mail de lembrete a cada x dias após o convite ser enviado (de 1 a 7 dias)

Id
id string

ID de um grupo de e-mail. Um identificador exclusivo de 40 caracteres que deve ser criado previamente

Nome
name string

Um nome do grupo. Use-o no 'Grupo de e-mail de etapas > de convite'

Email
email string

Endereço de e-mail que deve receber um convite

Email
email string

Endereço de e-mail do destinatário que receberá o e-mail de conclusão

Desativar Anexo de Documento
disable_document_attachment boolean

Se deseja desativar o envio de anexos de documentos com o e-mail de conclusão. Valores possíveis: Falso - ativar anexo de documento, Verdadeiro - desativar anexo de documento

Assunto
subject string

Assunto personalizado para o e-mail de conclusão

Message
message string

Mensagem personalizada para o e-mail de conclusão

Assinar como mesclado
sign_as_merged boolean

Se verdadeiro, permite que o usuário da API envie um convite que é aberto como grupo de documentos mesclados em um único documento

Carimbo de data/hora do cliente
client_timestamp integer

O carimbo de data/hora do convite do grupo de documentos

Email
email string

Endereço de e-mail que deve receber um convite

Assinatura QES
signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas QES dos signatários. Todos os signatários no convite devem usar o mesmo tipo de assinatura. Para criar um convite com o QES, o usuário deve pertencer a uma organização com o QES habilitado

Devoluções

Name Caminho Tipo Description
Id
id string

ID de convite do grupo de documentos

Link de convite pendente
pending_invite_link string

Link de convite pendente

Criar convite incorporado de documento

Esta ação cria um convite de assinatura incorporado para um documento. Depois que o convite for criado, gere um link de assinatura incorporado

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
id True string

ID do documento

E-mail do signatário
email True email

Endereço de e-mail do destinatário

Funções
role True string

Nome da função do destinatário, por exemplo, 'Signatário 1' (funções de visualizador não são suportadas)

Encomenda
order True integer

A ordem de assinatura

Fórmula do nome
name_formula string

Uma fórmula para gerar um nome de documento preenchido usando um prefixo (qualquer texto) e dados de campo preenchíveis. Exemplo: «Contrato|signer_name|signed_date», em que «Contrato» é o prefixo, e «signer_name» e «signed_date» são nomes de campos preenchíveis

Funções
role True string

Nome da função do destinatário, por exemplo, 'Signatário 1' (funções de visualizador não são suportadas)

Linguagem
language string

Especifica o idioma da sessão de assinatura e os e-mails de notificação para o signatário. Valores possíveis: En para inglês, Es para espanhol e Fr para francês. Se não estiver definido, o idioma é determinado pelo idioma da sua conta SignNow

Nome Próprio
first_name string

Nome do destinatário

Apelido
last_name string

Apelido do destinatário

Nome da assinatura predefinida necessária
required_preset_signature_name string

Texto pré-preenchido para o campo de assinatura, bloqueado para edição pelo destinatário. Não pode ser usado com 'prefill_signature_name' ou 'force_new_signature'

Nome da assinatura de pré-preenchimento
prefill_signature_name string

Uma cadeia de caracteres com um nome de assinatura que aparece quando um signatário clica em um campo de assinatura. O signatário pode editar a assinatura

Exigir nova assinatura
force_new_signature boolean

Define se o signatário pode usar sua assinatura salva ou não. Se definido como 'true', o signatário tem de adicionar uma nova assinatura. Se definido como 'false', o signatário pode usar a assinatura salva

Redirecionar Uri
redirect_uri string

O link que é aberto após a conclusão da sessão de assinatura

Recusar Uri de redirecionamento
decline_redirect_uri string

O link que é aberto depois que o destinatário se recusa a assinar o documento

Fechar Uri de Redirecionamento
close_redirect_uri string

O link que é aberto quando o destinatário clica em Salvar progresso e Concluir mais tarde durante uma sessão de assinatura ou em Fechar no modo de exibição

Destino de redirecionamento
redirect_target string

Determina se o URI de redirecionamento deve ser aberto em uma nova guia no navegador ou na mesma guia após a sessão de assinatura. Valores possíveis: 'No novo separador' – abre o link num novo separador, 'No mesmo separador' – abre o link no mesmo separador

Tipo de autenticação
authentication_type string

Tipo de autenticação usado para autenticação de destinatário durante a sessão de assinatura. Valores permitidos: 'Senha', 'Chamada telefônica' e 'Sms'

Senha de autenticação
authentication_password string

Senha definida para a autenticação do signatário. Necessário para o tipo de autenticação 'Senha'

Telefone de autenticação
authentication_phone string

Número de telefone usado para autenticar o signatário. Necessário para o tipo de autenticação 'Chamada telefónica' e 'Sms'. Exemplo: +1XXXXXXXXX

Mensagem SMS de autenticação
authentication_sms_message string

Mensagem sms personalizada enviada ao signatário, contendo o espaço reservado {password}. Usado com o tipo de autenticação 'Sms'. Sem este parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) - 'SignNow document invite unlock code: 123456' Exemplo: Introduza a palavra-passe {password} para desbloquear o seu documento

Tipo de Entrega
delivery_type string

Define como o convite é enviado

Expiração do link
link_expiration integer

Em quantos minutos o convite por e-mail expira. Só pode ser usado se 'Tipo de entrega = e-mail'. Intervalo válido: 15–43200 minutos

Expiração da sessão
session_expiration integer

Em quantos minutos a sessão de assinatura expira. Se um link for gerado para esse convite, a expiração da sessão será redefinida. Aplicável apenas quando 'Tipo de entrega = e-mail' e para ações 'assinar'. Intervalo válido: 15–1440 minutos

Assinatura QES
signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas QES dos signatários. Todos os signatários no convite devem usar o mesmo tipo de assinatura. Para criar um convite com o QES, o usuário deve pertencer a uma organização com o QES habilitado

Devoluções

Name Caminho Tipo Description
dados
data array of object

Data

Id
data.id string

ID do convite incorporado criado

Email
data.email string

E-mail do destinatário

ID da função
data.role_id string

ID da função de destinatário

Encomenda
data.order integer

Ordem de assinatura do destinatário

Situação
data.status string

Status de convite incorporado

Criar Convite Incorporado de Grupo de Documentos

Esta ação cria um convite de assinatura incorporado para um grupo de documentos. Depois que o convite for criado, gere um link de assinatura incorporado

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo de Documentos
id True string

ID do grupo de documentos

Encomenda
order True integer

Etapa de ordem de assinatura. Todos os signatários atribuídos a uma etapa específica order (por exemplo, order: 1) recebem o e-mail de convite simultaneamente. Os e-mails para a próxima etapa do pedido (por exemplo, order: 2) são enviados somente depois que todas as ações na etapa anterior do pedido forem concluídas

Email
email True string

Endereço de e-mail do destinatário

ID do documento
id True string

ID do documento

Funções
role string

Função de destinatário no documento. As funções não devem ser especificadas para a ação 'exibir'

Ação
action True string

A ação exigida do destinatário no documento. Valores permitidos: 'sign', 'view'

Encomenda
order True string

Etapa de ordem de assinatura

Email
email True string

Endereço de e-mail do destinatário

Linguagem
language string

Especifica o idioma da sessão de assinatura e os e-mails de notificação para o signatário. Valores possíveis: En para inglês, Es para espanhol e Fr para francês. Se não estiver definido, o idioma é determinado pelo idioma da sua conta SignNow

Nome Próprio
first_name string

Nome do destinatário

Apelido
last_name string

Apelido do destinatário

Nome da assinatura predefinida necessária
required_preset_signature_name string

Texto pré-preenchido para o campo de assinatura, bloqueado para edição pelo destinatário

Redirecionar Uri
redirect_uri string

O link que é aberto após a conclusão da sessão de assinatura

Recusar Uri de redirecionamento
decline_redirect_uri string

O link que é aberto depois que o destinatário se recusa a assinar o documento

Fechar Uri de Redirecionamento
close_redirect_uri string

O link que é aberto quando o destinatário clica em Salvar progresso e Concluir mais tarde durante uma sessão de assinatura ou em Fechar no modo de exibição

Destino de redirecionamento
redirect_target string

Determina se o URI de redirecionamento deve ser aberto em uma nova guia no navegador ou na mesma guia após a sessão de assinatura. Valores possíveis: 'No novo separador' – abre o link num novo separador, 'No mesmo separador' – abre o link no mesmo separador

Tipo de Entrega
delivery_type string

Define como o convite é enviado

Expiração do link
link_expiration integer

Em quantos minutos o convite por e-mail expira. Só pode ser usado se 'Tipo de entrega = e-mail'. Intervalo válido: 15–43200 minutos

Expiração da sessão
session_expiration integer

Em quantos minutos a sessão de assinatura expira. Se um link for gerado para esse convite, a expiração da sessão será redefinida. Aplicável apenas quando 'Tipo de entrega = e-mail' e para ações 'assinar'. Intervalo válido: 15–1440 minutos

Tipo de autenticação
authentication_type string

Tipo de autenticação usado para autenticação de destinatário durante a sessão de assinatura. Valores permitidos: 'Senha', 'Chamada telefônica' e 'Sms'

Senha de autenticação
authentication_password string

Senha definida para a autenticação do signatário. Necessário para o tipo de autenticação 'Senha'

Telefone de autenticação
authentication_phone string

Número de telefone usado para autenticar o signatário. Necessário para o tipo de autenticação 'Chamada telefónica' e 'Sms'. Exemplo: +1XXXXXXXXX

Mensagem SMS de autenticação
authentication_sms_message string

Mensagem sms personalizada enviada ao signatário, contendo o espaço reservado {password}. Usado com o tipo de autenticação 'Sms'. Sem este parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) - 'SignNow document invite unlock code: 123456'. Exemplo: Introduza a palavra-passe {password} para desbloquear o documento

Assinatura QES
signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas QES dos signatários. Todos os signatários no convite devem usar o mesmo tipo de assinatura. Para criar um convite com o QES, o usuário deve pertencer a uma organização com o QES habilitado

Devoluções

Name Caminho Tipo Description
ID do convite
id string

ID do convite incorporado criado

Criar documento a partir do modelo

Gerar um documento a partir de um modelo selecionado

Parâmetros

Name Chave Necessário Tipo Description
Modelo de documento
doc_id True string

Selecione um modelo na lista

Nome do documento
document_name string

Insira um novo nome de arquivo para o documento

Devoluções

Name Caminho Tipo Description
ID do documento
id DocumentId

ID de documento exclusivo

Criar grupo de documentos a partir de vários arquivos

Criar um grupo de documentos carregando vários arquivos como cadeias de caracteres codificadas em base64

Parâmetros

Name Chave Necessário Tipo Description
Nome do Grupo de Documentos
group_name True string

Insira um nome para o grupo de documentos

Nome do documento
name True string

Nome do documento com extensão: Report.pdf, Letter.docx etc

Conteúdo do Ficheiro
content True string

Cadeia de caracteres codificada em Base64 que representa o conteúdo do documento

Devoluções

Criar Grupo de Documentos a partir do Modelo de Grupo

Criar o grupo de documentos a partir de um modelo de grupo selecionado

Parâmetros

Name Chave Necessário Tipo Description
Modelo de Grupo
doc_group_id True string

Selecione o modelo de grupo na lista

Nome do Grupo de Documentos
group_name string

Insira um novo nome para o grupo de documentos

Devoluções

Name Caminho Tipo Description
ID do Grupo de Documentos
id DocumentGroupId

ID do Grupo de Documentos Exclusivo

Gere um link para o documento e compartilhe-o para que o documento seja assinado

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
doc_id True string

Especifique um ID de documento exclusivo ou selecione um documento na lista

campos
fields dynamic

Devoluções

Name Caminho Tipo Description
URL
url_no_signup string

Link de assinatura

Esta ação gera um link de envio incorporado para um documento específico, permitindo que usuários terceirizados preparem e enviem o documento para assinatura

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
id True string

ID do documento

Tipo
type string

Especifica a etapa de envio na qual o link deve ser aberto. Valores possíveis: 'Convidar': abre a página Enviar convite para o documento, onde o usuário pode adicionar e-mails do signatário, assunto, mensagem, etc. 'Documento': abre o documento no editor para adicionar campos preenchíveis e, em seguida, abre a página Enviar convite

Redirecionar Uri
redirect_uri string

A página que abre após o envio incorporado foi configurada. Necessário se 'Destino de redirecionamento' for adicionado

Expiração do link
link_expiration integer

Especifica quantos minutos o link permanecerá ativo. O intervalo permitido: 15 a 45 minutos. Os utilizadores de nível administrativo podem definir a duração até um máximo de 43200 minutos

Destino de redirecionamento
redirect_target string

Determina se o URI de redirecionamento deve ser aberto em uma nova guia no navegador ou na mesma guia após a sessão de assinatura. Valores possíveis: 'No novo separador' – abre o link num novo separador, 'No mesmo separador' – abre o link no mesmo separador

Devoluções

Name Caminho Tipo Description
Endereço URL
url string

O link para o envio do documento incorporado

Essa ação gera um link de envio incorporado para um grupo de documentos específico, permitindo que usuários de terceiros preparem e enviem o grupo de documentos para assinatura

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo de Documentos
id True string

ID do grupo de documentos

Tipo
type string

Especifica a etapa de envio na qual o link incorporado deve abrir: 'gerenciar' — abre o link na página Adicionar documentos ao grupo de documentos; 'editar': abre o link no editor; 'send-invite': abre o link na página Enviar convite

Redirecionar Uri
redirect_uri string

A página que abre após o envio incorporado foi configurada. Necessário se 'Destino de redirecionamento' for adicionado

Expiração do link
link_expiration integer

Especifica quantos minutos o link permanecerá ativo. O intervalo permitido: 15 a 45 minutos. Os utilizadores de nível administrativo podem definir a duração até um máximo de 43200 minutos

Destino de redirecionamento
redirect_target string

Determina se o URI de redirecionamento deve ser aberto em uma nova guia no navegador ou na mesma guia após a sessão de assinatura. Valores possíveis: 'No novo separador' – abre o link num novo separador, 'No mesmo separador' – abre o link no mesmo separador

Devoluções

Name Caminho Tipo Description
Endereço URL
url string

O link para o envio do grupo de documentos incorporado

Descarregar documento

Baixe um documento do SignNow

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
doc_id True string

Especifique um ID de documento exclusivo ou selecione um documento na lista

Formato
mode string

Selecione um formato de documento para download

Devoluções

response
binary

Excluir convite incorporado de documento

Esta ação exclui um convite incorporado para um documento

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
id True string

ID do documento

Excluir convite incorporado do grupo de documentos

Esta ação exclui um convite incorporado para um grupo de documentos específico

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo de Documentos
id True string

ID do grupo de documentos

Excluir documento

Excluir um documento do SignNow

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
doc_id True string

Especificar um ID de documento exclusivo

Devoluções

Name Caminho Tipo Description
Situação
status string

Estado de remoção de documentos

Esta ação gera um link para o convite incorporado do documento

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
id True string

ID do documento

ID do convite de campo
field_invite_id True string

ID de convite incorporado da ação 'Criar convite incorporado ao documento'

Expiração do link
link_expiration integer

Especifica quantos minutos o link permanecerá ativo. Intervalo válido: 15-45 minutos

Expiração da sessão
session_expiration integer

Especifica quantos minutos a sessão de assinatura permanecerá ativa. Intervalo válido: 15-1440 minutos

Devoluções

Name Caminho Tipo Description
Link
data.link string

Link de convite incorporado gerado para o documento

Esta ação gera um link para o convite incorporado do grupo de documentos

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo de Documentos
id True string

ID do grupo de documentos

ID de convite incorporado do grupo de documentos
invite_id True string

ID do convite incorporado do grupo de documentos da ação 'Criar convite incorporado do grupo de documentos'

Email
email True email

Endereço de e-mail do destinatário

Expiração do link
link_expiration integer

Especifica quantos minutos o link permanecerá ativo. Intervalo válido: 15-45 minutos

Expiração da sessão
session_expiration integer

Especifica quantos minutos a sessão de assinatura permanecerá ativa. Intervalo válido: 15-1440 minutos

Devoluções

Name Caminho Tipo Description
Link de convite incorporado
link string

O link para o convite incorporado do grupo de documentos

Obter campos do documento (visualização)

Recuperar valores dos campos preenchíveis no documento

Parâmetros

Name Chave Necessário Tipo Description
Template
template_id True string

Especifique um modelo de documento para obter campos de

ID do documento
doc_id True string

Especificar um ID de documento exclusivo

Devoluções

As saídas desta operação são dinâmicas.

Obter campos do documento [DEPRECATED]

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

Obter valores de campo de documento.

Parâmetros

Name Chave Necessário Tipo Description
Template
template_id True string

Especifique um modelo de documento para obter campos de

ID do documento
doc_id True string

Especificar um ID de documento exclusivo

Devoluções

As saídas desta operação são dinâmicas.

Obter esquema de documento [DEPRECATED]

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

Obter esquema de documento OpenAPI

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
doc_id string

Especificar um ID de documento exclusivo

Filtro de tipo de campo
select string

Separe com uma vírgula os tipos de campo que você gostaria de recuperar

Devoluções

Name Caminho Tipo Description
propriedades
properties object

Obter Grupo de Documentos

Recuperar uma lista de grupos de documentos do usuário

Parâmetros

Name Chave Necessário Tipo Description
Modelo de Grupo
doc_group_id True string

Selecione o modelo de grupo na lista

Template
template True boolean

Especificar se o grupo de documentos ou o modelo de grupo deve ser recuperado

Devoluções

Obter grupos de documentos

Recuperar uma lista de grupos de documentos do usuário

Parâmetros

Name Chave Necessário Tipo Description
Template
template True boolean

Especificar se os grupos de documentos ou modelos de grupo devem ser recuperados

Limite
limit integer

Número total de artigos devolvidos (entre 1 e 50)

Compensação
offset integer

O deslocamento (baseado em zero) do primeiro item da coleção a retornar

Devoluções

Obter informações do documento

Obtenha propriedades do documento como nome, id, datas de criação/atualização, etc.

Parâmetros

Name Chave Necessário Tipo Description
Template
template True boolean

Especificar se os documentos ou modelos devem ser recuperados

ID do documento
doc_id True string

Especifique um ID de documento exclusivo ou selecione um documento na lista

Devoluções

Obter lista de documentos

Recuperar uma lista de documentos do usuário

Parâmetros

Name Chave Necessário Tipo Description
Template
template boolean

Especificar se os documentos ou modelos devem ser recuperados

Incluir modelo padrão
includeDefaultTemplate boolean

Especificar se o modelo padrão deve ser adicionado à lista de modelos

Devoluções

Obter status de convite de documento

Esta ação recupera informações sobre um convite de documento, incluindo o status de cada etapa e ação

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
id True string

ID do documento

Devoluções

Name Caminho Tipo Description
Documento recusado
is_document_declined boolean

True se o documento foi recusado pelo signatário ou aprovador, false caso contrário

steps
steps array of object

Steps

Ordem de Assinatura
steps.signing_order integer

Ordem de assinatura

E-mail do destinatário
steps.signer_email string

Endereço de e-mail do destinatário

Nome do Direito de Acesso
steps.role_name string

Nome da função do destinatário

Tipo de ação
steps.action_type string

A ação exigida do destinatário no documento. Valores possíveis: 'Sign', 'View', 'Approve' ou 'FreeFormSign'

ID do convite
steps.invite_id string

ID do convite

Situação
steps.status string

Estado de assinatura. Valores possíveis: 'criado', 'pendente', 'cumprido', 'cancelado', 'ignorado'

Recusado
steps.declined boolean

Devolve 'true' se o destinatário deste passo recusou o documento

Motivo de Recusa
steps.decline_reason string

Mensagem fornecida pelo destinatário ao recusar o documento

Criado
steps.created integer

Data em que a etapa foi criada

Updated
steps.updated integer

Data em que o status da etapa foi atualizado pela última vez

Obter Status de Convite de Grupo de Documentos

Esta ação recupera informações sobre um convite de grupo de documentos, incluindo o status de cada etapa e ação

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo de Documentos
id True string

ID do grupo de documentos

Devoluções

Name Caminho Tipo Description
ID de convite do grupo de documentos
document_group_invite_id string

ID de convite do grupo de documentos

Estado do Grupo de Documentos
status string

Status de assinatura do grupo de documentos. Valores possíveis: 'criado', 'pendente', 'cumprido', 'cancelado'

E-mail do proprietário
owner_email string

Endereço de e-mail do proprietário do grupo de documentos

Grupo de documentos recusado
is_document_declined boolean

Devolve 'true' se algum documento do grupo for recusado por um signatário ou aprovador; caso contrário, retorna 'false'

steps
steps array of object

Steps

ID do passo
steps.step_id string

ID da etapa do convite do grupo de documentos

Ordem de Assinatura
steps.signing_order integer

Ordem de assinatura

ID do documento
steps.document_id string

ID do documento

Nome do documento
steps.document_name string

Nome do documento

E-mail do signatário
steps.signer_email string

Endereço de e-mail do destinatário

Nome do Direito de Acesso
steps.role_name string

Nome da função do destinatário

Tipo de ação
steps.action_type string

A ação exigida do destinatário no documento. Valores possíveis: 'Sign', 'View', 'Approve' ou 'FreeFormSign'

ID de convite de etapa
steps.invite_id string

ID da etapa de convite

Situação
steps.status string

O status de assinatura da etapa

Recusado
steps.declined boolean

True se o destinatário nesta etapa recusou o documento

Motivo de Recusa
steps.decline_reason string

Mensagem fornecida pelo destinatário ao recusar o documento

Criado
steps.created integer

Data em que a etapa foi criada

Updated
steps.updated integer

Data em que o status da etapa foi atualizado pela última vez

Preterido - Convidar para assinar

A ação foi preterida. Convidar outras pessoas para preencher e assinar o documento

Parâmetros

Name Chave Necessário Tipo Description
Template
template True boolean

Especificar se os documentos ou modelos devem ser recuperados

Documento
template_id True string

Selecione um modelo na lista

body
body True dynamic

Devoluções

response
object

Preterido - Convidar para assinar o Grupo de Documentos

A ação foi preterida. Convidar outras pessoas para preencher e assinar o grupo de documentos

Parâmetros

Name Chave Necessário Tipo Description
Template
template True boolean

Especificar se os grupos de documentos ou modelos de grupo devem ser recuperados

Grupo de documentos
template_group_id True string

Selecione o grupo de documentos na lista

body
body True dynamic

Devoluções

response
object

Preterido - Convite de documento avançado

A ação foi preterida. Solicitação de convite com esquema definido manualmente. Ele permite configurar o convite para um documento que será gerado no futuro

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
doc_id True string

Fornecer um ID de documento

Nome
role string

Nome da função do signatário

E-mail
email email

Especificar e-mail para signatário

Número de telefone (Convidar via SMS)
phone_invite string

Especifique o número de telefone do destinatário +XXXXXXXXXXXX. Necessário para convidar via SMS.

Encomenda
order integer

Definir a ordem de assinatura para vários signatários

Assunto Personalizado
subject string

Adicionar assunto personalizado para signatário

Mensagem Personalizada
message string

Adicionar mensagem personalizada para o signatário

Tipo de autenticação
authentication_type string

Verificar a identidade do usuário por meio de senha, SMS ou chamada telefônica

Palavra-passe
password string

Definir a senha para Tipo de autenticação Senha

Telemóvel
phone string

Especifique +XXXXXXXXXXXX número de telefone para o tipo de autenticação Telefone ou SMS

Dias até à expiração
expiration_days integer

Obter signatário ser notificado em quantos dias o convite expira

Enviar lembrete em
reminder integer

O número de dias após o envio do convite para acompanhar automaticamente com um lembrete por e-mail

Enviar lembrete a cada X Dias
remind_repeat integer

O destinatário receberá um e-mail de lembrete a cada quantidade definida de dias.

Permitir encaminhamento
reassign boolean

Permitir que o signatário delegue a assinatura a outra pessoa

Mostrar Recusa na Assinatura
decline_by_signature boolean

Carimbar um campo de assinatura como Recusar a assinatura se o destinatário se recusar a assinar o documento

CC
cc string

Um e-mail separado por vírgulas que será copiado no convite

Assunto
subject string

Escreva o seu assunto

Message
message string

Escreva a sua mensagem

Envie um e-mail para todas as partes após a conclusão
on_complete string

Todas as partes recebem um e-mail de notificação quando o documento é assinado

Devoluções

response
object

Pré-preencher valores de campo do documento (visualização)

Preencher automaticamente campos preenchíveis no documento com valores específicos

Parâmetros

Name Chave Necessário Tipo Description
Template
template_id True string

Especifique um modelo de documento para obter campos de

ID do documento
doc_id True string

Especificar um ID de documento exclusivo

campos
fields dynamic

Devoluções

Name Caminho Tipo Description
ID do documento
id DocumentId

ID de documento exclusivo

Pré-preencher valores de campo do grupo de documentos

Preencher automaticamente campos preenchíveis nos documentos com valores específicos

Parâmetros

Name Chave Necessário Tipo Description
Template
template_group_id True string

Especificar um modelo de grupo de documentos para obter campos de

ID do Grupo de Documentos
doc_group_id True string

Especificar um ID de grupo de documentos exclusivo

campos
fields dynamic

Devoluções

Name Caminho Tipo Description
ID do Grupo de Documentos
id DocumentGroupId

ID do Grupo de Documentos Exclusivo

Pré-preenchimento de valores de campo do documento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Valores de Campo de Documento de Pré-preenchimento .

Valores e propriedades do campo de pré-preenchimento.

Parâmetros

Name Chave Necessário Tipo Description
Template
template_id True string

Especifique um modelo de documento para obter campos de

ID do documento
doc_id True string

Especificar um ID de documento exclusivo

campos
fields dynamic

Devoluções

Name Caminho Tipo Description
ID do documento
id DocumentId

ID de documento exclusivo

Pré-preenchimento de valores de campo inteligente

Pré-preencher valores de Campo Inteligente para o documento especificado

Parâmetros

Name Chave Necessário Tipo Description
Template
template_id True string

Especifique um modelo de documento para obter campos de

ID do documento
doc_id True string

Especificar um ID de documento exclusivo

campos
fields dynamic

Pré-preenchimento de Valores de Campo Inteligente do Grupo de Documentos

Preencher automaticamente campos inteligentes nos documentos com valores específicos

Parâmetros

Name Chave Necessário Tipo Description
Template
template_group_id True string

Especificar um modelo de grupo de documentos para obter campos de

ID do Grupo de Documentos
doc_group_id True string

Especificar um ID de grupo de documentos exclusivo

campos
fields dynamic

Devoluções

Name Caminho Tipo Description
ID do Grupo de Documentos
id DocumentGroupId

ID do Grupo de Documentos Exclusivo

Substituir destinatários no convite de documento

Essa ação substitui os destinatários no convite de documento com base em suas funções. Ele também permite atualizar as configurações de convite, como tipo de autenticação, dias de expiração e outros parâmetros avançados para cada função

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
id True string

ID do documento

Funções
role True string

Nome da função do destinatário a ser substituído

Novo e-mail
email True string

E-mail do novo destinatário

Funções
role True string

Nome da função que requer parâmetros de convite adicionais

Dias de Validade
expiration_days integer

Em quantos dias o convite expira. 30 dias max

Permitir recusa por assinatura
decline_by_signature boolean

Define se a opção Recusar para assinar deve ser exibida nos campos de assinatura. Verdadeiro: mostrar a opção de recusa; Falso: ocultar a opção de recusa

Lembrete
reminder integer

Em quantos dias enviar um lembrete para o destinatário. 30 dias max

Tipo de autenticação
authentication_type string

Tipo de autenticação usado para autenticação de destinatário durante a sessão de assinatura. Valores permitidos: 'Senha', 'Chamada telefônica' e 'Sms'

Senha de autenticação
authentication_password string

Senha definida para a autenticação do signatário. Necessário para o tipo de autenticação 'Senha'

Telefone de autenticação
authentication_phone string

Número de telefone usado para autenticar o signatário. Necessário para o tipo de autenticação 'Chamada telefónica' e 'Sms'. Exemplo: +1XXXXXXXXX

Mensagem SMS de autenticação
authentication_sms_message string

Mensagem sms personalizada enviada ao signatário, contendo o espaço reservado {password}. Usado com o tipo de autenticação 'Sms'. Sem este parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) - 'SignNow document invite unlock code: 123456'. Exemplo: Introduza a palavra-passe {password} para desbloquear o documento

Devoluções

Name Caminho Tipo Description
Substituições
replacements array of object

Detalhes dos novos destinatários

Novo ID de convite
replacements.new_invite_id string

O novo ID de convite de campo

Funções
replacements.role string

Nome da função do destinatário que foi substituído

Novo e-mail
replacements.new_email string

E-mail do novo destinatário

Substituir destinatários no convite do grupo de documentos

Esta ação substitui os destinatários em um convite de grupo de documentos por sua ID de convite. Você também pode definir uma expiração de convite, lembretes, reatribuir permissões e recusar opções para cada documento

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo de Documentos
id True string

ID do grupo de documentos

ID do convite
invite_id True string

ID de convite do grupo de documentos

ID do passo
step_id string

ID da etapa de convite do convite do grupo de documentos

Destinatário a substituir
recipient_to_update string

E-mail do destinatário a substituir

Novo destinatário
new_recipient string

E-mail do novo destinatário

Dias de Validade
expiration_days integer

Em quantos dias o convite expira; 30 dias max

Lembrete
reminder integer

Em quantos dias enviar um lembrete ao signatário; 30 dias max

ID do documento
document_id True string

ID do documento do grupo de documentos

Permitir encaminhamento
allow_forwarding boolean

Permitir ou não que os destinatários reatribuam este convite a outro endereço de e-mail. Valores possíveis: Falso - não permitido. Verdadeiro - permitido.

Permitir recusa por assinatura
decline_by_signature boolean

Define se a opção Recusar para assinar deve ser exibida nos campos de assinatura. Verdadeiro: mostrar a opção de recusa; Falso: ocultar a opção de recusa

Devoluções

Name Caminho Tipo Description
Situação
status string

Estatuto de substituição dos destinatários

Acionadores

Iniciar fluxo no evento do documento (Pré-visualização)

Selecione o evento a ser acionado: o convite de assinatura novo ou atualizado; Quando alguém cria, atualiza, conclui ou exclui um documento

Iniciar fluxo no evento do documento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Iniciar fluxo no evento do documento .

Você pode criar gatilho para um desses eventos: criação de documentos, atualização de documentos, exclusão de documentos, conclusão de documentos, criação de convites, atualização de convidados

Iniciar fluxo no evento do documento (Pré-visualização)

Selecione o evento a ser acionado: o convite de assinatura novo ou atualizado; Quando alguém cria, atualiza, conclui ou exclui um documento

Parâmetros

Name Chave Necessário Tipo Description
Event
event True string

Selecione o evento que deve acionar o fluxo

Devoluções

Name Caminho Tipo Description
Event
meta.event string

Evento de documento que causou o gatilho.

ID do documento
content.document_id string

ID exclusivo do documento de destino que causou o evento.

Nome do documento
content.document_name string

Nome do arquivo do documento de destino sem extensão

Iniciar fluxo no evento do documento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Iniciar fluxo no evento do documento .

Você pode criar gatilho para um desses eventos: criação de documentos, atualização de documentos, exclusão de documentos, conclusão de documentos, criação de convites, atualização de convidados

Parâmetros

Name Chave Necessário Tipo Description
Event
event True string

Selecione o evento que deve acionar o fluxo.

Devoluções

Name Caminho Tipo Description
Data e Hora
meta.timestamp integer

Data e hora em que o evento ocorreu (formato Unix timestamp).

Event
meta.event string

Evento de documento que causou o gatilho.

ID do documento
content.document_id string

ID exclusivo do documento de destino que causou o evento.

Nome do documento
content.document_name string

Nome do arquivo do documento de destino sem extensão

Definições

DocumentProperties

Name Caminho Tipo Description
ID do documento
id DocumentId

ID de documento exclusivo

Nome do documento
document_name string

Nome do arquivo do documento sem extensão

Contagem de páginas
page_count integer

Número de páginas do documento

Criado
created integer

Data e hora em que o documento foi criado no formato Unix Timestamp

Updated
updated integer

A data e hora em que o documento foi atualizado no formato Unix Timestamp

Nome do modelo
original_filename string

Nome do arquivo de modelo com extensão (se houver)

ID do modelo
origin_document_id string

ID do documento do modelo (se houver)

É modelo
template boolean

true se o documento for modelo.

Estado do documento
status string

Estado do documento

DocumentGroupsResponse

Name Caminho Tipo Description
document_groups
document_groups array of DocumentGroupProperties
Contagem Total de Grupos de Documentos
document_group_total_count integer

O número total de grupos de documentos na conta SignNow

DocumentGroupProperties

Name Caminho Tipo Description
ID do Grupo de Documentos
group_id DocumentGroupId

ID do Grupo de Documentos Exclusivo

Nome do Grupo de Documentos
group_name string

Nome do Grupo de Documentos

Documents
documents array of DocumentGroupDocumentProperties

Documents

DocumentGroupDocumentProperties

Name Caminho Tipo Description
ID do documento
id DocumentId

ID de documento exclusivo

Nome do documento
document_name string

Nome do arquivo do documento sem extensão

ID do modelo
origin_document_id string

ID do documento do modelo (se houver)

CreateDocumentGroupFromFilesResponse

Name Caminho Tipo Description
Nome do Grupo de Documentos
group_name string

Nome do grupo de documentos

ID do Grupo de Documentos
group_id string

ID do grupo de documentos

Documentação
documents array of object
ID do documento
documents.id DocumentId

ID de documento exclusivo

Nome do documento
documents.name string

Nome do documento

ID do documento

ID de documento exclusivo

ID de documento exclusivo

ID do documento
string

DocumentGroupId

ID do Grupo de Documentos Exclusivo

ID do Grupo de Documentos Exclusivo

ID do Grupo de Documentos
string

objecto

Este é o tipo 'objeto'.

binário

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