Compartilhar via

SignNow

O SignNow permite fluxos de trabalho de eSignature seguros, compatíveis e prontos para auditoria para empresas, equipes jurídicas, de RH, de saúde e de finanças. Enviar e acompanhar solicitações de assinatura em ordem baseada em função, pré-preencher campos de documentos e gerenciar grupos de documentos usando o conector SignNow.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Central de Ajuda
URL https://support.signnow.com/
Email integrations@pdffiller.com
Metadados do conector
Publicador DaDaDocs
Website https://signnow.com
Política de privacidade https://www.signnow.com/privacy_policy
Categorias Produtividade; Recursos humanos

Conector do SignNow

O SignNow permite fluxos de trabalho de eSignature seguros, compatíveis e prontos para auditoria para empresas, equipes jurídicas, de RH, de saúde e de finanças. Enviar e acompanhar solicitações de assinatura em ordem baseada em função, pré-preencher campos de documentos e gerenciar grupos de documentos usando o conector SignNow.

Pré-requisitos

Você precisará de uma conta signnow 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 com suporte

Consulte a documentação para obter mais detalhes.

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Baixar Documento

Baixar um documento do SignNow
Cancelar convite

Cancelamento de convite de assinatura
Carregar documento

Carregar um documento no SignNow
Convidar para assinar documento

Essa ação cria e envia um convite de campo para que um documento seja assinado
Convidar para assinar grupo de documentos

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

Essa ação cria um convite de assinatura inserido para um documento. Depois que o convite for criado, gere um link de assinatura inserido
Criar convite inserido do grupo de documentos

Essa ação cria um convite de assinatura inserido para um grupo de documentos. Depois que o convite for criado, gere um link de assinatura inserido
Criar documento a partir do modelo

Gerar um documento de um modelo selecionado
Criar grupo de documentos com base em vários arquivos

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

Criar o grupo de documentos com base em um modelo de grupo selecionado
Criar link de assinatura

Gerar um link para o documento e compartilhá-lo para que o documento seja assinado
Criar link de envio do documento inserido

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

Essa ação gera um link de envio inserido para um grupo de documentos específico, permitindo que usuários de terceiros preparem e enviem o grupo de documentos para assinatura
Excluir Convite Inserido do Documento

Essa ação exclui um convite inserido para um documento
Excluir convite inserido do grupo de documentos

Essa ação exclui um convite inserido para um grupo de documentos específico
Excluir Documento

Excluir um documento do SignNow
Gerar link de convite inserido do documento

Essa ação gera um link para o convite inserido no documento
Gerar link de convite inserido do grupo de documentos

Essa ação gera um link para o convite inserido do grupo de documentos
Obter campos de documento

Recuperar valores dos campos preenchíveis no documento
Obter campos de documento [PRETERIDO]

Esta ação foi preterida. Em vez disso, use Obter Campos de Documento .

Obter valores de campo do documento.
Obter esquema de documento [PRETERIDO]

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

Obter o 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 o status do convite do documento

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

Essa ação recupera informações sobre um convite de grupo de documentos, incluindo o status de cada etapa e ação
Preenchir valores de campo do documento [PRETERIDO]

Esta ação foi preterida. Em vez disso , use valores de campo de documento de pré-arquivo .

Prefill field values and properties.
Prefill Document Field Values

Preencher automaticamente campos preenchíveis no documento com valores específicos
Prefill Document Group Field Values

Preencher automaticamente campos preenchíveis nos documentos com valores específicos
Prefill Document Group Smart Field Values

Preencher automaticamente campos inteligentes nos documentos com valores específicos
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 avançado de documento

A ação foi preterida. Convidar solicitação com esquema definido manualmente. Ele permite configurar o convite para um documento que será gerado no futuro
Pré-filtrar valores de campo inteligente

Prefill Smart Field values for the specified document
Substituir destinatários no Convite de Documento

Essa ação substitui os destinatários no convite do 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

Essa 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 opções de declínio para cada documento

Baixar Documento

ID da operação:
DownloadDocument

Baixar um documento do SignNow

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id True string

Especifique uma ID de documento exclusiva ou selecione um documento na lista
Formato
 mode string

Selecionar um formato de documento para download

Retornos

response
binary

Cancelar convite

ID da operação:
CancelInvite

Cancelamento de convite de assinatura

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id True string

Especificar a ID do documento para cancelamento de convite de assinatura

Retornos

response
object

Carregar documento

ID da operação:
UploadDocument

Carregar um documento no SignNow

Parâmetros

Nome Chave Obrigatório Tipo Description
File
 file True file

Arquivo a ser carregado

Retornos

Nome Caminho Tipo Description
ID do documento
 id DocumentId

ID de documento exclusiva

Convidar para assinar documento

ID da operação:
InviteToSignAllOptions

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 id True string

ID do documento
Email
 email string

Endereço de email do destinatário
Grupo de Email
 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 email'. Obrigatório se 'Email' ou 'Phone Invite' não for adicionado, mas não puder ser usado ao mesmo tempo com qualquer um desses parâmetros
Convite para Telefone
 phone_invite string

Número de telefone do destinatário. Necessário para Convidar via SMS
Função
 role True string

Nome da função do destinatário. Por exemplo, Signatário 1, Signatário 2
Pedido
 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. Depois que todos os destinatários em uma etapa de ordem concluirem a assinatura, o documento prosseguirá para a próxima etapa do pedido (por exemplo, 2, 3). Vários destinatários podem compartilhar a mesma ordem de assinatura
Função
 role True string

Nome da função do 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 por signatário
Nome de assinatura predefinido necessário
 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. False – 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 declínio por assinatura
 decline_by_signature boolean

Define se a opção Recusar para Assinar deve ser mostrada nos campos de assinatura. True – mostrar a opção de declínio; false – ocultar a opção de declínio
Enviar Lembrete em X Dias
 remind_after integer

X dias após o convite, um recepiente recebe um email de lembrete (de 1 a 179 dias). Deve ser menor que 'Dias até a expiração'
Enviar lembrete em X dias antes da expiração
 remind_before integer

X dias antes da expiração, um recepiente recebe um email de lembrete (de 1 a 179 dias). Deve ser menor que 'Dias até a expiração'
Enviar lembrete a cada x dias
 remind_repeat integer

Um recepiente recebe um email de lembrete a cada x dias após o convite ser enviado (de 1 a 7 dias)
Dias até a 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

Conjunto de senhas para a autenticação do signatário. Necessário para o tipo de autenticação 'Password'
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: +1XXXXXXXXXXXX
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 esse parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) – "Código de desbloqueio de convite do documento SignNow: 123456". Exemplo: insira a senha {password} para desbloquear seu documento
Assunto
 subject string

Assunto de email personalizado para o destinatário
Message
 message string

Mensagem de email personalizada para o destinatário
Uri de redirecionamento
 redirect_uri string

Quando todos os campos solicitados são concluídos e assinados, o signatário é redirecionado para esse 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: 'Na nova guia' – abre o link em uma nova guia, 'Na mesma guia' - abre o link na mesma guia
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 Fechar no modo de exibição
Concluir Redirecionamento 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; False – o redirecionamento permanece ativo
É Fechar Redirecionamento 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; False – o redirecionamento permanece ativo
Is Decline Redirect Canceled
 is_decline_redirect_canceled boolean

Especifica se a configuração de redirecionamento de declínio é cancelada para a organização. True – o redirecionamento é cancelado; False – o redirecionamento permanece ativo
Linguagem
 language string

Especifica o idioma da sessão de assinatura e emails 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 será determinado pelo idioma da sua conta do SignNow
Email
 email True string

Endereço de email do visualizador
Função
 role True string

Nome da função do visualizador
Pedido
 order True integer

Inteiro: a ordem de envio, a partir de 1
Função
 role True string

Nome da função do visualizador. Usado para mapear parâmetros avançados
Assunto
 subject string

Assunto de email personalizado para o visualizador
Message
 message string

Mensagem de email personalizada para o visualizador
Email
 email True string

Endereço de email do aprovador
Função
 role True string

Nome da função do aprovador
Pedido
 order True integer

A ordem de recebimento da solicitação de aprovação
Função
 role True string

Nome da função do aprovador. Usado para mapear parâmetros avançados
Dias de expiração
 expiration_days integer

Número de dias antes do convite expirar
Message
 message string

Mensagem de email personalizada para o aprovador
Assunto
 subject string

Assunto de email 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'
Senha
 password string

Conjunto de senhas para a autenticação do signatário. Necessário para o tipo de autenticação 'Password'
Telefone
 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: +1XXXXXXXXXXXX
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 esse parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) – "Código de desbloqueio de convite do documento SignNow: 123456". Exemplo: insira a senha {password} para desbloquear seu documento
Uri de redirecionamento
 redirect_uri string

A URL que é aberta após o aprovador aprovar 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: 'Na nova guia' – abre o link em uma nova guia, 'Na mesma guia' - abre o link na mesma guia
De
 from string

Endereço de email do remetente. Somente o email associado à sua conta do SignNow (email de logon) pode ser usado. Se deixado em branco, ele será definido automaticamente
ID
 id string

ID de um grupo de email. Um identificador exclusivo de 40 caracteres que deve ser criado com antecedência
Nome
 name string

Um nome do grupo. Usá-lo no campo Grupo de Email de Signatários >
Email
 email string

Endereço de email que deve receber um convite
Email
 email string

Endereço de email que deve receber um convite
Nome
 name string

Nome da etapa
Email
 email string

Endereço de email do destinatário CC
Passo
 step integer

A ordem de envio, a partir de 1
Assunto
 subject string

Assunto de email para todos os destinatários
Message
 message string

Mensagem de email para todos os destinatários
Assunto CC
 cc_subject string

Assunto de email CC para todos os destinatários cc
Mensagem CC
 cc_message string

Mensagem de email CC para todos os destinatários cc
Assinatura do QES
 signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas DO 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

Retornos

Nome Caminho Tipo Description
Situação
 status string

Situação

Convidar para assinar grupo de documentos

ID da operação:
InviteToSignDocGroupAllOptions

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Grupo de Documentos
 id True string

ID do grupo de documentos
Pedido
 order True integer

Ordem da etapa de assinatura: 1 – os destinatários assinam 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 email do destinatário
Grupo de Email
 email_group string

Um grupo de contatos de destinatários
Nome da Função
 role_name True string

Nome da função do 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: Exibir, Assinar, Aprovar
ID do documento
 document_id True string

ID do documento no qual as ações são necessárias desse destinatário
Nome de assinatura predefinido necessário
 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 declínio por assinatura
 decline_by_signature boolean

Define se a opção Recusar para Assinar deve ser mostrada nos campos de assinatura. True: mostrar a opção de declínio; False: ocultar a opção de declínio
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'
Senha
 value string

Conjunto de senhas para a autenticação do signatário. Necessário para o tipo de autenticação 'Password'
Telefone
 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: +1XXXXXXXXXXXX
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 esse parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) – "Código de desbloqueio de convite do documento SignNow: 123456"
MerchantId
 merchant_id string

A ID da conta do comerciante adicionada à sua organização
Moeda
 currency string

A moeda de pagamento solicitada
Quantidade
 amount string

O valor de pagamento solicitado
Uri
 redirect_uri string

Quando todos os campos solicitados são concluídos e assinados, o signatário é redirecionado para esse 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: 'Na nova guia' – abre o link em uma nova guia, 'Na mesma guia' - abre o link na mesma guia
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
Concluir Redirecionamento 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; False – o redirecionamento permanece ativo
É Fechar Redirecionamento 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; False – o redirecionamento permanece ativo
Is Decline Redirect Canceled
 is_decline_redirect_canceled boolean

Especifica se a configuração de redirecionamento de declínio é cancelada para a organização. True – o redirecionamento é cancelado; False – o redirecionamento permanece ativo
Linguagem
 language string

Especifica o idioma da sessão de assinatura e emails 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 será determinado pelo idioma da sua conta do SignNow
Pedido
 order True integer

Ordem da etapa de assinatura: 1 – os destinatários assinam 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 email do destinatário
Grupo de Email
 email_group string

Um grupo de contatos de destinatários
Assunto
 subject string

Assunto de email personalizado para o destinatário
Message
 message string

Mensagem de email personalizada para o destinatário
Dias até a 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 recepiente recebe um email de lembrete (de 1 a 179 dias). Deve ser menor que dias de expiração
Enviar lembrete em X dias antes da expiração
 remind_before integer

X dias antes da expiração, um recepiente recebe um email de lembrete (de 1 a 179 dias). Deve ser menor que dias de expiração
Enviar Lembrete a cada X Dias
 remind_repeat integer

Um recepiente recebe um email 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 email. Um identificador exclusivo de 40 caracteres que deve ser criado com antecedência
Nome
 name string

Um nome do grupo. Use-o no 'Grupo de Email etapas > de convite'
Email
 email string

Endereço de email que deve receber um convite
Email
 email string

Endereço de email do destinatário que receberá o email de conclusão
Desabilitar anexo de documento
 disable_document_attachment boolean

Se deseja desabilitar o envio de anexos de documento com o email de conclusão. Valores possíveis: False – habilitar anexo de documento, True – desabilitar anexo de documento
Assunto
 subject string

Assunto personalizado para o email de conclusão
Message
 message string

Mensagem personalizada para o email 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 um grupo de documentos mesclado 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 email que deve receber um convite
Assinatura do QES
 signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas DO 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

Retornos

Nome 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 inserido do documento

ID da operação:
CreateEmbeddedInvites

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 id True string

ID do documento
Email do signatário
 email True email

Endereço de email do destinatário
Função
 role True string

Nome da função do destinatário, por exemplo, 'Signatário 1' (não há suporte para funções de visualizador)
Pedido
 order True integer

A ordem de assinatura
Fórmula de nome
 name_formula string

Uma fórmula para gerar um nome de documento concluído usando um prefixo (qualquer texto) e dados de campo preenchíveis. Exemplo: 'Contract|signer_name|signed_date', em que 'Contract' é o prefixo e 'signer_name' e 'signed_date' são nomes de campos preenchíveis
Função
 role True string

Nome da função do destinatário, por exemplo, 'Signatário 1' (não há suporte para funções de visualizador)
Linguagem
 language string

Especifica o idioma da sessão de assinatura e emails 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 será determinado pelo idioma da sua conta do SignNow
Primeiro Nome
 first_name string

Nome do destinatário
Apelido
 last_name string

Sobrenome do destinatário
Nome de assinatura predefinido necessário
 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 precisará adicionar uma nova assinatura. Se definido como 'false', o signatário poderá usar a assinatura salva
Uri de redirecionamento
 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 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: 'Na nova guia' – abre o link em uma nova guia, 'Na mesma guia' - abre o link na mesma guia
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

Conjunto de senhas para a autenticação do signatário. Necessário para o tipo de autenticação 'Password'
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: +1XXXXXXXXXXXX
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 esse parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) – "Código de desbloqueio de convite do documento SignNow: 123456": insira a senha {password} para desbloquear 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 de email expira. Só poderá ser usado se 'Tipo de entrega=email'. Intervalo válido: 15 a 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 somente quando "Tipo de entrega=email" e para ações de "sinal". Intervalo válido: 15 a 1440 minutos
Assinatura do QES
 signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas DO 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

Retornos

Nome Caminho Tipo Description
dados
 data array of object

Dados
ID
 data.id string

ID do convite inserido criado
Email
 data.email string

Email do destinatário
ID da Função
 data.role_id string

ID da função de destinatário
Pedido
 data.order integer

Ordem de assinatura do destinatário
Situação
 data.status string

Status do convite inserido

Criar convite inserido do grupo de documentos

ID da operação:
CreateDocGroupEmbeddedInvites

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Grupo de Documentos
 id True string

ID do grupo de documentos
Pedido
 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 email de convite simultaneamente. Os emails para a próxima etapa de pedido (por exemplo, order: 2) são enviados somente depois que todas as ações na etapa de ordem anterior são concluídas
Email
 email True string

Endereço de email do destinatário
ID do documento
 id True string

ID do documento
Função
 role string

Função de destinatário no documento. As funções não devem ser especificadas para a ação 'view'
Ação
 action True string

A ação necessária do destinatário no documento. Valores permitidos: 'sign', 'view'
Pedido
 order True string

Etapa de ordem de assinatura
Email
 email True string

Endereço de email do destinatário
Linguagem
 language string

Especifica o idioma da sessão de assinatura e emails 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 será determinado pelo idioma da sua conta do SignNow
Primeiro Nome
 first_name string

Nome do destinatário
Apelido
 last_name string

Sobrenome do destinatário
Nome de assinatura predefinido necessário
 required_preset_signature_name string

Texto pré-preenchido para o campo de assinatura, bloqueado para edição pelo destinatário
Uri de redirecionamento
 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 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: 'Na nova guia' – abre o link em uma nova guia, 'Na mesma guia' - abre o link na mesma guia
Tipo de entrega
 delivery_type string

Define como o convite é enviado
Expiração do link
 link_expiration integer

Em quantos minutos o convite de email expira. Só poderá ser usado se 'Tipo de entrega=email'. Intervalo válido: 15 a 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 somente quando "Tipo de entrega=email" e para ações de "sinal". Intervalo válido: 15 a 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

Conjunto de senhas para autenticação do signatário. Necessário para o tipo de autenticação 'Password'
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: +1XXXXXXXXXXXX
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 esse parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) – "Código de desbloqueio de convite do documento SignNow: 123456". Exemplo: insira a senha {password} para desbloquear seu documento
Assinatura do QES
 signature string

Tipo de QES. Valores possíveis: 'Eideasy', 'Nom151'. Usado para solicitar assinaturas DO 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

Retornos

Nome Caminho Tipo Description
ID do convite
 id string

ID do convite inserido criado

Criar documento a partir do modelo

ID da operação:
CreateFromTemplate

Gerar um documento de um modelo selecionado

Parâmetros

Nome Chave Obrigatório Tipo Description
Modelo de documento
 doc_id True string

Selecione um modelo na lista
Nome do documento
 document_name string

Insira o novo nome de arquivo para o documento

Retornos

Nome Caminho Tipo Description
ID do documento
 id DocumentId

ID de documento exclusiva

Criar grupo de documentos com base em vários arquivos

ID da operação:
CreateDocGroupFromFiles

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

Parâmetros

Nome Chave Obrigató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 arquivo
 content True string

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

Retornos

Corpo
CreateDocumentGroupFromFilesResponse

Criar grupo de documentos com base no modelo de grupo

ID da operação:
CreateFromTemplateGroup

Criar o grupo de documentos com base em um modelo de grupo selecionado

Parâmetros

Nome Chave Obrigató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

Inserir novo nome para o grupo de documentos

Retornos

Nome Caminho Tipo Description
ID do Grupo de Documentos
 id DocumentGroupId

ID exclusiva do grupo de documentos
ID da operação:
CreateSigningLink

Gerar um link para o documento e compartilhá-lo para que o documento seja assinado

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id True string

Especifique uma ID de documento exclusiva ou selecione um documento na lista
fields
 fields dynamic

Retornos

Nome Caminho Tipo Description
URL
 url_no_signup string

Link de Assinatura
ID da operação:
CreateEmbeddedInviteSettingsLink

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

Parâmetros

Nome Chave Obrigató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, em que o usuário pode adicionar emails 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
Uri de redirecionamento
 redirect_uri string

A página que é aberta após o envio inserido 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 usuários no nível do administrador 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: 'Na nova guia' – abre o link em uma nova guia, 'Na mesma guia' - abre o link na mesma guia

Retornos

Nome Caminho Tipo Description
URL
 url string

O link para o envio de documento inserido
ID da operação:
CreateDocGroupEmbeddedInviteSettingsLink

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

Parâmetros

Nome Chave Obrigató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 inserido deve ser aberto: 'gerenciar' – abre o link na página Adicionar documentos ao grupo de documentos; 'edit': abre o link no editor; 'send-invite': abre o link na página Enviar Convite
Uri de redirecionamento
 redirect_uri string

A página que é aberta após o envio inserido 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 usuários no nível do administrador 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: 'Na nova guia' – abre o link em uma nova guia, 'Na mesma guia' - abre o link na mesma guia

Retornos

Nome Caminho Tipo Description
URL
 url string

O link para o envio do grupo de documentos inserido

Excluir Convite Inserido do Documento

ID da operação:
DeleteEmbeddedInvites

Essa ação exclui um convite inserido para um documento

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 id True string

ID do documento

Excluir convite inserido do grupo de documentos

ID da operação:
DeleteDocGroupEmbeddedInvites

Essa ação exclui um convite inserido para um grupo de documentos específico

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Grupo de Documentos
 id True string

ID do grupo de documentos

Excluir Documento

ID da operação:
DeleteDoc

Excluir um documento do SignNow

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id True string

Especificar uma ID de documento exclusiva

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status de remoção de documento
ID da operação:
GenerateEmbeddedInviteLink

Essa ação gera um link para o convite inserido no documento

Parâmetros

Nome Chave Obrigató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 inserida da ação 'Criar Convite Inserido em Documento'
Expiração do link
 link_expiration integer

Especifica quantos minutos o link permanecerá ativo. Intervalo válido:15 a 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

Retornos

Nome Caminho Tipo Description
Link
 data.link string

Link de convite inserido gerado para o documento
ID da operação:
GenerateDocGroupEmbeddedInviteLink

Essa ação gera um link para o convite inserido do grupo de documentos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Grupo de Documentos
 id True string

ID do grupo de documentos
ID do convite inserido do grupo de documentos
 invite_id True string

ID do convite inserido do grupo de documentos da ação 'Criar Convite inserido do grupo de documentos'
Email
 email True email

Endereço de email do destinatário
Expiração do link
 link_expiration integer

Especifica quantos minutos o link permanecerá ativo. Intervalo válido:15 a 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

Retornos

Nome Caminho Tipo Description
Link de convite inserido
 link string

O link para o convite inserido do grupo de documentos

Obter campos de documento

ID da operação:
GetDocFields_V2

Recuperar valores dos campos preenchíveis no documento

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template_id True string

Especificar um modelo de documento para obter campos de
ID do documento
 doc_id True string

Especificar uma ID de documento exclusiva

Retornos

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

Obter campos de documento [PRETERIDO]

ID da operação:
GetDocFields

Esta ação foi preterida. Em vez disso, use Obter Campos de Documento .

Obter valores de campo do documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template_id True string

Especificar um modelo de documento para obter campos de
ID do documento
 doc_id True string

Especificar uma ID de documento exclusiva

Retornos

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

Obter esquema de documento [PRETERIDO]

ID da operação:
GetDocSchema

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

Obter o esquema de documento OpenAPI

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id string

Especificar uma ID de documento exclusiva
Filtro de tipo de campo
 select string

Separar com uma vírgula quais tipos de campo você gostaria de recuperar

Retornos

Nome Caminho Tipo Description
propriedades
 properties object

Obter grupo de documentos

ID da operação:
GetDocumentGroup

Recuperar uma lista de grupos de documentos do usuário

Parâmetros

Nome Chave Obrigató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 devem ser recuperados

Retornos

Corpo
DocumentGroupProperties

Obter grupos de documentos

ID da operação:
GetListDocGroups

Recuperar uma lista de grupos de documentos do usuário

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template True boolean

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

Número total de itens retornados (entre 1 e 50)
Offset
 offset integer

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

Retornos

Corpo
DocumentGroupsResponse

Obter informações do documento

ID da operação:
GetDoc

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template True boolean

Especificar se documentos ou modelos devem ser recuperados
ID do documento
 doc_id True string

Especifique uma ID de documento exclusiva ou selecione um documento na lista

Retornos

Corpo
DocumentProperties

Obter lista de documentos

ID da operação:
GetListDoc

Recuperar uma lista de documentos do usuário

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template boolean

Especificar se documentos ou modelos devem ser recuperados
Incluir modelo padrão
 includeDefaultTemplate boolean

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

Retornos

response
array of DocumentProperties

Obter o status do convite do documento

ID da operação:
GetInviteStatus

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 id True string

ID do documento

Retornos

Nome Caminho Tipo Description
Documento recusado
 is_document_declined boolean

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

Steps
Ordem de Assinatura
 steps.signing_order integer

Ordem de assinatura
Email do destinatário
 steps.signer_email string

Endereço de email do destinatário
Nome da Função
 steps.role_name string

Nome da função do destinatário
Tipo de ação
 steps.action_type string

A ação necessária 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

Status de assinatura. Valores possíveis: 'criado', 'pendente', 'atendido', 'cancelado', 'ignorado'
Declined
 steps.declined boolean

Retorna 'true' se o destinatário desta etapa recusou o documento
Motivo do declínio
 steps.decline_reason string

Mensagem fornecida pelo destinatário ao recusar o documento
Criado
 steps.created integer

Data em que a etapa foi criada
Atualizado
 steps.updated integer

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

Obter status de convite do grupo de documentos

ID da operação:
GetDocumentGroupInviteStatus

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Grupo de Documentos
 id True string

ID do grupo de documentos

Retornos

Nome Caminho Tipo Description
ID de Convite do Grupo de Documentos
 document_group_invite_id string

ID de convite do grupo de documentos
Status do Grupo de Documentos
 status string

Status de assinatura do grupo de documentos. Valores possíveis: 'created', 'pending', 'fulfilled', 'canceled'
Email do Proprietário
 owner_email string

Endereço de email do proprietário do grupo de documentos
Grupo de documentos recusado
 is_document_declined boolean

Retornará 'true' se qualquer documento no grupo for recusado por um signatário ou aprovador; caso contrário, retornará 'false'
steps
 steps array of object

Steps
ID da etapa
 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
Email do signatário
 steps.signer_email string

Endereço de email do destinatário
Nome da Função
 steps.role_name string

Nome da função do destinatário
Tipo de ação
 steps.action_type string

A ação necessária do destinatário no documento. Valores possíveis: 'Sign', 'View', 'Approve' ou 'FreeFormSign'
ID do convite da etapa
 steps.invite_id string

ID da etapa de convite
Situação
 steps.status string

O status de assinatura da etapa
Declined
 steps.declined boolean

True se o destinatário nesta etapa recusou o documento
Motivo do declínio
 steps.decline_reason string

Mensagem fornecida pelo destinatário ao recusar o documento
Criado
 steps.created integer

Data em que a etapa foi criada
Atualizado
 steps.updated integer

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

Preenchir valores de campo do documento [PRETERIDO]

ID da operação:
UpdateFieldValues

Esta ação foi preterida. Em vez disso , use valores de campo de documento de pré-arquivo .

Prefill field values and properties.

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template_id True string

Especificar um modelo de documento para obter campos de
ID do documento
 doc_id True string

Especificar uma ID de documento exclusiva
fields
 fields dynamic

Retornos

Nome Caminho Tipo Description
ID do documento
 id DocumentId

ID de documento exclusiva

Prefill Document Field Values

ID da operação:
UpdateFieldValues_V2

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template_id True string

Especificar um modelo de documento para obter campos de
ID do documento
 doc_id True string

Especificar uma ID de documento exclusiva
fields
 fields dynamic

Retornos

Nome Caminho Tipo Description
ID do documento
 id DocumentId

ID de documento exclusiva

Prefill Document Group Field Values

ID da operação:
UpdateGroupFieldValues

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

Parâmetros

Nome Chave Obrigató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 uma ID de grupo de documentos exclusiva
fields
 fields dynamic

Retornos

Nome Caminho Tipo Description
ID do Grupo de Documentos
 id DocumentGroupId

ID exclusiva do grupo de documentos

Prefill Document Group Smart Field Values

ID da operação:
UpdateGroupSmartFieldValues

Preencher automaticamente campos inteligentes nos documentos com valores específicos

Parâmetros

Nome Chave Obrigató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 uma ID de grupo de documentos exclusiva
fields
 fields dynamic

Retornos

Nome Caminho Tipo Description
ID do Grupo de Documentos
 id DocumentGroupId

ID exclusiva do grupo de documentos

Preterido – Convidar para assinar

ID da operação:
SendInvite

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template True boolean

Especificar se documentos ou modelos devem ser recuperados
Documento
 template_id True string

Selecione um modelo na lista
body
 body True dynamic

Retornos

response
object

Preterido – Convidar para assinar o Grupo de Documentos

ID da operação:
SendGroupInvite

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

Parâmetros

Nome Chave Obrigató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

Retornos

response
object

Preterido – Convite avançado de documento

ID da operação:
SendUserDefinedInvite

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 doc_id True string

Fornecer uma ID do documento
Nome
 role string

Nome da função do signatário
Email
 email email

Especificar email para o signatário
Número de telefone (convidar via SMS)
 phone_invite string

Especifique o número de telefone do destinatário +XXXXXXXXXXXXX. Necessário para Convidar via SMS.
Pedido
 order integer

Definir a ordem de assinatura para vários signatários
Assunto Personalizado
 subject string

Adicionar assunto personalizado para o 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
Senha
 password string

Definir a senha para senha de tipo de autenticação
Telefone
 phone string

Especificar o número de telefone +XXXXXXXXXXXXX para o tipo de autenticação Telefone ou SMS
Dias até a expiração
 expiration_days integer

Obter o 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 acompanhamento automático com um lembrete de email
Enviar Lembrete a cada X Dias
 remind_repeat integer

O destinatário receberá um email de lembrete a cada quantidade definida de dias.
Permitir Encaminhamento
 reassign boolean

Permitir que o signatário delegar a assinatura a outra pessoa
Mostrar declínio na assinatura
 decline_by_signature boolean

Carimbar um campo de assinatura como Recusar ao Assinar se o destinatário se recusou a assinar o documento
CC
 cc string

Um email separado por vírgula que será Copiado em Carbono no convite
Assunto
 subject string

Digite seu assunto
Message
 message string

Digite sua mensagem
Enviar por email todas as partes na conclusão
 on_complete string

Todas as partes recebem um email de notificação quando o documento é assinado

Retornos

response
object

Pré-filtrar valores de campo inteligente

ID da operação:
PrefillSmartFields

Prefill Smart Field values for the specified document

Parâmetros

Nome Chave Obrigatório Tipo Description
Template
 template_id True string

Especificar um modelo de documento para obter campos de
ID do documento
 doc_id True string

Especificar uma ID de documento exclusiva
fields
 fields dynamic

Substituir destinatários no Convite de Documento

ID da operação:
ReplaceRecipientsInDocumentInvite

Essa ação substitui os destinatários no convite do 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

Nome Chave Obrigatório Tipo Description
ID do documento
 id True string

ID do documento
Função
 role True string

Nome da função do destinatário a ser substituído
Novo Email
 email True string

Novo email do destinatário
Função
 role True string

Nome da função que requer parâmetros de convite adicionais
Dias de expiração
 expiration_days integer

Em quantos dias o convite expira. Máximo de 30 dias
Permitir declínio por assinatura
 decline_by_signature boolean

Define se a opção Recusar para Assinar deve ser mostrada nos campos de assinatura. True: mostrar a opção de declínio; False: ocultar a opção de declínio
Lembrete
 reminder integer

Em quantos dias enviar um lembrete ao destinatário. Máximo de 30 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
 authentication_password string

Conjunto de senhas para a autenticação do signatário. Necessário para o tipo de autenticação 'Password'
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: +1XXXXXXXXXXXX
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 esse parâmetro, o signatário recebe um sms padrão com uma senha gerada automaticamente (código de desbloqueio) – "Código de desbloqueio de convite do documento SignNow: 123456". Exemplo: insira a senha {password} para desbloquear seu documento

Retornos

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

Detalhes dos novos destinatários
Nova ID de Convite
 replacements.new_invite_id string

A nova ID de convite do campo
Função
 replacements.role string

Nome da função do destinatário que foi substituído
Novo Email
 replacements.new_email string

Novo email do destinatário

Substituir destinatários no convite do grupo de documentos

ID da operação:
ReplaceRecipientsInDocumentGroupInvite

Essa 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 opções de declínio para cada documento

Parâmetros

Nome Chave Obrigató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 da etapa
 step_id string

ID da etapa de convite do convite do grupo de documentos
Destinatário a ser substituído
 recipient_to_update string

Email do destinatário a ser substituído
Novo Destinatário
 new_recipient string

Email do novo destinatário
Dias de expiração
 expiration_days integer

Em quantos dias o convite expira; Máximo de 30 dias
Lembrete
 reminder integer

Em quantos dias para enviar um lembrete ao signatário; Máximo de 30 dias
ID do documento
 document_id True string

ID do documento do grupo de documentos
Permitir Encaminhamento
 allow_forwarding boolean

Se deseja ou não permitir que os destinatários reatribuam esse convite para outro endereço de email. Valores possíveis: False – não permitido. True - permitido.
Permitir declínio por assinatura
 decline_by_signature boolean

Define se a opção Recusar para Assinar deve ser mostrada nos campos de assinatura. True: mostrar a opção de declínio; False: ocultar a opção de declínio

Retornos

Nome Caminho Tipo Description
Situação
 status string

Status da substituição de destinatários

Gatilhos

Iniciar fluxo no evento de documento

Selecione o evento no qual disparar: o convite de assinatura novo ou atualizado; quando alguém cria, atualiza, conclui ou exclui um documento
Iniciar fluxo no evento de documento [PRETERIDO]

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

Você pode criar um gatilho para um deste evento: criação de documento, atualização de documento, exclusão de documento, documento concluído, criação de convite, atualização de convite

Iniciar fluxo no evento de documento

ID da operação:
Triggers_V2

Selecione o evento no qual disparar: o convite de assinatura novo ou atualizado; quando alguém cria, atualiza, conclui ou exclui um documento

Parâmetros

Nome Chave Obrigatório Tipo Description
Event
 event True string

Selecionar evento que deve disparar o Fluxo

Retornos

Nome Caminho Tipo Description
Event
 meta.event string

Evento de documento que causou o gatilho.
ID do documento
 content.document_id string

ID exclusiva do documento de destino que causou o evento.
Nome do documento
 content.document_name string

Nome do arquivo de documento de destino sem extensão

Iniciar fluxo no evento de documento [PRETERIDO]

ID da operação:
Triggers

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

Você pode criar um gatilho para um deste evento: criação de documento, atualização de documento, exclusão de documento, documento concluído, criação de convite, atualização de convite

Parâmetros

Nome Chave Obrigatório Tipo Description
Event
 event True string

Selecione o evento que deve disparar o Fluxo.

Retornos

Nome Caminho Tipo Description
Timestamp
 meta.timestamp integer

Data e hora em que o evento ocorreu (formato de carimbo de data/hora Unix).
Event
 meta.event string

Evento de documento que causou o gatilho.
ID do documento
 content.document_id string

ID exclusiva do documento de destino que causou o evento.
Nome do documento
 content.document_name string

Nome do arquivo de documento de destino sem extensão

Definições

DocumentProperties

Nome Caminho Tipo Description
ID do documento
 id DocumentId

ID de documento exclusiva
Nome do documento
 document_name string

Nome do arquivo de documento sem extensão
Contagem de páginas
 page_count integer

Número de páginas no documento
Criado
 created integer

Data e hora em que o documento foi criado no formato De carimbo de data/hora do Unix
Atualizado
 updated integer

A data e a hora em que o documento foi atualizado no formato De carimbo de data/hora do Unix
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 de modelo (se houver)
É modelo
 template boolean

true se o documento for modelo.
Status do documento
 status string

Status do documento

DocumentGroupsResponse

Nome 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

Nome Caminho Tipo Description
ID do Grupo de Documentos
 group_id DocumentGroupId

ID exclusiva do grupo de documentos
Nome do Grupo de Documentos
 group_name string

Nome do Grupo de Documentos
Documentos
 documents array of DocumentGroupDocumentProperties

Documentos

DocumentGroupDocumentProperties

Nome Caminho Tipo Description
ID do documento
 id DocumentId

ID de documento exclusiva
Nome do documento
 document_name string

Nome do arquivo de documento sem extensão
ID do Modelo
 origin_document_id string

ID do documento de modelo (se houver)

CreateDocumentGroupFromFilesResponse

Nome 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
Documentos
 documents array of object
ID do documento
 documents.id DocumentId

ID de documento exclusiva
Nome do documento
 documents.name string

Nome do documento

DocumentId

ID de documento exclusiva

ID de documento exclusiva

ID do documento
string

DocumentGroupId

ID exclusiva do grupo de documentos

ID exclusiva do grupo de documentos

ID do Grupo de Documentos
string

objeto

Esse é o tipo 'object'.

binário

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