Compartilhar via

SignRequest (versão prévia)

SignRequest é uma ferramenta de assinatura eletrônico segura e legalmente vinculativa que permite que você e seus parceiros assinem contratos e outros documentos rapidamente e sem o incômodo de ter que imprimir, assinar e verificar.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Email tech-support@signrequest.com
Metadados do conector
Publicador SignRequest B.V.

Limitações

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

Ações

Enviar SignRequest

Cria e envia um novo SignRequest.

Enviar SignRequest

ID da operação:
SignrequestQuickCreateCreate

Cria e envia um novo SignRequest.

Parâmetros

Nome Chave Obrigatório Tipo Description
Dias de exclusão automática
 auto_delete_days integer

Número de dias após o qual um documento concluído (assinado/cancelado/recusado) será excluído automaticamente
Dias de expiração automática
 auto_expire_days integer

Número de dias após o qual um documento não concluído expirará automaticamente
Desabilitar anexos
 disable_attachments boolean

Desabilitar o carregamento/adição de anexos
Desabilitar a prova de blockchain
 disable_blockchain_proof boolean

Desabilita o armazenamento de hashes de prova de carimbo de data/hora em integrações de blockchain.
Data da desabilitação
 disable_date boolean

Desabilitar a adição de datas
Desabilitar emails
 disable_emails boolean

Desabilitar todos os emails de status SignRequest, bem como o email que contém os documentos assinados
Desabilitar texto
 disable_text boolean

Desabilitar a adição de texto
Desabilitar assinaturas de texto
 disable_text_signatures boolean

Desabilitar o uso de assinaturas geradas digitando (texto)
Desabilitar assinaturas de upload
 disable_upload_signatures boolean

Desabilitar o uso de assinaturas carregadas (imagens)
Documento
 document uri
URL de retorno de chamada de eventos
 events_callback_url uri

URL na qual receber retornos de chamada de evento para este documento
ID externa
 external_id string

ID usada para referenciar documento no sistema externo
File
 file uri

URL temporária para o arquivo original, expira em cinco minutos
Arquivo do conteúdo
 file_from_content byte

Conteúdo do documento codificado em Base64
Arquivo do nome do conteúdo
 file_from_content_name string

Nome do arquivo, incluindo extensão. Necessário ao usar file_from_content.
Arquivo da URL
 file_from_url uri

URL acessível publicamente do documento a ser baixado pelo SignRequest
Por email
 from_email email

Email do usuário enviando o SignRequest (deve ser um email validado)
Do nome do email
 from_email_name string

Nome a ser usado no cabeçalho de From email, por exemplo, {from_email_name} <no-reply@signrequest.com>
ID de front-end
 frontend_id string

Segredo compartilhado usado em conjunto com o cliente SignRequest-js para conceder ao usuário acesso a um documento que não seja membro da equipe do documento
Está sendo preparado
 is_being_prepared boolean

Faça com que o remetente de um SignRequest prepare o documento antes de enviar a solicitação, confira: prepare-se usando a interface da Web
Message
 message string

A mensagem a ser incluída no email SignRequest pode conter as seguintes marcas html: a, , abbr, acronym, b, blockquote, , codeem, i, , ul, , li, e ol, estrong
Nome
 name string

Padrões para nome de arquivo, incluindo extensão
Prefill Tags Checkbox Value
 checkbox_value boolean
Valor da data das marcas de pré-preenchimento
 date_value date
ID externa de marcas de pré-preenchimento
 external_id string
Texto de marcas de pré-preenchimento
 text string
Preparar url
 prepare_url uri
URL de redirecionamento
 redirect_url uri

URL na qual SignRequest será redirecionado quando um documento for assinado
Url de redirecionamento recusada
 redirect_url_declined uri

URL na qual SignRequest será redirecionado quando um documento for recusado
Nome do anexo necessário
 name True string
Uuid de anexo necessário
 uuid string
Enviar lembretes
 send_reminders boolean

Lembrar automaticamente os signatários de assinar um documento, confira: lembretes automáticos
Signatário após documento
 after_document uri
Somente aprovação do signatário
 approve_only boolean

Exigir que o usuário aprove o documento (sem adicionar uma assinatura), consulte: Aprovar somente
File
 file uri
Nome do anexo necessário
 name True string
Uuid de anexo necessário
 uuid string
Nome
 name string

Padrões para nome de arquivo
Uuid
 uuid string
Signatário recusado
 declined boolean
Signatário recusado
 declined_on date-time
Nome de Exibição do Signatário
 display_name string
Signatário Baixado
 downloaded boolean
Email do signatário
 email True email
Email do signatário exibido
 email_viewed boolean
Signatário enviado por email
 emailed boolean
Url de Inserção do Signatário
 embed_url uri
ID de Usuário da Url do Signatário
 embed_url_user_id string
Nome do signatário
 first_name string
Linguagem de força do signatário
 force_language boolean
Signatário Encaminhado
 forwarded boolean
Conector encaminhado
 forwarded_on date-time
Motivo encaminhado pelo signatário
 forwarded_reason string
Signatário encaminhado para email
 forwarded_to_email email
Entrar pessoalmente
 in_person boolean

Quando usados em combinação com uma URL de inserção no remetente, depois que o remetente tiver assinado, eles serão redirecionados para o próximo in_person signatário, consulte: Assinatura pessoal
Valor da caixa de seleção
 checkbox_value boolean
Valor da data
 date_value date
ID externa
 external_id string
Índice de página
 page_index True integer
Uuid de espaço reservado
 placeholder_uuid string
Texto
 text string
Tipo
 type string
Idioma do signatário
 language string
Sobrenome do signatário
 last_name string
Mensagem do signatário
 message string
O signatário precisa assinar
 needs_to_sign boolean

Quando false o usuário não precisar assinar, mas receber uma cópia do documento assinado e do log de assinatura, consulte: Copiar somente
Somente notificação do signatário
 notify_only boolean

Envie notificações sobre o documento e uma cópia do documento assinado e do log de assinatura, mas não exija que eles executem nenhuma ação, consulte: Notificar somente
Ordem do signatário
 order integer
Senha do signatário
 password string

Exija que o signatário insira essa senha antes de assinar um documento. Este campo é somente gravação.
URL de Redirecionamento do Signatário
 redirect_url uri
Url de Redirecionamento do Signatário recusada
 redirect_url_declined uri
Signatário assinado
 signed boolean
Logon do signatário
 signed_on date-time
Carimbo de uso do signatário somente para aprovação
 use_stamp_for_approve_only boolean

Colocar um carimbo de aprovação em um documento quando um signatário aprovar um documento
Signer Verify Bank Account
 verify_bank_account string
Signatário verificar número de telefone
 verify_phone_number string
Signatário Exibido
 viewed boolean
Equipe
 subdomain string
Assunto
 subject string

Assunto do email SignRequest
Template
 template uri
Verificação de mensagem de texto bloqueada
 text_message_verification_locked boolean

Quando uma verificação de mensagem de texto verdadeira é necessária antes que o signatário possa ver o documento
URL
 url uri
Uuid
 uuid string
Quem
 who string

m: somente eu, mo: eu e outros, o: somente outros

Retornos

Corpo
SignRequestQuickCreate

Gatilhos

Quando um status de documento é alterado

Dispara quando o status do documento de um SignRequest é alterado.

Quando um status de documento é alterado

ID da operação:
WebhooksCreate

Dispara quando o status do documento de um SignRequest é alterado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Criado
 created date-time
Tipo de evento
 event_type True string
Nome
 name string

Nome opcional para identificar facilmente para o que o webhook é usado
Equipe
 subdomain string
Nome da Equipe
 name string
Subdomínio da Equipe
 subdomain uri
URL da Equipe
 url uri
URL
 url uri
Uuid
 uuid string

Retornos

Nome Caminho Tipo Description
documento
 document Document

Definições

Documento

Nome Caminho Tipo Description
API de documento usada
 api_used boolean

Indica se o documento foi criado usando a API
attachments
 attachments array of DocumentAttachment
Excluir automaticamente o documento após
 auto_delete_after date-time

Data e hora calculadas usando auto_delete_days após o qual um documento concluído (assinado/cancelado/recusado) será excluído automaticamente
Dias de Exclusão Automática do Documento
 auto_delete_days integer

Número de dias após o qual um documento concluído (assinado/cancelado/recusado) será excluído automaticamente
Documento expira automaticamente após
 auto_expire_after date-time

Data e hora calculadas usando auto_expire_days após o qual um documento não concluído expirará automaticamente
Dias de expiração automática do documento
 auto_expire_days integer

Número de dias após o qual um documento não concluído expirará automaticamente
Url de Retorno de Chamada de Eventos de Documento
 events_callback_url uri

URL na qual receber retornos de chamada de evento para este documento
Documento de ID Externa
 external_id string

ID usada para referenciar documento no sistema externo
Arquivo de documento
 file uri

URL temporária para o arquivo original, expira em cinco minutos
Arquivo de documento como Pdf
 file_as_pdf uri

A URL temporária para o arquivo original como PDF expira em cinco minutos
Arquivo de documento do conteúdo
 file_from_content string

Conteúdo do documento codificado em Base64
Arquivo de documento do nome do conteúdo
 file_from_content_name string

Nome do arquivo, incluindo extensão. Necessário ao usar file_from_content.
Arquivo do sf
 file_from_sf FileFromSf
Arquivo de documento da URL
 file_from_url uri

URL acessível publicamente do documento a ser baixado pelo SignRequest
ID do front-end do documento
 frontend_id string

Segredo compartilhado usado em conjunto com o cliente SignRequest-js para conceder ao usuário acesso a um documento que não seja membro da equipe do documento
Nome do documento
 name string

Padrões para nome de arquivo, incluindo extensão
Pdf do documento
 pdf uri

A URL temporária para o documento assinado como PDF expira em cinco minutos
prefill_tags
 prefill_tags array of InlinePrefillTags

Dados de entrada do signatário de pré-arquivo, consulte marcas de pré-preenchimento
Processamento de documentos
 processing boolean

Indica se uma alteração no documento está sendo processada e o PDF pode estar desatualizado. É recomendável aguardar até que o processamento seja concluído antes de baixar o PDF. Os webhooks não são enviados até que o processamento seja concluído.
Área restrita do documento
 sandbox boolean

Indica se o documento foi criado como parte de uma equipe de área restrita
Hash de Segurança do Documento
 security_hash string

Hash SHA256 de conteúdo PDF
Autenticando o Pdf do Log
 signing_log.pdf uri

A URL temporária para o log de assinatura expira em cinco minutos
Hash de Segurança de Log de Assinatura
 signing_log.security_hash string

Hash SHA256 de conteúdo PDF
Anexações de desabilitar signrequest
 signrequest.disable_attachments boolean

Desabilitar o carregamento/adição de anexos
Signrequest Disable Blockchain Proof
 signrequest.disable_blockchain_proof boolean

Desabilita o armazenamento de hashes de prova de carimbo de data/hora em integrações de blockchain.
Data de desabilitação do signrequest
 signrequest.disable_date boolean

Desabilitar a adição de datas
Signrequest Disable Emails
 signrequest.disable_emails boolean

Desabilitar todos os emails de status SignRequest, bem como o email que contém os documentos assinados
Signrequest Disable Text
 signrequest.disable_text boolean

Desabilitar a adição de texto
Signrequest Disable Text Signatures
 signrequest.disable_text_signatures boolean

Desabilitar o uso de assinaturas geradas digitando (texto)
Signrequest Disable Upload Signatures
 signrequest.disable_upload_signatures boolean

Desabilitar o uso de assinaturas carregadas (imagens)
Solicitação de Solicitação de Email
 signrequest.from_email email

Email do usuário enviando o SignRequest (deve ser um email validado)
Signrequest From Email Name
 signrequest.from_email_name string

Nome a ser usado no cabeçalho de From email, por exemplo, {from_email_name} <no-reply@signrequest.com>
O signrequest está sendo preparado
 signrequest.is_being_prepared boolean

Faça com que o remetente de um SignRequest prepare o documento antes de enviar a solicitação, confira: prepare-se usando a interface da Web
Mensagem de solicitação de sinal
 signrequest.message string

A mensagem a ser incluída no email SignRequest pode conter as seguintes marcas html: a, , abbr, acronym, b, blockquote, , codeem, i, , ul, , li, e ol, estrong
Url de Preparação do Signrequest
 signrequest.prepare_url uri
Url de Redirecionamento de Solicitação de Sinal
 signrequest.redirect_url uri

URL na qual SignRequest será redirecionado quando um documento for assinado
Url de redirecionamento de solicitação de sinal recusada
 signrequest.redirect_url_declined uri

URL na qual SignRequest será redirecionado quando um documento for recusado
required_attachments
 signrequest.required_attachments array of RequiredAttachment
Lembretes de envio de solicitação de sinal
 signrequest.send_reminders boolean

Lembrar automaticamente os signatários de assinar um documento, confira: lembretes automáticos
Signatários
 signrequest.signers array of Signer
Assunto de solicitação de sinal
 signrequest.subject string

Assunto do email SignRequest
Verificação de mensagem de texto de solicitação de sinal bloqueada
 signrequest.text_message_verification_locked boolean

Quando uma verificação de mensagem de texto verdadeira é necessária antes que o signatário possa ver o documento
Signrequest Uuid
 signrequest.uuid string
Signrequest Who
 signrequest.who string

m: somente eu, mo: eu e outros, o: somente outros
Status do documento
 status string

co: convertendo, ne: new, se: sent, vi: viewed, si: signed, do: downloaded, sd: signed and downloaded, ca: cancelled, de: declined, ec: error converting, es: error sending, xp: expired
Nome da Equipe
 team.name string
Subdomínio da Equipe
 team.subdomain uri
URL da Equipe
 team.url uri
Modelo de documento
 template uri
URL do Documento
 url uri
Utilizador
 user User
Documento Uuid
 uuid string

DocumentAttachment

Nome Caminho Tipo Description
Documento de anexo do documento
 document uri
Arquivo de anexo de documento
 file uri

A URL temporária para documentar o anexo expira em cinco minutos
Arquivo de anexo do documento do conteúdo
 file_from_content string

Conteúdo do documento codificado em Base64
Arquivo de anexo do documento do nome do conteúdo
 file_from_content_name string

Nome do arquivo, incluindo extensão. Necessário ao usar file_from_content.
Arquivo de anexo do documento da URL
 file_from_url uri

URL acessível publicamente do documento a ser baixado pelo SignRequest
Nome do anexo do documento
 name string

Padrões para nome de arquivo, incluindo extensão
URL do Anexo do Documento
 url uri
Uuid do Anexo do Documento
 uuid string

FileFromSf

Nome Caminho Tipo Description
ID do objeto
 object_id string
Tipo de objeto
 object_type string
UID
 uid string

InlinePrefillTags

Dados de entrada do signatário de pré-arquivo, consulte marcas de pré-preenchimento

Nome Caminho Tipo Description
Prefill Tags Checkbox Value
 checkbox_value boolean
Valor da data das marcas de pré-preenchimento
 date_value date
ID externa de marcas de pré-preenchimento
 external_id string
Texto de marcas de pré-preenchimento
 text string

RequiredAttachment

Nome Caminho Tipo Description
Nome do anexo necessário
 name string
Uuid de anexo necessário
 uuid string

SignRequestQuickCreate

Nome Caminho Tipo Description
Dias de exclusão automática
 auto_delete_days integer

Número de dias após o qual um documento concluído (assinado/cancelado/recusado) será excluído automaticamente
Dias de expiração automática
 auto_expire_days integer

Número de dias após o qual um documento não concluído expirará automaticamente
Desabilitar anexos
 disable_attachments boolean

Desabilitar o carregamento/adição de anexos
Desabilitar a prova de blockchain
 disable_blockchain_proof boolean

Desabilita o armazenamento de hashes de prova de carimbo de data/hora em integrações de blockchain.
Data da desabilitação
 disable_date boolean

Desabilitar a adição de datas
Desabilitar emails
 disable_emails boolean

Desabilitar todos os emails de status SignRequest, bem como o email que contém os documentos assinados
Desabilitar texto
 disable_text boolean

Desabilitar a adição de texto
Desabilitar assinaturas de texto
 disable_text_signatures boolean

Desabilitar o uso de assinaturas geradas digitando (texto)
Desabilitar assinaturas de upload
 disable_upload_signatures boolean

Desabilitar o uso de assinaturas carregadas (imagens)
Documento
 document uri
URL de retorno de chamada de eventos
 events_callback_url uri

URL na qual receber retornos de chamada de evento para este documento
ID externa
 external_id string

ID usada para referenciar documento no sistema externo
File
 file uri

URL temporária para o arquivo original, expira em cinco minutos
Arquivo do conteúdo
 file_from_content byte

Conteúdo do documento codificado em Base64
Arquivo do nome do conteúdo
 file_from_content_name string

Nome do arquivo, incluindo extensão. Necessário ao usar file_from_content.
Arquivo da URL
 file_from_url uri

URL acessível publicamente do documento a ser baixado pelo SignRequest
Por email
 from_email email

Email do usuário enviando o SignRequest (deve ser um email validado)
Do nome do email
 from_email_name string

Nome a ser usado no cabeçalho de From email, por exemplo, {from_email_name} <no-reply@signrequest.com>
ID de front-end
 frontend_id string

Segredo compartilhado usado em conjunto com o cliente SignRequest-js para conceder ao usuário acesso a um documento que não seja membro da equipe do documento
Está sendo preparado
 is_being_prepared boolean

Faça com que o remetente de um SignRequest prepare o documento antes de enviar a solicitação, confira: prepare-se usando a interface da Web
Message
 message string

A mensagem a ser incluída no email SignRequest pode conter as seguintes marcas html: a, , abbr, acronym, b, blockquote, , codeem, i, , ul, , li, e ol, estrong
Nome
 name string

Padrões para nome de arquivo, incluindo extensão
prefill_tags
 prefill_tags array of InlinePrefillTags

Dados de entrada do signatário de pré-arquivo, consulte marcas de pré-preenchimento
Preparar url
 prepare_url uri
URL de redirecionamento
 redirect_url uri

URL na qual SignRequest será redirecionado quando um documento for assinado
Url de redirecionamento recusada
 redirect_url_declined uri

URL na qual SignRequest será redirecionado quando um documento for recusado
required_attachments
 required_attachments array of RequiredAttachment

Anexos que os signatários são necessários para carregar
Enviar lembretes
 send_reminders boolean

Lembrar automaticamente os signatários de assinar um documento, confira: lembretes automáticos
Signatários
 signers array of Signer
Equipe
 subdomain string
Assunto
 subject string

Assunto do email SignRequest
Template
 template uri
Verificação de mensagem de texto bloqueada
 text_message_verification_locked boolean

Quando uma verificação de mensagem de texto verdadeira é necessária antes que o signatário possa ver o documento
URL
 url uri
Uuid
 uuid string
Quem
 who string

m: somente eu, mo: eu e outros, o: somente outros

Signatário

Nome Caminho Tipo Description
Signatário após documento
 after_document uri
Somente aprovação do signatário
 approve_only boolean

Exigir que o usuário aprove o documento (sem adicionar uma assinatura), consulte: Aprovar somente
attachments
 attachments array of SignerAttachment
Signatário recusado
 declined boolean
Signatário recusado
 declined_on date-time
Nome de Exibição do Signatário
 display_name string
Signatário Baixado
 downloaded boolean
Email do signatário
 email email
Email do signatário exibido
 email_viewed boolean
Signatário enviado por email
 emailed boolean
Url de Inserção do Signatário
 embed_url uri
ID de Usuário da Url do Signatário
 embed_url_user_id string
Nome do signatário
 first_name string
Linguagem de força do signatário
 force_language boolean
Signatário Encaminhado
 forwarded boolean
Conector encaminhado
 forwarded_on date-time
Motivo encaminhado pelo signatário
 forwarded_reason string
Signatário encaminhado para email
 forwarded_to_email email
Entrar pessoalmente
 in_person boolean

Quando usados em combinação com uma URL de inserção no remetente, depois que o remetente tiver assinado, eles serão redirecionados para o próximo in_person signatário, consulte: Assinatura pessoal
entradas
 inputs array of SignerInputs
Idioma do signatário
 language string
Sobrenome do signatário
 last_name string
Mensagem do signatário
 message string
O signatário precisa assinar
 needs_to_sign boolean

Quando false o usuário não precisar assinar, mas receber uma cópia do documento assinado e do log de assinatura, consulte: Copiar somente
Somente notificação do signatário
 notify_only boolean

Envie notificações sobre o documento e uma cópia do documento assinado e do log de assinatura, mas não exija que eles executem nenhuma ação, consulte: Notificar somente
Ordem do signatário
 order integer
Senha do signatário
 password string

Exija que o signatário insira essa senha antes de assinar um documento. Este campo é somente gravação.
URL de Redirecionamento do Signatário
 redirect_url uri
Url de Redirecionamento do Signatário recusada
 redirect_url_declined uri
Signatário assinado
 signed boolean
Logon do signatário
 signed_on date-time
Carimbo de uso do signatário somente para aprovação
 use_stamp_for_approve_only boolean

Colocar um carimbo de aprovação em um documento quando um signatário aprovar um documento
Signer Verify Bank Account
 verify_bank_account string
Signatário verificar número de telefone
 verify_phone_number string
Signatário Exibido
 viewed boolean

SignerAttachment

Nome Caminho Tipo Description
File
 file uri
for_attachment
 for_attachment RequiredAttachment
Nome
 name string

Padrões para nome de arquivo
Uuid
 uuid string

SignerInputs

Nome Caminho Tipo Description
Valor da caixa de seleção
 checkbox_value boolean
Valor da data
 date_value date
ID externa
 external_id string
Índice de página
 page_index integer
Uuid de espaço reservado
 placeholder_uuid string
Texto
 text string
Tipo
 type string

Utilizador

Nome Caminho Tipo Description
Nome de Exibição do Usuário
 display_name string
Endereço de email do usuário
 email email
Nome do usuário
 first_name string
Sobrenome do Usuário
 last_name string