Sinal de Marca (Pré-visualização)

Mark Sign é um serviço qualificado de assinatura eletrónica em conformidade com a regulamentação eIDAS. Envie os documentos para assinatura, espere pelas assinaturas, descarregue e valide os ficheiros assinados.

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

Service Classe Regiões
Estúdio Copiloto Premium Todas as regiões Power Automate 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 Azure Government
     - 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 (CCG)
     - 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 (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contact
Name ID de marca, UAB
URL https://marksign.eu
Email pagalba@marksign.lt
Metadados do conector
Publisher ID de marca, UAB
Website https://marksign.eu
Política de privacidade https://marksign.eu/privacy-policy
Categories Produtividade; Conteúdo e Ficheiros

Sinal de Marca

Mark Sign é um serviço qualificado de assinatura eletrónica em conformidade com o regulamento eIDAS. Um fluxo pode enviar um documento para assinatura, esperar até ser assinado, depois descarregar o ficheiro assinado e validá-lo.

Publisher: Mark ID, UAB

Prerequisites

Precisas de um token de acesso à API Mark Sign. Consulte Obtenção de Credenciais abaixo.

Operações suportadas

Documento: Upload

Carrega um documento (PDF, ADoc, BDoc ou ASiC-E) e prepara-o para assinatura. O nome do ficheiro torna-se o título do documento.

Sessão de autógrafos: Convite por email

Convida uma pessoa a assinar; Mark Sign envia o email de convite. Chamar novamente para a mesma pessoa envia um lembrete.

Assinatura: Convite por URL

Adiciona um signatário sem enviar um email e devolve o URL de convite pessoal para que entregues.

Assinaturas: Esperar por todos os signatários

Mantém o processo até o documento ser assinado ou rejeitado, ou termina com o timed_out estado quando o tempo de espera (29 dias por defeito) termina.

Assinatura: Esperar por um signatário

Mantém o fluxo até que um signatário em particular, escolhido por email, assine. Qualquer rejeição também termina a espera.

Assinatura: Esperar pelo próximo signatário

Retoma o fluxo no momento em que o próximo signatário assina ou rejeita, sem sondagens.

Documentar: Obter o estado

Verifica o estado geral de assinatura do documento.

Documentar: Obtenha signatários

Lista o estado de cada signatário, incluindo o motivo da rejeição caso tenha sido rejeitado.

Documentar: Descarregar

Descarrega o documento com todas as assinaturas recolhidas até ao momento.

Documento: Lista

Lista os documentos no seu espaço de trabalho, com pesquisa de texto e paginação.

Documentar: Remover

Remove um documento do espaço de trabalho.

Documentar: Carregar como contentor

Combina vários ficheiros num único documento contentor assinável (ADoc, BDoc ou ASiC-E). A faturação segue o padrão de Marcação de Sinal, onde cada signatário paga.

Cria um link de assinatura pessoal para cada signatário, para se entregarem por si próprio. Os links expiram, podem exigir verificação de identidade e são as únicas páginas de assinatura com opção de rejeição.

Cria um link que qualquer pessoa pode abrir para assinar os documentos, cada um sob a sua própria identidade verificada.

Apaga um link de assinante ou um link partilhado antes de expirar.

Documento: Estender a validade da assinatura

Atualiza as assinaturas dos documentos para validade a longo prazo (LT) ou arquivamento a longo prazo (LTA).

Documentar: Validar

Verifica as assinaturas de um documento e devolve o relatório completo de validação.

Obtenção de credenciais

Contacte o apoio ao cliente da Mark Sign para pagalba@marksign.lt solicitar um token de acesso à API para o seu espaço de trabalho. Ao criar uma ligação no Power Automate, cole o token no campo "API Key".

O token está ligado a um espaço de trabalho, por isso todos os documentos criados ou listados através da ligação pertencem a esse espaço de trabalho.

Introdução

O fluxo de assinaturas mais simples:

  1. Documentar: Carregar (por exemplo, o conteúdo do ficheiro e os tokens de nome do SharePoint ou OneDrive).
  2. Sessão de autógrafos: Convite por email. Mark Sign envia o convite por email.
  3. Sessão de autógrafos: Espere pelo próximo signatário. O fluxo pausa aqui até acontecer a sessão de autógrafos.
  4. Documentar: Descarrega e guarda onde precisares.

Com vários signatários, use Assinatura: Convite por email para cada pessoa, depois um Assinatura: Espere pelo passo de todos os signatários antes do download. Para entregar os links você próprio em vez de emails do Mark Sign, use Assinar: Convidar por URL ou Assinar: Crie links de assinantes e envie a cada pessoa o seu link com a sua própria ação no Outlook ou Teams.

Problemas conhecidos e limitações

  • O conector não fornece gatilhos de fluxo; utilize as operações de espera dentro de um fluxo em vez disso.
  • Um documento tem um registo de notificação. Não execute duas assinaturas: Aguarde os próximos passos do signatário no mesmo documento ao mesmo tempo. O segundo substitui o primeiro, e o primeiro passo espera até expirar. Preencher um campo URL de Callback em qualquer bloco também substitui o registo.
  • Os signatários só podem rejeitar um documento numa página de Assinatura: Criar links de signatário (com o botão Mostrar Rejeitar ativado); convites por email, URLs de convite e links partilhados não oferecem opção de rejeição.
  • O Mark Sign notifica apenas sobre assinaturas. Quando um bloco de convite usa um Propósito de review ou confirmation, a ação dessa pessoa nunca desperta Assinatura: Espere pelo próximo signatário; verifique o seu estado com Documentar: Obter assinantes em vez disso.
  • Document: Download devolve apenas o conteúdo do ficheiro; escolha o nome do ficheiro de Document: List ou do seu passo de upload.
  • Uma corrida de fluxo pode durar no máximo 30 dias (um limite do Power Automate), por isso nenhuma espera pode durar mais do que isso. Assinatura: Esperar por todos os signatários e Assinatura: Esperar que um signatário termine com o timed_out estado após 29 dias por defeito. Para assinatura: Espere pelo próximo signatário, defina um Timeout (por exemploP29D) nas definições da ação e adicione um ramo configurado para correr depois de a ação expirar. Se o limite de 30 dias de execução atingir primeiro, o Power Automate cancela toda a execução e nenhum ramo a trata.
  • Documento: A lista não suporta filtragem por estado.
  • Documento: O upload aceita um ficheiro por chamada; faz loop sobre anexos para carregar vários. Documento: O upload como contentor destina-se a alguns ficheiros; combinar muitos ficheiros grandes numa só 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 implementar este conector como um conector personalizado no seu ambiente Power Platform. Consulte a documentação do Paconn para mais detalhes.

Suporte

Para problemas com o conector ou a API Mark Sign, contacte pagalba@marksign.lt.

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.

Name Tipo Description Required
Chave de API securestring O token de acesso Mark Sign API do seu espaço de trabalho. Solicite um ao apoio da Mark Sign em pagalba@marksign.lt. True

Ações

Assinar: Apagar o link

Apaga um link de assinante ou um link partilhado antes de expirar. Os links de convite não podem ser eliminados.

Assinatura: Convite por URL

Adiciona um signatário ao documento sem enviar um email e devolve o link do convite pessoal para que entregues. O link não expira e não pode ser eliminado; use "Assinar: Criar links de signatários" quando precisar de links que possa revogar.

Assinatura: Criar ligação partilhada

Cria um único link de assinatura que qualquer pessoa pode abrir para assinar os documentos. Entregas tu mesmo.

Assinatura: Crie links para signatários

Cria um link de assinatura pessoal para cada signatário. Tu próprio entregas os links, por exemplo por email ou mensagem no Teams.

Assinatura: Esperar pelo próximo signatário

Espera até que o próximo signatário assine ou rejeite o documento, sem enviar qualquer convite. Usa-o num ciclo para esperar por vários signatários sem fazer sondagens.

Assinatura: Esperar por um signatário

Espera até que um determinado signatário assine o documento e depois deixa o fluxo continuar. Termina com o estado timed_out quando o tempo acaba.

Assinaturas: Esperar por todos os signatários

Espera até que todos os signatários assinem ou que alguém rejeite o documento, depois deixa o fluxo continuar. Termina com o estado timed_out quando o tempo acaba.

Documentar: Carregar como contentor

Combina vários ficheiros num único documento contentor assinável, como um ADoc ou ASiC-E. Os ficheiros são carregados e combinados num único passo.

Documentar: Descarregar

Descarrega o documento com todas as assinaturas recolhidas até ao momento.

Documentar: Obtenha signatários

Lista os signatários de um documento com o seu estatuto de assinatura.

Documentar: Obter o estado

Obtém o estado de assinatura de um documento.

Documentar: Remover

Remove um documento do teu espaço de trabalho.

Documentar: Validar

Verifica as assinaturas de um documento e devolve o relatório de validação. O fluxo espera até a verificação terminar.

Documento: Estender a validade da assinatura

Melhora as assinaturas dos documentos para validade ou arquivamento a longo prazo.

Documento: Lista

Lista os documentos no seu espaço de trabalho, os mais recentes primeiro.

Documento: Upload

Carrega um documento e prepara-o para assinatura.

Sessão de autógrafos: Convite por email

Convida uma pessoa a assinar o documento. Mark Sign envia o convite por email.

Apaga um link de assinante ou um link partilhado antes de expirar. Os links de convite não podem ser eliminados.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID de Link de Assinatura
temporarySigningLinkId True string

O ID do Link de Assinatura vem do resultado de "Assinar: Criar links de assinatura" ou "Assinar: Criar ligação partilhada".

Devoluções

Assinatura: Convite por URL

Adiciona um signatário ao documento sem enviar um email e devolve o link do convite pessoal para que entregues. O link não expira e não pode ser eliminado; use "Assinar: Criar links de signatários" quando precisar de links que possa revogar.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Nome Próprio
name True string

O primeiro nome do signatário.

Apelido
surname True string

O apelido do signatário.

Email
email True email

O endereço de email do signatário.

URL de sucesso
success_url string

Para onde enviar o signatário depois de terminar de assinar.

Purpose
purpose string

Porque é que a pessoa é convidada. Escolha a revisão para convite apenas para visualização.

URL de retorno de chamada
callback_url string

Um URL para notificar quando o documento é assinado.

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

URL do convite
data.invitation_url string

O link da página de assinatura pessoal para entregar ao signatário.

Assinatura: Criar ligação partilhada

Cria um único link de assinatura que qualquer pessoa pode abrir para assinar os documentos. Entregas tu mesmo.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Identificadores de Documento
documents True array of string

Os documentos assinados pelo link. Use valores de ID de Documento a partir de passos de upload ou de lista.

URL de retorno de chamada
callback_url string

Um URL para notificar quando o documento é assinado.

Expirar após (minutos)
expire_after integer

Minutos até o link expirar. O padrão é 2880 (dois dias).

Apagar Documento Após (Minutos)
delete_document_after integer

Minutos até o documento ser apagado do espaço de trabalho. Por defeito, é mantido.

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

Link de assinatura
data.signing_link string

O link que qualquer pessoa pode abrir para assinar.

ID de Link de Assinatura
data.signing_link_id string

O ID do link, para "Assinar: Eliminar link".

Válido até
data.valid_until integer

Quando o link expira, como um carimbo temporal Unix.

Cria um link de assinatura pessoal para cada signatário. Tu próprio entregas os links, por exemplo por email ou mensagem no Teams.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Identificadores de Documento
documents True array of string

Os documentos para criar links de assinatura. Use valores de ID de Documento a partir de passos de upload ou de lista.

ID do signatário
id string

O seu próprio documento de identificação para o signatário, único dentro do pedido. É obrigatório quando o email está vazio.

Nome Próprio
name string

O primeiro nome do signatário.

Apelido
surname string

O apelido do signatário.

Email
email email

O endereço de email do signatário. Obrigatório quando o ID do Signante está vazio.

Código Pessoal
personal_code string

O código pessoal do signatário. É necessário quando é necessária autenticação.

Exigir autenticação
authentication_required boolean

Se sim, o signatário deve verificar a sua identidade antes de abrir o link.

Posição (apenas ADoc)
position string

A posição de trabalho do signatário, mostrada em assinaturas ADoc.

Departamento (apenas ADoc)
structural_subdivision string

O departamento do signatário, mostrado nas assinaturas do ADoc.

Propósito de Assinatura (apenas ADoc)
signing_purpose string

Porque é que a pessoa assina, mostrado nas assinaturas ADoc.

URL de retorno de chamada
callback_url string

Um URL para notificar quando o documento é assinado.

URL de Retorno de Rejeição
reject_callback_url string

Um URL para notificar quando um signatário rejeita o documento.

Expirar após (minutos)
expire_after integer

Minutos até o link expirar. O padrão é 2880 (dois dias).

Mostrar botão Rejeitar
show_reject_button boolean

Se os signatários podem rejeitar o documento na página de assinatura. O padrão é sim.

Apagar Documento Após (Minutos)
delete_document_after integer

Minutos até o documento ser apagado do espaço de trabalho. Por defeito, é mantido.

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

Links para Assinaturas:
temporary_signing_links array of object

Um link de assinatura por signatário.

ID do signatário
temporary_signing_links.id string

O seu próprio cartão de identificação para quem assina.

Nome Próprio
temporary_signing_links.member_name string

O primeiro nome do signatário.

Apelido
temporary_signing_links.member_surname string

O apelido 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 de Link de Assinatura
temporary_signing_links.temporary_signing_link_id string

O ID do link de assinatura.

Válido até
temporary_signing_links.valid_until integer

Quando o link expira, como um carimbo temporal Unix.

Documentos:
documents array of object

Os documentos para os quais os links foram criados.

ID do documento
documents.uuid string

A ID do documento.

Nome do arquivo
documents.filename string

O nome do ficheiro do documento.

Assinatura: Esperar pelo próximo signatário

Espera até que o próximo signatário assine ou rejeite o documento, sem enviar qualquer convite. Usa-o num ciclo para esperar por vários signatários sem fazer sondagens.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Devoluções

Assinatura: Esperar por um signatário

Espera até que um determinado signatário assine o documento e depois deixa o fluxo continuar. Termina com o estado timed_out quando o tempo acaba.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

E-mail do signatário
signer_email True string

O email do signatário para esperar, o mesmo email usado ao convidá-lo.

Tempo morto (minutos)
timeout_minutes integer

Quanto tempo esperar, em minutos, antes de terminar com o estado timed_out. O padrão é 41760 (29 dias), o máximo é 43200 (30 dias).

Devoluções

Assinaturas: Esperar por todos os signatários

Espera até que todos os signatários assinem ou que alguém rejeite o documento, depois deixa o fluxo continuar. Termina com o estado timed_out quando o tempo acaba.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Tempo morto (minutos)
timeout_minutes integer

Quanto tempo esperar, em minutos, antes de terminar com o estado timed_out. O padrão é 41760 (29 dias), o máximo é 43200 (30 dias).

Devoluções

Documentar: Carregar como contentor

Combina vários ficheiros num único documento contentor assinável, como um ADoc ou ASiC-E. Os ficheiros são carregados e combinados num único passo.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Tipo de Documento
document_type True string

O tipo de documento a criar.

Nome do arquivo
file_name True string

O nome do ficheiro com a sua extensão, por exemplo contract.pdf.

Conteúdo do Ficheiro
file_content True byte

O conteúdo do arquivo.

Tipo de ficheiro (apenas ADoc)
adoc_file_type string

O papel do ficheiro no contentor. Usado apenas quando o tipo de documento é um ADoc.

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

ID do documento
data.uuid string

A ID do documento.

Nome do arquivo
data.filename string

O nome do ficheiro do documento.

Documentar: Descarregar

Descarrega o documento com todas as assinaturas recolhidas até ao momento.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Devoluções

O conteúdo do ficheiro do documento.

Conteúdo do Ficheiro
file

Documentar: Obtenha signatários

Lista os signatários de um documento com o seu estatuto de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

Signatários:
data array of object

Os signatários do documento.

ID do signatário
data.id string

A identificação do signatário.

Nome Próprio
data.name string

O primeiro nome do signatário.

Apelido
data.surname string

O apelido 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, assinado, rejeitado, a rever, confirmado, negado ou avaliado.

Motivo da rejeição
data.rejection_reason string

A razão que o signatário deu ao rejeitar o documento.

Documentar: Obter o estado

Obtém o estado de assinatura de um documento.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

Estado do documento
data.document_status string

O estado de assinatura: guardado (à espera de assinaturas), signed_partially (alguns assinaram) ou assinaram (todos assinaram).

Documentar: Remover

Remove um documento do teu espaço de trabalho.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Devoluções

Documentar: Validar

Verifica as assinaturas de um documento e devolve o relatório de validação. O fluxo espera até a verificação terminar.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

é válido
data.document.is_valid boolean

Se as assinaturas dos documentos são válidas.

Válido Até
data.document.valid_to string

Quanto tempo o documento se mantém válido.

Nome do documento
data.document.name string

O título do documento.

Tipo de MIME
data.document.mimetype string

O tipo de ficheiro do documento.

Assinaturas:
data.signatures array of object

O resultado para cada assinatura.

ID da assinatura
data.signatures.id string

A identificação da assinatura.

Tempo de Assinatura
data.signatures.signing_time string

Quando a assinatura foi feita.

Formato da 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

Quanto tempo a assinatura se mantém válida.

Certificados
data.certificates array of object

Os certificados usados pelas assinaturas.

items
data.certificates object
Marcas temporais
data.timestamps array of object

Os carimbos temporais aplicavam-se ao documento.

items
data.timestamps object
Tempo de validação
metadata.validation_time string

Quando a validação foi realizada.

Documento: Estender a validade da assinatura

Melhora as assinaturas dos documentos para validade ou arquivamento a longo prazo.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Level
level True string

LT para validade a longo prazo, LTA para arquivamento a longo prazo.

Devoluções

Documento: Lista

Lista os documentos no seu espaço de trabalho, os mais recentes primeiro.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Pesquisa
query string

Uma expressão a procurar nos títulos de documentos e nomes de ficheiros.

Offset
offset integer

Quantos documentos devo ignorar.

Limit
limit integer

Quantos documentos devolver. O padrão é 10.

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

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.

Estado do documento
data.status string

O estado de assinatura do documento, como guardado (à espera de assinatura), 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: Upload

Carrega um documento e prepara-o para assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Nome do arquivo
file_name True string

O nome do ficheiro com a sua extensão, por exemplo contract.pdf. Torna-se o título do documento.

body
body True binary
Access
access string

Quem pode ver o documento. O padrão é privado.

Tipo de Faturação
billing_type True string

Quem paga pelas assinaturas.

Devoluções

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

ID do documento
data.uuid string

A ID do documento.

Nome do arquivo
data.filename string

O nome do arquivo.

Sessão de autógrafos: Convite por email

Convida uma pessoa a assinar o documento. Mark Sign envia o convite por email.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
documentId True string

O ID do documento, a partir do resultado de "Documento: Carregar", "Documento: Carregar como contentor" ou "Documento: Lista".

Nome Próprio
name True string

O primeiro nome do signatário.

Apelido
surname True string

O apelido do signatário.

Email
email True email

O endereço de email do signatário.

Linguagem
language string

A linguagem do convite. O padrão é lituano.

URL de sucesso
success_url string

Para onde enviar o signatário depois de terminar de assinar.

Purpose
purpose string

Porque é que a pessoa é convidada. Escolha a revisão para convite apenas para visualização.

URL de retorno de chamada
callback_url string

Um URL para notificar quando o documento é assinado.

Devoluções

Definições

Evento de Assinatura

Nome Caminho Tipo Descrição
ID do documento
uuid string

A ID do documento.

Estado do documento
status string

O estado de assinatura do documento, como assinado ou signed_partially. Uma rejeição manifesta-se no estatuto dos signatários.

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 identificação do signatário.

Nome Próprio
members.member_name string

O primeiro nome do signatário.

Apelido
members.member_surname string

O apelido do signatário.

Email
members.member_email string

O endereço de email do signatário.

Status de assinatura
members.status string

O estatuto de assinante, como pendente, assinado ou rejeitado.

ConfirmadoResposta

Nome Caminho Tipo Descrição
Status
status RequestStatus

O estado da fatura.

AssinarEsperaResposta

Nome Caminho Tipo Descrição
Estado do documento
document_status string

Como terminou a espera: assinado, rejeitado ou timed_out.

Rejeitado por
rejected_by string

Quem rejeitou o documento, caso fosse rejeitado.

Motivo da rejeição
rejection_reason string

A razão dada pelo signatário, caso o documento fosse rejeitado.

Estado do Pedido

O estado da fatura.

O estado da fatura.

Status
string

ficheiro

Este é o tipo de dados básicos 'arquivo'.