BoldSign (Pré-visualização)
O BoldSign é uma solução de assinatura eletrônica segura e fácil de usar que fornece maneiras juridicamente vinculativas de enviar, assinar e gerenciar documentos.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte BoldSign |
| URL | https://support.boldsign.com |
| support@boldsign.com |
| Metadados do conector | |
|---|---|
| Editora | Syncfusion-Inc |
| Sítio Web | https://boldsign.com/ |
| Categorias | Conteúdos e Ficheiros; Produtividade |
| Política de privacidade | https://boldsign.com/privacy-policy/ |
O BoldSign é um aplicativo de assinatura eletrônica on-line e o conector BoldSign abrange os seguintes cenários
- Um usuário pode ouvir o gatilho e enviar um documento para assinatura com base nas informações do gatilho.
- Um usuário pode ouvir um evento de documento concluído e baixar o documento PDF assinado para armazená-lo em seu armazenamento em nuvem preferido ou qualquer ação que preferir.
- Um usuário pode monitorar o status ou obter o status de um documento e executar ações com base nele, como enviar um lembrete por e-mail ou SMS através de outro serviço ou conector.
- Um usuário pode ouvir vários eventos, como enviado, falha na autenticação, recusado, expirado, etc., para executar ações com base nas informações fornecidas através do gatilho de evento.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Selecionar Região | cadeia (de caracteres) | Selecione o data center regional da BoldSign onde a conta reside |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
|
Baixar Audit |
Faça o download da trilha de auditoria de um documento concluído. |
| Descarregar documento |
Descarrega o ficheiro PDF do ID do documento fornecido. |
| Enviar documento usando modelo com destinatário |
Envie um documento para assinatura usando um modelo especificado para um destinatário. |
| Obter status do documento |
Recupera o status do documento e suas informações de um documento. |
Baixar AuditTrail
Faça o download da trilha de auditoria de um documento concluído.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Fornecer ID do documento |
|
Em nome de
|
onBehalfOf | string |
Selecione um endereço de e-mail para executar a ação em nome de outra pessoa |
Descarregar documento
Descarrega o ficheiro PDF do ID do documento fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Fornecer ID do documento |
|
Em nome de
|
onBehalfOf | string |
Selecione um endereço de e-mail para executar a ação em nome de outra pessoa |
Enviar documento usando modelo com destinatário
Envie um documento para assinatura usando um modelo especificado para um destinatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Template
|
templateId | True | string |
Selecionar modelo |
|
Modo Sandbox
|
isSandbox | True | boolean |
Quando ativado, o BoldSign enviará solicitações de assinatura no modo sandbox, permitindo que você teste a integração |
|
Título do documento
|
title | True | string |
Insira o título do documento |
|
Descrição do documento
|
message | string |
Insira a descrição do documento |
|
|
CC
|
cc | string |
Insira um ou mais endereços de e-mail separados por vírgula |
|
|
Marca
|
brandId | string |
Selecionar Marca |
|
|
Em nome de
|
onBehalfOf | string |
Selecione um endereço de e-mail para enviar em nome de outra pessoa |
|
|
Dias de validade
|
expiryDays | integer |
Indique o número de dias após os quais o documento expirará |
|
|
Etiquetas dos documentos
|
labels | string |
Fornecer um ou mais rótulos para o documento, separados por vírgulas |
|
|
Ocultar ID do documento
|
hideDocumentId | boolean |
Quando ativada, a impressão de ID ficará oculta na parte superior do documento |
|
|
Permitir impressão e assinatura
|
enablePrintAndSign | boolean |
Quando permitido, o signatário poderá imprimir e assinar o documento |
|
|
Permitir reatribuição
|
enableReassign | boolean |
Quando permitido, o signatário poderá reatribuir o documento a outras pessoas |
|
|
Ativar lembrete automático
|
enableAutoReminder | boolean |
Quando ativado, o BoldSign enviará e-mails de lembrete automáticos na frequência especificada |
|
|
Signatários
|
signers | True | dynamic |
Os signatários do documento. |
Devoluções
O objeto de resposta do modelo enviar solicitação de documento.
Obter status do documento
Recupera o status do documento e suas informações de um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Fornecer ID do documento |
Devoluções
O objeto de resposta da solicitação de propriedades do documento.
Acionadores
| Eventos Webhook |
Isso aciona o evento webhook de documentos. |
Eventos Webhook
Isso aciona o evento webhook de documentos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Selecionar Eventos Webhook
|
events | True | string |
Selecione o evento webhook para o qual o fluxo deve ser acionado. |
|
Eventos do usuário da equipe
|
adminMode | True | boolean |
Habilite essa opção para receber notificações de eventos acionados pelos membros da sua equipe. Os administradores de conta também receberão notificações para eventos em toda a organização. Se estiver desativado, receberá apenas notificações para os seus próprios eventos. |
Devoluções
Dados de eventos Webhooks.
- Body
- WebHookEventOject
Definições
SendDocumentFromTemplateResponse
O objeto de resposta do modelo enviar solicitação de documento.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
documentId | string |
A ID do documento criado. |
DocumentPropertiesResponse
O objeto de resposta da solicitação de propriedades do documento.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Estado do documento
|
status | string |
O estado e outras informações do documento |
WebHookEventOject
Dados de eventos Webhooks.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Evento
|
event.id | string |
A ID do evento |
|
Criado
|
event.created | integer |
O evento criou a hora da data |
|
Tipo de Evento
|
event.eventType | string |
O tipo de evento |
|
ID de Cliente
|
event.clientId | string |
O ID do cliente |
|
Meio Ambiente
|
event.environment | string |
O tipo de ambiente |
|
Objeto
|
data.object | string |
O tipo de objeto |
|
ID do documento
|
data.documentId | string |
O id do documento |
|
Título do documento
|
data.messageTitle | string |
O título do documento |
|
Descrição do Documento
|
data.documentDescription | string |
A descrição do documento |
|
Estado do documento
|
data.status | string |
O status do documento |
|
Nome do remetente
|
data.senderDetail.name | string |
O nome do remetente |
|
E-mail do remetente
|
data.senderDetail.emailAddress | string |
O e-mail do remetente |
|
signerDetalhes
|
data.signerDetails | array of object |
Os detalhes do signatário |
|
Nome do signatário
|
data.signerDetails.signerName | string |
O nome do signatário |
|
Função do signatário
|
data.signerDetails.signerRole | string |
A função de signatário |
|
E-mail do signatário
|
data.signerDetails.signerEmail | string |
O e-mail do signatário |
|
Código do país
|
data.signerDetails.phoneNumber.countryCode | string |
Código do país |
|
Número de Telefone
|
data.signerDetails.phoneNumber.number | string |
O número de telefone |
|
Status do signatário
|
data.signerDetails.status | string |
O status do signatário |
|
Código de acesso ativado
|
data.signerDetails.enableAccessCode | boolean |
Indica se o código de acesso está habilitado ou não |
|
Falha na autenticação
|
data.signerDetails.isAuthenticationFailed | string |
Indica se a autenticação falhou ou não |
|
OTP de e-mail ativada
|
data.signerDetails.enableEmailOTP | boolean |
Indica se a OTP de e-mail está habilitada ou não |
|
Falha na entrega
|
data.signerDetails.isDeliveryFailed | boolean |
Indica se a entrega de documentos falhou ou não |
|
Visualizado
|
data.signerDetails.isViewed | boolean |
Indica se o documento é visualizado ou não |
|
Ordem do signatário
|
data.signerDetails.order | integer |
A ordem do signatário |
|
Tipo de signatário
|
data.signerDetails.signerType | string |
O tipo de signatário |
|
Reatribuído
|
data.signerDetails.isReassigned | boolean |
Indica se o signatário foi reatribuído ou não |
|
Reatribuir mensagem
|
data.signerDetails.reassignMessage | string |
A mensagem de reatribuição |
|
Recusar mensagem
|
data.signerDetails.declineMessage | string |
A mensagem de recusa |
|
Data da Última Atividade
|
data.signerDetails.lastActivityDate | integer |
A data da última atividade |
|
Tipo de autenticação
|
data.signerDetails.authenticationType | string |
O tipo de autenticação |
|
Tipo de verificação de identidade
|
data.signerDetails.idVerification.type | string |
O tipo de verificação de identidade |
|
Contagem máxima de tentativas
|
data.signerDetails.idVerification.maximumRetryCount | integer |
A contagem máxima de tentativas |
|
Status de verificação de identidade
|
data.signerDetails.idVerification.status | string |
O status da verificação de identidade |
|
Matcher de nomes
|
data.signerDetails.idVerification.nameMatcher | string |
O tipo de correspondente de nome |
|
Captura ao vivo necessária
|
data.signerDetails.idVerification.requireLiveCapture | boolean |
Indica se a captura ao vivo é necessária ou não |
|
Selfie de correspondência necessária
|
data.signerDetails.idVerification.requireMatchingSelfie | boolean |
Indica se a selfie correspondente é necessária ou não |
|
Configuração de campo permitido
|
data.signerDetails.allowFieldConfiguration | boolean |
Indica se a configuração de campo é necessária ou não |
|
E-mails CC
|
data.ccDetails | array of |
Os endereços de e-mail cc |
|
Em nome de
|
data.onBehalfOf | string |
O em nome do e-mail |
|
Data de criação
|
data.createdDate | integer |
A data de criação do documento |
|
Data de Expiração
|
data.expiryDate | integer |
Data de validade do documento |
|
Ordem de assinatura ativada
|
data.enableSigningOrder | boolean |
Indica se a ordem de assinatura está habilitada ou não |
|
E-mails desativados
|
data.disableEmails | boolean |
Indica se os e-mails estão desativados ou não |
|
Revogar mensagem
|
data.revokeMessage | string |
A mensagem de revogação |
|
Mensagem de erro
|
data.errorMessage | string |
A mensagem de erro |
|
Rótulos / Etiquetas
|
data.labels | array of |
Os rótulos dos documentos |
|
Auditoria Combinada
|
data.isCombinedAudit | boolean |
Indica se a trilha de auditoria é combinada com o documento ou não |