BoldSign (versão prévia)
BoldSign é uma solução de assinatura eletrônica segura e fácil de usar que fornece maneiras legalmente vinculativas de enviar, assinar e gerenciar documentos.
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 | |
|---|---|
| Nome | Suporte ao BoldSign |
| URL | https://support.boldsign.com |
| support@boldsign.com |
| Metadados do conector | |
|---|---|
| Publicador | Syncfusion-Inc |
| Site | https://boldsign.com/ |
| Categorias | Conteúdo e arquivos; Produtividade |
| Política de privacidade | https://boldsign.com/privacy-policy/ |
BoldSign é um aplicativo de assinatura eletrônico online e o conector BoldSign aborda os cenários a seguir
- Um usuário pode escutar o gatilho e enviar um documento para assinatura com base nas informações do gatilho.
- Um usuário pode escutar um evento concluído de documento e baixar o documento PDF assinado para armazená-lo em seu armazenamento em nuvem preferido ou em 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 email ou SMS por meio de outro serviço ou conector.
- Um usuário pode escutar vários eventos, como enviado, falha na autenticação, recusada, expirado etc. para executar ações com base nas informações fornecidas por meio do gatilho de evento.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 | Selecione o data center regional boldSign onde a conta reside |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
|
Baixar Audit |
Baixe a trilha de auditoria de um documento concluído. |
| Baixar Documento |
Baixa o arquivo PDF da ID do documento fornecida. |
| Enviar documento usando o modelo com o 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
Baixe a trilha de auditoria de um documento concluído.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Fornecer ID do documento |
|
Em nome de
|
onBehalfOf | string |
Selecione um endereço de email para executar a ação em nome de outra pessoa |
Baixar Documento
Baixa o arquivo PDF da ID do documento fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Fornecer ID do documento |
|
Em nome de
|
onBehalfOf | string |
Selecione um endereço de email para executar a ação em nome de outra pessoa |
Enviar documento usando o modelo com o destinatário
Envie um documento para assinatura usando um modelo especificado para um destinatário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Template
|
templateId | True | string |
Selecionar Modelo |
|
Modo de área restrita
|
isSandbox | True | boolean |
Quando habilitado, o BoldSign enviará solicitações de assinatura no modo de área restrita, 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 |
Inserir descrição do documento |
|
|
CC
|
cc | string |
Insira um ou mais endereços de email separados por vírgula |
|
|
Marca
|
brandId | string |
Selecionar Marca |
|
|
Em nome de
|
onBehalfOf | string |
Selecione um endereço de email para enviar em nome de outra pessoa |
|
|
Dias de expiração
|
expiryDays | integer |
Forneça o número de dias após o qual o documento expirará |
|
|
Rótulos de documentos
|
labels | string |
Forneça um ou mais rótulos para o documento, separados por vírgulas |
|
|
Ocultar ID do documento
|
hideDocumentId | boolean |
Quando habilitada, a marca de ID ficará oculta na parte superior do documento |
|
|
Permitir impressão e sinal
|
enablePrintAndSign | boolean |
Quando permitido, o signatário poderá imprimir e assinar o documento |
|
|
Permitir reatribuir
|
enableReassign | boolean |
Quando permitido, o signatário poderá reatribuir o documento para outras pessoas |
|
|
Habilitar o lembrete automático
|
enableAutoReminder | boolean |
Quando habilitado, o BoldSign enviará emails de lembrete automatizados na frequência especificada |
|
|
Signatários
|
signers | True | dynamic |
Os signatários do documento. |
Retornos
O objeto de resposta do modelo envia solicitação de documento.
Obter status do documento
Recupera o status do documento e suas informações de um documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Fornecer ID do documento |
Retornos
O objeto de resposta da solicitação de propriedades do documento.
Gatilhos
| Eventos de webhook |
Isso dispara o evento de webhook de documentos. |
Eventos de webhook
Isso dispara o evento de webhook de documentos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Selecionar eventos de webhook
|
events | True | string |
Selecione o evento de webhook para o qual o fluxo deve ser disparado. |
|
Eventos do usuário da equipe
|
adminMode | True | boolean |
Habilite essa opção para receber notificações de eventos disparados pelos membros da equipe. Os administradores de conta também receberão notificações para eventos em toda a organização. Se estiver desabilitado, você receberá apenas notificações para seus próprios eventos. |
Retornos
Dados de eventos de webhooks.
- Corpo
- WebHookEventOject
Definições
SendDocumentFromTemplateResponse
O objeto de resposta do modelo envia solicitação de documento.
| Nome | 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.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status do documento
|
status | string |
O status e outras informações do documento |
WebHookEventOject
Dados de eventos de webhooks.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Evento
|
event.id | string |
A ID do evento |
|
Criado
|
event.created | integer |
A hora da data criada pelo evento |
|
Tipo de evento
|
event.eventType | string |
O tipo do evento |
|
ID do cliente
|
event.clientId | string |
O ID do cliente |
|
Ambiente
|
event.environment | string |
O tipo de ambiente |
|
Object
|
data.object | string |
O tipo de objeto |
|
ID do documento
|
data.documentId | string |
A 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 |
|
Status do documento
|
data.status | string |
O status do documento |
|
Nome do remetente
|
data.senderDetail.name | string |
O nome do remetente |
|
Email do remetente
|
data.senderDetail.emailAddress | string |
O email do remetente |
|
signerDetails
|
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 de signatário
|
data.signerDetails.signerRole | string |
A função de signatário |
|
Email do signatário
|
data.signerDetails.signerEmail | string |
O email do signatário |
|
Código do país
|
data.signerDetails.phoneNumber.countryCode | string |
O 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 habilitado
|
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 Email Habilitado
|
data.signerDetails.enableEmailOTP | boolean |
Indica se o OTP de email está habilitado ou não |
|
Falha na entrega
|
data.signerDetails.isDeliveryFailed | boolean |
Indica se a entrega de documentos falhou ou não |
|
Exibido
|
data.signerDetails.isViewed | boolean |
Indica se o documento foi exibido 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ída
|
data.signerDetails.isReassigned | boolean |
Indica se o signatário foi reatribuído ou não |
|
Reatribuir mensagem
|
data.signerDetails.reassignMessage | string |
A mensagem de reatribuir |
|
Mensagem de declínio
|
data.signerDetails.declineMessage | string |
A mensagem de declínio |
|
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 repetições
|
data.signerDetails.idVerification.maximumRetryCount | integer |
A contagem máxima de repetição |
|
Status da verificação de identidade
|
data.signerDetails.idVerification.status | string |
O status de verificação de identidade |
|
Correspondente de Nome
|
data.signerDetails.idVerification.nameMatcher | string |
O tipo de correspondente de nome |
|
Captura dinâmica necessária
|
data.signerDetails.idVerification.requireLiveCapture | boolean |
Indica se a captura dinâmica é necessária ou não |
|
Selfie correspondente necessária
|
data.signerDetails.idVerification.requireMatchingSelfie | boolean |
Indica se a selfie correspondente é necessária ou não |
|
Configuração de campo permitida
|
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 email cc |
|
Em nome de
|
data.onBehalfOf | string |
O em nome do email |
|
Data de criação
|
data.createdDate | integer |
A data de criação do documento |
|
Data de vencimento
|
data.expiryDate | integer |
A data de expiração do documento |
|
Ordem de assinatura habilitada
|
data.enableSigningOrder | boolean |
Indica se a ordem de assinatura está habilitada ou não |
|
Emails desabilitados
|
data.disableEmails | boolean |
Indica se os emails estão desabilitados 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
|
data.labels | array of |
Os rótulos do documento |
|
Auditoria combinada
|
data.isCombinedAudit | boolean |
Indica se a trilha de auditoria é combinada com o documento ou não |