Partilhar via

Legalesign (Pré-visualização)

Projetado para equipes jurídicas e de operações focadas em conformidade, o conector da Legalesign conecta a plataforma de energia da Microsoft com a assinatura eletrônica Legalesign para acionar fluxos de trabalho de documentos e destinatários, enviar lembretes, buscar PDFs e dados de formulários de superfície. Requer uma assinatura ativa do Legalesign aprovada para uso da API.

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 de API
URL https://legalesign.com/contact/
Email sales@legalesign.com
Metadados do conector
Editora Legalesign
Saiba mais sobre a Legalesign https://docs.microsoft.com/connectors/legalesign
Sítio Web https://legalesign.com
Política de Privacidade https://legalesign.com/opn/privacy/
Categorias Conteúdos e Ficheiros; Produtividade

Conector REST de assinatura eletrônica Legalesign

A API REST do Legalesign habilita os fluxos de trabalho de assinatura eletrônica. Este conector fornece acesso total à API e gatilhos em tempo real, permitindo uma integração perfeita com o Microsoft Power Automate, Logic Apps e plataformas relacionadas.

Pré-requisitos

Para começar, você precisa de uma conta Legalesign e chave API: 1. Inscreva-se para uma avaliação gratuita. 2. Crie um grupo (um ambiente individual — por exemplo, um para desenvolvimento e outro para produção). 3. Solicite uma chave de API criando um tíquete de suporte. Inclua seu caso de uso, empresa e função para que o Suporte possa verificar sua identidade. 4. Uma vez verificado, faça login no Painel da API para recuperar sua chave.

Implantação

Novas contas começam no modo sandbox com as seguintes limitações: • Os documentos só podem ser enviados para testar endereços de e-mail configurados no Painel da API. • Os pedidos são limitados a 100/minuto.

Quando estiver pronto para entrar no ar, crie um tíquete de suporte para mudar sua conta de sandbox para produção. Nessa altura, as restrições serão levantadas. Consulte o guia de implantação para obter detalhes.

Acionadores

O conector suporta dois gatilhos em tempo real:

  • Eventos do documento (por exemplo, criado, rejeitado, assinado, PDF final criado)
  • Eventos do destinatário (por exemplo, concluído, rejeitado, e-mail aberto, devolvido, lembretes enviados)

Você pode receber todos os documentos ou destinatários, de filtro por grupo ou tipo de evento. Todos os webhooks Legalesign associados podem ser gerenciados e monitorados no Painel da API.

Operations

As operações da API REST do Legalesign são suportadas. Os mais comuns incluem o download de um PDF assinado, o gerenciamento de modelos, documentos, destinatários e posicionamento de campo. Consulte a documentação completa da API para obter a especificação completa.

No Legalesign, um documento carregado é chamado de "modelo". Quando um modelo é enviado a um ou mais destinatários, torna-se um «documento». Normalmente, carregará um modelo, recuperará o respetivo identificador e, em seguida, enviá-lo-á para um ou mais destinatários.

As operações comuns incluem:

Modelos

  • Create PDF template - carregar um modelo (qualquer tipo de arquivo, como PDF, Word ou imagem).
  • Get PDF embeddable link - um link de uso único para mostrar o editor de modelos a um usuário

Documents

  • Location to download PDF - devolve o binário PDF de um documento assinado
  • Create signing document - enviar um documento (selecione um modelo e destinatários)
  • Void/archive signing document - impedir que um documento seja assinado
  • Permanently delete signing document - remover um documento para sempre

Destinatários (signatários)

  • Send signer reminder email - lembre o destinatário de preencher o seu documento
  • Get signer rejection reason - se o documento for rejeitado, veja porquê

Colocação no terreno

Legalesign tem um sistema de formulário avançado com campos. Se tiver signatários, cada signatário deve ter pelo menos um campo de assinatura.

Há quatro maneiras de definir campos em seu modelo:

  1. Carregue um PDF com campos incorporados (convertido automaticamente pela Legalesign).
  2. Use tags de texto Legalesign.
  3. Defina coordenadas x/y.
  4. Use o editor de formulários Legalesign (através do link de incorporação ou do aplicativo Web).

Clique aqui para ver o guia

Consultas e suporte

Para suporte adicional ou consultas, inicie sessão na sua conta Legalesign e crie um ticket de suporte.

Criando uma conexã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
chave_de_api securestring O api_key para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Carregar anexo PDF

Salve um pdf para anexar a um e-mail de destinatário.
Carregar modelo PDF

Carregue um documento PDF que deseja enviar para ser assinado.
Documento nulo e arquivado

Define um documento com status 40 -removido- e arquiva-o.
Enviar documento

Envie um documento para assinatura ou aprovação.
Enviar e-mail de lembrete do destinatário

Envie um e-mail de lembrete a um destinatário.
Excluir permanentemente o documento

Exclui permanentemente dados e arquivos.
Excluir um anexo

Excluir um anexo.
Faça o download do log de auditoria de documentos

PDF apenas do documento auditlog.
Membro de um grupo

Detalhes de um usuário específico dentro de um grupo.
Membros de grupos

Listagens de todos os membros dos seus grupos.
Obter anexo

Obtenha um anexo.
Obter anexos

Listar anexos.
Obter campos de documento

Os campos do documento.
Obter campos de formulário de destinatário

Retornar os campos de formulário de um destinatário específico.
Obter destinatário

Obtenha o status e os detalhes de um destinatário individual.
Obter documento

Devolver um documento específico.
Obter documentos

Listar documentos de assinatura não arquivados.
Obter grupos

Listar grupos aos quais o usuário da api pertence.
Obter link de destinatário

Link de uso único para o destinatário ir para páginas de assinatura.
Obter link incorporável em PDF

Retorne um link de uso único para incorporar o editor de PDF.
Obter modelo PDF

Detalhes de um modelo PDF específico
Obter modelos PDF

Listar modelos PDF
Obter o motivo de rejeição do destinatário

Retorna o motivo que o signatário deu para rejeitar um documento.
Obter utilizador

Obtenha os detalhes do usuário.
Transferir PDF

Obtenha o rascunho ou o PDF final de um documento de assinatura, dependendo do seu status. Observe que uma resposta 200 ou 302 é possível.

Carregar anexo PDF

ID da Operação:
PostAttachment

Salve um pdf para anexar a um e-mail de destinatário.

Parâmetros

Name Chave Necessário Tipo Description
agrupar
 group True string

Uri de recurso de grupo
pdf_file
 pdf_file True byte

Base64 dados de arquivo PDF codificados, tamanho máximo é uma configuração de grupo, 5MB por padrão.
filename
 filename True string

Nome alfanumérico simples que termina .pdf
utilizador
 user string

Atribua a outro usuário.
descrição
 description string

Carregar modelo PDF

ID da Operação:
PostPdfTemplate

Carregue um documento PDF que deseja enviar para ser assinado.

Parâmetros

Name Chave Necessário Tipo Description
Arquivar após o envio
 archive_upon_send boolean

Defina true se este carregamento for apenas para uma utilização.
Grupo
 group True string

Especifique o grupo onde isso será usado.
Ficheiro PDF
 pdf_file True byte

Dados do arquivo PDF codificado em Base64.
Tags de processo
 process_tags boolean

Se o arquivo contiver tags de texto, converta-as em campos.
Title
 title string

Nomeie este registro, usará o nome do arquivo se não for usado.
User
 user string

Atribua ao membro do grupo se não for usuário da api.

Documento nulo e arquivado

ID da Operação:
UpdateArchiveDocument

Define um documento com status 40 -removido- e arquiva-o.

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 docId True uuid

ID do documento
Enviar e-mail de notificação ao destinatário
 email string

Se definido como true ou 1, os destinatários são notificados, o documento é anulado.

Enviar documento

ID da Operação:
PostDocument

Envie um documento para assinatura ou aprovação.

Parâmetros

Name Chave Necessário Tipo Description
Grupo
 group True string

Uri de recurso de grupo
Nome
 name True string

Especifique o nome do documento
Modelo PDF
 templatepdf True string

O PDF carregado para enviar.
e-mail
 email True email

Email
Primeiro nome
 firstname True string

Nome próprio
Apelido
 lastname True string

Apelido
attachments
 attachments array of string

Lista de uris de recursos de anexo.
expira
 expires date-time

ISO8601 datetime formado, definido como TZ do remetente ou fuso horário, se usado
mensagem
 message string

A sua mensagem pessoal para o grupo, inserida no centro do modelo de e-mail do grupo. Use o nome de um modelo de email salvo precedido por um símbolo de hash para usar esse modelo. Se houver mais de um modelo com o mesmo nome, ele selecionará o último modificado.
Primeiro nome
 firstname string

Nome próprio
Apelido
 lastname string

Apelido
e-mail
 email True email

Email
include_link
 include_link boolean

Inclua um link para as páginas de assinatura permitindo que um revisor assine
mensagem de texto (SMS)
 sms string

Use o número de formato internacional para adicionar a verificação por SMS. Obrigatório se for uma testemunha ou um signatário testemunhado.
Assunto
 subject string

Linha de assunto para e-mail de saída
timezone
 timezone string

TZ do signatário, deve ser TZ válido de acordo com o timezoneenum (consulte Usuário para obter detalhes de timezoneenum). Se estiver em branco usa tz do remetente.
Tipo de assinatura
 signature_type integer

Use 4 para obter a certificação PDF executada. Recomendado. O padrão é 1 (usa um hash sha256 para integridade do documento).
Anexar PDF
 append_pdf boolean

Anexe as informações de validação do Legalesign ao PDF final.
auto_archive
 auto_archive boolean

Enviar para arquivo logo após a assinatura. Mantém a desorganização de aplicações Web livre
Use e-mails Legalesign
 do_email boolean

Use o e-mail Legalesign para enviar e-mails de notificação. Se false suprime todos os e-mails.
CC após a conclusão
 cc_emails string

Cadeia de caracteres delimitada por vírgulas de endereços de e-mail que são notificados de assinatura ou rejeição.
Converter campos de remetente vazios em campos de primeiro destinatário
 convert_sender_to_signer boolean

Se algum campo do remetente for deixado em branco, converta-o em campos para o primeiro destinatário.
Palavra-passe PDF
 pdf_password string

Defina uma palavra-passe. Deve ser codificável ascii, você também deve definir signature_type para 4 e escolher um pdf_password_type.
Configurações de senha do PDF
 pdf_password_type integer

1 para armazenar senha, 2 para excluir de nossos registros após a assinatura final.
Texto em pdf
 pdftext object

Atribua valores a campos de remetente PDF, use o rótulo de campo do modelo ou seu uuid como chaves de objeto. Consulte templatepdf/:id/fields/ e filtre por element_type="admin", para obter campos relevantes com seu rótulo ou uuid. Ver também strict_fields.
URL de redirecionamento
 redirect string

URL para enviar o signatário após a assinatura (em vez da página de download). Seu URL incluirá parâmetros de consulta com informações de ID e estado da seguinte maneira: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Cronograma de lembretes
 reminders string

Coloque 'padrão' se você quiser usar a agenda de lembrete padrão no grupo (vá para o aplicativo Web para definir a programação padrão)
Retornar links de signatário
 return_signer_links boolean

Retornar links de documentos para signatários no BODY de resposta.
Enviar sequenciamento
 signers_in_order boolean

Notifique os signatários em sua sequência de ordem. Se falso, todos são notificados simultaneamente.
signertext
 signertext object

Adicione espaços reservados personalizados aos campos do signatário. Use rótulos de campo ou uuid como chaves no objeto (como para pdftext). Veja templatepdf/:id/fields/ e filtre por element_type = "texto" para obter campos relevantes com seus rótulos ou uuid.
Impor validação de campo
 strict_fields boolean

Pdftext falha nas verificações de validação silenciosamente, defina true para validar.
A sua referência
 tag string

Tag
A sua referência
 tag1 string

Tag
A sua referência
 tag2 string

Tag
utilizador
 user string

Atribua documento a outro usuário do grupo.

Enviar e-mail de lembrete do destinatário

ID da Operação:
PostSignerReminder

Envie um e-mail de lembrete a um destinatário.

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário
enviar SMS
 text string

Texto da mensagem personalizada

Excluir permanentemente o documento

ID da Operação:
DeleteDocument

Exclui permanentemente dados e arquivos.

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 docId True uuid

ID do documento

Excluir um anexo

ID da Operação:
DeleteAttachment

Excluir um anexo.

Parâmetros

Name Chave Necessário Tipo Description
ID do anexo
 attachId True uuid

Anexar ID

Faça o download do log de auditoria de documentos

ID da Operação:
GetDocumentAuditLog

PDF apenas do documento auditlog.

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 docId True uuid

ID do documento

Devoluções

response
file

Membro de um grupo

ID da Operação:
GetMember

Detalhes de um usuário específico dentro de um grupo.

Parâmetros

Name Chave Necessário Tipo Description
ID do Membro
 memberId True uuid

ID do Membro

Devoluções

Body
MemberResponse

Membros de grupos

ID da Operação:
GetMembers

Listagens de todos os membros dos seus grupos.

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo
 group string

Filtrar por um grupo específico
Limite de consultas
 limit integer

Use com deslocamento para iterar os resultados.
Deslocamento da consulta
 offset integer

Use com limite para iterar através dos resultados.

Devoluções

Body
MemberListResponse

Obter anexo

ID da Operação:
GetAttachment

Obtenha um anexo.

Parâmetros

Name Chave Necessário Tipo Description
ID do anexo
 attachId True uuid

ID do anexo

Devoluções

Anexar item.

Body
AttachmentResponse

Obter anexos

ID da Operação:
GetAttachments

Listar anexos.

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo
 group string

Filtrar por um grupo específico.
Limite de consultas
 limit integer

Use com deslocamento para iterar os resultados.
Deslocamento da consulta
 offset integer

Use com limite para iterar através dos resultados.

Devoluções

Listagem de anexos

Body
AttachmentListResponse

Obter campos de documento

ID da Operação:
GetDocumentFields

Os campos do documento.

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 docId True uuid

ID do documento

Devoluções

Name Caminho Tipo Description
array of object

Lista de campos do documento
element_type
 element_type string

Tipo de elemento
ordem de campo
 fieldorder integer

Ordem de campo
etiqueta
 label string

Etiqueta
label_extra
 label_extra string

Rótulo extra
signatário
 signer integer

Recipient
state
 state boolean
validação
 validation integer

Identificador de validação
valor
 value string

Valor

Obter campos de formulário de destinatário

ID da Operação:
GetSignerFields

Retornar os campos de formulário de um destinatário específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário

Devoluções

Name Caminho Tipo Description
array of object
etiqueta
 label string

Etiqueta
label_extra
 label_extra string

Rótulo extra
state
 state boolean

Estado
ordem de campo
 fieldorder integer

Ordem de campo
valor
 value string

Se o campo for um ficheiro de signatário, este valor será um URL de transferência de curta duração.

Obter destinatário

ID da Operação:
GetRecipient

Obtenha o status e os detalhes de um destinatário individual.

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário

Devoluções

Detalhes do destinatário

Body
SignerResponse

Obter documento

ID da Operação:
GetDocument

Devolver um documento específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 docId True uuid

ID do documento

Devoluções

Detalhes do documento

Body
DocumentResponseDetail

Obter documentos

ID da Operação:
GetDocuments

Listar documentos de assinatura não arquivados.

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo
 group True string

Filtrar por um grupo específico, obrigatório.
Inclua documentos arquivados
 archived string

Filtre no status arquivado, o padrão é unarchived, use o valor all neste parâmetro para consultar todos os documentos.
Filtrar por e-mail do destinatário
 email string

Filtre por e-mail do destinatário.
Limite de consultas
 limit integer

Comprimento do conjunto de dados a ser retornado. Use com a consulta de deslocamento para iterar os resultados.
Deslocamento da consulta
 offset integer

Deslocamento do início do conjunto de dados. Use com a consulta limit para iterar através do conjunto de dados.
Filtrar por estado do documento
 status integer

Filtre o status do documento.
Remover destinatários da resposta
 nosigners string

Adicione o valor 1 para remover informações de destinatários para uma consulta mais rápida.
Filtro para criado após esta data
 created_gt date-time

Filtre os documentos criados após um determinado tempo.
Filtro para modificado após esta data
 modified_gt date-time

Filtre os documentos modificados após um determinado tempo.

Devoluções

Listagens de documentos

Body
DocumentListResponse

Obter grupos

ID da Operação:
GetGroups

Listar grupos aos quais o usuário da api pertence.

Parâmetros

Name Chave Necessário Tipo Description
Deslocamento da consulta
 offset integer

Deslocamento do início do conjunto de dados. Use com a consulta limit para iterar através do conjunto de dados.
Limite de consultas
 limit integer

Comprimento do conjunto de dados a ser retornado. Use com a consulta de deslocamento para iterar os resultados.

Devoluções

Lista de grupos

Body
GroupListResponse
ID da Operação:
GetSignerLink

Link de uso único para o destinatário ir para páginas de assinatura.

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário
ID da Operação:
GetPdfTemplateEditLink

Retorne um link de uso único para incorporar o editor de PDF.

Parâmetros

Name Chave Necessário Tipo Description
Pdf Id
 pdfId True string

Defina o ID do PDF carregado.
Ocultar listagem de campos da página renderizada
 hide_sender_fields boolean

Ocultar listagem de campos da página renderizada.
Código hexadecimal excluindo símbolo de hash para cor de fundo
 css_body_backgroundcolor string

Use o código hexadecimal excluindo o símbolo de hash para alterar a cor do plano de fundo.

Obter modelo PDF

ID da Operação:
GetPdfTemplate

Detalhes de um modelo PDF específico

Parâmetros

Name Chave Necessário Tipo Description
ID PDF carregado
 pdfId True uuid

ID PDF carregado

Devoluções

Detalhes do modelo

Body
TemplatePdfResponse

Obter modelos PDF

ID da Operação:
GetPdfTemplates

Listar modelos PDF

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo
 group string

Pode ser completo resource_uri ou apenas id.
Limite de consultas
 limit integer

Comprimento do conjunto de dados a ser retornado. Use com a consulta de deslocamento para iterar os resultados.
Deslocamento da consulta
 offset integer

Deslocamento do início do conjunto de dados. Use com a consulta limit para iterar através do conjunto de dados.

Devoluções

Listagens de modelos

Body
TemplatePdfListResponse

Obter o motivo de rejeição do destinatário

ID da Operação:
GetSignerRejection

Retorna o motivo que o signatário deu para rejeitar um documento.

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário

Devoluções

Name Caminho Tipo Description
estado
 status integer

Estátuas destinatárias.
razão
 reason string

Rejeite a razão.

Obter utilizador

ID da Operação:
GetUser

Obtenha os detalhes do usuário.

Parâmetros

Name Chave Necessário Tipo Description
ID de Utilizador
 userId True uuid

ID de Utilizador

Devoluções

Detalhes do usuário.

Body
UserDetailResponse

Transferir PDF

ID da Operação:
GetDocumentPdf

Obtenha o rascunho ou o PDF final de um documento de assinatura, dependendo do seu status. Observe que uma resposta 200 ou 302 é possível.

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 docId True uuid

ID do documento

Devoluções

response
file

Acionadores

Evento do destinatário

Gatilho para quando ocorre um evento de destinatário
Evento do documento

Ocorre o gatilho para um evento de documento

Evento do destinatário

ID da Operação:
RecipientTrigger

Gatilho para quando ocorre um evento de destinatário

Parâmetros

Name Chave Necessário Tipo Description
eventFilter
 eventFilter True string

Filtro de eventos
agrupar
 group string

Filtro de grupo

Devoluções

Name Caminho Tipo Description
versão
 version string

Versão
objecto
 object string

Objeto
etiqueta
 data.tag string

Tag
tag1
 data.tag1 string

Tag1
tag2
 data.tag2 string

Tag2
Identificador Único Universal (UUID)
 data.uuid string

ID do destinatário
e-mail
 data.email string

Email
agrupar
 data.group string

Grupo
order
 data.order integer

Encomenda
estado
 data.status integer

Situação
documento
 data.document string

Documento
Apelido
 data.lastname string

Apelido
roleText
 data.roleText string

Texto da função
Primeiro nome
 data.firstname string

Nome próprio
statusTexto
 data.statusText string

Texto de estado
emailBounce
 data.emailBounce integer

O e-mail foi devolvido
resourceUri
 data.resourceUri string

Uri do recurso do destinatário
Nome do documento
 data.documentName string

Nome do documento
rejectReason
 data.rejectReason string

Motivo de rejeição
groupResourceUri
 data.groupResourceUri string

Uri de recurso de grupo
emailBounceMessage
 data.emailBounceMessage string

Mensagem de devolução de e-mail
documentResourceUri
 data.documentResourceUri string

Uri do recurso do documento
criado
 created integer

Criado
id
 id string

ID
evento
 event string

Event

Evento do documento

ID da Operação:
DocumentTrigger

Ocorre o gatilho para um evento de documento

Parâmetros

Name Chave Necessário Tipo Description
eventFilter
 eventFilter True string

Filtro de eventos
agrupar
 group string

Filtro de grupo

Devoluções

Name Caminho Tipo Description
versão
 version string

Versão
objecto
 object string

Objeto
tag1
 data.tag1 string

Tag
recipients
 data.recipients array of object

Destinatários
Identificador Único Universal (UUID)
 data.recipients.uuid string

ID do destinatário
e-mail
 data.recipients.email string

E-mail do destinatário
order
 data.recipients.order integer

Número de ordem do destinatário
estado
 data.recipients.status integer

Estado do destinatário
Apelido
 data.recipients.lastname string

Apelido do destinatário
roleText
 data.recipients.roleText string

Texto da função de destinatário
Primeiro nome
 data.recipients.firstname string

Nome do destinatário
statusTexto
 data.recipients.statusText string

Status do destinatárioTexto
resourceUri
 data.recipients.resourceUri string

Uri do recurso do destinatário
rejectReason
 data.recipients.rejectReason string

rejectReason
groupResourceUri
 data.groupResourceUri string

Uri de recurso de grupo
statusTexto
 data.statusText string

Texto do estado do documento
nome
 data.name string

Nome do documento
etiqueta
 data.tag string

Tag
resourceUri
 data.resourceUri string

Uri do recurso
Identificador Único Universal (UUID)
 data.uuid string

ID do documento
tag2
 data.tag2 string

Tag2
agrupar
 data.group string

Grupo
estado
 data.status integer

Estado do documento
criado
 created integer

Criado
id
 id string

Fez
evento
 event string

Event

Definições

PermissionsEnum

Opções de permissão

Opções de permissão

integer

ListMeta

Meta informações sobre listagem.

Name Caminho Tipo Description
limit
 limit integer

Número máximo de objetos.
next
 next string

URL para o próximo conjunto de objetos.
offset
 offset integer

Número de itens desde o início do conjunto de resultados.
anterior
 previous string

URL para o conjunto anterior de objetos.
total_count
 total_count integer

Número total de objetos.

GroupListResponse

Lista de grupos

Name Caminho Tipo Description
meta
 meta ListMeta

Meta informações sobre listagem.
objetos
 objects array of object
criado
 objects.created date-time

Criado
is_active
 objects.is_active boolean

Active
modificado
 objects.modified date-time

Modificado
nome
 objects.name string

Nome
public_name
 objects.public_name string

Nome público
resource_uri
 objects.resource_uri string

Uri do recurso
lesma
 objects.slug string

Nome exclusivo
utilizador
 objects.user string

Uri do recurso do criador
xframe_allow
 objects.xframe_allow boolean

Permitir assinatura de incorporação
xframe_allow_pdf_edit
 objects.xframe_allow_pdf_edit boolean

Permitir edição de incorporação

TemplatePdfListResponse

Listagens de modelos

Name Caminho Tipo Description
meta
 meta ListMeta

Meta informações sobre listagem.
objetos
 objects array of TemplatePdfResponse

TemplatePdfResponse

Detalhes do modelo

Name Caminho Tipo Description
criado
 created date-time

Criado
agrupar
 group string

Uri do grupo
modificado
 modified date-time

Modificado
Festas
 parties string

JSON stringified array de partes do documento.
page_count
 page_count integer

Contagem de páginas
resource_uri
 resource_uri string

Uri do recurso
signer_count
 signer_count integer

Contagem de signatários
title
 title string

Title
utilizador
 user string

Uri de recurso do criador
Identificador Único Universal (UUID)
 uuid uuid

Pdf Id
válido
 valid boolean

Pode ser enviado (se os campos não validarem).

DocumentListResponse

Listagens de documentos

Name Caminho Tipo Description
meta
 meta ListMeta

Meta informações sobre listagem.
objetos
 objects array of object

Documents
arquivado
 objects.archived boolean

Arquivado
auto_archive
 objects.auto_archive boolean

Arquivo após envio.
cc_emails
 objects.cc_emails string

Lista delimitada por vírgulas e-mails para cc após a conclusão.
criado
 objects.created date-time

Criado
do_email
 objects.do_email boolean

Use e-mails Legalesign.
download_final
 objects.download_final boolean

Está pronto para download após a conclusão.
agrupar
 objects.group string

Uri de recurso de grupo.
modificado
 objects.modified date-time

Modificado
nome
 objects.name string

Nome do documento
Texto em pdf
 objects.pdftext string

Valores de campo do remetente
redirecionamento
 objects.redirect string

URL para redirecionar o destinatário após a assinatura
resource_uri
 objects.resource_uri string

Uri do recurso
return_signer_links
 objects.return_signer_links boolean

Adicionar links de destinatários à resposta
signatários
 objects.signers array of array

Matrizes aninhadas com detalhes do signatário
items
 objects.signers array of

Sempre contém [uri do signatário, nome, sobrenome, e-mail, número SMS, has_fields, status, ordem do signatário (0-indexado)]
signers_in_order
 objects.signers_in_order integer

Destinatários de e-mail simultânea ou sequencialmente
estado
 objects.status DocumentStatusEnum

Opções de status do documento:

  • 10 - Estado inicial, verifique o status do signatário para enviado/não enviado
  • 20 - Campos preenchidos
  • 30 - Assinado
  • 40 - Removido (antes de assinar)
  • 50 - Rejeitado
etiqueta
 objects.tag string

Documento de etiqueta
tag1
 objects.tag1 string

Documento de etiqueta
tag2
 objects.tag2 string

Documento de etiqueta
modelo
 objects.template string

Uri do recurso do modelo, se usado
Modelopdf
 objects.templatepdf string

Uri do recurso de modelo PDF
enviar SMS
 objects.text string

Texto para assinatura
utilizador
 objects.user string

Uri do criador
Identificador Único Universal (UUID)
 objects.uuid uuid

ID do documento

DocumentStatusEnum

Opções de status do documento:

  • 10 - Estado inicial, verifique o status do signatário para enviado/não enviado
  • 20 - Campos preenchidos
  • 30 - Assinado
  • 40 - Removido (antes de assinar)
  • 50 - Rejeitado

Opções de status do documento:

  • 10 - Estado inicial, verifique o status do signatário para enviado/não enviado
  • 20 - Campos preenchidos
  • 30 - Assinado
  • 40 - Removido (antes de assinar)
  • 50 - Rejeitado
integer

SignerResponse

Detalhes do destinatário

Name Caminho Tipo Description
documento
 document string

Documento
e-mail
 email string

E-mail do destinatário
primeiro_nome
 first_name string

Nome do destinatário
sobrenome
 last_name string

Apelido do destinatário
has_fields
 has_fields boolean

O destinatário tem campos
order
 order integer

Ordem do destinatário
resource_uri
 resource_uri string

Uri do recurso do destinatário
estado
 status SignerStatusEnum

Opções de status do signatário:

  • 4 - não enviado
  • 5 - Envio previsto
  • 10 - enviado
  • 15 - e-mail aberto
  • 20 - visitou
  • 30 - campos completos
  • 35 - campos completos ex assinatura
  • 39 - Aguardando Testemunha para completar
  • 40 - assinado
  • 50 - descarregado
  • 60 - rejeitado

SignerStatusEnum

Opções de status do signatário:

  • 4 - não enviado
  • 5 - Envio previsto
  • 10 - enviado
  • 15 - e-mail aberto
  • 20 - visitou
  • 30 - campos completos
  • 35 - campos completos ex assinatura
  • 39 - Aguardando Testemunha para completar
  • 40 - assinado
  • 50 - descarregado
  • 60 - rejeitado

Opções de status do signatário:

  • 4 - não enviado
  • 5 - Envio previsto
  • 10 - enviado
  • 15 - e-mail aberto
  • 20 - visitou
  • 30 - campos completos
  • 35 - campos completos ex assinatura
  • 39 - Aguardando Testemunha para completar
  • 40 - assinado
  • 50 - descarregado
  • 60 - rejeitado
integer

DocumentResponseDetail

Detalhes do documento

Name Caminho Tipo Description
arquivado
 archived boolean

Está arquivado
auto_archive
 auto_archive boolean

Enviar arquivo de documentos após a assinatura.
cc_emails
 cc_emails string

Quem estará com o remetente na notificação por e-mail quando assinado
criado
 created date-time

Criado
do_email
 do_email boolean

Use e-mails Legalesign
download_final
 download_final boolean

O PDF final está disponível para download
rodapé
 footer string

Documentos HTML - texto para rodapé, se usado
footer_height
 footer_height integer

HTMl docs - px altura do rodapé se usado
agrupar
 group string

Uri de recursos do grupo
has_fields
 has_fields boolean

O documento tem campos
hash_value
 hash_value string

Soma de verificação SHA256 do documento final, use-a para validar o download final do PDF
cabeçalho
 header string

Documentos HTML - texto para cabeçalho, se usado
header_height
 header_height integer

HTMl docs - px altura do cabeçalho se usado
modificado
 modified date-time

Modificado
nome
 name string

Nome do documento
pdf_password
 pdf_password string

Palavra-passe PDF
pdf_password_type
 pdf_password_type string

Se a senha do pdf for mantida
Texto em pdf
 pdftext string

Ignore isto
redirecionamento
 redirect string

URL para redirecionamento de destinatário após a assinatura
resource_uri
 resource_uri string

Uri do recurso
return_signer_links
 return_signer_links boolean

Ignorar
sign_mouse
 sign_mouse boolean

ignorar
sign_time
 sign_time date-time

Hora do sinal
sign_type
 sign_type boolean

Legado
sign_upload
 sign_upload boolean

Legado
signature_placement
 signature_placement integer

Legado
signature_type
 signature_type integer

legado - sempre 4
signatários
 signers array of array

Matrizes aninhadas com detalhes do signatário
items
 signers array of

Sempre contém [uri do signatário, nome, sobrenome, e-mail, número SMS, has_fields, status, ordem do signatário (0-indexado)]
signer_objects
 signer_objects array of object

Lista de destinatários
e-mail
 signer_objects.email string

Email
Primeiro nome
 signer_objects.firstname string

Nome próprio
Apelido
 signer_objects.lastname string

Apelido
Tel.
 signer_objects.tel string

Número de telefone
order
 signer_objects.order integer

Ordem de assinatura
resource_uri
 signer_objects.resource_uri string

Uri do recurso
função
 signer_objects.role string

Funções
estado
 signer_objects.status integer

Código de status do destinatário
Identificador Único Universal (UUID)
 signer_objects.uuid string

ID do destinatário
signers_in_order
 signers_in_order boolean

Destinatários de e-mail simultânea ou sequencialmente
estado
 status DocumentStatusEnum

Opções de status do documento:

  • 10 - Estado inicial, verifique o status do signatário para enviado/não enviado
  • 20 - Campos preenchidos
  • 30 - Assinado
  • 40 - Removido (antes de assinar)
  • 50 - Rejeitado
etiqueta
 tag string

A sua referência
tag1
 tag1 string

A sua referência
tag2
 tag2 string

A sua referência
modelo
 template string

Uri de recurso para modelo de texto, se usado
Modelopdf
 templatepdf string

Uri de recurso para modelo pdf se usado
enviar SMS
 text string

Texto para o documento, se usado
utilizador
 user string

Uri de recursos do usuário.
Identificador Único Universal (UUID)
 uuid uuid

ID do documento

MemberListResponse

Name Caminho Tipo Description
meta
 meta ListMeta

Meta informações sobre listagem.
objetos
 objects array of MemberResponse

MemberResponse

Name Caminho Tipo Description
criado
 created date-time

Criado
agrupar
 group string

Uri de recurso de grupo
modificado
 modified date-time

Modificado
permissão
 permission PermissionsEnum

Opções de permissão
resource_uri
 resource_uri string

Uri do recurso
utilizador
 user string

Uri de recursos do usuário.

AttachmentResponse

Anexar item.

Name Caminho Tipo Description
criado
 created date-time

Criado
descrição
 description string

Description
filename
 filename string

Nome do ficheiro
agrupar
 group string

Grupo
resource_uri
 resource_uri string

Anexar uri de recurso
utilizador
 user string

Uri de recursos do usuário
Identificador Único Universal (UUID)
 uuid uuid

Anexar ID

AttachmentListResponse

Listagem de anexos

Name Caminho Tipo Description
meta
 meta ListMeta

Meta informações sobre listagem.
objetos
 objects array of object

Listagem
criado
 objects.created date-time

Criado
descrição
 objects.description string

Description
filename
 objects.filename string

Nome do ficheiro
agrupar
 objects.group string

Grupo
resource_uri
 objects.resource_uri string

Uri do recurso
utilizador
 objects.user string

Uri de recursos do usuário
Identificador Único Universal (UUID)
 objects.uuid uuid

Anexar ID

UserDetailResponse

Detalhes do usuário.

Name Caminho Tipo Description
date_joined
 date_joined date-time

Data de adesão
e-mail
 email email

Email
primeiro_nome
 first_name string

Nome próprio
groups
 groups array of string

Lista de grupos aos quais este utilizador aderiu.
last_login
 last_login date-time

Último login
sobrenome
 last_name string

Apelido
resource_uri
 resource_uri string

Uri do recurso
timezone
 timezone string

Fuso horário
nome de utilizador
 username string

Nome de utilizador

ficheiro

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