Partilhar via

SignRequest (Pré-visualização)

SignRequest é uma ferramenta de assinatura eletrônica segura e juridicamente 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 digitalizar.

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
Email tech-support@signrequest.com
Metadados do conector
Editora SignRequest Bv

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de 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

Name Chave Necessário Tipo Description
Exclusão automática de dias
 auto_delete_days integer

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

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

Desativar o upload/adição de anexos
Desativar 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.
Desativar data
 disable_date boolean

Desativar a adição de datas
Desativar e-mails
 disable_emails boolean

Desative todos os e-mails de status do SignRequest, bem como o e-mail que contém os documentos assinados
Desativar texto
 disable_text boolean

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

Desativar o uso de assinaturas geradas pela digitação (texto)
Desativar assinaturas de upload
 disable_upload_signatures boolean

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

URL para receber retornos de chamada de eventos para este documento
Identificação externa
 external_id string

ID utilizado para referenciar documento no sistema externo
Ficheiro
 file uri

URL temporário 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. Obrigatório ao usar file_from_contento .
Arquivo de url
 file_from_url uri

URL acessível publicamente do documento a ser baixado pelo SignRequest
Do e-mail
 from_email email

Email do usuário que envia o SignRequest (deve ser um e-mail validado)
Do nome do e-mail
 from_email_name string

Nome a ser usado no cabeçalho do From e-mail, por exemplo: {from_email_name} <no-reply@signrequest.com>
Identificação do frontend
 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 é membro da equipe do documento
Está a ser preparado
 is_being_prepared boolean

Peça ao remetente de um SignRequest que prepare o documento antes de enviar a solicitação, consulte: Preparar usando a interface da Web
Message
 message string

A mensagem a incluir no e-mail SignRequest pode conter as seguintes tags html: a, abbr, acronym, b, blockquote, code, em, iliulolestrong
Nome
 name string

O padrão é o nome do arquivo, incluindo a extensão
Valor da caixa de seleção de tags de pré-preenchimento
 checkbox_value boolean
Pré-preenchimento Tags Valor da data
 date_value date
Etiquetas de pré-preenchimento ID externo
 external_id string
Texto das tags de pré-preenchimento
 text string
Preparar url
 prepare_url uri
URL de redirecionamento
 redirect_url uri

URL para a qual SignRequest redirecionará quando um documento for assinado
URL de redirecionamento recusado
 redirect_url_declined uri

URL para a qual SignRequest redirecionará quando um documento for recusado
Nome do anexo obrigatório
 name True string
Uuid de anexo necessário
 uuid string
Enviar lembretes
 send_reminders boolean

Lembre automaticamente os signatários de assinar um documento, consulte: lembretes automáticos
Signatário após o documento
 after_document uri
Signatário Aprovar Apenas
 approve_only boolean

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

Padrão para o nome do arquivo
Uuid
 uuid string
Signatário recusado
 declined boolean
Signatário recusado em
 declined_on date-time
Nome de exibição do signatário
 display_name string
Signatário baixado
 downloaded boolean
E-mail do signatário
 email True email
E-mail do signatário visualizado
 email_viewed boolean
Signatário enviado por e-mail
 emailed boolean
URL de incorporação do signatário
 embed_url uri
ID de usuário do Signer Embed Url
 embed_url_user_id string
Nome do signatário
 first_name string
Linguagem da Força do Signatário
 force_language boolean
Signatário encaminhado
 forwarded boolean
Signatário encaminhado em
 forwarded_on date-time
Motivo encaminhado do signatário
 forwarded_reason string
Signatário encaminhado para e-mail
 forwarded_to_email email
Signatário Presencial
 in_person boolean

Quando usado em combinação com um url de incorporação no remetente, depois que o remetente assinar, eles serão redirecionados para o próximo in_person signatário, consulte: Assinatura presencial
Valor da caixa de seleção
 checkbox_value boolean
Valor da data
 date_value date
Identificação externa
 external_id string
Índice da página
 page_index True integer
Espaço reservado uuid
 placeholder_uuid string
Texto
 text string
Tipo
 type string
Língua 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: Somente cópia
Apenas 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 tomem nenhuma ação, consulte: Notificar somente
Ordem do signatário
 order integer
Palavra-passe do signatário
 password string

Exija que o signatário insira essa senha antes de assinar um documento. Este campo é apenas de escrita.
URL de redirecionamento do signatário
 redirect_url uri
URL de redirecionamento do signatário recusado
 redirect_url_declined uri
Signatário assinado
 signed boolean
Signatário conectado
 signed_on date-time
O signatário usa o carimbo apenas para aprovar
 use_stamp_for_approve_only boolean

Colocar um carimbo de aprovação num documento quando um signatário aprova um documento
Signatário Verificar Conta Bancária
 verify_bank_account string
Signatário Verificar número de telefone
 verify_phone_number string
Signatário visualizado
 viewed boolean
Equipa
 subdomain string
Assunto
 subject string

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

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

m: só eu, mo: eu e os outros, o: só os outros

Devoluções

Body
SignRequestQuickCreate

Acionadores

Quando o status de um documento é alterado

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

Quando o status de um documento é alterado

ID da Operação:
WebhooksCreate

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

Parâmetros

Name Chave Necessário Tipo Description
Criado
 created date-time
Tipo de evento
 event_type True string
Nome
 name string

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

Devoluções

Name Caminho Tipo Description
documento
 document Document

Definições

Documento

Name Caminho Tipo Description
Api de documento usada
 api_used boolean

Indica se o documento foi criado usando a API
attachments
 attachments array of DocumentAttachment
Exclusão automática de documentos após
 auto_delete_after date-time

Data e hora calculadas após auto_delete_days as quais um documento concluído (assinado/cancelado/recusado) será automaticamente excluído
Dias de exclusão automática de documentos
 auto_delete_days integer

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

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

Número de dias após os quais um documento não concluído expirará automaticamente
Eventos do documento URL de retorno de chamada
 events_callback_url uri

URL para receber retornos de chamada de eventos para este documento
ID Externo do Documento
 external_id string

ID utilizado para referenciar documento no sistema externo
Ficheiro de Documentos
 file uri

URL temporário para o arquivo original, expira em cinco minutos
Ficheiro de documento em formato pdf
 file_as_pdf uri

URL temporário 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. Obrigatório ao usar file_from_contento .
Arquivo de 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 Frontend 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 é membro da equipe do documento
Nome do documento
 name string

O padrão é o nome do arquivo, incluindo a extensão
Documento pdf
 pdf uri

URL temporário para documento assinado como PDF, expira em cinco minutos
prefill_tags
 prefill_tags array of InlinePrefillTags

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

Indica se uma alteração no documento está sendo processada e o PDF pode estar desatualizado. Recomenda-se aguardar até que o processamento esteja concluído antes de fazer o download do PDF. Webhooks não são enviados até que o processamento tenha sido 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 de Documentos
 security_hash string

SHA256 hash de conteúdo PDF
Assinando Log Pdf
 signing_log.pdf uri

URL temporário para assinar log, expira em cinco minutos
Assinando hash de segurança do log
 signing_log.security_hash string

SHA256 hash de conteúdo PDF
Signrequest Desativar anexos
 signrequest.disable_attachments boolean

Desativar o upload/adição de anexos
Signrequest Desativar Blockchain Proof
 signrequest.disable_blockchain_proof boolean

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

Desativar a adição de datas
Signrequest Desativar e-mails
 signrequest.disable_emails boolean

Desative todos os e-mails de status do SignRequest, bem como o e-mail que contém os documentos assinados
Signrequest Desativar Texto
 signrequest.disable_text boolean

Desativar a adição de texto
Signrequest Desativar assinaturas de texto
 signrequest.disable_text_signatures boolean

Desativar o uso de assinaturas geradas pela digitação (texto)
Signrequest Desativar Carregar Assinaturas
 signrequest.disable_upload_signatures boolean

Desativar o uso de assinaturas carregadas (imagens)
Signrequest de e-mail
 signrequest.from_email email

Email do usuário que envia o SignRequest (deve ser um e-mail validado)
Signrequest do nome do e-mail
 signrequest.from_email_name string

Nome a ser usado no cabeçalho do From e-mail, por exemplo: {from_email_name} <no-reply@signrequest.com>
Signrequest está sendo preparado
 signrequest.is_being_prepared boolean

Peça ao remetente de um SignRequest que prepare o documento antes de enviar a solicitação, consulte: Preparar usando a interface da Web
Mensagem de solicitação de sinal
 signrequest.message string

A mensagem a incluir no e-mail SignRequest pode conter as seguintes tags html: a, abbr, acronym, b, blockquote, code, em, iliulolestrong
Signrequest Preparar URL
 signrequest.prepare_url uri
url de redirecionamento signrequest
 signrequest.redirect_url uri

URL para a qual SignRequest redirecionará quando um documento for assinado
url de redirecionamento signrequest recusada
 signrequest.redirect_url_declined uri

URL para a qual SignRequest redirecionará quando um documento for recusado
required_attachments
 signrequest.required_attachments array of RequiredAttachment
Signrequest Enviar Lembretes
 signrequest.send_reminders boolean

Lembre automaticamente os signatários de assinar um documento, consulte: lembretes automáticos
signatários
 signrequest.signers array of Signer
Signrequest Assunto
 signrequest.subject string

Assunto do e-mail SignRequest
Verificação de mensagem de texto Signrequest bloqueada
 signrequest.text_message_verification_locked boolean

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

m: só eu, mo: eu e os outros, o: só os outros
Estado do documento
 status string

co: convertendo, ne: novo, se: enviado, vi: visualizado, si: assinado, do: baixado, sd: assinado e baixado, ca: cancelado, de: recusado, ec: erro ao converter, es: erro ao enviar, xp: expirado
Nome da Equipa
 team.name string
Subdomínio da Equipa
 team.subdomain uri
URL da Equipa
 team.url uri
Modelo de documento
 template uri
URL do documento
 url uri
User
 user User
Documento Uuid
 uuid string

DocumentoAnexo:

Name Caminho Tipo Description
Documento Anexo ao Documento
 document uri
Ficheiro Anexo do Documento
 file uri

URL temporário para anexo de documento, expira em cinco minutos
Arquivo de anexo de documento do conteúdo
 file_from_content string

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

Nome do arquivo, incluindo extensão. Obrigatório ao usar file_from_contento .
Arquivo de anexo de 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

O padrão é o nome do arquivo, incluindo a extensão
URL do Anexo do Documento
 url uri
Anexo do documento Uuid
 uuid string

FileFromSf

Name 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é-preenchimento, consulte tags de pré-preenchimento

Name Caminho Tipo Description
Valor da caixa de seleção de tags de pré-preenchimento
 checkbox_value boolean
Pré-preenchimento Tags Valor da data
 date_value date
Etiquetas de pré-preenchimento ID externo
 external_id string
Texto das tags de pré-preenchimento
 text string

ObrigatórioAnexo

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

SignRequestQuickCreate

Name Caminho Tipo Description
Exclusão automática de dias
 auto_delete_days integer

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

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

Desativar o upload/adição de anexos
Desativar 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.
Desativar data
 disable_date boolean

Desativar a adição de datas
Desativar e-mails
 disable_emails boolean

Desative todos os e-mails de status do SignRequest, bem como o e-mail que contém os documentos assinados
Desativar texto
 disable_text boolean

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

Desativar o uso de assinaturas geradas pela digitação (texto)
Desativar assinaturas de upload
 disable_upload_signatures boolean

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

URL para receber retornos de chamada de eventos para este documento
Identificação externa
 external_id string

ID utilizado para referenciar documento no sistema externo
Ficheiro
 file uri

URL temporário 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. Obrigatório ao usar file_from_contento .
Arquivo de url
 file_from_url uri

URL acessível publicamente do documento a ser baixado pelo SignRequest
Do e-mail
 from_email email

Email do usuário que envia o SignRequest (deve ser um e-mail validado)
Do nome do e-mail
 from_email_name string

Nome a ser usado no cabeçalho do From e-mail, por exemplo: {from_email_name} <no-reply@signrequest.com>
Identificação do frontend
 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 é membro da equipe do documento
Está a ser preparado
 is_being_prepared boolean

Peça ao remetente de um SignRequest que prepare o documento antes de enviar a solicitação, consulte: Preparar usando a interface da Web
Message
 message string

A mensagem a incluir no e-mail SignRequest pode conter as seguintes tags html: a, abbr, acronym, b, blockquote, code, em, iliulolestrong
Nome
 name string

O padrão é o nome do arquivo, incluindo a extensão
prefill_tags
 prefill_tags array of InlinePrefillTags

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

URL para a qual SignRequest redirecionará quando um documento for assinado
URL de redirecionamento recusado
 redirect_url_declined uri

URL para a qual SignRequest redirecionará quando um documento for recusado
required_attachments
 required_attachments array of RequiredAttachment

Anexos que os signatários são obrigados a carregar
Enviar lembretes
 send_reminders boolean

Lembre automaticamente os signatários de assinar um documento, consulte: lembretes automáticos
signatários
 signers array of Signer
Equipa
 subdomain string
Assunto
 subject string

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

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

m: só eu, mo: eu e os outros, o: só os outros

Signatário

Name Caminho Tipo Description
Signatário após o documento
 after_document uri
Signatário Aprovar Apenas
 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 em
 declined_on date-time
Nome de exibição do signatário
 display_name string
Signatário baixado
 downloaded boolean
E-mail do signatário
 email email
E-mail do signatário visualizado
 email_viewed boolean
Signatário enviado por e-mail
 emailed boolean
URL de incorporação do signatário
 embed_url uri
ID de usuário do Signer Embed Url
 embed_url_user_id string
Nome do signatário
 first_name string
Linguagem da Força do Signatário
 force_language boolean
Signatário encaminhado
 forwarded boolean
Signatário encaminhado em
 forwarded_on date-time
Motivo encaminhado do signatário
 forwarded_reason string
Signatário encaminhado para e-mail
 forwarded_to_email email
Signatário Presencial
 in_person boolean

Quando usado em combinação com um url de incorporação no remetente, depois que o remetente assinar, eles serão redirecionados para o próximo in_person signatário, consulte: Assinatura presencial
Insumos
 inputs array of SignerInputs
Língua 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: Somente cópia
Apenas 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 tomem nenhuma ação, consulte: Notificar somente
Ordem do signatário
 order integer
Palavra-passe do signatário
 password string

Exija que o signatário insira essa senha antes de assinar um documento. Este campo é apenas de escrita.
URL de redirecionamento do signatário
 redirect_url uri
URL de redirecionamento do signatário recusado
 redirect_url_declined uri
Signatário assinado
 signed boolean
Signatário conectado
 signed_on date-time
O signatário usa o carimbo apenas para aprovar
 use_stamp_for_approve_only boolean

Colocar um carimbo de aprovação num documento quando um signatário aprova um documento
Signatário Verificar Conta Bancária
 verify_bank_account string
Signatário Verificar número de telefone
 verify_phone_number string
Signatário visualizado
 viewed boolean

SignerAttachment

Name Caminho Tipo Description
Ficheiro
 file uri
for_attachment
 for_attachment RequiredAttachment
Nome
 name string

Padrão para o nome do arquivo
Uuid
 uuid string

SignerInputs

Name Caminho Tipo Description
Valor da caixa de seleção
 checkbox_value boolean
Valor da data
 date_value date
Identificação externa
 external_id string
Índice da página
 page_index integer
Espaço reservado uuid
 placeholder_uuid string
Texto
 text string
Tipo
 type string

User

Name Caminho Tipo Description
Nome de exibição do usuário
 display_name string
Endereço de e-mail do usuário
 email email
Nome do usuário
 first_name string
Apelido do Utilizador
 last_name string