Sinal de marcação (versão prévia)
Mark Sign é um serviço de assinatura eletrônica qualificado compatível com a regulamentação do eIDAS. Envie documentos para assinatura, aguarde as assinaturas, baixe e valide os arquivos assinados.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Classe | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões 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: – Azure Governamental regiões - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões 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 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 | |
|---|---|
| Name | ID de marca, UAB |
| URL | https://marksign.eu |
| pagalba@marksign.lt |
| Metadados do conector | |
|---|---|
| Publicador | ID de marca, UAB |
| Website | https://marksign.eu |
| Política de privacidade | https://marksign.eu/privacy-policy |
| Categories | Produtividade; Conteúdo e arquivos |
Marcar Sinal
Mark Sign é um serviço de assinatura eletrônica qualificado compatível com o regulamento do eIDAS. Um fluxo pode enviar um documento para assinatura, aguardar até que ele seja assinado e, em seguida, baixar o arquivo assinado e validá-lo.
Publisher: ID de marca, UAB
Prerequisites
Você precisa de um token de acesso à API do Mark Sign. Veja a obtenção de credenciais abaixo.
Operações com suporte
Documento: Carregar
Carrega um documento (PDF, ADoc, BDoc ou ASiC-E) e o prepara para assinatura. O nome do arquivo se torna o título do documento.
Assinatura: Convidar por email
Convida uma pessoa a assinar; Mark Sign envia o email de convite. Chamá-lo novamente para a mesma pessoa envia um lembrete.
Assinatura: Convidar por URL
Adiciona um signatário sem enviar um email e retorna a URL de Convite pessoal para você entregar.
Assinatura: aguarde todos os signatários
Mantém o fluxo até que o documento seja assinado ou rejeitado ou termine com o timed_out status quando o tempo de espera (29 dias por padrão) se esgotar.
Assinatura: aguarde um signatário
Mantém o fluxo até que um signatário específico, escolhido por email, assine. Qualquer rejeição também encerra a espera.
Assinatura: aguarde o próximo signatário
Retoma o fluxo no momento em que o próximo signatário assina ou rejeita, sem sondagem.
Documento: Obter status
Verifica o status geral de assinatura do documento.
Documento: Obter signatários
Lista o status de cada signatário, incluindo o motivo da rejeição se um signatário for rejeitado.
Documento: Baixar
Baixa o documento com todas as assinaturas coletadas até agora.
Documento: Listar
Lista os documentos em seu workspace, com pesquisa e paginação de texto.
Documento: Remover
Remove um documento do workspace.
Documento: Carregar como contêiner
Combina vários arquivos em um documento de contêiner que pode ser assinado (ADoc, BDoc ou ASiC-E). A cobrança segue o padrão do Sinal de Marca, em que cada signatário paga.
Assinatura: Criar links de signatário
Cria um link de assinatura pessoal para cada signatário, para entregar a si mesmo. Os links expiram, podem exigir a verificação de identidade e são as únicas páginas de assinatura com uma opção de rejeição.
Assinatura: Criar link compartilhado
Cria um link que qualquer pessoa pode abrir para assinar os documentos, cada um sob sua própria identidade verificada.
Assinatura: Excluir link
Exclui um link do signatário ou um link compartilhado antes de expirar.
Documento: Estender a validade da assinatura
Atualiza as assinaturas de documento para LT (validade de longo prazo) ou LTA (arquivamento de longo prazo).
Documento: Validar
Verifica as assinaturas de um documento e retorna o relatório de validação completo.
Obtendo credenciais
Entre em contato com o suporte pagalba@marksign.lt ao cliente do Mark Sign para solicitar um token de acesso à API para seu workspace. Ao criar uma conexão no Power Automate, cole o token no campo "Chave de API".
O token está vinculado a um workspace, portanto, cada documento criado ou listado por meio da conexão pertence a esse workspace.
Introdução
O fluxo de assinatura mais simples:
- Documento: Carregar (por exemplo, o conteúdo do arquivo e os tokens de nome de SharePoint ou OneDrive).
- Assinatura: Convidar por email. Marque um email para o convite.
- Assinatura: aguarde o próximo signatário. O fluxo pausa aqui até que a assinatura aconteça.
- Documento: baixe-o e armazene-o onde precisar.
Com vários signatários, use Assinatura: Convidar por email para cada pessoa e, em seguida, uma assinatura: aguarde a etapa de todos os signatários antes do download. Para entregar os links por conta própria em vez de marcar emails, use Assinatura: Convidar por URL ou Assinatura: Crie links de signatário e envie a cada pessoa seu link com sua própria ação Outlook ou do Teams.
Problemas e limitações conhecidos
- O conector não fornece gatilhos de fluxo; em vez disso, use as operações de espera dentro de um fluxo.
- Um documento tem um registro de notificação. Não execute duas Assinaturas: aguarde as próximas etapas do signatário no mesmo documento ao mesmo tempo. O segundo substitui o primeiro e a primeira etapa aguarda até atingir o tempo limite. Preencher um campo url de retorno de chamada em qualquer bloco também substitui o registro.
- Os signatários podem rejeitar um documento somente em uma página Assinatura: Criar links do signatário (com o Botão Mostrar Rejeitar ativado); convites de email, URLs de convite e links compartilhados não oferecem nenhuma opção de rejeição.
- Mark Sign notifica apenas sobre assinaturas. Quando um bloco de convite usa uma Finalidade ou
reviewconfirmation, a ação dessa pessoa nunca ativa a Assinatura: aguarde o próximo signatário; verifique seu status com Documento: Obter signatários . - Documento: O download retorna apenas o conteúdo do arquivo; tire o nome do arquivo do Documento: Listar ou da etapa de upload.
- Uma execução de fluxo pode durar no máximo 30 dias (um limite de Power Automate), portanto, nenhuma espera pode sobreviver a isso.
Assinatura: aguarde todos os signatários e assinatura: aguarde até que um signatário termine com o
timed_outstatus após 29 dias por padrão. Para Assinatura: aguarde o próximo signatário, defina um Tempo limite (por exemploP29D) nas configurações de ação e adicione um branch configurado para ser executado após o tempo limite da ação. Se o limite de execução de 30 dias atingir primeiro, Power Automate cancelará toda a execução e nenhuma ramificação o manipulará. - Documento: A lista não dá suporte à filtragem por status.
- Documento: o upload aceita um arquivo por chamada; loop sobre anexos para carregar vários. Documento: Carregar como contêiner destina-se a alguns arquivos; a combinação de muitos arquivos grandes em uma chamada pode exceder o limite de tempo de processamento.
Instruções de implantação
Execute paconn create --api-prop apiProperties.json --api-def apiDefinition.swagger.json --script script.csx --icon icon.png para implantar esse conector como um conector personalizado em seu ambiente do Power Platform. Consulte a documentação da paconn para obter detalhes.
Suporte
Para problemas com o conector ou a API de Sinal de Marca, entre em contato pagalba@marksign.lt.
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.
| Name | Tipo | Description | Required |
|---|---|---|---|
| Chave de API | secureString | O token de acesso à API de Sinal de Marca do seu workspace. Solicite um do suporte ao Mark Sign em pagalba@marksign.lt. | True |
Ações
| Assinatura: aguarde o próximo signatário |
Aguarda até que o próximo signatário assine ou rejeite o documento, sem enviar convites. Use-o em um loop para esperar por vários signatários sem sondagem. |
| Assinatura: aguarde todos os signatários |
Aguarda até que cada signatário tenha assinado ou alguém rejeitou o documento e, em seguida, permite que o fluxo continue. Termina com o status timed_out quando o tempo se esgota. |
| Assinatura: aguarde um signatário |
Aguarda até que um signatário específico assine o documento e, em seguida, permite que o fluxo continue. Termina com o status timed_out quando o tempo se esgota. |
| Assinatura: Convidar por email |
Convida uma pessoa a assinar o documento. Mark Sign envia o convite por email. |
| Assinatura: Convidar por URL |
Adiciona um signatário ao documento sem enviar um email e retorna o link de convite pessoal para você entregar. O link não expira e não pode ser excluído; use "Assinatura: criar links do signatário" quando precisar de links que você possa revogar. |
| Assinatura: Criar link compartilhado |
Cria um link de assinatura que qualquer pessoa pode abrir para assinar os documentos. Você mesmo entrega. |
| Assinatura: Criar links de signatário |
Cria um link de assinatura pessoal para cada signatário. Você mesmo entrega os links, por exemplo, por email ou mensagem do Teams. |
| Assinatura: Excluir link |
Exclui um link do signatário ou um link compartilhado antes de expirar. Os links de convite não podem ser excluídos. |
| Documento: Baixar |
Baixa o documento com todas as assinaturas coletadas até agora. |
| Documento: Carregar |
Carrega um documento e o prepara para assinatura. |
| Documento: Carregar como contêiner |
Combina vários arquivos em um documento de contêiner que pode ser assinado, como um ADoc ou ASiC-E. Os arquivos são carregados e combinados em uma única etapa. |
| Documento: Estender a validade da assinatura |
Atualiza as assinaturas de documento para validade ou arquivamento de longo prazo. |
| Documento: Listar |
Lista os documentos em seu workspace, o mais recente primeiro. |
| Documento: Obter signatários |
Lista os signatários de um documento com seu status de assinatura. |
| Documento: Obter status |
Obtém o status de assinatura de um documento. |
| Documento: Remover |
Remove um documento do workspace. |
| Documento: Validar |
Verifica as assinaturas de um documento e retorna o relatório de validação. O fluxo aguarda até que a verificação seja concluída. |
Assinatura: aguarde o próximo signatário
Aguarda até que o próximo signatário assine ou rejeite o documento, sem enviar convites. Use-o em um loop para esperar por vários signatários sem sondagem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
Retornos
- Body
- SigningEvent
Assinatura: aguarde todos os signatários
Aguarda até que cada signatário tenha assinado ou alguém rejeitou o documento e, em seguida, permite que o fluxo continue. Termina com o status timed_out quando o tempo se esgota.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
|
Tempo limite (Minutos)
|
timeout_minutes | integer |
Quanto tempo esperar, em minutos, antes de terminar com o status timed_out. O padrão é 41760 (29 dias), o máximo é 43200 (30 dias). |
Retornos
- Body
- SigningWaitResponse
Assinatura: aguarde um signatário
Aguarda até que um signatário específico assine o documento e, em seguida, permite que o fluxo continue. Termina com o status timed_out quando o tempo se esgota.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
|
Email do signatário
|
signer_email | True | string |
O email do signatário a ser aguardado, o mesmo email usado ao convidá-los. |
|
Tempo limite (Minutos)
|
timeout_minutes | integer |
Quanto tempo esperar, em minutos, antes de terminar com o status timed_out. O padrão é 41760 (29 dias), o máximo é 43200 (30 dias). |
Retornos
- Body
- SigningWaitResponse
Assinatura: Convidar por email
Convida uma pessoa a assinar o documento. Mark Sign envia o convite por email.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
|
Primeiro nome
|
name | True | string |
O nome do signatário. |
|
Apelido
|
surname | True | string |
O sobrenome do signatário. |
|
Email
|
True |
O endereço de email do signatário. |
||
|
Linguagem
|
language | string |
O idioma do convite. O padrão é lituano. |
|
|
URL de êxito
|
success_url | string |
Para onde enviar o signatário depois que eles terminarem de assinar. |
|
|
Purpose
|
purpose | string |
Por que a pessoa é convidada. Escolha examinar para convidar somente para exibição. |
|
|
URL de Callback
|
callback_url | string |
Uma URL a ser notificada quando o documento for assinado. |
Retornos
- Body
- AcknowledgedResponse
Assinatura: Convidar por URL
Adiciona um signatário ao documento sem enviar um email e retorna o link de convite pessoal para você entregar. O link não expira e não pode ser excluído; use "Assinatura: criar links do signatário" quando precisar de links que você possa revogar.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
|
Primeiro nome
|
name | True | string |
O nome do signatário. |
|
Apelido
|
surname | True | string |
O sobrenome do signatário. |
|
Email
|
True |
O endereço de email do signatário. |
||
|
URL de êxito
|
success_url | string |
Para onde enviar o signatário depois que eles terminarem de assinar. |
|
|
Purpose
|
purpose | string |
Por que a pessoa é convidada. Escolha examinar para convidar somente para exibição. |
|
|
URL de Callback
|
callback_url | string |
Uma URL a ser notificada quando o documento for assinado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
URL de convite
|
data.invitation_url | string |
O link da página de assinatura pessoal a ser entregue ao signatário. |
Assinatura: Criar link compartilhado
Cria um link de assinatura que qualquer pessoa pode abrir para assinar os documentos. Você mesmo entrega.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de documento
|
documents | True | array of string |
Os documentos que o link assina. Use valores de ID do Documento das etapas de upload ou lista. |
|
URL de Callback
|
callback_url | string |
Uma URL a ser notificada quando o documento for assinado. |
|
|
Expirar após (minutos)
|
expire_after | integer |
Minutos até que o link expire. O padrão é 2880 (dois dias). |
|
|
Excluir documento após (minutos)
|
delete_document_after | integer |
Minutos até que o documento seja excluído do workspace. Por padrão, ele é mantido. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
Link de Assinatura
|
data.signing_link | string |
O link que qualquer pessoa pode abrir para assinar. |
|
ID do link de assinatura
|
data.signing_link_id | string |
A ID do link, para "Assinatura: Excluir link". |
|
Válido até
|
data.valid_until | integer |
Quando o link expira, como um carimbo de data/hora unix. |
Assinatura: Criar links de signatário
Cria um link de assinatura pessoal para cada signatário. Você mesmo entrega os links, por exemplo, por email ou mensagem do Teams.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de documento
|
documents | True | array of string |
Os documentos para os qual criar links de assinatura. Use valores de ID do Documento das etapas de upload ou lista. |
|
ID do signatário
|
id | string |
Sua própria ID para o signatário, exclusiva dentro da solicitação. Necessário quando o email está vazio. |
|
|
Primeiro nome
|
name | string |
O nome do signatário. |
|
|
Apelido
|
surname | string |
O sobrenome do signatário. |
|
|
Email
|
O endereço de email do signatário. Necessário quando a ID do Signatário estiver vazia. |
|||
|
Código Pessoal
|
personal_code | string |
O código pessoal do signatário. Necessário quando a autenticação é necessária. |
|
|
Exigir autenticação
|
authentication_required | boolean |
Se sim, o signatário deverá verificar sua identidade antes de abrir o link. |
|
|
Posição (somente ADoc)
|
position | string |
A posição de trabalho do signatário, mostrada nas assinaturas do ADoc. |
|
|
Departamento (somente ADoc)
|
structural_subdivision | string |
O departamento do signatário, mostrado em assinaturas do ADoc. |
|
|
Finalidade de assinatura (somente ADoc)
|
signing_purpose | string |
Por que a pessoa assina, mostradas em assinaturas do ADoc. |
|
|
URL de Callback
|
callback_url | string |
Uma URL a ser notificada quando o documento for assinado. |
|
|
URL de Retorno de Chamada de Rejeição
|
reject_callback_url | string |
Uma URL a ser notificada quando um signatário rejeitar o documento. |
|
|
Expirar após (minutos)
|
expire_after | integer |
Minutos até que o link expire. O padrão é 2880 (dois dias). |
|
|
Mostrar botão de rejeição
|
show_reject_button | boolean |
Se os signatários podem rejeitar o documento na página de assinatura. O padrão é sim. |
|
|
Excluir documento após (minutos)
|
delete_document_after | integer |
Minutos até que o documento seja excluído do workspace. Por padrão, ele é mantido. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
Links de assinatura:
|
temporary_signing_links | array of object |
Um link de assinatura por signatário. |
|
ID do signatário
|
temporary_signing_links.id | string |
Sua própria ID para o signatário. |
|
Primeiro nome
|
temporary_signing_links.member_name | string |
O nome do signatário. |
|
Apelido
|
temporary_signing_links.member_surname | string |
O sobrenome do signatário. |
|
Email
|
temporary_signing_links.member_email | string |
O endereço de email do signatário. |
|
Link de Assinatura
|
temporary_signing_links.temporary_signing_link | string |
O link que o signatário abre para assinar o documento. |
|
ID do link de assinatura
|
temporary_signing_links.temporary_signing_link_id | string |
A ID do link de assinatura. |
|
Válido até
|
temporary_signing_links.valid_until | integer |
Quando o link expira, como um carimbo de data/hora unix. |
|
Documentos:
|
documents | array of object |
Os documentos para os qual os links foram criados. |
|
ID do documento
|
documents.uuid | string |
A ID do documento. |
|
Nome do arquivo
|
documents.filename | string |
O nome do arquivo de documento. |
Assinatura: Excluir link
Exclui um link do signatário ou um link compartilhado antes de expirar. Os links de convite não podem ser excluídos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do link de assinatura
|
temporarySigningLinkId | True | string |
A ID do Link de Assinatura da saída de "Assinatura: Criar links do signatário" ou "Assinatura: Criar link compartilhado". |
Retornos
- Body
- AcknowledgedResponse
Documento: Baixar
Baixa o documento com todas as assinaturas coletadas até agora.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
Retornos
O conteúdo do arquivo de documento.
- Conteúdo do arquivo
- file
Documento: Carregar
Carrega um documento e o prepara para assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do arquivo
|
file_name | True | string |
O nome do arquivo com sua extensão, por exemplo, contract.pdf. Ele se torna o título do documento. |
|
body
|
body | True | binary | |
|
Access
|
access | string |
Quem pode exibir o documento. O padrão é privado. |
|
|
Tipo de cobrança
|
billing_type | True | string |
Quem paga pelas assinaturas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
ID do documento
|
data.uuid | string |
A ID do documento. |
|
Nome do arquivo
|
data.filename | string |
O nome do arquivo. |
Documento: Carregar como contêiner
Combina vários arquivos em um documento de contêiner que pode ser assinado, como um ADoc ou ASiC-E. Os arquivos são carregados e combinados em uma única etapa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de documento
|
document_type | True | string |
O tipo de documento a ser criado. |
|
Nome do arquivo
|
file_name | True | string |
O nome do arquivo com sua extensão, por exemplo, contract.pdf. |
|
Conteúdo do arquivo
|
file_content | True | byte |
O conteúdo do ficheiro. |
|
Tipo de arquivo (somente ADoc)
|
adoc_file_type | string |
A função do arquivo no contêiner. Usado somente quando o tipo de documento é um ADoc. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
ID do documento
|
data.uuid | string |
A ID do documento. |
|
Nome do arquivo
|
data.filename | string |
O nome do arquivo de documento. |
Documento: Estender a validade da assinatura
Atualiza as assinaturas de documento para validade ou arquivamento de longo prazo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
|
Nível
|
level | True | string |
LT para validade de longo prazo, LTA para arquivamento de longo prazo. |
Retornos
- Body
- AcknowledgedResponse
Documento: Listar
Lista os documentos em seu workspace, o mais recente primeiro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisa
|
query | string |
Uma frase a ser pesquisada em títulos de documento e nomes de arquivo. |
|
|
Compensação
|
offset | integer |
Quantos documentos ignorar. |
|
|
Limit
|
limit | integer |
Quantos documentos devem ser retornados. O valor padrão é 10. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
Documentos:
|
data | array of object |
Os documentos. |
|
ID do documento
|
data.uuid | string |
A ID do documento. |
|
Nome do arquivo
|
data.filename | string |
O nome do arquivo. |
|
Status do documento
|
data.status | string |
O status de assinatura do documento, como salvo (aguardando assinaturas), signed_partially ou assinado. |
|
Carregado em
|
data.uploaded_at | date-time |
Quando o documento foi carregado. |
|
Total
|
total | integer |
O número total de documentos correspondentes. |
Documento: Obter signatários
Lista os signatários de um documento com seu status de assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
Signatários:
|
data | array of object |
Os signatários do documento. |
|
ID do signatário
|
data.id | string |
A ID do signatário. |
|
Primeiro nome
|
data.name | string |
O nome do signatário. |
|
Apelido
|
data.surname | string |
O sobrenome do signatário. |
|
Email
|
data.email | string |
O endereço de email do signatário. |
|
Status de Assinatura
|
data.status | string |
Se o signatário assinou: pendente, assinada, rejeitada, revisão, confirmada, negada ou revisada. |
|
Motivo da rejeição
|
data.rejection_reason | string |
O motivo pelo qual o signatário deu ao rejeitar o documento. |
Documento: Obter status
Obtém o status de assinatura de um documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
Status do documento
|
data.document_status | string |
O status de assinatura: salvo (aguardando assinaturas), signed_partially (alguns assinaram) ou assinados (todos assinaram). |
Documento: Remover
Remove um documento do workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
Retornos
- Body
- AcknowledgedResponse
Documento: Validar
Verifica as assinaturas de um documento e retorna o relatório de validação. O fluxo aguarda até que a verificação seja concluída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento, da saída de "Documento: Carregar", "Documento: Carregar como contêiner" ou "Documento: Lista". |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
|
É válido
|
data.document.is_valid | boolean |
Se as assinaturas de documento são válidas. |
|
Válido até
|
data.document.valid_to | string |
Por quanto tempo o documento permanece válido. |
|
Nome do documento
|
data.document.name | string |
O título do documento. |
|
Tipo MIME
|
data.document.mimetype | string |
O tipo de arquivo do documento. |
|
Assinaturas:
|
data.signatures | array of object |
O resultado de cada assinatura. |
|
ID da Assinatura
|
data.signatures.id | string |
A ID da assinatura. |
|
Hora de assinatura
|
data.signatures.signing_time | string |
Quando a assinatura foi feita. |
|
Formato de assinatura
|
data.signatures.signature_format | string |
O formato da assinatura. |
|
É válido
|
data.signatures.is_valid | boolean |
Se a assinatura é válida. |
|
Válido até
|
data.signatures.valid_to | string |
Por quanto tempo a assinatura permanece válida. |
|
Certificados
|
data.certificates | array of object |
Os certificados usados pelas assinaturas. |
|
items
|
data.certificates | object | |
|
Marcas de tempo
|
data.timestamps | array of object |
Os carimbos de data/hora aplicados ao documento. |
|
items
|
data.timestamps | object | |
|
Tempo de validação
|
metadata.validation_time | string |
Quando a validação foi executada. |
Definições
SigningEvent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
uuid | string |
A ID do documento. |
|
Status do documento
|
status | string |
O status de assinatura do documento, como assinado ou signed_partially. Uma rejeição mostra os status do signatário. |
|
Contagem de signatários
|
members_count | integer |
Quantas pessoas foram convidadas a assinar. |
|
Contagem assinada
|
signed_members_count | integer |
Quantas pessoas assinaram. |
|
Signatários:
|
members | array of object |
Todos convidados a assinar. |
|
ID do signatário
|
members.id | string |
A ID do signatário. |
|
Primeiro nome
|
members.member_name | string |
O nome do signatário. |
|
Apelido
|
members.member_surname | string |
O sobrenome do signatário. |
|
Email
|
members.member_email | string |
O endereço de email do signatário. |
|
Status de Assinatura
|
members.status | string |
O status do signatário, como pendente, assinado ou rejeitado. |
AcknowledgedResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | RequestStatus |
O status da solicitação. |
SigningWaitResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status do documento
|
document_status | string |
Como a espera terminou: assinada, rejeitada ou timed_out. |
|
Rejeitado por
|
rejected_by | string |
Quem rejeitou o documento, se ele foi rejeitado. |
|
Motivo da rejeição
|
rejection_reason | string |
O motivo pelo qual o signatário deu, se o documento foi rejeitado. |
RequestStatus
arquivo
Esse é o tipo de dados básico 'file'.