Compartilhar via

Legalesign (versão prévia)

Projetado para equipes legais e de operações focadas em conformidade, o conector da Legalesign vincula a plataforma de energia da Microsoft à eSignature Legalesign para disparar fluxos de trabalho de documentos e destinatários, enviar lembretes, buscar PDFs e dados de formulário de superfície. Requer uma assinatura ativa do Legalesign aprovada para uso da API.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte de API
URL https://legalesign.com/contact/
Email sales@legalesign.com
Metadados do conector
Publicador Legalesign
Saiba mais sobre a Legalesign https://docs.microsoft.com/connectors/legalesign
Site da Web https://legalesign.com
Política de privacidade https://legalesign.com/opn/privacy/
Categorias Conteúdo e arquivos; Produtividade

Legalesign eSignature REST Connector

A API REST do Legalesign habilita fluxos de trabalho de eSignature. Esse conector fornece acesso completo à API e gatilhos em tempo real, permitindo a integração perfeita com o Microsoft Power Automate, aplicativos lógicos e plataformas relacionadas.

Pré-requisitos

Para começar, você precisa de uma conta do Legalesign e uma chave de API: 1. Inscreva-se para uma avaliação gratuita. 2. Criar 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. Depois de verificado, faça logon no Painel de API para recuperar sua chave.

Implantação

Novas contas começam no modo área restrita com as seguintes limitações: • Os documentos só podem ser enviados para testar endereços de email configurados no Painel de API. • As solicitações são limitadas a 100/minuto.

Quando estiver pronto para entrar em operação, crie um tíquete de suporte para mudar sua conta da área restrita para a produção. Nesse ponto, as restrições serão levantadas. Consulte o guia de implantação para obter detalhes.

Triggers

O conector dá suporte a dois gatilhos em tempo real:

  • Eventos de documento (por exemplo, criados, rejeitados, assinados, pdf final criado)
  • Eventos de destinatário (por exemplo, concluídos, rejeitados, emails abertos, retornados, 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 de API.

Operations

Há suporte para operações de API REST legalesign. As 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.

Em Legalesign, um documento carregado é chamado de "modelo". Quando um modelo é enviado a um ou mais destinatários, ele se torna um "documento". Normalmente, você carregará um modelo, recuperará seu identificador e o enviará para um ou mais destinatários.

As operações comuns incluem:

Modelos

  • Create PDF template – carregue 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 para um usuário

Documentos

  • Location to download PDF – retorna o binário PDF de um documento assinado
  • Create signing document - enviar um documento (selecionar 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 concluir seu documento
  • Get signer rejection reason - se o documento for rejeitado, veja por que

Posicionamento de campo

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

Há quatro maneiras de definir campos em seu modelo:

  1. Carregue um PDF com campos inseridos (convertidos automaticamente pela Legalesign).
  2. Use marcas de texto Legalesign.
  3. Definir coordenadas x/y.
  4. Use o editor de formulários Legalesign (por meio do link de inserção ou do aplicativo Web).

Clique aqui para obter o guia

Consultas e suporte

Para obter suporte ou consultas adicionais, faça logon em sua conta do Legalesign e crie um tíquete de suporte.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
chave_de_api secureString O api_key desta api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Baixar a auditoria do documento

PDF somente do relatório de auditoria de documentos.
Baixar PDF

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

Salve um pdf para anexar a um email de destinatário.
Carregar modelo de PDF

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

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

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

Envie um email de lembrete a um destinatário.
Excluir permanentemente o documento

Exclui permanentemente dados e arquivos.
Excluir um anexo

Excluir um anexo.
Membro de um grupo

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

Listagens de todos os membros de seus grupos.
Obter anexo

Obter um anexo.
Obter anexos

Listar anexos.
Obter campos de documento

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

Retorne 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

Retornar um documento específico.
Obter documentos

Listar documentos de assinatura não criados.
Obter grupos

Listar grupos aos quais o usuário da API pertence.
Obter link inserível em PDF

Retornar um link de uso único para inserir o editor de PDF.
Obter modelo de PDF

Detalhes de um modelo específico de PDF
Obter modelos de PDF

Listar modelos de PDF
Obter o link do destinatário

Link de uso único para o destinatário ir para páginas de assinatura.
Obter o motivo da rejeição do destinatário

Retorna o motivo pelo qual o signatário deu para rejeitar um documento.
Obter usuário

Obtenha detalhes do usuário.

Baixar a auditoria do documento

ID da operação:
GetDocumentAuditLog

PDF somente do relatório de auditoria de documentos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 docId True uuid

ID do documento

Retornos

response
file

Baixar PDF

ID da operação:
GetDocumentPdf

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 docId True uuid

ID do documento

Retornos

response
file

Carregar anexo PDF

ID da operação:
PostAttachment

Salve um pdf para anexar a um email de destinatário.

Parâmetros

Nome Chave Obrigatório Tipo Description
agrupar
 group True string

URI de recurso de grupo
pdf_file
 pdf_file True byte

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

Nome alfanumérico simples terminando .pdf
usuário
 user string

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

Carregar modelo de PDF

ID da operação:
PostPdfTemplate

Carregue um documento PDF que você deseja enviar para ser assinado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Arquivar ao enviar
 archive_upon_send boolean

Defina true se esse upload for somente para uso único.
Grupo
 group True string

Especifique o grupo em que isso será usado.
Arquivo PDF
 pdf_file True byte

Dados de arquivo PDF codificados em Base64.
Marcas de processo
 process_tags boolean

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

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

Atribua ao membro do grupo, se não o usuário da API.

Documento nulo e arquivado

ID da operação:
UpdateArchiveDocument

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 docId True uuid

ID do documento
Fazer email de notificação para o destinatário
 email string

Se definido como true ou 1, os destinatários serão notificados de que o documento será anulado.

Enviar documento

ID da operação:
PostDocument

Envie um documento para assinatura ou aprovação.

Parâmetros

Nome Chave Obrigatório Tipo Description
Grupo
 group True string

URI de recurso de grupo
Nome
 name True string

Especificar o nome do documento
Modelo de PDF
 templatepdf True string

O PDF carregado a ser enviado.
email
 email True email

Email
primeiro nome
 firstname True string

Nome próprio
sobrenome
 lastname True string

Apelido
attachments
 attachments array of string

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

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

Sua mensagem pessoal para a parte, inserida no centro do modelo de email do grupo. Use o nome de um modelo de email salvo pré-configurado 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
sobrenome
 lastname string

Apelido
email
 email True email

Email
include_link
 include_link boolean

Incluir um link para as páginas de assinatura que permitem que um revisor assine
mensagem de texto
 sms string

Use o número de formato internacional para adicionar a verificação de SMS. Necessário se uma testemunha ou um signatário testemunhado.
assunto
 subject string

Linha de assunto para email de saída
timezone
 timezone string

O TZ do signatário deve ser TZ válido de acordo com o fuso horário (consulte o usuário para obter detalhes de fuso horário). Se em branco usar tz do remetente.
Tipo de assinatura
 signature_type integer

Use 4 para obter o PDF certificado executado. Recomendado. O padrão é 1 (usa um hash sha256 para integridade do documento).
Acrescentar PDF
 append_pdf boolean

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

Envie para o arquivo morto logo após a assinatura. Mantém a desordem do aplicativo Web livre
Usar emails do Legalesign
 do_email boolean

Use o email do Legalesign para enviar emails de notificação. Se false suprimir todos os emails.
CC após a conclusão
 cc_emails string

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

Se os campos de remetente forem deixados em branco, converta-os em campos para o primeiro destinatário.
Senha pdf
 pdf_password string

Definir uma senha. Deve ser capaz de codificar ascii, você também deve definir signature_type como 4 e escolher um pdf_password_type.
Configurações de senha de PDF
 pdf_password_type integer

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

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

URL para a qual enviar o signatário após a assinatura (em vez da página de download). Sua 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]
Agendamento de lembrete
 reminders string

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

Retornar links de documento para os signatários no CORPO da resposta.
sequenciamento de envio
 signers_in_order boolean

Notifique os signatários na sequência de pedidos. Se false todos forem notificados de forma simulada.
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). Consulte templatepdf/:id/fields/ e filtre para element_type = "text" para obter campos relevantes com seus rótulos ou uuid.
Impor validação de campo
 strict_fields boolean

O pdftext falha nas verificações de validação silenciosamente, definido como true para validação.
Sua referência
 tag string

Etiqueta
Sua referência
 tag1 string

Etiqueta
Sua referência
 tag2 string

Etiqueta
usuário
 user string

Atribuir documento a outro usuário no grupo.

Enviar email de lembrete do destinatário

ID da operação:
PostSignerReminder

Envie um email de lembrete a um destinatário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário
enviar SMS
 text string

Texto da mensagem personalizado

Excluir permanentemente o documento

ID da operação:
DeleteDocument

Exclui permanentemente dados e arquivos.

Parâmetros

Nome Chave Obrigató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

Nome Chave Obrigatório Tipo Description
ID do anexo
 attachId True uuid

Anexar ID

Membro de um grupo

ID da operação:
GetMember

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do membro
 memberId True uuid

ID do membro

Retornos

Corpo
MemberResponse

Membros de grupos

ID da operação:
GetMembers

Listagens de todos os membros de seus grupos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do grupo
 group string

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

Use com deslocamento para iterar por meio de resultados.
Deslocamento de consulta
 offset integer

Use com limite para iterar por meio de resultados.

Retornos

Corpo
MemberListResponse

Obter anexo

ID da operação:
GetAttachment

Obter um anexo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do anexo
 attachId True uuid

ID do anexo

Retornos

Anexar item.

Corpo
AttachmentResponse

Obter anexos

ID da operação:
GetAttachments

Listar anexos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do grupo
 group string

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

Use com deslocamento para iterar por meio de resultados.
Deslocamento de consulta
 offset integer

Use com limite para iterar por meio de resultados.

Retornos

Listagem de anexos

Corpo
AttachmentListResponse

Obter campos de documento

ID da operação:
GetDocumentFields

Os campos do documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 docId True uuid

ID do documento

Retornos

Nome Caminho Tipo Description
array of object

Lista de campos de documento
element_type
 element_type string

Tipo de elemento
fieldorder
 fieldorder integer

Ordem do campo
etiqueta
 label string

Etiqueta
label_extra
 label_extra string

Rótulo extra
signatário
 signer integer

Recipient
estado
 state boolean
validação
 validation integer

Identificador de validação
value
 value string

Value

Obter campos de formulário do destinatário

ID da operação:
GetSignerFields

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário

Retornos

Nome Caminho Tipo Description
array of object
etiqueta
 label string

Etiqueta
label_extra
 label_extra string

Rótulo extra
estado
 state boolean

Estado
fieldorder
 fieldorder integer

Ordem do campo
value
 value string

Se o campo for um arquivo de signatário, esse valor será uma URL de download 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

Nome Chave Obrigatório Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário

Retornos

Detalhes do destinatário

Corpo
SignerResponse

Obter documento

ID da operação:
GetDocument

Retornar um documento específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 docId True uuid

ID do documento

Retornos

Detalhes do documento

Corpo
DocumentResponseDetail

Obter documentos

ID da operação:
GetDocuments

Listar documentos de assinatura não criados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do grupo
 group True string

Filtrar por um grupo específico, necessário.
Incluir documentos arquivados
 archived string

Filtrar o status arquivado, o padrão não é baseado, use o valor todo nesse parâmetro para consultar todos os documentos.
Filtrar por email do destinatário
 email string

Filtrar por email do destinatário.
Limite de consulta
 limit integer

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

Deslocamento do início do conjunto de dados. Use com a consulta de limite para iterar por meio do conjunto de dados.
Filtrar por status do documento
 status integer

Filtrar 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.
Filtrar para criado após esta data
 created_gt date-time

Filtre para esses documentos criados após um determinado momento.
Filtrar para modificado após esta data
 modified_gt date-time

Filtre para esses documentos modificados após um determinado momento.

Retornos

Listagens de documentos

Corpo
DocumentListResponse

Obter grupos

ID da operação:
GetGroups

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Deslocamento de consulta
 offset integer

Deslocamento do início do conjunto de dados. Use com a consulta de limite para iterar por meio do conjunto de dados.
Limite de consulta
 limit integer

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

Retornos

Listagem de grupos

Corpo
GroupListResponse
ID da operação:
GetPdfTemplateEditLink

Retornar um link de uso único para inserir o editor de PDF.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pdf Id
 pdfId True string

Defina a ID de PDF carregada.
Ocultar a listagem de campos da página renderizada
 hide_sender_fields boolean

Ocultar a listagem de campos da página renderizada.
Código Hex excluindo o símbolo de hash para a cor do plano de fundo
 css_body_backgroundcolor string

Use o código hex excluindo o símbolo de hash para alterar a cor da tela de fundo.

Obter modelo de PDF

ID da operação:
GetPdfTemplate

Detalhes de um modelo específico de PDF

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de PDF carregada
 pdfId True uuid

ID de PDF carregada

Retornos

Detalhes do modelo

Corpo
TemplatePdfResponse

Obter modelos de PDF

ID da operação:
GetPdfTemplates

Listar modelos de PDF

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do grupo
 group string

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

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

Deslocamento do início do conjunto de dados. Use com a consulta de limite para iterar por meio do conjunto de dados.

Retornos

Listagens de modelo

Corpo
TemplatePdfListResponse
ID da operação:
GetSignerLink

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário

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

ID da operação:
GetSignerRejection

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do destinatário
 recipientId True uuid

ID do destinatário

Retornos

Nome Caminho Tipo Description
status
 status integer

Estátuas do destinatário.
reason
 reason string

Rejeite o motivo.

Obter usuário

ID da operação:
GetUser

Obtenha detalhes do usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id do usuário
 userId True uuid

Id do usuário

Retornos

Detalhes do usuário.

Corpo
UserDetailResponse

Gatilhos

Evento de destinatário

Gatilho para quando ocorrer um evento de destinatário
Evento de documento

Gatilho para um evento de documento ocorre

Evento de destinatário

ID da operação:
RecipientTrigger

Gatilho para quando ocorrer um evento de destinatário

Parâmetros

Nome Chave Obrigatório Tipo Description
eventFilter
 eventFilter True string

Filtro de evento
agrupar
 group string

Filtro de grupo

Retornos

Nome Caminho Tipo Description
versão
 version string

Versão
objeto
 object string

Object
marca
 data.tag string

Etiqueta
tag1
 data.tag1 string

Tag1
tag2
 data.tag2 string

Tag2
identificador único universal (UUID)
 data.uuid string

ID do destinatário
email
 data.email string

Email
agrupar
 data.group string

Grupo
ordem
 data.order integer

Pedido
status
 data.status integer

Situação
documento
 data.document string

Documento
sobrenome
 data.lastname string

Apelido
roleText
 data.roleText string

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

Nome próprio
statusText
 data.statusText string

Texto de status
emailBounce
 data.emailBounce integer

O e-mail retornou
resourceUri
 data.resourceUri string

URI de recurso do destinatário
nome_do_documento
 data.documentName string

Nome do documento
rejectReason
 data.rejectReason string

Rejeitar motivo
groupResourceUri
 data.groupResourceUri string

URI de recurso de grupo
emailBounceMessage
 data.emailBounceMessage string

Mensagem de retorno de email
documentResourceUri
 data.documentResourceUri string

URI do recurso de documento
criadas
 created integer

Criado
id
 id string

ID
evento
 event string

Event

Evento de documento

ID da operação:
DocumentTrigger

Gatilho para um evento de documento ocorre

Parâmetros

Nome Chave Obrigatório Tipo Description
eventFilter
 eventFilter True string

Filtro de evento
agrupar
 group string

Filtro de grupo

Retornos

Nome Caminho Tipo Description
versão
 version string

Versão
objeto
 object string

Object
tag1
 data.tag1 string

Etiqueta
recipients
 data.recipients array of object

Destinatários
identificador único universal (UUID)
 data.recipients.uuid string

ID do destinatário
email
 data.recipients.email string

Email do destinatário
ordem
 data.recipients.order integer

Número do pedido do destinatário
status
 data.recipients.status integer

Status do destinatário
sobrenome
 data.recipients.lastname string

Sobrenome 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
statusText
 data.recipients.statusText string

Statustexto do destinatário
resourceUri
 data.recipients.resourceUri string

URI de recurso do destinatário
rejectReason
 data.recipients.rejectReason string

rejectReason
groupResourceUri
 data.groupResourceUri string

URI de recurso de grupo
statusText
 data.statusText string

Texto de status do documento
nome
 data.name string

Nome do documento
marca
 data.tag string

Etiqueta
resourceUri
 data.resourceUri string

Uri de recurso
identificador único universal (UUID)
 data.uuid string

ID do documento
tag2
 data.tag2 string

Tag2
agrupar
 data.group string

Grupo
status
 data.status integer

Status do documento
criadas
 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.

Nome Caminho Tipo Description
limit
 limit integer

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

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

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

URL do conjunto anterior de objetos.
total_count
 total_count integer

Número total de objetos.

GroupListResponse

Listagem de grupos

Nome Caminho Tipo Description
meta
 meta ListMeta

Meta-informações sobre listagem.
Objetos
 objects array of object
criadas
 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 de recurso
lesma
 objects.slug string

Nome exclusivo
usuário
 objects.user string

URI de recurso do criador
xframe_allow
 objects.xframe_allow boolean

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

Permitir edição de inserção

TemplatePdfListResponse

Listagens de modelo

Nome Caminho Tipo Description
meta
 meta ListMeta

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

TemplatePdfResponse

Detalhes do modelo

Nome Caminho Tipo Description
criadas
 created date-time

Criado
agrupar
 group string

URI de grupo
modificado
 modified date-time

Modificado
Partes
 parties string

Matriz de caracteres JSON de partes de documento.
page_count
 page_count integer

Contagem de páginas
resource_uri
 resource_uri string

Uri de recurso
signer_count
 signer_count integer

Contagem de signatários
title
 title string

Title
usuário
 user string

URI de recurso do criador
identificador único universal (UUID)
 uuid uuid

Pdf Id
válido
 valid boolean

É possível enviar (se os campos não validarem).

DocumentListResponse

Listagens de documentos

Nome Caminho Tipo Description
meta
 meta ListMeta

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

Documentos
Arquivados
 objects.archived boolean

Arquivados
auto_archive
 objects.auto_archive boolean

Arquivar depois de enviar.
cc_emails
 objects.cc_emails string

Emails de lista delimitados por vírgulas para cc após a conclusão.
criadas
 objects.created date-time

Criado
do_email
 objects.do_email boolean

Use emails do 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
pdftext
 objects.pdftext string

Valores de campo do remetente
redirecionamento
 objects.redirect string

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

Uri de recurso
return_signer_links
 objects.return_signer_links boolean

Adicionar links de destinatário à 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, email, número de sms, has_fields, status, ordem do signatário (0 indexado)]
signers_in_order
 objects.signers_in_order integer

Destinatários de email de forma simultânea ou sequencial
status
 objects.status DocumentStatusEnum

Opções de status do documento:

  • 10 – Estado inicial, verificar o status do signatário para enviado/não enviado
  • 20 – Campos concluídos
  • 30 – Assinado
  • 40 – Removido (antes de assinar)
  • 50 - Rejeitado
marca
 objects.tag string

Marcar documento
tag1
 objects.tag1 string

Marcar documento
tag2
 objects.tag2 string

Marcar documento
modelo
 objects.template string

URI de recurso de modelo, se usado
templatepdf
 objects.templatepdf string

URI de recurso de modelo de PDF
enviar SMS
 objects.text string

Texto para assinatura
usuário
 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, verificar o status do signatário para enviado/não enviado
  • 20 – Campos concluídos
  • 30 – Assinado
  • 40 – Removido (antes de assinar)
  • 50 - Rejeitado

Opções de status do documento:

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

SignerResponse

Detalhes do destinatário

Nome Caminho Tipo Description
documento
 document string

Documento
email
 email string

Email do destinatário
primeiro_nome
 first_name string

Nome do destinatário
sobrenome
 last_name string

Sobrenome do destinatário
has_fields
 has_fields boolean

O destinatário tem campos
ordem
 order integer

Ordem do destinatário
resource_uri
 resource_uri string

URI de recurso do destinatário
status
 status SignerStatusEnum

Opções de status do signatário:

  • 4 – desagradar
  • 5 - agendado para ser enviado
  • 10 - enviado
  • 15 – email aberto
  • 20 - visitado
  • 30 – campos concluídos
  • 35 – campos completam a assinatura ex
  • 39 - aguardando a conclusão da testemunha
  • 40 - assinado
  • 50 – baixado
  • 60 - rejeitado

SignerStatusEnum

Opções de status do signatário:

  • 4 – desagradar
  • 5 - agendado para ser enviado
  • 10 - enviado
  • 15 – email aberto
  • 20 - visitado
  • 30 – campos concluídos
  • 35 – campos completam a assinatura ex
  • 39 - aguardando a conclusão da testemunha
  • 40 - assinado
  • 50 – baixado
  • 60 - rejeitado

Opções de status do signatário:

  • 4 – desagradar
  • 5 - agendado para ser enviado
  • 10 - enviado
  • 15 – email aberto
  • 20 - visitado
  • 30 – campos concluídos
  • 35 – campos completam a assinatura ex
  • 39 - aguardando a conclusão da testemunha
  • 40 - assinado
  • 50 – baixado
  • 60 - rejeitado
integer

DocumentResponseDetail

Detalhes do documento

Nome Caminho Tipo Description
Arquivados
 archived boolean

É arquivado
auto_archive
 auto_archive boolean

Enviar arquivo morto do documento após a assinatura.
cc_emails
 cc_emails string

Quem será cc'd com remetente na notificação por email quando assinado
criadas
 created date-time

Criado
do_email
 do_email boolean

Usar emails do 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

Documentos HTMl – altura px do rodapé se usado
agrupar
 group string

URI de recurso 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

Documentos HTMl – altura px do cabeçalho, se usado
modificado
 modified date-time

Modificado
nome
 name string

Nome do documento
pdf_password
 pdf_password string

Senha pdf
pdf_password_type
 pdf_password_type string

Se a senha em pdf for retida
pdftext
 pdftext string

Ignorar isso
redirecionamento
 redirect string

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

Uri de 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

herdado
sign_upload
 sign_upload boolean

herdado
signature_placement
 signature_placement integer

herdado
signature_type
 signature_type integer

herdado - 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, email, número de sms, has_fields, status, ordem do signatário (0 indexado)]
signer_objects
 signer_objects array of object

Lista de destinatários
email
 signer_objects.email string

Email
primeiro nome
 signer_objects.firstname string

Nome próprio
sobrenome
 signer_objects.lastname string

Apelido
Tel
 signer_objects.tel string

Número tel
ordem
 signer_objects.order integer

Ordem de assinatura
resource_uri
 signer_objects.resource_uri string

Uri de recurso
função
 signer_objects.role string

Função
status
 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 email de forma simultânea ou sequencial
status
 status DocumentStatusEnum

Opções de status do documento:

  • 10 – Estado inicial, verificar o status do signatário para enviado/não enviado
  • 20 – Campos concluídos
  • 30 – Assinado
  • 40 – Removido (antes de assinar)
  • 50 - Rejeitado
marca
 tag string

Sua referência
tag1
 tag1 string

Sua referência
tag2
 tag2 string

Sua referência
modelo
 template string

URI de recurso para modelo de texto, se usado
templatepdf
 templatepdf string

URI de recurso para modelo de pdf, se usado
enviar SMS
 text string

Texto para documento, se usado
usuário
 user string

URI de recurso do usuário.
identificador único universal (UUID)
 uuid uuid

ID do documento

MemberListResponse

Nome Caminho Tipo Description
meta
 meta ListMeta

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

MemberResponse

Nome Caminho Tipo Description
criadas
 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 de recurso
usuário
 user string

URI de recurso do usuário.

AttachmentResponse

Anexar item.

Nome Caminho Tipo Description
criadas
 created date-time

Criado
descrição
 description string

Description
filename
 filename string

Nome do arquivo
agrupar
 group string

Grupo
resource_uri
 resource_uri string

Anexar uri de recurso
usuário
 user string

URI de recurso do usuário
identificador único universal (UUID)
 uuid uuid

Anexar ID

AttachmentListResponse

Listagem de anexos

Nome Caminho Tipo Description
meta
 meta ListMeta

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

Listagem
criadas
 objects.created date-time

Criado
descrição
 objects.description string

Description
filename
 objects.filename string

Nome do arquivo
agrupar
 objects.group string

Grupo
resource_uri
 objects.resource_uri string

Uri de recurso
usuário
 objects.user string

URI de recurso do usuário
identificador único universal (UUID)
 objects.uuid uuid

Anexar ID

UserDetailResponse

Detalhes do usuário.

Nome Caminho Tipo Description
date_joined
 date_joined date-time

Data ingressada
email
 email email

Email
primeiro_nome
 first_name string

Nome próprio
groups
 groups array of string

Lista de grupos que esse usuário ingressou.
last_login
 last_login date-time

Último logon
sobrenome
 last_name string

Apelido
resource_uri
 resource_uri string

Uri de recurso
timezone
 timezone string

Fuso horário
nome de usuário
 username string

Nome de usuário

arquivo

Esse é o tipo de dados básico 'file'.