SigningHub (Pré-visualização)

A SigningHub, da Ascertia, oferece uma suíte abrangente para assinaturas digitais de alta confiança e automação de fluxos de trabalho documentais. Este conector permite às empresas autenticar utilizadores de forma segura, iniciar pedidos de assinatura de documentos e gerir ciclos de aprovação de ponta a ponta. Concebido para cumprir rigorosos padrões globais de segurança, garante que os seus fluxos de trabalho automatizados permaneçam legalmente aplicáveis, transparentes e altamente seguros em toda a sua organização.

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

Serviço	Class	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 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)

Contato
Nome	Support
URL	https://www.signinghub.com/contact-us/
Email	support@ascertia.com

Metadados do conector
Publisher	Ascertia Limitada.
Publisher	Ascertia
StackOwner	SigningHub
Cor da Marca	#1C1C1C
IconBrandColor	#1C1C1C
Sítio Web	https://signinghub.com
Política de privacidade	https://www.signinghub.com/privacy-policy
Categories	Conteúdos e Ficheiros; Produtividade

Conector SigningHub

O SigningHub disponibiliza uma API REST abrangente que permite às organizações automatizar e gerir fluxos de trabalho digitais de assinatura de documentos. Usando este conector, pode integrar o SigningHub com o Power Automate para simplificar os processos de aprovação de documentos e automatizar ações de assinatura dentro de fluxos de trabalho personalizados.

Este conector permite a automação da assinatura de documentos e de outras ações do SigningHub diretamente nos fluxos do Power Automate, ajudando as organizações a construir fluxos de trabalho documentais eficientes e seguros.

Publisher: Ascertia

Pré-requisitos

Para usar esse conector, você deve ter:

Uma conta ativa no SigningHub (https://www.signinghub.com).
Uma Integração válida definida no SigningHub.

Como obter credenciais

Preencha os campos do Formulário de Login com os seguintes valores:

Email: O email da conta SigningHub.
Palavra-passe: A palavra-passe da conta SigningHub.
ID do Cliente API: A Ascertia ou o administrador da sua empresa fornecerá o ID do Cliente API para usar o conector.
API Client Secret: A Ascertia ou o administrador da sua empresa fornecerá o API Client Secret para usar o conector.
URL da API: URL da API do SigningHub, por defeito https://api.signinghub.com

Operações suportadas

Este conector fornece alguma cobertura da API REST do SigningHub. Para uma lista de ações suportadas e os seus parâmetros, consulte o Guia da API do SigningHub.

Suporte & Ligações

Limites de Limitação

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

Ações

Adicionar Campo CheckBox	As aplicações empresariais podem usar esta API de serviço para adicionar uma caixa de seleção a um documento dentro de um pacote. Pelo menos um utilizador deve existir num fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho. Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores. Se os parâmetros de largura e altura não forem fornecidos, será atribuído um tamanho padrão de 10x10. Se forem fornecidas largura ou altura (ou ambas), o sistema irá comparar estes valores fornecidos entre si. O valor maior entre largura e altura será atribuído a ambas as dimensões.
Adicionar Campo de Assinatura Digital	Aplicações empresariais podem usar esta API de serviço para adicionar um campo de assinatura digital a um documento num pacote. Pelo menos um utilizador deve existir num fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho. Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores.
Adicionar Campo de Caixa de Texto	Aplicações empresariais podem usar esta API de serviço para adicionar um campo de introdução de texto a um documento num pacote. Pelo menos um utilizador deve existir num fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho. Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores.
Adicionar Campo Inicial	Aplicações empresariais podem usar esta API de serviço para adicionar um campo de iniciais a um documento dentro de um pacote. Pelo menos um utilizador deve existir num fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho. Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores.
Adicionar Campo Presencial	Aplicações empresariais podem usar esta API de serviço para adicionar um campo de assinatura presencial a um documento dentro de um pacote. Pelo menos um utilizador deve existir num fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho. Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores. Para organizar uma reunião presencial, um utilizador do SigningHub deve fazer parte do fluxo de trabalho. Devem ser adicionados com o Papel "INPERSON_HOST" ou "SIGNER". Para a opção host, não requerem assinatura ou campo de entrada no documento, e o campo de assinatura presencial pode ser assinado pelo utilizador não registado no SigningHub. Note que este é um cenário de fluxo de trabalho especial em que se espera que o utilizador e o destinatário do SigningHub estejam no mesmo local. Este tipo de assinatura não se destina a ser usado para que um documento seja partilhado com os destinatários através de um link de email no método normal de integração solta.
Adicionar Campo RadioBox	As aplicações empresariais podem usar esta API de serviço para adicionar uma caixa de seleção a um documento dentro de um pacote. Pelo menos um utilizador deve existir num fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho. Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores. Se os parâmetros de largura e altura não forem fornecidos, será atribuído um tamanho padrão de 10x10. Se forem fornecidas largura ou altura (ou ambas), o sistema irá comparar estes valores fornecidos entre si. O valor maior entre largura e altura será atribuído a ambas as dimensões.
Adicionar Código QR	Aplicações empresariais podem usar esta API de serviço para adicionar um Código QR a um documento dentro de um pacote.
Adicionar Grupos ao Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para adicionar grupos como destinatários a um fluxo de trabalho. Um grupo SigningHub significa que qualquer membro do grupo pode realizar a ação, ou seja, assinar, em nome de todos os membros do grupo. Note que o grupo será adicionado como o último utilizador/grupo no fluxo de trabalho. Assim, pode ser necessário mais trabalho para remover um utilizador/grupo atual, já presente no fluxo de trabalho. Enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
Adicionar ou Atualizar Documento a partir da Biblioteca	As aplicações empresariais podem usar esta API de serviço para adicionar um documento da biblioteca do utilizador a um pacote. O ID do pacote é fornecido na URL, o ID do documento também deve ser fornecido como "document_id" no URL do recurso para identificar o documento da biblioteca a ser copiado. Note que um pacote já deve existir antes de poder adicionar um documento usando esta chamada.
Adicionar Pacote	Esta API de serviço é usada para adicionar/criar um pacote de documentos para armazenar um ou mais documentos. Este pacote pode depois ser usado para adicionar documentos e destinatários para iniciar um novo fluxo de trabalho. Como referido anteriormente, esta chamada é obrigatória se quiser trabalhar com documentos. Tem de existir um pacote antes de poderes carregar ou adicionar documentos ao SigningHub.. Mesmo um único documento faz parte de um pacote: um pacote que contém um documento. Nota: Um pacote pode ser renomeado se necessário após a criação.
Adicionar um Espaço Temporário ao Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para adicionar um espaço temporário a um fluxo de trabalho dentro de um pacote. É necessário um marcador de lugar quando não se conhece a identidade do destinatário pretendido num fluxo de trabalho. Note que o marcador será adicionado como o último utilizador no fluxo de trabalho. Assim, pode ser necessário mais trabalho para remover um utilizador/grupo atual, já presente no fluxo de trabalho. Adicionar um marcador permite avançar e adicionar campos de assinatura e/ou introdução ao documento, que podem depois ser atribuídos a utilizadores individuais numa fase posterior. Enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
Adicionar Utilizadores ao Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para adicionar destinatários a um fluxo de trabalho. Esta chamada só adiciona um destinatário ao fluxo de trabalho. Ou seja, nenhum campo atualmente no documento será automaticamente atribuído ao(s) novo(s) destinatário(s), nem isto criará novos campos. Note que o(s) destinatário(s) serão adicionados como a última pessoa no fluxo de trabalho. Por isso, pode ser necessário mais trabalho para remover um(s) destinatário(s) atual(es) já presente no fluxo de trabalho. Pelo menos um utilizador deve existir num fluxo de trabalho antes de os campos (entrada e assinatura) poderem ser adicionados ao documento. Note que a entrada aceita um ou mais utilizadores numa única chamada. Nesta chamada específica, o utilizador é uma pessoa natural conhecida. No entanto, as mesmas regras aplicam-se a Grupos e Placeholders. Em qualquer um destes casos, o destinatário torna-se um Grupo de utilizadores em que qualquer membro do grupo pode assinar o documento, ou um Placeholder. Este último caso é usado quando não se sabe a identidade do signatário pretendido. Nota: A ordem de assinatura do workflow SigningHub começa em "1". Assim, adicionar um utilizador ao fluxo de trabalho sem recetores atuais inicia a contagem de novas ordens de assinatura. O parâmetro "signing_order" é obrigatório se o tipo de fluxo de trabalho for "personalizado". Importante, usar esta chamada API pode afetar o tipo de fluxo de trabalho. Se houver destinatários atuais num fluxo de trabalho sequencial e um novo for adicionado com a mesma ordem de assinatura que um destinatário atual, então essa parte do fluxo de trabalho muda automaticamente de sequencial para paralelo. Assim, o fluxo de trabalho no geral é agora de tipo personalizado em vez de puramente sequencial. Adicionar um destinatário com a mesma ordem de assinatura que dois ou em paralelo não altera o fluxo de trabalho. Existem apenas três ou mais destinatários nesse ponto específico do fluxo de trabalho; Tudo em ordem paralela. Note que, embora a preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
Aplicar Modelo de Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para aplicar um modelo de fluxo de trabalho a um documento. O ID do documento ao qual o modelo deve ser aplicado é fornecido na URL do recurso. Quando o ID do documento está definido para 0, o template será aplicado a todos os doucments num pacote. Ao aplicar o modelo, é importante lembrar estes dois pontos importantes: Ponto 1 - Se o modelo aplicado for criado usando um PDF que já contém campos de formulário, então certifique-se de que o documento onde este modelo está agora a ser aplicado deve conter esses campos de formulário antecipadamente e que o SigningHub NÃO irá criar esses campos através do modelo, apenas aplicando os dados do formulário e atribuindo-os aos respetivos utilizadores. Ponto 2 - Se o modelo aplicado for criado onde os campos do formulário são adicionados manualmente (daí que não estão presentes originalmente no PDF) via SigningHub, por exemplo, campo de assinatura, inicial, assinatura presencial, caixas de seleção, botões de versão, campos de texto, etc., então, ao aplicar tal modelo, esses campos de formulário serão criados no documento de destino, mesmo que esses campos já estivessem presentes no documento.
Aprovar Documento	As aplicações empresariais podem usar esta API de serviço para aprovar um documento por um utilizador especificado na ordem.
Assinar o Documento	As aplicações empresariais podem usar esta API de serviço para assinar um documento (tanto eletrónico como digital) sem apresentar o documento ao utilizador final através do SigningHub. Por exemplo, uma aplicação empresarial pode ter outro método para exibir o documento ao utilizador, sendo necessária apenas a funcionalidade de assinatura do SigningHub, ou para operações em massa pode ser justificado assinar sem exigir que o utilizador veja e aprove cada documento individualmente. Se houver alterações a guardar no documento antes da assinatura, deve ser chamada a API de Preencher Campos de Formulário antes de chamar a API de Assinatura. Note que quaisquer campos de entrada obrigatórios num documento devem ser concluídos antes de esta API ser concluída com sucesso. O signatário é identificado pelo token de acesso apresentado na chamada. Por isso, é necessária a autenticação do signatário antes de fazer esta chamada. Não pode autenticar-se como Administrador Empresarial com a variável de âmbito e assinar um documento em nome de um utilizador. O token de acesso deve ser emitido ao signatário como resultado da autenticação direta. Quando esta chamada termina, é importante que, se o signatário foi o último signatário de um documento, a chamada API Terminar Documento seja invocada. A razão é que, sem chamar essa API, o documento permanecerá no estado de "Em Progresso" para o proprietário do documento. Depois de a API ser chamada, o estado muda para "Concluído" para o proprietário do documento. Uma vez assinado o documento, a resposta de verificação pode ser vista através da API Get Document Verification . Utilização de OTP de Primeiro ou Segundo Fator para Autenticação Se a autenticação OTP for ativada para a operação de assinatura do lado do servidor, as aplicações cliente terão de gerar um OTP para o número móvel usando Autenticação do Signante via chamada OTP API. As respetivas aplicações empresariais devem recuperar o OTP do uso e submetê-lo ao efetuar a chamada API. Isto é feito usando o cabeçalho "x-otp" no pedido.
Atribuir Campo de Documento	Aplicações empresariais podem usar esta API de serviço para atribuir os utilizadores a campos de entrada, por exemplo, campos de assinatura, e assim definir a ordem de assinatura. Os campos devem já estar presentes no documento e os utilizadores devem estar presentes no fluxo de trabalho. O ID do documento de fluxo de trabalho é fornecido na URL do recurso, juntamente com o identificador do pacote. Quando os destinatários estão num fluxo de trabalho, são numerados, começando em um e contando para cima para cada um extra. Portanto, se houver três utilizadores num fluxo de trabalho, são numerados "1", "2" e "3" respeitosamente. Esta chamada API permite-lhe atribuir um utilizador pelo número de ordem do seu fluxo de trabalho, a um campo de entrada no documento.
Atualizar a Política de Certificação para um documento	As aplicações empresariais podem usar esta API de serviço para atualizar as definições de assinatura de certificação para um documento dentro de um pacote.
Atualizar Autenticação do Utilizador do Fluxo de Trabalho (Abertura de Documentos) do Pacote Empresarial	As aplicações empresariais podem usar esta API de serviço para atualizar as autenticações dos pacotes e a duração de acesso dos destinatários. Esta API também pode ser usada pelo administrador empresarial ou pelo utilizador empresarial se a variável "âmbito" foi usada no pedido de autenticação
Atualizar Campo CheckBox	As aplicações empresariais podem usar esta API de serviço para atualizar um campo de caixa de seleção de um documento num pacote. Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações. Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica. A largura e altura não podem ser atualizadas. Permanecerão iguais à data em que foram adicionados.
Atualizar Campo de Assinatura Digital	As aplicações empresariais podem usar esta API de serviço para atualizar um campo de assinatura digital de um documento num pacote. Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações. Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica.
Atualizar Campo TextBox	Aplicações empresariais podem usar esta API de serviço para atualizar uma caixa de texto de um documento num pacote. Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações. Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica.
Atualizar Código QR	Aplicações empresariais podem usar esta API de serviço para atualizar um Código QR de um documento num pacote.
Atualizar Detalhes do Fluxo de Trabalho	Aplicações empresariais podem usar esta API de serviço para atualizar os detalhes do fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento, mas as aplicações empresariais querem sobrepor-se à autorização de certificação ou aos detalhes de pós-processamento. O ID do pacote é fornecido na URL do recurso.
Atualizar o Campo Inicial	Aplicações empresariais podem usar esta API de serviço para atualizar um campo de iniciais de um documento num pacote. Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações. Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica.
Atualizar o Campo presencial	Aplicações empresariais podem usar esta API de serviço para atualizar um campo de assinatura presencial de um documento num pacote. Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações. Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica.
Atualizar o Espaço Partilhado	As aplicações empresariais podem usar esta API de serviço para atualizar o espaço partilhado. A disponibilidade para atualizar espaços partilhados está sujeita ao papel de utilizador empresarial atribuído. Para permitir esta disposição, o Enterprise Admin irá ativar a opção 'Gerir Espaço Partilhado' nas Definições do Documento de Papéis>.
Atualizar o Placeholder	As aplicações empresariais podem usar esta API de serviço para atualizar um marcador no fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor os detalhes de um marcador específico dentro do fluxo de trabalho. O ID do documento do fluxo de trabalho é fornecido na URL do recurso, e o marcador de posição do fluxo de trabalho é identificado pela ordem em que é adicionado ao fluxo de trabalho. Enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
Atualizar o Utilizador do Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para atualizar os dados de um destinatário, grupo ou marcador de posição que já foi adicionado a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor os detalhes de um utilizador específico dentro do fluxo de trabalho. O ID do documento de workflow é fornecido na URL do recurso, e o destinatário do workflow é identificado pela ordem em que é adicionado ao workflow. Note-se que, embora a preparação de documentos do tipo XML, só suporta os tipos de função "SIGNER", "REVIEWER" e "CARBON_COPY".
Atualizar permissões de utilizador do fluxo de trabalho	As aplicações empresariais podem usar esta API de serviço para atualizar as permissões de fluxo de trabalho de um utilizador que já foi adicionado a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor as permissões dentro do fluxo de trabalho. O ID do pacote de documentos é fornecido na URL do recurso, e o utilizador do fluxo de trabalho é identificado pela ordem em que é adicionado ao fluxo de trabalho.
Atualização do Fluxo de Trabalho Encomenda dos Utilizadores	As aplicações empresariais podem usar esta API de serviço para atualizar a ordem do destinatário no fluxo de trabalho.
Atualização RadioBox Field	Aplicações empresariais podem usar esta API de serviço para atualizar um botão de opção de um documento num pacote. Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações. Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica. A largura e altura não podem ser atualizadas. Permanecerão iguais à data em que foram adicionados.
Baixar anexo	As aplicações empresariais podem usar esta API de serviço para descarregar o anexo de um documento.
Campos AutoPlace	Aplicações empresariais podem chamar esta API para adicionar campos de assinatura ou formulário definidos pelo utilizador a um documento com base no critério de pesquisa fornecido. As opções de colocação são: à esquerda, à direita, em cima e em baixo. O documento é pesquisado e todas as instâncias dos critérios de pesquisa cumpridas são processadas. Isto permite adicionar vários campos numa só chamada. Por exemplo, carregue um documento e coloque automaticamente um campo de assinatura à direita de todas as instâncias da palavra "Assine aqui:". Isto poupa tempo e garante que nenhuma assinatura é perdida no fluxo de trabalho. A chamada API suporta todos os tipos de campos; nomeadamente eletrónica, digital, presencial, iniciais, campo de texto, etc. Além disso, a chamada API suporta a variável "order". Isto significa que pode atribuir automaticamente um conjunto de campos de assinatura a um único utilizador. Assim, a chamada pode ser repetida para colocar e atribuir campos de assinatura a mais do que um utilizador no fluxo de trabalho. Pelo menos um utilizador deve existir num fluxo de trabalho antes de poderem adicionar campos de assinatura ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho. Esta chamada de API pode ser usada várias vezes no mesmo documento. A razão para isso é acomodar múltiplos signatários num documento. O destinatário ou signatário é identificado pela variável "ordem" passada na chamada. Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores.
Carregar anexo	As aplicações empresariais podem usar esta API de serviço para carregar um anexo num documento.
Carregar documento	As aplicações empresariais podem usar esta API de serviço para adicionar um documento a um pacote de documentos ligado à conta de um utilizador empresarial. A informação do documento é enviada no cabeçalho do pedido HTTP e os bytes do documento são enviados no corpo do pedido HTTP. Note O SigningHub converterá formatos de documentos suportados para PDF se o cabeçalho "x-convert-document" estiver definido para o valor "true". O único caso suportado em que este valor é definido como "falso" é para manter o formato Word e documentos XML. O SigningHub suporta uma grande variedade de formatos de documentos, cada um dos quais pode ser convertido para PDF após o carregamento. Clique aqui para a lista completa. Nota: os documentos PDF não são alterados ao serem carregados no sistema. Note que um pacote já deve existir antes de poder adicionar um documento usando esta chamada.
Delete Workflow User	As aplicações empresariais podem usar esta API de serviço para eliminar o destinatário do fluxo de trabalho.
Descarregar documento	As aplicações empresariais podem usar esta API de serviço para descarregar os bytes do documento. O ID do pacote e o ID do documento são fornecidos na URL do recurso.
Documento de Aprovação do Gatekeeper	As aplicações empresariais podem usar esta API de serviço para aprovar um documento por um utilizador especificado na ordem.
Documento de Declínio	Aplicações empresariais podem usar esta API de serviço para recusar um documento de um utilizador especificado na encomenda.
Documento de Declínio do Gatekeeper	Aplicações empresariais podem usar esta API de serviço para recusar um documento por um utilizador especificado na encomenda.
Documento de Recall	As aplicações empresariais podem usar esta API de serviço para interromper um fluxo de trabalho em andamento. O ID do documento é fornecido na URL do recurso. Após a recolha, o estado do documento muda automaticamente para "RASCUNHO".
Eliminar Campo de Documento	Aplicações empresariais podem usar esta API de serviço para eliminar um campo de documento num pacote.
Eliminar Espaço Partilhado	Aplicações empresariais podem usar esta API de serviço para eliminar espaço partilhado. A possibilidade de eliminar espaços partilhados está sujeita ao papel de utilizador empresarial atribuído. Para permitir esta disposição, o Enterprise Admin irá ativar a opção 'Gerir Espaço Partilhado' nas Definições do Documento de Papéis>.
Estado de Assinatura em Massa	As aplicações empresariais podem usar esta API para obter o estado de uma transação específica de assinatura em massa, juntamente com os detalhes dos pacotes de documentos processados pela API de Pacotes de Assinatura em Massa . Deve chamar esta API após a API de Pacotes de Assinatura em Massa. O signatário é identificado pelo token de acesso apresentado na chamada. Por isso, é necessária a autenticação do signatário antes de fazer esta chamada. Não pode autenticar-se como Administrador Empresarial com a variável de âmbito e assinar um documento em nome de um utilizador. O token de acesso deve ser emitido ao signatário como resultado da autenticação direta. Para assinatura RAS, a propriedade ACTION será REMOTE_AUTHORIZATION_REQURIED e a propriedade STATUS será PENDENTE, indicando que o pedido precisa de ser autorizado através do dispositivo móvel. Se o processo de assinatura falhar num documento devido a diferentes níveis de garantia configurados e o utilizador quiser reiniciar o processo de assinatura para concluir o processo de assinatura em documentos falhados, a propriedade ACTION será REINITIATE_SIGNING_PROCESS e a propriedade STATUS será PENDENTE.
Excluir anexo	As aplicações empresariais podem usar esta API de serviço para eliminar o anexo de um documento.
Excluir documento	Aplicações empresariais podem usar esta API de serviço para eliminar um documento num pacote.
Excluir pacote	Aplicações empresariais podem usar esta API de serviço para eliminar um documento da caixa de entrada do utilizador. O ID do pacote é fornecido no URL do recurso como "{package_id}". Se o estado do documento for PENDENTE, então é automaticamente recusado como resultado da operação de eliminação. Se o estado do documento for PARTILHADO, então o documento é automaticamente recolhido e o fluxo de trabalho é interrompido antes de o documento ser eliminado.
Fluxo de Trabalho Completo no Meio (Terminar Fluxo de Trabalho)	As aplicações empresariais podem marcar o fluxo de trabalho como concluído mesmo a meio do processo. Use esta API de serviço para alterar o estado do fluxo de trabalho para concluído. Se houver destinatários que ainda não assinaram o documento. A assinatura deles já não será necessária e não poderão ver o documento na caixa de entrada. O token portador deve pertencer ao proprietário do documento ou o administrador da empresa pode usar a variável de alcance para obter o token de acesso em nome do proprietário do documento para realizar esta ação.
Iniciais de Preenchimento	As aplicações empresariais podem usar esta API de serviço para preencher um campo de iniciais num documento por um utilizador especificado na ordem.
Lembretes de Atualização do Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para atualizar os lembretes de fluxo de trabalho para um destinatário que já foi adicionado a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor as definições de lembretes dentro do fluxo de trabalho. O ID do documento de workflow é fornecido na URL do recurso, e o destinatário do workflow é identificado pela ordem em que é adicionado ao workflow.
Mover Pacote para uma pasta Personalizada ou Espaço Partilhado	As aplicações empresariais podem usar esta API de serviço para mover o pacote do documento para um espaço partilhado ou para uma pasta personalizada do utilizador.
Obtenha a Política de Certificação para um documento	Aplicações empresariais podem usar esta API de serviço para obter definições de assinatura de certificação de um documento num pacote.
Obtenha Autenticação do Utilizador por Fluxo de Trabalho (Abertura de Documentos) de um Pacote Empresarial	As aplicações empresariais podem usar esta API de serviço para ativar as definições de segurança de acesso para o pacote. Os destinatários para quem a segurança está configurada são identificados pela ordem no URL. O ID do pacote também é identificado no URL do pedido. Os destinatários não poderão aceder ao pacote de documentos fora do âmbito deste período se a segurança de acesso estiver ativada. O proprietário do documento também pode configurar a segurança do pacote baseada em autenticação para um destinatário.
Obtenha Detalhes do Documento	As aplicações empresariais podem usar esta API de serviço para obter os detalhes do documento. O ID do documento é fornecido na URL como "{document_id}".
Obtenha Detalhes do Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para obter detalhes do fluxo de trabalho para o pacote.
Obtenha Detalhes do Pacote	As aplicações empresariais podem usar esta API de serviço para obter os detalhes de um pacote. Esta API pode também ser usada pela aplicação empresarial para realizar ações em nome do utilizador empresarial através da "Autenticação de Escopo".
Obtenha Espaço Partilhado	As aplicações empresariais podem usar esta API de serviço para obter um espaço partilhado específico. Esta API devolve informações sobre o espaço partilhado, o seu proprietário e colaborador.
Obtenha Histórico de Fluxo de Trabalho	As aplicações empresariais podem utilizar esta API de serviço para recuperar a lista de ações realizadas num documento. O ID do pacote é fornecido na URL do recurso. O campo de pesquisa (cabeçalho x-search-text) destina-se a email, nome do documento, ação, infokey e infovalue.
Obtenha Modelos Empresariais	Aplicações empresariais podem usar esta API de serviço para obter listas de modelos empresariais do utilizador atual. Isto significa o administrador empresarial ou o utilizador empresarial se a variável "âmbito" foi usada no pedido de autenticação. É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text".
Obtenha o Relatório de Provas de Processo	As aplicações empresariais podem usar esta API de serviço para descarregar o relatório de evidência do processo de fluxo de trabalho de um documento.
Obtenha Permissões de Utilizador do Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para obter permissões de documentos para um destinatário. O destinatário é identificado pela ordem no fluxo de trabalho. O ID do pacote é fornecido na URL do recurso.
Obtenha Utilizadores do Fluxo de Trabalho	As aplicações empresariais podem usar esta API de serviço para obter detalhes do fluxo de trabalho para o pacote.
Obter anexos	As aplicações empresariais podem usar esta API de serviço para obter os anexos de um documento.
Obter campos de documento	Aplicações empresariais podem usar esta API de serviço para obter campos de documento, ou seja, iniciais, campos de assinatura, campos de assinatura ou de formulário.
Obter Contactos	As aplicações empresariais podem usar esta API de serviço para identificar contactos tanto pessoais como empresariais para o utilizador atual. É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text". Além disso, é possível pesquisar os contactos específicos de um utilizador ou da empresa a que o utilizador pertence. A informação de resposta de pesquisa contém o endereço de email do utilizador e o respetivo nome de utilizador.
Obter modelos	Aplicações empresariais podem usar esta API de serviço para obter listas de modelos para o utilizador atual. É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text". Além disso, é possível pesquisar os modelos pessoais de um utilizador ou os modelos empresariais conforme permitido pelo seu papel de utilizador pelo administrador da empresa.
Pacote de Renomeação	Esta API de serviço é usada para renomear um pacote de documentos. O pacote do documento é identificado pelo seu identificador único no URL da chamada.
Pacotes de Sinais em Massa	As aplicações empresariais podem usar esta API para assinar/partilhar/assinar e partilhar múltiplos documentos (tanto eletrónicos como digitais) sem apresentar os documentos ao utilizador final. Esta API necessita de informações da aplicação empresarial sobre pacotes de documentos e detalhes de assinaturas, campos presenciais e iniciais. Após a conclusão bem-sucedida da transação de assinatura em massa, a API devolverá os estados e IDs das transações dos pacotes de documentos. Ao contrário da API Sign Document, esta API não só assina um pacote de documento, como também o marca como aprovado e revisto, consoante se o destinatário é Signatário, Editor ou Revisor. Qualquer pacote documental cujo estado devolve como CONCLUÍDO foi assinado, aprovado ou revisto por esta API. A assinatura em massa funciona com todos os métodos de autenticação em tempo de assinatura. Se o SIGN for aprovado como bulk_action e o pacote estiver em estado de Rascunho, o Sign and Share será realizado automaticamente. Deve chamar esta API após a API Pre Bulk Sign Documents . Caso precise de fazer alterações em algum documento antes de assinar, deve ser chamada a API Field Form Fields antes de chamar a API de Documento Pre Bulk Sign. Lembre-se, quaisquer campos de entrada obrigatórios num documento precisam de ser preenchidos antes de esta API ser concluída com sucesso; enquanto isso, os campos preenchidos automaticamente (como Nome, Email, Data, Título do Cargo, etc.) serão preenchidos automaticamente. O signatário é identificado pelo token de acesso apresentado na chamada. Por isso, é necessária a autenticação do signatário antes de fazer esta chamada. Não pode autenticar-se como Administrador Empresarial com a variável de âmbito e assinar um documento em nome de um utilizador. O token de acesso deve ser emitido ao signatário como resultado da autenticação direta. Uma vez assinado o documento, a resposta de verificação pode ser vista através da API de Estado de Assinatura em Massa . Utilização de OTP de Primeiro ou Segundo Fator para Autenticação Caso a autenticação OTP esteja ativada para a operação de assinatura do lado do servidor, as aplicações clientes terão de gerar um OTP para o número móvel usando a Autenticação de Assinatura em Massa via chamada OTP API. As respetivas aplicações empresariais devem recuperar o OTP do uso e submetê-lo ao efetuar a chamada API. Isto é feito usando o cabeçalho "x-otp" no pedido.
Partilhar Pacote de Documentos	As aplicações empresariais podem usar esta API de serviço para partilhar um pacote de documentos com os signatários e iniciar um novo fluxo de trabalho. O documento já deve ter sido preparado aplicando um modelo e, opcionalmente, atualizando os utilizadores e ações definidos no modelo. O ID do pacote a partilhar é fornecido na URL do recurso.
Preencher campos de formulário	As aplicações empresariais podem usar esta API de serviço para preencher um ou mais campos de formulário num documento por um utilizador especificado na ordem.
Processamento de Acabamento	As aplicações empresariais podem usar esta API de serviço para concluir o processamento do documento após assinarem todos os campos de assinatura. Este método é usado principalmente por aplicações móveis nativas do SigningHub para iOS e Android, bem como por casos de uso na web móvel. Aplicações empresariais gerais que utilizam integração estreita no seu respetivo portal não precisam de usar este método. No entanto, ao utilizar a API Sign Document (e por isso o utilizador não recebe uma representação visual do documento que é solicitado a assinar), é necessário chamar esta API para garantir que o respetivo fluxo de trabalho continua ou se conclui. Por exemplo, uma vez que todas as assinaturas tenham sido aplicadas usando a chamada "cega" Sign Document API, o documento não aparecerá como estado "Completado" ao proprietário até que esta API seja invocada. O proprietário do documento verá um estado de "Em Progresso" até que esta API seja chamada. Dentro das aplicações móveis nativas do SigningHub e dos casos de uso da web móvel, esta chamada é necessária para garantir que cada utilizador completa as suas respetivas ações relativamente ao SigningHub. Por exemplo, depois de um signatário ter assinado um documento na aplicação SigningHub, este método é invocado pela aplicação para garantir que o fluxo de trabalho continua a ser processado e que o próximo signatário é notificado, e o estado do documento está disponível através do URL de retorno de chamada configurado.
Pós-Processamento de Atualização	As aplicações empresariais podem usar esta API de serviço para adicionar um documento temporário a um fluxo de trabalho, um documento num pacote.
Receba Pacotes	As aplicações empresariais podem usar esta API de serviço para obter uma lista de documentos filtrada por diferentes estados. Os utilizadores podem dividir os registos em páginas fornecendo um número de registos por página.
Receba um lembrete de fluxo de trabalho	As aplicações empresariais podem usar esta API de serviço para atualizar os lembretes para os destinatários que já foram adicionados a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor as definições de lembretes dentro do fluxo de trabalho. O ID do documento de workflow é fornecido na URL do recurso, e o destinatário do workflow é identificado pela ordem em que é adicionado ao workflow.
Renomeação do Documento	As aplicações empresariais podem usar esta API de serviço para renomear um documento num pacote.
Submeter Documento	Um dos papéis do SigningHub chama-se "Editor". Isto permite ao destinatário editar campos de entrada num documento, mas não requer assinatura. Depois de concluído, o destinatário submete as suas alterações. O botão usado na interface gráfica chama-se "Submit". Esta é a operação equivalente para um editor submeter as suas alterações através de uma chamada API. Clique em SigningHub Roles para uma descrição de todas as funções disponíveis para destinatários do fluxo de trabalho.
Transferir Pacote	Aplicações empresariais podem usar esta API de serviço para descarregar o pacote de documentos em formato binário. O ID do pacote é fornecido na URL do recurso. Se o pacote contiver apenas um documento, o download é o documento PDF binário. Alternativamente, se o pacote tiver mais do que um documento, o download é o ficheiro binário zip de todos os documentos. Os cabeçalhos x-password e x-otp são opcionais. São obrigatórios se o proprietário do documento os definiu durante a fase de criação do fluxo de trabalho.

Adicionar Campo CheckBox

ID da Operação:: V4_Checkbox_AddCheckBox

As aplicações empresariais podem usar esta API de serviço para adicionar uma caixa de seleção a um documento dentro de um pacote.

Pelo menos um utilizador deve existir num fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho.

Consulte Adicionar Utilizadores ao Fluxo de Trabalho para mais informações. Note que se tiver um documento com um modelo aplicado, ou tiver aplicado um usando as APIs, então o fluxo de trabalho já conterá utilizadores.

Se os parâmetros de largura e altura não forem fornecidos, será atribuído um tamanho padrão de 10x10. Se forem fornecidas largura ou altura (ou ambas), o sistema irá comparar estes valores fornecidos entre si. O valor maior entre largura e altura será atribuído a ambas as dimensões.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
order	order	True	integer	A ordem do utilizador no fluxo de trabalho para a qual o campo está a ser adicionado.
page_no	page_no	True	integer	Número de página onde o campo será criado.
field_name	field_name		string	Nome do campo fornecido que deve ser adicionado. Se não for fornecido, o sistema atribuirá um nome único gerado automaticamente ao campo.
valor	value		string	Valor do campo. Os valores possíveis são "verdadeiro" ou "falso"
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
validation_rule	validation_rule		string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".

Devoluções

Body: AddFieldResponse

Adicionar Campo de Assinatura Digital

ID da Operação:: V4_Signature_AddSignature

Aplicações empresariais podem usar esta API de serviço para adicionar um campo de assinatura digital a um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para o qual os detalhes do fluxo de trabalho precisam de ser atualizados.
ID do documento	documentId	True	integer	O ID do documento onde o campo deve ser adicionado.
order	order	True	integer	Ordem do destinatário para o qual o campo está a ser criado.
page_no	page_no	True	integer	Número de página onde o campo está prestes a ser criado.
field_name	field_name		string	Nome do campo que será adicionado. Se não for fornecido, o sistema atribuirá um nome único gerado automaticamente ao campo.
level_of_assurance	level_of_assurance		array of string	Nível de Garantia a ser adicionado. Os Valores Possíveis são "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
Ecrã	display		string	Visibilidade do campo a ser adicionado, os valores possíveis são "VISIBLE" e "INVISIBLE"
enabled	enabled	True	boolean	Verdade, se a autenticação estiver ativada para o campo. Caso contrário, é falso.
enabled	enabled	True	boolean	Verdade, se a autenticação OTP por SMS/Email estiver ativada para o campo. Caso contrário, é falso.
mobile_number	mobile_number		string	Número de telemóvel do destinatário ao qual o campo está atribuído.
enabled	enabled	True	boolean	Verdade, se a autenticação TOTP estiver ativada para o campo. Caso contrário, é falso.

Devoluções

Body: SignatureFieldResponse

Adicionar Campo de Caixa de Texto

ID da Operação:: V4_TextBox_AddTextBox

Aplicações empresariais podem usar esta API de serviço para adicionar um campo de introdução de texto a um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
order	order	True	integer	A ordem do utilizador no fluxo de trabalho para a qual o campo está a ser adicionado.
page_no	page_no	True	integer	Número de página onde o campo será criado.
tipo	type	True	string	Tipo de campo, os valores possíveis são "TEXTO", "NOME", "EMAIL", "EMPRESA", "CARGO DO CARGO", "DATA". Todos os campos de texto, exceto TEXTO, são preenchidos automaticamente em modo pendente com os atributos/dados do destinatário.
valor	value		string	Valor do campo. Para tipo = DATA, espera-se que o valor siga o formato ISO 8601. Seguindo o formato YYYY-MM-DD hh:mm:ss +00. Como os valores são para campos de data, as aplicações clientes podem enviar YYYY-MM-DD e ignorar hh:mm:ss +00. Se o valor não estiver no formato correto, será devolvido um erro.
marcador de posição	placeholder		string	Texto provisório para o campo de texto. Para nome, email, empresa, título do cargo e data, o valor provisório pode ser "NOME", "EMAIL", "EMPRESA", "CARGO", "DATA". Os programadores podem enviar os seus próprios marcadores para sobrescrever os valores padrão. Para "TEXTO" os programadores podem fornecer os seus próprios textos provisórios. Estes marcadores de posição aparecem nos campos de texto enquanto se visualiza o documento no visualizador.
max_length	max_length	True	integer	Comprimento máximo do valor permitido no campo. Deve ser entre 1 e 9999
format	format		string	Formato de texto do campo. Usado apenas para o campo do tipo de data. Os valores possíveis são M/D d/m/aa m/d/yyyy mm/dd/yy dd/mm/aaaa mm/yy mm/yyyy D-mmm M-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd AAAA-MM-DD mmm-yy Mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
field_name	field_name		string	Nome do campo que será adicionado. Se não for fornecido, o sistema atribuirá um nome único gerado automaticamente ao campo.
field_type	field_type	True	string	Tipo de campo relativamente à aceitação do tipo de valores, os valores possíveis são "NUMBER" ou "TEXT".
validation_rule	validation_rule	True	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
required	required	True	boolean
tipo	type		string	Especifica o tipo de regra de validação, que atualmente está sempre definida como EQUALS para o campo de texto.
valor	value		string	Representa o valor utilizado para validação.
Nome	name		string	Nome da fonte selecionada para o campo de texto. Os valores possíveis são "COURIER", "HELVETICA".
size	size		string	Tamanho da fonte selecionado para o campo de texto. Os valores possíveis são 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Tamanho da fonte no documento PDF original.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
multilinha	multiline	True	boolean	Se definido como verdadeiro, seria criado o campo área de texto

Devoluções

Body: AddFieldResponse

Adicionar Campo Inicial

ID da Operação:: V4_Initials_AddInitial

Aplicações empresariais podem usar esta API de serviço para adicionar um campo de iniciais a um documento dentro de um pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
order	order	True	integer	A ordem do utilizador no fluxo de trabalho para a qual o campo está a ser adicionado.
page_no	page_no	True	integer	Número de página onde o campo será criado.
field_name	field_name		string	Nome do campo que será adicionado. Se não for fornecido, o sistema atribuirá um nome único gerado automaticamente ao campo.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.

Devoluções

Body: AddFieldResponse

Adicionar Campo Presencial

ID da Operação:: V4_InPerson_AddInPerson

Aplicações empresariais podem usar esta API de serviço para adicionar um campo de assinatura presencial a um documento dentro de um pacote.

Para organizar uma reunião presencial, um utilizador do SigningHub deve fazer parte do fluxo de trabalho. Devem ser adicionados com o Papel "INPERSON_HOST" ou "SIGNER". Para a opção host, não requerem assinatura ou campo de entrada no documento, e o campo de assinatura presencial pode ser assinado pelo utilizador não registado no SigningHub.

Note que este é um cenário de fluxo de trabalho especial em que se espera que o utilizador e o destinatário do SigningHub estejam no mesmo local. Este tipo de assinatura não se destina a ser usado para que um documento seja partilhado com os destinatários através de um link de email no método normal de integração solta.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
order	order	True	integer	A ordem do utilizador no fluxo de trabalho para a qual o campo está a ser adicionado.
page_no	page_no	True	integer	Número de página onde o campo será criado.
field_name	field_name		string	Nome do campo que será adicionado. Se não for fornecido, o sistema atribuirá um nome único gerado automaticamente ao campo.
marcador de posição	placeholder	True	string	Identificador de string para o campo presencial, pode ser Cliente, Jack, CEO, etc.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
Ecrã	display		string	Visibilidade do campo a ser adicionado, os valores possíveis são "VISIBLE" e "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Nível de Garantia a ser atualizado. Os Valores Possíveis são "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
enabled	enabled	True	boolean	Verdade, se a autenticação estiver ativada para o campo. Caso contrário, é falso.
enabled	enabled	True	boolean	Verdade, se a autenticação OTP por SMS/Email estiver ativada para o campo. Caso contrário, é falso.
mobile_number	mobile_number		string	Número de telemóvel do destinatário ao qual o campo está atribuído.
enabled	enabled	True	boolean	Verdade, se a autenticação TOTP estiver ativada para o campo. Caso contrário, é falso.

Devoluções

Body: AddFieldResponse

Adicionar Campo RadioBox

ID da Operação:: V4_Radio_AddRadioBox

As aplicações empresariais podem usar esta API de serviço para adicionar uma caixa de seleção a um documento dentro de um pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
order	order	True	integer	A ordem do utilizador no fluxo de trabalho para a qual o campo está a ser adicionado.
page_no	page_no	True	integer	Número de página onde o campo será criado.
field_name	field_name		string	Nome do campo fornecido que deve ser adicionado. Se não for fornecido, o sistema atribuirá um nome único gerado automaticamente ao campo.
valor	value		string	Valor do campo. Os valores possíveis são "verdadeiro" ou "falso"
validation_rule	validation_rule	True	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
radio_group_name	radio_group_name	True	string
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.

Devoluções

Body: AddFieldResponse

Adicionar Código QR

ID da Operação:: V4_QR_AddQRCode

Aplicações empresariais podem usar esta API de serviço para adicionar um Código QR a um documento dentro de um pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
page_no	page_no	True	integer	Número de página onde o campo será criado.
field_name	field_name		string	Nome do campo fornecido que deve ser adicionado. Se não for fornecido, o sistema atribuirá um nome único gerado automaticamente ao campo.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
dados	data		string	Os dados em texto simples devem ser codificados no código QR. O padrão é URL gerado para aceder ao documento relacionado. por exemplo, {base_url}/document/{document_unique_id}
error_correction_level	error_correction_level	True	string	Nível de Correção de Erros para o código QR, que determina a quantidade de redundância dos dados. As opções são: L (Baixo), M (Médio), Q (Quartil) e H (Alto). Níveis mais altos oferecem maior resistência a erros. O padrão é "Q"
codificação	encoding	True	string	Especifica o modo de codificação de caracteres para o conteúdo do código QR. As opções suportadas são: Default, Iso8859_1, Iso8859_2 e Utf8. O padrão é "Padrão"
pixels_per_module	pixels_per_module	True	integer	Especifica o número de píxeis por módulo no código QR. Um número maior resulta num código QR maior e mais detalhado. O padrão é "20". Os valores possíveis são: 20 \| 30 \| 40 \| 50
add_margins	add_margins	True	boolean	Indica se as zonas de silêncio (margens) devem ser desenhadas em torno do código QR. As zonas silenciosas ajudam os scanners a detetar e decifrar o código QR com mais precisão. O padrão é "verdadeiro"
pontos	dots		string	Representa a cor escura usada para os pontos no código QR. O padrão é "preto". por exemplo, "#000000"
em segundo plano	background		string	Representa a cor clara usada para o fundo do código QR. O padrão é "branco". por exemplo, "#ffffff"
base64	base64		string	Um ícone opcional (base64) para colocar no centro do código QR.
hide_background_dots	hide_background_dots	True	boolean	A cor de fundo atrás do ícone, se for fornecido um ícone. Se não for fornecida cor, é implementado fundo transparente.
size	size	True	integer	O tamanho do ícone como percentagem do tamanho do código QR, se for fornecido um ícone. O padrão é "15". Valores possíveis são: 10 \| 15 \| 20 \| 25 \| 30 \| 35 \| 40

Devoluções

Body: AddQrCodeResponse

Adicionar Grupos ao Fluxo de Trabalho

ID da Operação:: V4_Workflow_WorkflowAddGroup

As aplicações empresariais podem usar esta API de serviço para adicionar grupos como destinatários a um fluxo de trabalho. Um grupo SigningHub significa que qualquer membro do grupo pode realizar a ação, ou seja, assinar, em nome de todos os membros do grupo.

Note que o grupo será adicionado como o último utilizador/grupo no fluxo de trabalho. Assim, pode ser necessário mais trabalho para remover um utilizador/grupo atual, já presente no fluxo de trabalho. Enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote para o qual o grupo será adicionado.
group_name	group_name		string	O nome do novo grupo a ser adicionado no fluxo de trabalho.
email_notification	email_notification	True	boolean	Definir o seu valor para "verdadeiro" envia uma notificação por email ao utilizador quando chega a sua vez no fluxo de trabalho. Definir o seu valor como "falso" não envia a notificação por email ao utilizador no seu turno. Se não for fornecido valor, o valor padrão de "verdadeiro" será definido.
função	role	True	string	Papel do destinatário no fluxo de trabalho. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST". No entanto, enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem em que o fluxo de trabalho será assinado pelos destinatários. Esta ordem de assinatura é importante quando o tipo de fluxo de trabalho está definido como "PERSONALIZADO".

Devoluções

response: array of CollaboratorGroupResponse

Adicionar ou Atualizar Documento a partir da Biblioteca

ID da Operação:: V4_Documents_UploadFromLibrary

As aplicações empresariais podem usar esta API de serviço para adicionar um documento da biblioteca do utilizador a um pacote. O ID do pacote é fornecido na URL, o ID do documento também deve ser fornecido como "document_id" no URL do recurso para identificar o documento da biblioteca a ser copiado.

Note que um pacote já deve existir antes de poder adicionar um documento usando esta chamada.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote ao qual o documento está a ser adicionado.
ID do documento	documentId	True	integer	O ID do documento da biblioteca que precisa de ser adicionado/atualizado
ID de Documento Antigo	x-document-id		string	ID do documento antigo do pacote atual que precisa de ser atualizado

Devoluções

Body: UploadDocumentLibraryResponse

Adicionar Pacote

ID da Operação:: V4_Package_AddPackage

Esta API de serviço é usada para adicionar/criar um pacote de documentos para armazenar um ou mais documentos. Este pacote pode depois ser usado para adicionar documentos e destinatários para iniciar um novo fluxo de trabalho.

Como referido anteriormente, esta chamada é obrigatória se quiser trabalhar com documentos. Tem de existir um pacote antes de poderes carregar ou adicionar documentos ao SigningHub..

Mesmo um único documento faz parte de um pacote: um pacote que contém um documento.

Nota: Um pacote pode ser renomeado se necessário após a criação.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
package_name	package_name		string	O nome do pacote. O nome padrão do pacote é sempre "Untitled" se o package_name não for fornecido.
workflow_mode	workflow_mode	True	string	O modo do fluxo de trabalho é suportado por três tipos de modos de fluxo de trabalho na aplicação. Os valores possíveis são "ONLY_ME", "ME_AND_OTHERS" e "ONLY_OTHERS"
folder_name	folder_name		string	O nome da pasta. Será usado para carregar pacotes em qualquer pasta do utilizador, seja uma pasta personalizada ou uma pasta partilhada.

Devoluções

Body: AddPackageResponse

Adicionar um Espaço Temporário ao Fluxo de Trabalho

ID da Operação:: V4_Workflow_WorkflowAddPlaceholder

As aplicações empresariais podem usar esta API de serviço para adicionar um espaço temporário a um fluxo de trabalho dentro de um pacote. É necessário um marcador de lugar quando não se conhece a identidade do destinatário pretendido num fluxo de trabalho.

Note que o marcador será adicionado como o último utilizador no fluxo de trabalho. Assim, pode ser necessário mais trabalho para remover um utilizador/grupo atual, já presente no fluxo de trabalho.

Adicionar um marcador permite avançar e adicionar campos de assinatura e/ou introdução ao documento, que podem depois ser atribuídos a utilizadores individuais numa fase posterior. Enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID da embalagem para a qual o espaço provisório deve ser adicionado.
marcador de posição	placeholder		string	O nome do novo marcador a ser adicionado no fluxo de trabalho.
email_notification	email_notification	True	boolean	Definir o seu valor para "verdadeiro" envia uma notificação por email ao utilizador quando chega a sua vez no fluxo de trabalho. Definir o seu valor como "falso" não envia a notificação por email ao utilizador no seu turno.
função	role	True	string	Papel do destinatário no fluxo de trabalho. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST". No entanto, enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem em que o fluxo de trabalho será assinado pelos destinatários. Esta ordem de assinatura é importante quando o tipo de fluxo de trabalho está definido como "PERSONALIZADO".

Devoluções

response: array of CollaboratorPlaceholderResponse

Adicionar Utilizadores ao Fluxo de Trabalho

ID da Operação:: V4_Workflow_WorkflowAddUser

As aplicações empresariais podem usar esta API de serviço para adicionar destinatários a um fluxo de trabalho. Esta chamada só adiciona um destinatário ao fluxo de trabalho. Ou seja, nenhum campo atualmente no documento será automaticamente atribuído ao(s) novo(s) destinatário(s), nem isto criará novos campos.

Note que o(s) destinatário(s) serão adicionados como a última pessoa no fluxo de trabalho. Por isso, pode ser necessário mais trabalho para remover um(s) destinatário(s) atual(es) já presente no fluxo de trabalho.

Pelo menos um utilizador deve existir num fluxo de trabalho antes de os campos (entrada e assinatura) poderem ser adicionados ao documento.

Note que a entrada aceita um ou mais utilizadores numa única chamada.

Nesta chamada específica, o utilizador é uma pessoa natural conhecida. No entanto, as mesmas regras aplicam-se a Grupos e Placeholders. Em qualquer um destes casos, o destinatário torna-se um Grupo de utilizadores em que qualquer membro do grupo pode assinar o documento, ou um Placeholder. Este último caso é usado quando não se sabe a identidade do signatário pretendido.

Nota: A ordem de assinatura do workflow SigningHub começa em "1". Assim, adicionar um utilizador ao fluxo de trabalho sem recetores atuais inicia a contagem de novas ordens de assinatura. O parâmetro "signing_order" é obrigatório se o tipo de fluxo de trabalho for "personalizado".

Importante, usar esta chamada API pode afetar o tipo de fluxo de trabalho. Se houver destinatários atuais num fluxo de trabalho sequencial e um novo for adicionado com a mesma ordem de assinatura que um destinatário atual, então essa parte do fluxo de trabalho muda automaticamente de sequencial para paralelo. Assim, o fluxo de trabalho no geral é agora de tipo personalizado em vez de puramente sequencial. Adicionar um destinatário com a mesma ordem de assinatura que dois ou em paralelo não altera o fluxo de trabalho. Existem apenas três ou mais destinatários nesse ponto específico do fluxo de trabalho; Tudo em ordem paralela.

Note que, embora a preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote SigningHub, ao qual os destinatários devem ser adicionados.
user_email	user_email		string	Endereço de email do utilizador a ser adicionado no fluxo de trabalho.
user_name	user_name	True	string	Nome do destinatário a ser adicionado no fluxo de trabalho.
user_national_id	user_national_id		string	Identificação nacional do utilizador do destinatário
email_notification	email_notification	True	boolean	Se estiver definido como verdadeiro, o SigningHub enviará notificações ao utilizador por email, conforme as definições do proprietário do documento e das notificações ao utilizador. Um valor de false significa que não serão enviadas notificações ao utilizador durante todo o fluxo de trabalho.
função	role	True	string	Papel do destinatário no fluxo de trabalho. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST". No entanto, enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem do destinatário no fluxo de trabalho. Esta ordem de assinatura é obrigatória quando o tipo de fluxo de trabalho é "PERSONALIZADO".
delivery_method	delivery_method	True	string	Método de entrega do destinatário no fluxo de trabalho. Os valores possíveis são "EMAIL", "SMS" ou "EMAIL_AND_SMS". O valor padrão seria EMAIL
mobile_number	mobile_number		string	Número de telemóvel

Devoluções

response: array of CollaboratorResponse

Aplicar Modelo de Fluxo de Trabalho

ID da Operação:: V4_Workflow_ApplyTemplate

As aplicações empresariais podem usar esta API de serviço para aplicar um modelo de fluxo de trabalho a um documento. O ID do documento ao qual o modelo deve ser aplicado é fornecido na URL do recurso. Quando o ID do documento está definido para 0, o template será aplicado a todos os doucments num pacote.

Ao aplicar o modelo, é importante lembrar estes dois pontos importantes:

Ponto 1 - Se o modelo aplicado for criado usando um PDF que já contém campos de formulário, então certifique-se de que o documento onde este modelo está agora a ser aplicado deve conter esses campos de formulário antecipadamente e que o SigningHub NÃO irá criar esses campos através do modelo, apenas aplicando os dados do formulário e atribuindo-os aos respetivos utilizadores.

Ponto 2 - Se o modelo aplicado for criado onde os campos do formulário são adicionados manualmente (daí que não estão presentes originalmente no PDF) via SigningHub, por exemplo, campo de assinatura, inicial, assinatura presencial, caixas de seleção, botões de versão, campos de texto, etc., então, ao aplicar tal modelo, esses campos de formulário serão criados no documento de destino, mesmo que esses campos já estivessem presentes no documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote ao qual o modelo precisa de ser aplicado.
ID do documento	documentId	True	integer	O ID do documento onde o modelo deve ser aplicado. Se o valor estiver definido como 0, se o template for aplicado a todos os documentos do pacote.
template_name	template_name	True	string	Nome do modelo a ser aplicado no documento.
apply_to_all	apply_to_all	True	boolean	Verdade, se o modelo for aplicado a todos os documentos do pacote.

Devoluções

Body: DocumentDetailsResponse

Aprovar Documento

ID da Operação:: V4_Package_Approve

As aplicações empresariais podem usar esta API de serviço para aprovar um documento por um utilizador especificado na ordem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote a ser aprovado.
razão	reason		string	A razão para aprovar um pacote.
Palavra-passe de Acesso a Documentos	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
Documento One-Time Palavra-passe	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Assinar o Documento

ID da Operação:: V4_Signing_SignDocument

As aplicações empresariais podem usar esta API de serviço para assinar um documento (tanto eletrónico como digital) sem apresentar o documento ao utilizador final através do SigningHub. Por exemplo, uma aplicação empresarial pode ter outro método para exibir o documento ao utilizador, sendo necessária apenas a funcionalidade de assinatura do SigningHub, ou para operações em massa pode ser justificado assinar sem exigir que o utilizador veja e aprove cada documento individualmente. Se houver alterações a guardar no documento antes da assinatura, deve ser chamada a API de Preencher Campos de Formulário antes de chamar a API de Assinatura. Note que quaisquer campos de entrada obrigatórios num documento devem ser concluídos antes de esta API ser concluída com sucesso.

O signatário é identificado pelo token de acesso apresentado na chamada. Por isso, é necessária a autenticação do signatário antes de fazer esta chamada. Não pode autenticar-se como Administrador Empresarial com a variável de âmbito e assinar um documento em nome de um utilizador. O token de acesso deve ser emitido ao signatário como resultado da autenticação direta.

Quando esta chamada termina, é importante que, se o signatário foi o último signatário de um documento, a chamada API Terminar Documento seja invocada. A razão é que, sem chamar essa API, o documento permanecerá no estado de "Em Progresso" para o proprietário do documento. Depois de a API ser chamada, o estado muda para "Concluído" para o proprietário do documento.

Uma vez assinado o documento, a resposta de verificação pode ser vista através da API Get Document Verification .

Utilização de OTP de Primeiro ou Segundo Fator para Autenticação

Se a autenticação OTP for ativada para a operação de assinatura do lado do servidor, as aplicações cliente terão de gerar um OTP para o número móvel usando Autenticação do Signante via chamada OTP API. As respetivas aplicações empresariais devem recuperar o OTP do uso e submetê-lo ao efetuar a chamada API. Isto é feito usando o cabeçalho "x-otp" no pedido.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O identificador da embalagem que contém o documento para assinatura.
ID do documento	documentId	True	integer	Identificador do documento a assinar.
field_name	field_name	True	string	Identificador único do campo de assinatura no documento.
hand_signature_image	hand_signature_image		string	Imagem de string codificada em Base64 da aparência da assinatura visível, que é colocada no documento. Note que isto pode ser recuperado nas definições pessoais do utilizador através desta chamada. (A resposta é binária, pelo que a aplicação empresarial deve então codificar o Base64 antes de submeter nesta chamada API.)
hand_signature_method	hand_signature_method		integer	0 = DESENHO 1 = TEXTO 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NENHUM
signing_reason	signing_reason		string	Motivo da assinatura fornecido pelo destinatário. Nota: Indicação de tipo de compromisso para documentos XML
signing_location	signing_location		string	Local do signatário fornecido pelo destinatário.
contact_information	contact_information		string	Informações de contacto do signatário fornecidas pelo destinatário.
user_name	user_name		string	Nome do signatário fornecido pelo destinatário. Note que isto aplica-se apenas a operações de assinaturas presenciais.
user_password	user_password		string	Palavra-passe fornecida pelo utilizador, sujeita às definições de assinatura do utilizador.
appearance_design	appearance_design		string	Nome da aparência da assinatura fornecido pelo utilizador para assinatura. Caso não seja fornecido o nome da aparência, a aparência selecionada por defeito será usada. Os valores possíveis são "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_capacity	signing_capacity		string	Nome do perfil de certificação/capacidade de assinatura com o qual o documento deve ser assinado. Se não for fornecida, a capacidade padrão será usada para assinar. O nome fornecido deve ser exatamente o mesmo do perfil real devido à sensibilidade maiúscula.
skip_verification	skip_verification	True	boolean	Nenhuma verificação de assinatura retorna no corpo da resposta quando está definida como verdadeira. Valor padrão deste parâmetro definido como falso.
signing_server	signing_server		string	Nome do servidor de assinatura com o qual o documento deve ser assinado.
mechanism	mechanism		string	Mecanismo da autenticação. Os valores possíveis para o mecanismo são: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC
palavra-passe	password		string	É um parâmetro opcional, mas só é obrigatório quando se usa 'AUTHENTICATION_PASSWORD' como valor de parâmetro em 'mecanismo'
token	token		string	É um parâmetro opcional que será recebido de servidores de terceiros, mas só é obrigatório ao usar 'AUTHENTICATION_AZURE_ACTIVE_DIRECTORY', 'AUTHENTICATION_OFFICE_365', 'AUTHENTICATION_OAUTH2', 'AUTHENTICATION_OIDC''AUTHENTICATION_GOOGLE''AUTHENTICATION_LINKED_IN'' 'AUTHENTICATION_SALES_FORCE' como valor de parâmetro em 'mecanismo'
user_identifier	user_identifier		string	É um parâmetro opcional, mas só é obrigatório quando se usa 'AUTHENTICATION_ACTIVE_DIRECTORY' ou 'AUTHENTICATION_SAML' como valor de parâmetro em 'mecanismo'
id	id		string	É um parâmetro opcional, mas só é obrigatório quando se usa 'AUTHENTICATION_SALES_FORCE' ou 'AUTHENTICATION_IDFY' como valor de parâmetro em 'mecanismo'. Para 'AUTHENTICATION_IDFY' é requestId
code_verifier	code_verifier		string	Verificador de Código se o PKCE estiver ativado para o cliente.
nonce	nonce		string	Valor nonce se estiver ativado para o cliente.
One-Time Palavra-passe (OTP)	x-otp		string	O OTP é usado como autenticação de segundo fator para a operação de assinatura.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.
Originador Móvel	x-mobile		string	Defina o originador (Web/Mobile) do pedido/ação

Devoluções

Body: SignDocumentResponse

Atribuir Campo de Documento

ID da Operação:: V4_Fields_AutoAssignField

Aplicações empresariais podem usar esta API de serviço para atribuir os utilizadores a campos de entrada, por exemplo, campos de assinatura, e assim definir a ordem de assinatura. Os campos devem já estar presentes no documento e os utilizadores devem estar presentes no fluxo de trabalho. O ID do documento de fluxo de trabalho é fornecido na URL do recurso, juntamente com o identificador do pacote.

Quando os destinatários estão num fluxo de trabalho, são numerados, começando em um e contando para cima para cada um extra. Portanto, se houver três utilizadores num fluxo de trabalho, são numerados "1", "2" e "3" respeitosamente. Esta chamada API permite-lhe atribuir um utilizador pelo número de ordem do seu fluxo de trabalho, a um campo de entrada no documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual o utilizador do fluxo de trabalho precisa de ser atualizado.
field_name	field_name	True	string	Nome do campo de assinatura que deve ser atribuído.
radio_group_name	radio_group_name		string	Fornecer o nome do grupo para a caixa de rádio
order	order	True	integer	A ordem do utilizador no fluxo de trabalho, a que o campo está a ser atribuído.
level_of_assurance	level_of_assurance		array of string	Nível de Garantia a ser adicionado. Os Valores Possíveis são "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

Devoluções

response: object

Atualizar a Política de Certificação para um documento

ID da Operação:: V4_Documents_UpdateCertifyPolicy

As aplicações empresariais podem usar esta API de serviço para atualizar as definições de assinatura de certificação para um documento dentro de um pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	O ID do documento sobre o qual a ação deve ser realizada.
enabled	enabled	True	boolean	É verdade se as definições de certificação estiverem ativadas para o documento.
permissão	permission	True	string	Certificar o nível de permissão que deve ser definido para o documento. Os valores possíveis são "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" e "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".
lock_form_fields	lock_form_fields	True	boolean	É verdade se os campos do formulário forem bloqueados após a última assinatura no documento atual.

Devoluções

response: object

Atualizar Autenticação do Utilizador do Fluxo de Trabalho (Abertura de Documentos) do Pacote Empresarial

ID da Operação:: V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

As aplicações empresariais podem usar esta API de serviço para atualizar as autenticações dos pacotes e a duração de acesso dos destinatários. Esta API também pode ser usada pelo administrador empresarial ou pelo utilizador empresarial se a variável "âmbito" foi usada no pedido de autenticação

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para o qual o fluxo de trabalho acede, segurança e autenticação deve ser atualizado.
Ordem do destinatário	order	True	integer	Ordem do destinatário no fluxo de trabalho para o qual a segurança de acesso e autenticação deve ser atualizada.
apply_to_all	apply_to_all	True	boolean	Verdade, se a segurança de acesso ou as autenticações forem aplicadas a todos os destinatários no fluxo de trabalho.
enabled	enabled	True	boolean	Verdade, se a autenticação estiver ativada para o pacote.
enabled	enabled	True	boolean	Verdade, se a autenticação por palavra-passe estiver ativada para o pacote.
user_password	user_password		string	String de palavra-passe se o campo de palavra-passe estiver ativado. Se uma palavra-passe já estiver definida e o proprietário não quiser alterá-la, remova o campo da resposta ou envie nulo.
enabled	enabled	True	boolean	Verdade, se a autenticação OTP por SMS estiver ativada para o pacote.
mobile_number	mobile_number		string	Número de telemóvel do destinatário. É necessário um número de telemóvel para enviar o SMS ao destinatário para a autenticação.
enabled	enabled	True	boolean	Ativado
enabled	enabled	True	boolean	Verdade, se a autenticação estiver ativada para o pacote.
mobile_number	mobile_number		string	Número de telemóvel do destinatário. É necessário um número de telemóvel para enviar o SMS ao destinatário para a autenticação.
enabled	enabled	True	boolean	Ativado
enabled	enabled	True	boolean	Verdade, se a segurança da duração do acesso estiver ativada para o pacote.
enabled	enabled	True	boolean	É verdade se a segurança de acesso estiver ativada durante um determinado período por data e hora.
start_date_time	start_date_time		date-time	Data e hora a partir da qual o pacote estará acessível ao destinatário.
end_date_time	end_date_time		date-time	Data e hora após as quais o pacote deixará de estar acessível ao destinatário.
enabled	enabled	True	boolean	Verdade, se a segurança de acesso estiver ativada durante um período de dias.
total_days	total_days	True	integer	Número total de dias em que a encomenda estará acessível ao destinatário após receber a encomenda.

Devoluções

response: object

Atualizar Campo CheckBox

ID da Operação:: V4_Checkbox_UpdateCheckBox

As aplicações empresariais podem usar esta API de serviço para atualizar um campo de caixa de seleção de um documento num pacote.

Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações. Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica.

A largura e altura não podem ser atualizadas. Permanecerão iguais à data em que foram adicionados.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome atual do campo, que vai ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se for intenção de renomear.
page_no	page_no	True	integer	Número de página onde o campo será criado.
valor	value		string	Valor do campo. Os valores possíveis são "verdadeiro" ou "falso"
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
validation_rule	validation_rule		string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Atualizar Campo de Assinatura Digital

ID da Operação:: V4_Signature_UpdateSignature

As aplicações empresariais podem usar esta API de serviço para atualizar um campo de assinatura digital de um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome atual do campo, que vai ser atualizado.
level_of_assurance	level_of_assurance		array of string	Nível de Garantia a ser atualizado. Os Valores Possíveis são "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
renamed_as	renamed_as		string	Nome atualizado do campo se for intenção de renomear o campo.
page_no	page_no	True	integer	Número de página onde o campo será criado.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
Ecrã	display		string	Visibilidade do campo a atualizar, os valores possíveis são "VISÍVEL" e "INVISÍVEL"
enabled	enabled	True	boolean	Verdade, se a autenticação estiver ativada para o campo. Caso contrário, é falso.
enabled	enabled	True	boolean	Verdade, se a autenticação OTP por SMS/Email estiver ativada para o campo. Caso contrário, é falso.
mobile_number	mobile_number		string	Número de telemóvel do destinatário ao qual o campo está atribuído.
enabled	enabled	True	boolean	Verdade, se a autenticação TOTP estiver ativada para o campo. Caso contrário, é falso.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Atualizar Campo TextBox

ID da Operação:: V4_TextBox_UpdateTextBox

Aplicações empresariais podem usar esta API de serviço para atualizar uma caixa de texto de um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome atual do campo, que vai ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se for intenção de renomear.
page_no	page_no	True	integer	Número de página onde o campo será criado.
valor	value		string	Valor do campo. Para tipo = DATA, espera-se que o valor siga o formato ISO 8601. Seguindo o formato YYYY-MM-DD hh:mm:ss +00. Como os valores são para campos de data, as aplicações clientes podem enviar YYYY-MM-DD e ignorar hh:mm:ss +00. Se o valor não estiver no formato correto, será devolvido um erro.
max_length	max_length	True	integer	Comprimento máximo do valor permitido no campo. Deve ser entre 1 e 9999
field_type	field_type	True	string	Tipo de campo relativamente à aceitação do tipo de valores, os valores possíveis são "NUMBER" ou "TEXT".
validation_rule	validation_rule	True	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
Nome	name		string	Nome da fonte selecionada para o campo de texto. Os valores possíveis são "COURIER", "HELVETICA".
size	size		string	Tamanho da fonte selecionado para o campo de texto. Os valores possíveis são 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Tamanho da fonte no documento PDF original.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
marcador de posição	placeholder		string	Os programadores podem fornecer os seus próprios textos provisórios. Estes marcadores de posição aparecem nos campos de texto enquanto se visualiza o documento no visualizador.
format	format		string	Formato de texto do campo. Usado apenas para o campo do tipo de data. Os valores possíveis são M/D d/m/aa m/d/yyyy mm/dd/yy dd/mm/aaaa mm/yy mm/yyyy D-mmm M-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd AAAA-MM-DD mmm-yy Mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
required	required	True	boolean
tipo	type		string	Especifica o tipo de regra de validação, que atualmente está sempre definida como EQUALS para o campo de texto.
valor	value		string	Representa o valor utilizado para validação.

Devoluções

response: object

Atualizar Código QR

ID da Operação:: V4_QR_UpdateQRCode

Aplicações empresariais podem usar esta API de serviço para atualizar um Código QR de um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome atual do campo, que vai ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se for intenção de renomear.
page_no	page_no	True	integer	O número da página para qual campo precisa de ser atualizado
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
dados	data		string	Os dados em texto simples devem ser codificados no código QR. O padrão é URL gerado para aceder ao documento relacionado. por exemplo, {base_url}/document/{document_unique_id}
error_correction_level	error_correction_level	True	string	Nível de Correção de Erros para o código QR, que determina a quantidade de redundância dos dados. As opções são: L (Baixo), M (Médio), Q (Quartil) e H (Alto). Níveis mais altos oferecem maior resistência a erros. O padrão é "Q"
codificação	encoding	True	string	Especifica o modo de codificação de caracteres para o conteúdo do código QR. As opções suportadas são: Default, Iso8859_1, Iso8859_2 e Utf8. O padrão é "Padrão"
pixels_per_module	pixels_per_module	True	integer	Especifica o número de píxeis por módulo no código QR. Um número maior resulta num código QR maior e mais detalhado. O padrão é "20". Os valores possíveis são: 20 \| 30 \| 40 \| 50
add_margins	add_margins	True	boolean	Indica se as zonas de silêncio (margens) devem ser desenhadas em torno do código QR. As zonas silenciosas ajudam os scanners a detetar e decifrar o código QR com mais precisão. O padrão é "verdadeiro"
pontos	dots		string	Representa a cor escura usada para os pontos no código QR. O padrão é "preto". por exemplo, "#000000"
em segundo plano	background		string	Representa a cor clara usada para o fundo do código QR. O padrão é "branco". por exemplo, "#ffffff"
base64	base64		string	Um ícone opcional (base64) para colocar no centro do código QR.
hide_background_dots	hide_background_dots	True	boolean	A cor de fundo atrás do ícone, se for fornecido um ícone. Se não for fornecida cor, é implementado fundo transparente.
size	size	True	integer	O tamanho do ícone como percentagem do tamanho do código QR, se for fornecido um ícone. O padrão é "15". Valores possíveis são: 10 \| 15 \| 20 \| 25 \| 30 \| 35 \| 40

Devoluções

Body: UpdateQrCodeResponse

Atualizar Detalhes do Fluxo de Trabalho

ID da Operação:: V4_Workflow_UpdateWorkflow

Aplicações empresariais podem usar esta API de serviço para atualizar os detalhes do fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento, mas as aplicações empresariais querem sobrepor-se à autorização de certificação ou aos detalhes de pós-processamento. O ID do pacote é fornecido na URL do recurso.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para o qual os detalhes do fluxo de trabalho precisam de ser atualizados.
workflow_type	workflow_type		string	Tipo de fluxo de trabalho para o pacote, por exemplo (SERIAL, PARALELO, INDIVIDUAL, PERSONALIZADO). Se não for fornecido valor, o valor antigo será mantido.
workflow_mode	workflow_mode		string	Modo de fluxo de trabalho do pacote, por exemplo (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). Se o modo de workflow estiver definido para ONLY_ME então nenhum colaborador pode ser adicionado ao pacote além do utilizador autenticado
continue_on_decline	continue_on_decline		boolean	Verdade, se o fluxo de trabalho precisar continuar mesmo que algum destinatário recuse o documento. Se não for fornecido valor, o valor antigo será mantido.
mensagem	message		string	Uma mensagem de string personalizada do proprietário do documento para cada destinatário, esta mensagem aparece tanto no email de partilha como no ecrã. Se não for fornecido valor, o valor antigo será mantido.
comments	comments		boolean	Permitir comentários

Devoluções

response: object

Atualizar o Campo Inicial

ID da Operação:: V4_Initials_UpdateInitial

Aplicações empresariais podem usar esta API de serviço para atualizar um campo de iniciais de um documento num pacote.

Note que todos os parâmetros de entrada podem ser alterados. Se quiser manter a configuração atual, envie-a na chamada sem alterações.

Assim, pode usar os mesmos parâmetros de quando adicionou o campo de entrada, ou a informação devolvida pelos Campos do Documento Obter. Esta última pode ser usada quando um modelo foi aplicado ou o documento foi criado usando a interface gráfica.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome atual do campo, que vai ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se for intenção de renomear.
page_no	page_no	True	integer	Número de página onde o campo será criado.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.

Devoluções

response: object

Atualizar o Campo presencial

ID da Operação:: V4_InPerson_UpdateInPerson

Aplicações empresariais podem usar esta API de serviço para atualizar um campo de assinatura presencial de um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome atual do campo, que vai ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo, se for intenção de renomear.
page_no	page_no	True	integer	Número de página onde o campo será criado.
marcador de posição	placeholder		string	Identificador de string para o campo presencial, pode ser Cliente, Jack, CEO, etc.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
Ecrã	display		string	Visibilidade do campo a atualizar, os valores possíveis são "VISÍVEL" e "INVISÍVEL"
level_of_assurance	level_of_assurance		array of string	Nível de Garantia a ser atualizado. Os Valores Possíveis são "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
enabled	enabled	True	boolean	Verdade, se a autenticação estiver ativada para o campo. Caso contrário, é falso.
enabled	enabled	True	boolean	Verdade, se a autenticação OTP por SMS/Email estiver ativada para o campo. Caso contrário, é falso.
mobile_number	mobile_number		string	Número de telemóvel do destinatário ao qual o campo está atribuído.
enabled	enabled	True	boolean	Verdade, se a autenticação TOTP estiver ativada para o campo. Caso contrário, é falso.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Atualizar o Espaço Partilhado

ID da Operação:: V4_WorkSpace_UpdateSharedSpace

As aplicações empresariais podem usar esta API de serviço para atualizar o espaço partilhado. A disponibilidade para atualizar espaços partilhados está sujeita ao papel de utilizador empresarial atribuído. Para permitir esta disposição, o Enterprise Admin irá ativar a opção 'Gerir Espaço Partilhado' nas Definições do Documento de Papéis>.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de Espaço Partilhado	id	True	integer	ID do espaço partilhado que queres atualizar
Nome	name		string	Nome do espaço partilhado
Nome	name	True	string	Nome do membro do espaço de trabalho
e-mail	email	True	string	Endereço de email do membro do espaço de trabalho

Devoluções

response: object

Atualizar o Placeholder

ID da Operação:: V4_Workflow_WorkflowUpdatePlaceholder

As aplicações empresariais podem usar esta API de serviço para atualizar um marcador no fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor os detalhes de um marcador específico dentro do fluxo de trabalho. O ID do documento do fluxo de trabalho é fornecido na URL do recurso, e o marcador de posição do fluxo de trabalho é identificado pela ordem em que é adicionado ao fluxo de trabalho. Enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID da embalagem para a qual o espaço provisório deve ser adicionado.
Encomenda	order	True	integer	Ordem do destinatário no fluxo de trabalho.
marcador de posição	placeholder		string	O nome do novo marcador a ser adicionado no fluxo de trabalho. Se não for fornecido valor, o valor antigo será mantido.
email_notification	email_notification		boolean	Definir o seu valor para "verdadeiro" envia uma notificação por email ao utilizador quando chega a sua vez no fluxo de trabalho. Definir o seu valor como "falso" não envia a notificação por email ao utilizador no seu turno. Se não for fornecido valor, o valor antigo será mantido.
função	role	True	string	Papel do destinatário a ser atualizado. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST". Se não for fornecido valor, o valor antigo será mantido. No entanto, enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem em que o fluxo de trabalho será assinado pelos destinatários. Esta ordem de assinatura é importante quando o tipo de fluxo de trabalho está definido como "PERSONALIZADO".

Devoluções

response: object

Atualizar o Utilizador do Fluxo de Trabalho

ID da Operação:: V4_Workflow_WorkflowUserUpdate

As aplicações empresariais podem usar esta API de serviço para atualizar os dados de um destinatário, grupo ou marcador de posição que já foi adicionado a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor os detalhes de um utilizador específico dentro do fluxo de trabalho. O ID do documento de workflow é fornecido na URL do recurso, e o destinatário do workflow é identificado pela ordem em que é adicionado ao workflow. Note-se que, embora a preparação de documentos do tipo XML, só suporta os tipos de função "SIGNER", "REVIEWER" e "CARBON_COPY".

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para qual o utilizador do fluxo de trabalho precisa de ser atualizado.
Encomenda	order	True	integer	A ordem do utilizador no fluxo de trabalho.
user_email	user_email		string	O endereço de email do novo utilizador a ser atualizado no fluxo de trabalho. Se não for fornecido valor, o valor antigo será mantido.
user_name	user_name		string	Nome do destinatário a ser atualizado. Se não for fornecido valor, o valor antigo será mantido.
email_notification	email_notification		boolean	Definir o seu valor para "verdadeiro" envia uma notificação por email ao utilizador quando chega a sua vez no fluxo de trabalho. Definir o seu valor como "falso" não envia a notificação por email ao utilizador no seu turno. Se não for fornecido valor, o valor antigo será mantido.
mobile_number	mobile_number		string	Número de telemóvel. Se não for fornecido valor, o valor antigo será mantido.
função	role	True	string	Papel do destinatário a ser atualizado. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST". Se não for fornecido valor, o valor antigo será mantido. No entanto, enquanto preparação de documentos do tipo XML, apenas os tipos de função suportados são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem em que o fluxo de trabalho será assinado pelos destinatários. Esta ordem de assinatura é importante quando o tipo de fluxo de trabalho está definido como "PERSONALIZADO".
email_language_code	email_language_code		string	Código da linguagem do email
delivery_method	delivery_method	True	string	Método de entrega do destinatário no fluxo de trabalho. Os valores possíveis são "EMAIL", "SMS" ou "EMAIL_AND_SMS". O valor padrão seria EMAIL
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

Body: UpdateCollaboratorResponse

Atualizar permissões de utilizador do fluxo de trabalho

ID da Operação:: V4_WorkflowPermission_UpdateWorkflowPermissions

As aplicações empresariais podem usar esta API de serviço para atualizar as permissões de fluxo de trabalho de um utilizador que já foi adicionado a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor as permissões dentro do fluxo de trabalho. O ID do pacote de documentos é fornecido na URL do recurso, e o utilizador do fluxo de trabalho é identificado pela ordem em que é adicionado ao fluxo de trabalho.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para que permissões de workflow devem ser atualizadas.
Encomenda	order	True	integer	A ordem do destinatário para a qual as permissões do fluxo de trabalho devem ser atualizadas.
apply_to_all	apply_to_all	True	boolean	Verdade, se as permissões forem aplicadas a todos os destinatários no fluxo de trabalho.
imprimir	print		boolean	Define se o destinatário pode imprimir o documento.
descarregamento	download		boolean	Define se o destinatário pode descarregar o documento.
add_text	add_text		boolean	Define se o destinatário pode adicionar campos de texto no documento.
change_recipients	change_recipients		boolean	Permite ao utilizador alterar qualquer destinatário que ainda não tenha assinado.
add_attachment	add_attachment		boolean	Define se o destinatário pode adicionar anexos no documento PDF.
enabled	enabled	True	boolean	Verdade, se o aviso legal estiver ativado.
legal_notice_name	legal_notice_name		string	Nome do aviso legal selecionado para o destinatário.
enabled	enabled	True	boolean	Ativado
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Atualização do Fluxo de Trabalho Encomenda dos Utilizadores

ID da Operação:: V4_Workflow_WorkflowUserUpdateOrder

As aplicações empresariais podem usar esta API de serviço para atualizar a ordem do destinatário no fluxo de trabalho.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual os destinatários devem ser adicionados.
Encomenda	order	True	integer	Ordem existente do destinatário que deve ser atualizada.
order	order	True	integer	A ordem do destinatário que deve ser atualizada.

Devoluções

response: object

Atualização RadioBox Field

ID da Operação:: V4_Radio_UpdateRadioBox

Aplicações empresariais podem usar esta API de serviço para atualizar um botão de opção de um documento num pacote.

A largura e altura não podem ser atualizadas. Permanecerão iguais à data em que foram adicionados.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome atual do campo, que vai ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se for intenção de renomear.
page_no	page_no	True	integer	Número de página onde o campo será criado.
valor	value		string	Valor do campo. Os valores possíveis são "verdadeiro" ou "falso"
validation_rule	validation_rule	True	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
radio_group_name	radio_group_name	True	string	O nome do grupo ao qual pertence o campo.
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.

Devoluções

response: object

Baixar anexo

ID da Operação:: V4_Attachment_DownloadAttachment

As aplicações empresariais podem usar esta API de serviço para descarregar o anexo de um documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo foi adicionado.
ID do anexo	attachment_id	True	integer	ID do anexo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Campos AutoPlace

ID da Operação:: V4_Fields_AutoPlace

Aplicações empresariais podem chamar esta API para adicionar campos de assinatura ou formulário definidos pelo utilizador a um documento com base no critério de pesquisa fornecido. As opções de colocação são: à esquerda, à direita, em cima e em baixo. O documento é pesquisado e todas as instâncias dos critérios de pesquisa cumpridas são processadas. Isto permite adicionar vários campos numa só chamada. Por exemplo, carregue um documento e coloque automaticamente um campo de assinatura à direita de todas as instâncias da palavra "Assine aqui:". Isto poupa tempo e garante que nenhuma assinatura é perdida no fluxo de trabalho.

A chamada API suporta todos os tipos de campos; nomeadamente eletrónica, digital, presencial, iniciais, campo de texto, etc.

Além disso, a chamada API suporta a variável "order". Isto significa que pode atribuir automaticamente um conjunto de campos de assinatura a um único utilizador. Assim, a chamada pode ser repetida para colocar e atribuir campos de assinatura a mais do que um utilizador no fluxo de trabalho.

Pelo menos um utilizador deve existir num fluxo de trabalho antes de poderem adicionar campos de assinatura ao documento desta forma. O número da encomenda corresponde ao destinatário no fluxo de trabalho. Portanto, este número deve ser igual ou inferior ao total de utilizadores no fluxo de trabalho. O exemplo abaixo atribui este novo campo de assinatura à primeira pessoa do fluxo de trabalho.

Esta chamada de API pode ser usada várias vezes no mesmo documento. A razão para isso é acomodar múltiplos signatários num documento. O destinatário ou signatário é identificado pela variável "ordem" passada na chamada.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual os campos são solicitados.
search_text	search_text		string	Word que precisa de ser pesquisado no documento.
order	order	True	integer	A ordem do utilizador a que os campos serão atribuídos automaticamente. Fluxo de trabalho no SigningHub encomenda os destinatários. Esta lista começa com "1" para o primeiro signatário designado.
colocação	placement		string	Se o texto for encontrado, os campos devem ser colocados no documento. A colocação do campo pode ser mencionada neste atributo. Os possíveis valores de colocação de um campo são ESQUERDA, DIREITA, CIMA, BAIXO. Se não for fornecido nenhum valor, o valor padrão será DEIXADO.
field_type	field_type		string	Tipo de campo a criar no documento. Os valores possíveis são "ASSINATURA", "IN_PERSON_SIGNATURE", "INICIAIS", "TEXTO", "NÚMERO", "NOME", "EMAIL", "EMPRESA", "CARGO", "RADIOBOX", "CAIXA DE SELEÇÃO", "DATA", "ANEXO"
level_of_assurance	level_of_assurance		array of string	Nível de Garantia a ser atualizado. Os Valores Possíveis são "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Localização esquerda do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
Largura	width	True	double	Largura do campo em pixel.
altura	height	True	double	Altura do campo em pixel.
marcador de posição	placeholder		string	Avise no caso de Apego Obrigatório
radio_group_name	radio_group_name		string	O nome do grupo é necessário apenas ao adicionar um campo do tipo Caixa de Rádio para agrupar várias caixas de Rádio.
format	format		string	Formato de texto do campo. Usado apenas para o campo do tipo de data. Os valores possíveis são M/D d/m/aa m/d/yyyy mm/dd/yy dd/mm/aaaa mm/yy mm/yyyy D-mmm M-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd AAAA-MM-DD mmm-yy Mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
valor	value		string	Valor que o utilizador queira mostrar no campo.
max_length	max_length	True	integer	Comprimento máximo do valor permitido no campo. Deve ser entre 1 e 9999
validation_rule	validation_rule		string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
required	required	True	boolean
tipo	type		string	Especifica o tipo de regra de validação, que atualmente está sempre definida como EQUALS para o campo de texto.
valor	value		string	Representa o valor utilizado para validação.
Nome	name		string	Nome da fonte selecionada para o campo de texto. Os valores possíveis são "COURIER", "HELVETICA".
size	size		string	Tamanho da fonte selecionado para o campo de texto. Os valores possíveis são 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Tamanho da fonte no documento PDF original.
multilinha	multiline	True	boolean	Isto pertence ao tipo de campo Área de Texto e, se definido como verdadeiro, o campo de área de texto será criado com opção multi-linha.

Devoluções

response: array of AutoPlaceFieldsResponse

Carregar anexo

ID da Operação:: V4_Attachment_UploadAttachment

As aplicações empresariais podem usar esta API de serviço para carregar um anexo num documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo precisa de ser adicionado.
Conteúdo do arquivo de anexo	body	True	binary	Este é o documento em formato binário bruto.
Nome do campo	x-field-name		string	Nome do campo, se necessário. Isto é opcional e, com o nome do campo, o campo anexo é processado. Além disso, o valor recomendado para o parâmetro do nome do campo está no formato codificado Base64.
Nome do arquivo	x-file-name	True	string	É o nome do ficheiro com extensão.
Palavra-passe do documento	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
One-Time Palavra-passe	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

Body: AddAttachmentResponse

Carregar documento

ID da Operação:: V4_Documents_UploadStream

As aplicações empresariais podem usar esta API de serviço para adicionar um documento a um pacote de documentos ligado à conta de um utilizador empresarial. A informação do documento é enviada no cabeçalho do pedido HTTP e os bytes do documento são enviados no corpo do pedido HTTP. Note O SigningHub converterá formatos de documentos suportados para PDF se o cabeçalho "x-convert-document" estiver definido para o valor "true". O único caso suportado em que este valor é definido como "falso" é para manter o formato Word e documentos XML.

O SigningHub suporta uma grande variedade de formatos de documentos, cada um dos quais pode ser convertido para PDF após o carregamento. Clique aqui para a lista completa.

Nota: os documentos PDF não são alterados ao serem carregados no sistema.

Note que um pacote já deve existir antes de poder adicionar um documento usando esta chamada.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento está a ser adicionado.
Conteúdo do Ficheiro	body	True	binary	Este é o documento em formato binário bruto.
Nome do arquivo	x-file-name		string	É o nome do ficheiro com extensão.
Converter Documento	x-convert-document		string	Isto determina se deve converter o documento para PDF ou se deve ser mantido no seu formato original. Note que o único formato original suportado atualmente é Word & XML. Todos os outros tipos de documentos resultarão num erro se este valor de cabeçalho for definido como "falso". Se carregar um documento PDF, este cabeçalho pode ser omitido.
Source	x-source		string	Esta é a identificação da origem do documento de onde o documento é carregado, por exemplo, "A Minha App".

Devoluções

Body: UploadDocument

Delete Workflow User

ID da Operação:: V4_Workflow_WorkflowDeleteUser

As aplicações empresariais podem usar esta API de serviço para eliminar o destinatário do fluxo de trabalho.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote do qual o destinatário deve ser eliminado.
Encomenda	order	True	integer	Ordem do destinatário no fluxo de trabalho que deve ser eliminada.

Devoluções

response: object

Descarregar documento

ID da Operação:: V4_Documents_DownloadDocumentBytes

As aplicações empresariais podem usar esta API de serviço para descarregar os bytes do documento. O ID do pacote e o ID do documento são fornecidos na URL do recurso.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	O ID do documento a ser descarregado.
Palavra-passe do documento	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
One-Time Palavra-passe (OTP)	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Documento de Aprovação do Gatekeeper

ID da Operação:: V4_Package_GatekeeperApprove

As aplicações empresariais podem usar esta API de serviço para aprovar um documento por um utilizador especificado na ordem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote a ser aprovado.
razão	reason		string	A razão para aprovar um pacote.
Palavra-passe de Acesso a Documentos	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
Documento One-Time Palavra-passe	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.

Devoluções

response: object

Documento de Declínio

ID da Operação:: V4_Package_Decline

Aplicações empresariais podem usar esta API de serviço para recusar um documento de um utilizador especificado na encomenda.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID da encomenda será recusado.
razão	reason		string	Razão fornecida pelo utilizador para recusar.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Documento de Declínio do Gatekeeper

ID da Operação:: V4_Package_GatekeeperDecline

Aplicações empresariais podem usar esta API de serviço para recusar um documento por um utilizador especificado na encomenda.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID da encomenda será recusado.
razão	reason		string	Razão fornecida pelo utilizador para recusar.

Devoluções

response: object

Documento de Recall

ID da Operação:: V4_Workflow_RecallWorkflow

As aplicações empresariais podem usar esta API de serviço para interromper um fluxo de trabalho em andamento. O ID do documento é fornecido na URL do recurso. Após a recolha, o estado do documento muda automaticamente para "RASCUNHO".

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	A identificação da encomenda a ser recolhida.

Devoluções

response: object

Eliminar Campo de Documento

ID da Operação:: V4_Fields_DeleteDocumentField

Aplicações empresariais podem usar esta API de serviço para eliminar um campo de documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual a ação deve ser tomada.
field_name	field_name	True	string	Nome do campo a eliminar.

Devoluções

response: object

Eliminar Espaço Partilhado

ID da Operação:: V4_WorkSpace_DeleteSharedSpace

Aplicações empresariais podem usar esta API de serviço para eliminar espaço partilhado. A possibilidade de eliminar espaços partilhados está sujeita ao papel de utilizador empresarial atribuído. Para permitir esta disposição, o Enterprise Admin irá ativar a opção 'Gerir Espaço Partilhado' nas Definições do Documento de Papéis>.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de Espaço Partilhado	id	True	integer	ID do espaço partilhado que queres apagar

Devoluções

response: object

Estado de Assinatura em Massa

ID da Operação:: V4_Signing_BulkSignStatus

As aplicações empresariais podem usar esta API para obter o estado de uma transação específica de assinatura em massa, juntamente com os detalhes dos pacotes de documentos processados pela API de Pacotes de Assinatura em Massa .

Deve chamar esta API após a API de Pacotes de Assinatura em Massa.

Para assinatura RAS, a propriedade ACTION será REMOTE_AUTHORIZATION_REQURIED e a propriedade STATUS será PENDENTE, indicando que o pedido precisa de ser autorizado através do dispositivo móvel. Se o processo de assinatura falhar num documento devido a diferentes níveis de garantia configurados e o utilizador quiser reiniciar o processo de assinatura para concluir o processo de assinatura em documentos falhados, a propriedade ACTION será REINITIATE_SIGNING_PROCESS e a propriedade STATUS será PENDENTE.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
identificador_de_transação	transaction_id		string	O número de identificação da transação de assinatura em massa
Ação em massa	bulk_action	True	string	Ação em massa a realizar. Os valores possíveis são: SIGN \| PARTILHAR

Devoluções

Body: BulkSignStatusResponse

Excluir anexo

ID da Operação:: V4_Attachment_DeleteAttachment

As aplicações empresariais podem usar esta API de serviço para eliminar o anexo de um documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo foi adicionado.
ID do anexo	attachment_id	True	integer	ID do anexo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Excluir documento

ID da Operação:: V4_Documents_DeleteDocument

Aplicações empresariais podem usar esta API de serviço para eliminar um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	ID do documento a ser apagado.

Devoluções

Body: DocumentResponse

Excluir pacote

ID da Operação:: V4_Package_DeletePackage

Aplicações empresariais podem usar esta API de serviço para eliminar um documento da caixa de entrada do utilizador. O ID do pacote é fornecido no URL do recurso como "{package_id}". Se o estado do documento for PENDENTE, então é automaticamente recusado como resultado da operação de eliminação. Se o estado do documento for PARTILHADO, então o documento é automaticamente recolhido e o fluxo de trabalho é interrompido antes de o documento ser eliminado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId_bulkAction	True	integer	ID do pacote que contém o documento.

Devoluções

response: object

Fluxo de Trabalho Completo no Meio (Terminar Fluxo de Trabalho)

ID da Operação:: V4_Workflow_MarkWorkflowCompleted

As aplicações empresariais podem marcar o fluxo de trabalho como concluído mesmo a meio do processo. Use esta API de serviço para alterar o estado do fluxo de trabalho para concluído. Se houver destinatários que ainda não assinaram o documento. A assinatura deles já não será necessária e não poderão ver o documento na caixa de entrada. O token portador deve pertencer ao proprietário do documento ou o administrador da empresa pode usar a variável de alcance para obter o token de acesso em nome do proprietário do documento para realizar esta ação.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote do qual o destinatário deve ser eliminado.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Iniciais de Preenchimento

ID da Operação:: V4_Initials_Fill

As aplicações empresariais podem usar esta API de serviço para preencher um campo de iniciais num documento por um utilizador especificado na ordem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento.
field_name	field_name	True	string	Identificador único do campo no documento.
imagem	image	True	string	Imagem Base64 usada para preencher as iniciais.
método	method		integer	0 = DESENHO 1 = TEXTO 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NENHUM
apply_to_all	apply_to_all	True	boolean	Verdade se todas as iniciais estiverem preenchidas.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Lembretes de Atualização do Fluxo de Trabalho

ID da Operação:: V4_Workflow_UpdateWorkflowReminder

As aplicações empresariais podem usar esta API de serviço para atualizar os lembretes de fluxo de trabalho para um destinatário que já foi adicionado a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor as definições de lembretes dentro do fluxo de trabalho. O ID do documento de workflow é fornecido na URL do recurso, e o destinatário do workflow é identificado pela ordem em que é adicionado ao workflow.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para quais os lembretes do fluxo de trabalho a atualizar.
Encomenda	order	True	integer	A ordem do utilizador para a qual os lembretes do fluxo de trabalho devem ser atualizados.
apply_to_all	apply_to_all	True	boolean	Verdade, se as definições de lembrete forem aplicadas a todos os destinatários no fluxo de trabalho.
enabled	enabled	True	boolean	Verdade, se as definições de lembrete estiverem ativadas.
frequência	frequency		string	Frequência de Lembrete. Valores possíveis são DIAS \| HORAS.
remind_after	remind_after	True	integer	Obrigatório, no caso de propriedade ativada será verdadeira. O número de dias após os quais o primeiro lembrete seria enviado ao utilizador do fluxo de trabalho.
enabled	enabled	True	boolean	Verdade, se os lembretes subsequentes estiverem ativados.
frequência	frequency		string	Repetir a frequência dos lembretes. Valores possíveis são DIAS \| HORAS.
keep_reminding_after	keep_reminding_after	True	integer	Obrigatório, no caso de propriedade ativada será verdadeira. O número de dias após os quais os lembretes subsequentes seriam enviados ao utilizador do fluxo de trabalho.
total_reminders	total_reminders	True	integer	Obrigatório, no caso de propriedade ativada será verdadeira. O número de lembretes subsequentes seria enviado ao utilizador do fluxo de trabalho.

Devoluções

response: object

Mover Pacote para uma pasta Personalizada ou Espaço Partilhado

ID da Operação:: V4_Folder_MovePackage

As aplicações empresariais podem usar esta API de serviço para mover o pacote do documento para um espaço partilhado ou para uma pasta personalizada do utilizador.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID de pacote que precisa de ser movido para uma pasta
folder_name	folder_name	True	string	Nome da pasta de destino em que pacote precisa de ser movido

Devoluções

response: object

Obtenha a Política de Certificação para um documento

ID da Operação:: V4_Documents_GetCertifyPolicy

Aplicações empresariais podem usar esta API de serviço para obter definições de assinatura de certificação de um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	O ID do documento a ser descarregado.

Devoluções

Body: CertifyPolicyResponse

Obtenha Autenticação do Utilizador por Fluxo de Trabalho (Abertura de Documentos) de um Pacote Empresarial

ID da Operação:: V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

As aplicações empresariais podem usar esta API de serviço para ativar as definições de segurança de acesso para o pacote. Os destinatários para quem a segurança está configurada são identificados pela ordem no URL. O ID do pacote também é identificado no URL do pedido. Os destinatários não poderão aceder ao pacote de documentos fora do âmbito deste período se a segurança de acesso estiver ativada. O proprietário do documento também pode configurar a segurança do pacote baseada em autenticação para um destinatário.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para o qual o fluxo de trabalho acede, segurança e autenticação deve ser atualizado.
Ordem do destinatário	order	True	integer	Ordem do destinatário no fluxo de trabalho para o qual a segurança de acesso e autenticação deve ser atualizada.

Devoluções

Body: EnterpriseAccessResponse

Obtenha Detalhes do Documento

ID da Operação:: V4_Documents_GetDocumentDetails

As aplicações empresariais podem usar esta API de serviço para obter os detalhes do documento. O ID do documento é fornecido na URL como "{document_id}".

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	O documento de identificação para o qual os detalhes do documento são solicitados.
Palavra-passe do documento	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
One-Time Palavra-passe (OTP)	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

Body: DocumentDetailsResponse

Obtenha Detalhes do Fluxo de Trabalho

ID da Operação:: V4_Workflow_GetWorkflowDetail

As aplicações empresariais podem usar esta API de serviço para obter detalhes do fluxo de trabalho para o pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote a descarregar.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

Body: WorkflowDetailsResponse

Obtenha Detalhes do Pacote

ID da Operação:: V4_Package_GetPackageDetails

As aplicações empresariais podem usar esta API de serviço para obter os detalhes de um pacote. Esta API pode também ser usada pela aplicação empresarial para realizar ações em nome do utilizador empresarial através da "Autenticação de Escopo".

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote do documento.

Devoluções

Body: GetPackageDetailsResponse

Obtenha Espaço Partilhado

ID da Operação:: V4_WorkSpace_GetSharedSpace

As aplicações empresariais podem usar esta API de serviço para obter um espaço partilhado específico. Esta API devolve informações sobre o espaço partilhado, o seu proprietário e colaborador.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de Espaço Partilhado	id	True	integer	ID do espaço partilhado que queres ter

Devoluções

Body: WorkSpaceResponse

Obtenha Histórico de Fluxo de Trabalho

ID da Operação:: V4_Workflow_GetWorkflowHistory

As aplicações empresariais podem utilizar esta API de serviço para recuperar a lista de ações realizadas num documento. O ID do pacote é fornecido na URL do recurso. O campo de pesquisa (cabeçalho x-search-text) destina-se a email, nome do documento, ação, infokey e infovalue.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do documento para o qual o registo é exigido.
Número da página	pageNo	True	integer	Número de página a recuperar.
Registos por Página	recordsPerPage	True	integer	Número total de registos a recuperar numa página.
Pesquisar Texto	x-search-text		string	O campo de pesquisa (cabeçalho x-search-text) destina-se a email, nome do documento, ação, infokey e infovalue.

Devoluções

Body: WorkflowHistoryResponse

Obtenha Modelos Empresariais

ID da Operação:: V4_Template_GetEnterpriseTemplates

Aplicações empresariais podem usar esta API de serviço para obter listas de modelos empresariais do utilizador atual. Isto significa o administrador empresarial ou o utilizador empresarial se a variável "âmbito" foi usada no pedido de autenticação.

É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text".

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Número de registos por página	recordPerPage	True	integer	Número total de registos a recuperar numa página.
Número da página a recuperar	pageNo	True	integer	Número de página a recuperar.
Ordenar por coluna	sort-by		string	Ordenar o resultado por valores possíveis é mencionado acima.
Ordenar o conjunto de resultados	asc		boolean	Ordene o conjunto de resultados por ascendente ou descendente.
Filtrar por IDs de template	id		array	Pesquise por IDs modelo.
Pesquisar texto	x-search-text		string	Procure texto, se necessário. Isto é opcional e, sem ele, toda a lista é devolvida. Além disso, o valor recomendado para o parâmetro de texto de pesquisa está no formato codificado em Base64.
Número total de registos	x-total-records		string	O número total de registos encontrados com os critérios de pesquisa fornecidos.

Devoluções

response: array of EnterpriseTemplateResponse

Obtenha o Relatório de Provas de Processo

ID da Operação:: V4_WorkflowEvidenceReport_DownloadBytes

As aplicações empresariais podem usar esta API de serviço para descarregar o relatório de evidência do processo de fluxo de trabalho de um documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	A ID do documento.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Obtenha Permissões de Utilizador do Fluxo de Trabalho

ID da Operação:: V4_WorkflowPermission_GetWorkflowPermissions

As aplicações empresariais podem usar esta API de serviço para obter permissões de documentos para um destinatário. O destinatário é identificado pela ordem no fluxo de trabalho. O ID do pacote é fornecido na URL do recurso.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do documento para o qual o utilizador do fluxo de trabalho precisa de ser atualizado.
Encomenda	order	True	integer	A ordem do utilizador no fluxo de trabalho para a qual as permissões são solicitadas. Ao fornecer o valor 0 por ordem, o serviço devolveria as permissões do colaborador adicionado mais recentemente no fluxo de trabalho.

Devoluções

Body: WorkflowPermissionResponse

Obtenha Utilizadores do Fluxo de Trabalho

ID da Operação:: V4_Workflow_GetWorkflowUsers

As aplicações empresariais podem usar esta API de serviço para obter detalhes do fluxo de trabalho para o pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote a descarregar.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: array of WorkflowRecipient

Obter anexos

ID da Operação:: V4_Attachment_GetAttachments

As aplicações empresariais podem usar esta API de serviço para obter os anexos de um documento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo foi adicionado.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: array of GetAttachmentResponse

Obter campos de documento

ID da Operação:: V4_Fields_GetAllDocumentFields

Aplicações empresariais podem usar esta API de serviço para obter campos de documento, ou seja, iniciais, campos de assinatura, campos de assinatura ou de formulário.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	O ID do documento para o qual os campos são solicitados.
N.º da página	pageNo	True	integer	Página número do documento para o qual os campos são solicitados. Se o número de página não for fornecido, os campos do documento completo são devolvidos.
Originador	x-mobile		string	Defina o originador (Web/Mobile) do pedido/ação

Devoluções

Body: FieldsResponse

Obter Contactos

ID da Operação:: V4_Contacts_Get

As aplicações empresariais podem usar esta API de serviço para identificar contactos tanto pessoais como empresariais para o utilizador atual.

É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text". Além disso, é possível pesquisar os contactos específicos de um utilizador ou da empresa a que o utilizador pertence.

A informação de resposta de pesquisa contém o endereço de email do utilizador e o respetivo nome de utilizador.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Registos por Página	recordPerPage	True	integer	Número total de registos a recuperar numa página.
Número da página	pageNo	True	integer	Número de página a recuperar.
Ordenar Por	sort-by		string	Ordenar o resultado por valores possíveis é mencionado acima.
Ascendente	asc		boolean	Ordene o conjunto de resultados por ascendente ou descendente.
Pesquisar Texto	x-search-text		string	Procure texto, se necessário. Isto é opcional e, sem ele, toda a lista é devolvida. Além disso, o valor recomendado para o parâmetro de texto de pesquisa está no formato codificado em Base64.
Apenas Contactos Empresariais	x-enterprise		string	Quando definido como "verdadeiro", apenas a lista de contactos empresariais será devolvida. Em caso de "falso", apenas a lista de contactos do utilizador será devolvida. Se não definir o cabeçalho, tanto as listas de contactos empresariais como as do utilizador serão devolvidas.
Total de Registos	x-total-records		string	O número total de registos encontrados com os critérios de pesquisa fornecidos.

Devoluções

response: array of ContactResponse

Obter modelos

ID da Operação:: V4_Settings_GetTemplates

Aplicações empresariais podem usar esta API de serviço para obter listas de modelos para o utilizador atual.

É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text". Além disso, é possível pesquisar os modelos pessoais de um utilizador ou os modelos empresariais conforme permitido pelo seu papel de utilizador pelo administrador da empresa.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Número de registos por página	recordPerPage	True	integer	Número total de registos a recuperar numa página.
Número da página a recuperar	pageNo	True	integer	Número de página a recuperar.
Ordenar por coluna	sort-by		string	Ordenar por coluna. Os Valores Possíveis são CREATED_ON e NOME. O padrão é ordenar por CREATED_ON
Asc	asc		boolean	A ordem resultante da lista. A lista resultante por defeito será decrescente
Pesquisar texto	x-search-text		string	Procure texto, se necessário. Isto é opcional e, sem ele, toda a lista é devolvida. Além disso, o valor recomendado para o parâmetro de texto de pesquisa está no formato codificado em Base64.
Apenas modelos empresariais	x-enterprise		string	Quando definido como "verdadeiro", apenas a lista de modelos empresariais será devolvida. Em caso de "falso", apenas a lista de modelos do utilizador será devolvida. Se não definir o cabeçalho, as listas de modelos empresariais e de utilizador serão devolvidas.
Número total de registos	x-total-records		string	O número total de registos encontrados com os critérios de pesquisa fornecidos.

Devoluções

response: array of TemplateResponse

Pacote de Renomeação

ID da Operação:: V4_Package_RenamePackage

Esta API de serviço é usada para renomear um pacote de documentos.

O pacote do documento é identificado pelo seu identificador único no URL da chamada.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId_bulkAction	True	integer	ID do pacote para alterar o nome.
package_name	package_name	True	string	Novo nome do pacote do documento.

Devoluções

response: object

Pacotes de Sinais em Massa

ID da Operação:: V4_Signing_BulkSignDocuments

As aplicações empresariais podem usar esta API para assinar/partilhar/assinar e partilhar múltiplos documentos (tanto eletrónicos como digitais) sem apresentar os documentos ao utilizador final. Esta API necessita de informações da aplicação empresarial sobre pacotes de documentos e detalhes de assinaturas, campos presenciais e iniciais. Após a conclusão bem-sucedida da transação de assinatura em massa, a API devolverá os estados e IDs das transações dos pacotes de documentos.

Ao contrário da API Sign Document, esta API não só assina um pacote de documento, como também o marca como aprovado e revisto, consoante se o destinatário é Signatário, Editor ou Revisor. Qualquer pacote documental cujo estado devolve como CONCLUÍDO foi assinado, aprovado ou revisto por esta API.

A assinatura em massa funciona com todos os métodos de autenticação em tempo de assinatura.

Se o SIGN for aprovado como bulk_action e o pacote estiver em estado de Rascunho, o Sign and Share será realizado automaticamente.

Deve chamar esta API após a API Pre Bulk Sign Documents .

Caso precise de fazer alterações em algum documento antes de assinar, deve ser chamada a API Field Form Fields antes de chamar a API de Documento Pre Bulk Sign. Lembre-se, quaisquer campos de entrada obrigatórios num documento precisam de ser preenchidos antes de esta API ser concluída com sucesso; enquanto isso, os campos preenchidos automaticamente (como Nome, Email, Data, Título do Cargo, etc.) serão preenchidos automaticamente.

Uma vez assinado o documento, a resposta de verificação pode ser vista através da API de Estado de Assinatura em Massa .

Utilização de OTP de Primeiro ou Segundo Fator para Autenticação

Caso a autenticação OTP esteja ativada para a operação de assinatura do lado do servidor, as aplicações clientes terão de gerar um OTP para o número móvel usando a Autenticação de Assinatura em Massa via chamada OTP API. As respetivas aplicações empresariais devem recuperar o OTP do uso e submetê-lo ao efetuar a chamada API. Isto é feito usando o cabeçalho "x-otp" no pedido.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
IDs	ids		array of integer	Um array dos IDs dos pacotes de documentos selecionados para assinatura em massa.
hand_signature_initials_image	hand_signature_initials_image		string	Imagem Base64 usada para preencher as iniciais
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DESENHO 1 = TEXTO 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NENHUM
hand_signature_image	hand_signature_image		string	Imagem de string codificada em Base64 da aparência da assinatura visível
hand_signature_method	hand_signature_method		integer	0 = DESENHO 1 = TEXTO 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NENHUM
signing_reason	signing_reason		string	Motivo da assinatura fornecido pelo destinatário.
signing_location	signing_location		string	Local do signatário fornecido pelo destinatário
contact_information	contact_information		string	Informações de contacto do signatário fornecidas pelo destinatário
appearance_design	appearance_design		string	Nome da aparência da assinatura fornecido pelo utilizador para assinatura. Caso não seja fornecido o nome da aparência, a aparência selecionada por defeito será usada. Os valores possíveis são "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_server	signing_server		string	Nome do servidor de assinatura pelo qual o documento deve ser assinado
signing_capacity	signing_capacity		string	Nome do perfil de certificação/capacidade de assinatura com o qual o documento deve ser assinado
mechanism	mechanism		string	Mecanismo da autenticação. Os valores possíveis para o mecanismo são: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC
palavra-passe	password		string	É um parâmetro opcional, mas só é obrigatório quando se usa 'AUTHENTICATION_PASSWORD' como valor de parâmetro em 'mecanismo'
token	token		string	É um parâmetro opcional que será recebido de servidores de terceiros, mas só é obrigatório ao usar 'AUTHENTICATION_AZURE_ACTIVE_DIRECTORY', 'AUTHENTICATION_OFFICE_365', 'AUTHENTICATION_OAUTH2', 'AUTHENTICATION_OIDC''AUTHENTICATION_GOOGLE''AUTHENTICATION_LINKED_IN'' 'AUTHENTICATION_SALES_FORCE' como valor de parâmetro em 'mecanismo'
user_identifier	user_identifier		string	É um parâmetro opcional, mas só é obrigatório quando se usa 'AUTHENTICATION_ACTIVE_DIRECTORY' ou 'AUTHENTICATION_SAML' como valor de parâmetro em 'mecanismo'
id	id		string	É um parâmetro opcional, mas só é obrigatório quando se usa 'AUTHENTICATION_SALES_FORCE' ou 'AUTHENTICATION_IDFY' como valor de parâmetro em 'mecanismo'. Para 'AUTHENTICATION_IDFY' é requestId
code_verifier	code_verifier		string	Verificador de Código se o PKCE estiver ativado para o cliente.
nonce	nonce		string	Valor nonce se estiver ativado para o cliente.
identificador_de_transação	transaction_id		string	Identificação da transação do processo de assinatura reiniciada
ID do pacote	packageId_bulkAction	True	string	Ação em massa a realizar. Os valores possíveis são: SIGN \| PARTILHAR
Assinatura do OTP	x-otp		string	O OTP/TOTP era usado como segundo fator/autenticação de assinatura de documentos para a operação de assinatura.
Palavra-passe de Acesso a Documentos	x-open-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
Documento One-Time Palavra-passe	x-open-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.
Originador Móvel	x-mobile		string	Defina o originador (Web/Mobile) do pedido/ação

Devoluções

Body: BulkSignResponse

Partilhar Pacote de Documentos

ID da Operação:: V4_Workflow_StartWorkflow

As aplicações empresariais podem usar esta API de serviço para partilhar um pacote de documentos com os signatários e iniciar um novo fluxo de trabalho. O documento já deve ter sido preparado aplicando um modelo e, opcionalmente, atualizando os utilizadores e ações definidos no modelo. O ID do pacote a partilhar é fornecido na URL do recurso.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O pacote do documento a ser partilhado.

Devoluções

response: array of StartWorkflowResponse

Preencher campos de formulário

ID da Operação:: V4_Fields_FillFormFields

As aplicações empresariais podem usar esta API de serviço para preencher um ou mais campos de formulário num documento por um utilizador especificado na ordem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento.
auto_save	auto_save	True	boolean	O valor predefinido é falso. Verdade, se os campos do formulário estiverem a ser guardados sem intervenção do utilizador, por exemplo, ao fechar o documento ou pressionar para trás. Para ações de assinatura, iniciais, presença, revisão, submissão, o valor é falso.
field_name	field_name	True	string	Identificador único do campo no documento.
valor	value		string	Valor do campo a ser guardado no documento.
field_name	field_name	True	string	Identificador único do campo no documento.
radio_group_name	radio_group_name		string	Nome do grupo ao qual pertence o botão de rádio.
valor	value	True	boolean	Valor do campo a ser guardado no documento.
field_name	field_name	True	string	Identificador único do campo no documento.
valor	value	True	boolean	Valor do campo a ser guardado no documento.
field_name	field_name	True	string	Identificador único do campo no documento.
valor	value		string	Valor do campo a ser guardado no documento.
field_name	field_name	True	string	Identificador único do campo no documento.
valor	value		string	Valor do campo a ser guardado no documento.
Palavra-passe do documento	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
One-Time Palavra-passe (OTP)	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Processamento de Acabamento

ID da Operação:: V4_Package_Finish

As aplicações empresariais podem usar esta API de serviço para concluir o processamento do documento após assinarem todos os campos de assinatura. Este método é usado principalmente por aplicações móveis nativas do SigningHub para iOS e Android, bem como por casos de uso na web móvel. Aplicações empresariais gerais que utilizam integração estreita no seu respetivo portal não precisam de usar este método. No entanto, ao utilizar a API Sign Document (e por isso o utilizador não recebe uma representação visual do documento que é solicitado a assinar), é necessário chamar esta API para garantir que o respetivo fluxo de trabalho continua ou se conclui. Por exemplo, uma vez que todas as assinaturas tenham sido aplicadas usando a chamada "cega" Sign Document API, o documento não aparecerá como estado "Completado" ao proprietário até que esta API seja invocada. O proprietário do documento verá um estado de "Em Progresso" até que esta API seja chamada.

Dentro das aplicações móveis nativas do SigningHub e dos casos de uso da web móvel, esta chamada é necessária para garantir que cada utilizador completa as suas respetivas ações relativamente ao SigningHub. Por exemplo, depois de um signatário ter assinado um documento na aplicação SigningHub, este método é invocado pela aplicação para garantir que o fluxo de trabalho continua a ser processado e que o próximo signatário é notificado, e o estado do documento está disponível através do URL de retorno de chamada configurado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID da encomenda a terminar.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Pós-Processamento de Atualização

ID da Operação:: V4_Workflow_UpdateWorkflowPostProcess

As aplicações empresariais podem usar esta API de serviço para adicionar um documento temporário a um fluxo de trabalho, um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote de documentos para o qual o pós-processamento está a ser atualizado.
enabled	enabled	True	boolean	Verdade, se o pós-processamento estiver ativado para o pacote.
contacts	contacts		array of string
Nome	name	True	string
e-mail	email	True	string
mensagem	message		string	Uma mensagem de string personalizada para todos os contactos. A mensagem passa a fazer parte do email enviado aos contactos.
google_drive	google_drive		boolean	Verdade, se o documento for para ser carregado na conta Google fornecida após a conclusão do fluxo de trabalho.
Dropbox	dropbox		boolean	Verdade, se o documento for para ser carregado na conta dropbox fornecida após a conclusão do fluxo de trabalho.
onedrive	onedrive		boolean	Verdade, se o documento for para ser carregado para a conta oneDrive fornecida após a conclusão do fluxo de trabalho.
workflow_recipients	workflow_recipients	True	boolean	É verdade, se o relatório de conclusão do fluxo de trabalho for enviado a todos os destinatários do fluxo de trabalho quando o pós-processamento for executado. O valor predefinido é falso.
document_processing_report	document_processing_report	True	boolean	É verdade que, se Enviar, o relatório de processamento de documentos (XML) também for ativado para o fluxo de trabalho

Devoluções

response: object

Receba Pacotes

ID da Operação:: V4_Package_GetAllPackages

As aplicações empresariais podem usar esta API de serviço para obter uma lista de documentos filtrada por diferentes estados. Os utilizadores podem dividir os registos em páginas fornecendo um número de registos por página.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Estado do documento	document_status	True	string	Filtrar por estado do documento os valores possíveis são TODOS, RASCUNHO, PENDENTE, ASSINADO, RECUSADO, EM PROGRESSO, EDITADO, REVISTO, CONCLUÍDO, EXPIRING_IN_SEVEN_DAYS.
Número da página	pageNo	True	integer	Número de página, de acordo com a divisão de registos por página.
Registos por Página	recordPerPage	True	integer	Número de registos necessários a obter num único pedido.
Nome do Pacote	package-name		string	Nome do Pacote
ID do pacote	package-id		integer	ID da Encomenda
De	recipient-from		string	De
Para	recipient-to		string	Para
ID do documento	document-id		integer	ID do documento
Validade (Dias)	expiry		integer	Validade (Dias)
A partir da Data Modificada	modified-from		date-time	A partir da Data Modificada
Até à Data Modificada	modified-to		date-time	Até à Data Modificada
Do Tamanho (KB)	size-from		integer	Do Tamanho (KB)
À medida (KB)	size-to		integer	À medida (KB)
Documentos Certificados	certified-documents		boolean	Apenas documentos autenticados assinados
Campos de formulário	form-fields		boolean	Apenas documentos que têm campos de formulário
Anexos	attachments		boolean	Apenas documentos que têm anexos
Tipo de Documento	document-type		string	Tipo de documento como XML, PDF, DOCX, etc
Ordenar Por	sort-by		string	Organize os registos resultantes conforme a sua escolha
Ordem Ascendente	asc		boolean	Ordenou os registos resultantes por ordem ascendente ou descendente
Estado dos Documentos	document-statuses		array	Tipo de Documento
Propriedade de	owned-by		string	Os valores possíveis do filtro Owned By são ME_OTHERS, EU, OUTROS.
Nome Smart Form	smart-form		string	Nome da forma inteligente
Nome da pasta	x-folder		string	Nome da pasta de onde os documentos devem ser recolhidos. Os valores possíveis são INBOX e ARCHIVE. Além disso, o valor recomendado para o parâmetro x-folder está no formato codificado em Base64.
Pesquisar Texto	x-search-text		string	Pesquise texto enviado nos cabeçalhos para uma filtragem adicional dos documentos. O ID do pacote, nome e proprietário do documento podem ser pesquisados. Além disso, o valor recomendado para o parâmetro de texto de pesquisa está no formato codificado em Base64.
Total de Registos	x-total-records		string	O número total de registos encontrados com os critérios de pesquisa fornecidos.
Source	x-source		string	Esta é a identificação da origem do documento de onde o documento é carregado, por exemplo, "A Minha App".
Detalhes do Destinatário	x-recipient-details		string	Se "verdadeiro" for transmitido, os detalhes do destinatário relativos à Duração de Acesso ao Documento serão fornecidos juntamente com a informação de recusa

Devoluções

response: array of GetPackagesResponse

Receba um lembrete de fluxo de trabalho

ID da Operação:: V4_Workflow_GetWorkflowReminder

As aplicações empresariais podem usar esta API de serviço para atualizar os lembretes para os destinatários que já foram adicionados a um fluxo de trabalho. Normalmente, esta chamada é útil depois de um modelo ter sido aplicado a um documento e as aplicações empresariais quererem sobrepor as definições de lembretes dentro do fluxo de trabalho. O ID do documento de workflow é fornecido na URL do recurso, e o destinatário do workflow é identificado pela ordem em que é adicionado ao workflow.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote para quais os lembretes do fluxo de trabalho a atualizar.
Encomenda	order	True	integer	A ordem do utilizador para a qual os lembretes do fluxo de trabalho devem ser atualizados.

Devoluções

Body: ReminderResponse

Renomeação do Documento

ID da Operação:: V4_Documents_RenameDocument

As aplicações empresariais podem usar esta API de serviço para renomear um documento num pacote.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	ID do pacote ao qual o documento foi adicionado.
ID do documento	documentId	True	integer	O ID do documento sobre o qual a ação deve ser realizada.
document_name	document_name	True	string	Novo nome do documento.

Devoluções

Body: DocumentResponse

Submeter Documento

ID da Operação:: V4_Package_Submit

Um dos papéis do SigningHub chama-se "Editor". Isto permite ao destinatário editar campos de entrada num documento, mas não requer assinatura. Depois de concluído, o destinatário submete as suas alterações. O botão usado na interface gráfica chama-se "Submit".

Esta é a operação equivalente para um editor submeter as suas alterações através de uma chamada API.

Clique em SigningHub Roles para uma descrição de todas as funções disponíveis para destinatários do fluxo de trabalho.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId	True	integer	O ID do pacote SigningHub que contém o documento a submeter.
Palavra-passe de Acesso a Documentos	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
Documento One-Time Palavra-passe	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Transferir Pacote

ID da Operação:: V4_Package_DownloadPackageBytes

Aplicações empresariais podem usar esta API de serviço para descarregar o pacote de documentos em formato binário.

O ID do pacote é fornecido na URL do recurso.

Se o pacote contiver apenas um documento, o download é o documento PDF binário.

Alternativamente, se o pacote tiver mais do que um documento, o download é o ficheiro binário zip de todos os documentos.

Os cabeçalhos x-password e x-otp são opcionais. São obrigatórios se o proprietário do documento os definiu durante a fase de criação do fluxo de trabalho.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do pacote	packageId_bulkAction	True	integer	O ID do pacote a ser descarregado.
Identificadores de Documento	document-ids		array	O parâmetro Document IDs é opcional. Se x-combine-files estiver definido como true, os documentos serão fundidos com base nos documentos mencionados do pacote.
Palavra-passe de Acesso a Documentos	x-password		string	A palavra-passe definida pelo proprietário do documento para aceder ao documento, se existir. Se a palavra-passe não tiver sido definida, então o valor será nulo.
Documento One-Time Palavra-passe	x-otp		string	A One-Time Palavra-passe (OTP) definida pelo proprietário do documento para aceder ao documento, se existir. Se o OTP não tiver sido definido, então o valor será nulo.
Ficheiros Combine	x-combine-files		string	O valor predefinido é falso, definido como "true" para combinar todo o pacote do documento num único ficheiro PDF.
ID da pasta	x-folder-id		string	Especifique o ID da pasta, para recuperar os itens da pasta, quando estiver envolvida uma pasta de espaço partilhado.

Devoluções

response: object

Definições

EletrónicoRecebedor

Name	Caminho	Tipo	Descrição
Nome	name	string
level_of_assurance	level_of_assurance	string

PermissãoAvisoLegalResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se o aviso legal estiver ativado e configurado para o destinatário.
allowed_notices	allowed_notices	array of LegalNoticeResponse	Lista de notificações legais permitidas ao proprietário do documento, a partir das quais pode selecionar uma para o destinatário.
default_notice	default_notice	array of LegalNoticeResponse	Aviso legal em incumprimento ou selecionado para o destinatário.

AvisoLegalResposta

Name	Caminho	Tipo	Descrição
legal_notice_id	legal_notice_id	integer
legal_notice_name	legal_notice_name	string	AvisoLegalResposta
legal_notice_html	legal_notice_html	string	Conteúdo HTML do aviso legal.

AccessResponse

Name	Caminho	Tipo
autenticação	authentication	AuthenticationResponse
authentication_signing	authentication_signing	AuthenticationSigningResponse
access_duration	access_duration	PermissionAccessDurationResponse

AuthenticationResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação estiver ativada para o pacote.
palavra-passe	password	AccessSecurityPasswordResponse
sms_otp	sms_otp	AccessSecuritySmsOtpResponse
totp	totp	TotpPermissionResponse

AcessoSegurançaPasswordResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação por palavra-passe estiver ativada para o pacote.
user_password	user_password	string	Palavra-passe de autenticação para acesso a documentos.

AcessoSegurançaSmsOtpResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação OTP por SMS estiver ativada para o pacote.
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Número de telemóvel do destinatário. É necessário um número de telemóvel para enviar o SMS ao destinatário para a autenticação.
methods	methods	array of string	Métodos OTP permitidos

TotpPermissionResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Ativado

AutenticaçãoAssinaturaResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação estiver ativada para o pacote.
sms_otp	sms_otp	AuthenticationSigningSmsOtpResponse
totp	totp	TotpPermissionResponse

AutenticaçãoAssinaturaSmsOtpResposta

Name	Caminho	Tipo	Descrição
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Número de telemóvel do destinatário. É necessário um número de telemóvel para enviar o SMS ao destinatário para a autenticação.
methods	methods	array of string	Métodos OTP permitidos

PermissãoAcessoDuraçãoResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a segurança da duração do acesso estiver ativada para o pacote.
duration_by_date	duration_by_date	AccessDurationByDateResponse
duration_by_days	duration_by_days	AccessDurationByDaysResponse

DuraçãoDeAcessoDataDataResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	É verdade se a segurança de acesso estiver ativada durante um determinado período por data e hora.
acessível	accessible	boolean
duration	duration	DurationByDateResponse

DuraçãoPorDataResposta

Name	Caminho	Tipo	Descrição
start_date_time	start_date_time	string	Data e hora a partir da qual o pacote estará acessível ao destinatário.
end_date_time	end_date_time	string	Data e hora após as quais o pacote deixará de estar acessível ao destinatário.

AcessoDuraçãoDeDiasResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a segurança de acesso estiver ativada durante um período de dias.
acessível	accessible	boolean
duration	duration	DurationByDaysResponse

DuraçãoPorDiasResposta

Name	Caminho	Tipo	Descrição
total_days	total_days	integer	Número total de dias em que a encomenda estará acessível ao destinatário após receber a encomenda.

ReminderResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se os lembretes estiverem ativados para o destinatário
frequência	frequency	string	Frequência de Lembrete. Valores possíveis são DIAS \| HORAS.
remind_after	remind_after	integer	O número de dias após os quais o primeiro lembrete seria enviado ao utilizador do fluxo de trabalho.
repetir	repeat	ReminderRepeat

LembreteRepetir

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se os lembretes subsequentes estiverem ativados.
frequência	frequency	string	Repetir a frequência dos lembretes. Valores possíveis são DIAS \| HORAS.
keep_reminding_after	keep_reminding_after	integer	O número de dias após os quais os lembretes subsequentes seriam enviados ao destinatário do fluxo de trabalho.
total_reminders	total_reminders	integer	O número de lembretes subsequentes a enviar ao utilizador do fluxo de trabalho.

AddQrCodeResponse

Name	Caminho	Tipo	Descrição
dados	data	string	Dados gerados por QR Code
field_name	field_name	string	Nome do campo criado no documento.
valor	value	string	O valor será a base 64 da imagem QrCode

QrCodeOptions

Name	Caminho	Tipo	Descrição
error_correction_level	error_correction_level	ECCLevelAPI	Nível de Correção de Erros para o código QR, que determina a quantidade de redundância dos dados. As opções são: L (Baixo), M (Médio), Q (Quartil) e H (Alto). Níveis mais altos oferecem maior resistência a erros. O padrão é "Q"
codificação	encoding	EciModeAPI	Especifica o modo de codificação de caracteres para o conteúdo do código QR. As opções suportadas são: Default, Iso8859_1, Iso8859_2 e Utf8. O padrão é "Padrão"
pixels_per_module	pixels_per_module	integer	Especifica o número de píxeis por módulo no código QR. Um número maior resulta num código QR maior e mais detalhado. O padrão é "20". Os valores possíveis são: 20 \| 30 \| 40 \| 50
add_margins	add_margins	boolean	Indica se as zonas de silêncio (margens) devem ser desenhadas em torno do código QR. As zonas silenciosas ajudam os scanners a detetar e decifrar o código QR com mais precisão. O padrão é "verdadeiro"

ECCLevelAPI

Nível de Correção de Erros para o código QR, que determina a quantidade de redundância dos dados. As opções são: L (Baixo), M (Médio), Q (Quartil) e H (Alto). Níveis mais altos oferecem maior resistência a erros. O padrão é "Q"

: string

EciModeAPI

Especifica o modo de codificação de caracteres para o conteúdo do código QR. As opções suportadas são: Default, Iso8859_1, Iso8859_2 e Utf8. O padrão é "Padrão"

: string

QrCodeColor

Name	Caminho	Tipo	Descrição
pontos	dots	string	Representa a cor escura usada para os pontos no código QR. O padrão é "preto". por exemplo, "#000000"
em segundo plano	background	string	Representa a cor clara usada para o fundo do código QR. O padrão é "branco". por exemplo, "#ffffff"

QrCodeLogótipo

Name	Caminho	Tipo	Descrição
base64	base64	string	Um ícone opcional (base64) para colocar no centro do código QR.
hide_background_dots	hide_background_dots	boolean	A cor de fundo atrás do ícone, se for fornecido um ícone. Se não for fornecida cor, é implementado fundo transparente.
size	size	integer	O tamanho do ícone como percentagem do tamanho do código QR, se for fornecido um ícone. O padrão é "15". Valores possíveis são: 10 \| 15 \| 20 \| 25 \| 30 \| 35 \| 40

AddFieldResponse

Name	Caminho	Tipo	Descrição
field_name	field_name	string	Nome do campo criado no documento.
created_on	created_on	string	Data e hora da criação do campo.

Regra de Validação

Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".

: string

SignatureFieldResponse

Name	Caminho	Tipo	Descrição
field_name	field_name	string	Nome do campo criado no documento.
created_on	created_on	string	Data e hora da criação do campo.

UpdateQrCodeResponse

Name	Caminho	Tipo	Descrição
valor	value	string	O valor será a base 64 da imagem QrCode

FieldValidationValue

Name	Caminho	Tipo	Descrição
required	required	boolean
rules	rules	array of FieldValidationValueRule

FieldValidationValueRule

Name	Caminho	Tipo	Descrição
tipo	type	string	Especifica o tipo de regra de validação, que atualmente está sempre definida como EQUALS para o campo de texto.
valor	value	string	Representa o valor utilizado para validação.

PostProcessResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se o pós-processamento estiver ativado para o pacote.
contacts	contacts	array of string	Lista de endereços de email para os quais o email será enviado quando o fluxo de trabalho estiver concluído.
recipients	recipients	array of PostProcessRecipientResponse	Lista do nome e dos endereços de email para quem os emails são enviados quando o pós-processamento é executado após a conclusão do fluxo de trabalho.
mensagem	message	string	Qualquer mensagem de string personalizada que deve ser enviada aos contactos quando o fluxo de trabalho estiver concluído.
google_drive	google_drive	boolean	Verdade, se o upload do Google Drive estiver ativado para o pacote. Os documentos serão carregados no Google Drive quando o fluxo de trabalho estiver concluído.
one_drive	one_drive	boolean	Verdade, se um disco estiver ativado o upload para o pacote. Os documentos serão carregados para um disco quando o fluxo de trabalho estiver concluído.
Dropbox	dropbox	boolean	Verdade, se o upload do Dropbox estiver ativado para o pacote. Os documentos serão carregados no Google Drive quando o fluxo de trabalho estiver concluído.
workflow_recipients	workflow_recipients	boolean	É verdade, se o relatório de conclusão do fluxo de trabalho for enviado a todos os destinatários do fluxo de trabalho quando o pós-processamento for executado. O valor predefinido é falso.
document_processing_report	document_processing_report	boolean	É verdade que, se Enviar, o relatório de processamento de documentos (XML) também for ativado para o fluxo de trabalho

RespostaPós-ProcessoRecetor

Name	Caminho	Tipo	Descrição
Nome	name	string
e-mail	email	string

CertifyResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	É verdade, se as definições de assinatura de certificação estiverem ativadas para o documento.
allowed_permissions	allowed_permissions	array of string	Certificar o nível de permissão definido para o documento com as definições de assinatura certificar.
default_permission	default_permission	string

GroupMemberResponse

Name	Caminho	Tipo	Descrição
user_email	user_email	string	Endereço de email do membro do grupo
user_name	user_name	string	Nome de utilizador do membro do grupo

ColaboradorResposta

Name	Caminho	Tipo	Descrição
user_email	user_email	string	E-mail do usuário
signing_order	signing_order	integer	Ordem de assinatura
guest_user	guest_user	boolean	É utilizador convidado
email_language_code	email_language_code	string	Código da linguagem do email
permissão	permission	WorkflowPermissionResponse
lembrete	reminder	ReminderResponse

WorkflowPermissionResponse

Name	Caminho	Tipo	Descrição
imprimir	print	boolean	Verdade, se a impressão for permitida para este destinatário.
descarregamento	download	boolean	Verdade, se o download for permitido.
add_text	add_text	boolean	Verdade, se for permitido adicionar anotação de texto no documento.
change_recipients	change_recipients	boolean	É verdade, se o destinatário na encomenda atual puder mudar outros destinatários no fluxo de trabalho depois de o fluxo de trabalho ser partilhado.
add_attachment	add_attachment	boolean	Verdade, se anexos e fusão de documentos PDF forem permitidos.
legal_notice	legal_notice	PermissionLegalNoticeResponse
Acessório	attachment	AttachmentPermissionResponse

AttachmentPermissionResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Ativado

EnterpriseTemplateResponse

Name	Caminho	Tipo	Descrição
id	id	integer	ID do modelo
Nome	name	string	Nome do modelo.
público	public	boolean	A resposta é "verdadeira" se o modelo empresarial estiver marcado como público. Caso contrário, "falso" seria devolvido
read_only	read_only	boolean	Resposta de "verdadeiro" se o modelo for apenas leitura e o utilizador não puder fazer alterações ao fluxo de trabalho após aplicar este modelo. Caso contrário, "falso".
descrição	description	string	Descrição do modelo
created_on	created_on	string	Data e hora em que o modelo foi criado
funções	roles	array of EnterpriseTemplateRole
Documentação	documents	array of TemplateDocumentResponse

EmpresaTemplateRole

Name	Caminho	Tipo	Descrição
Nome	name	string	Nome do papel empresarial atribuído ao utilizador.
id	id	integer	ID do papel empresarial atribuído ao utilizador.

TemplateDocumentResponse

Name	Caminho	Tipo	Descrição
id	id	integer	ID do documento modelo
Nome	name	string	Nome do documento modelo.

Next_signer_email

Name	Caminho	Tipo	Descrição
user_email	user_email	string	Endereço de email do próximo signatário.
user_name	user_name	string	Nome do próximo signatário.

WorkflowRecipient

Name	Caminho	Tipo	Descrição
order	order	integer	Ordem do destinatário no fluxo de trabalho.
user_email	user_email	string	Endereço de email do destinatário se o utilizador não for um grupo.
user_name	user_name	string	Nome do destinatário se o utilizador não for um grupo.
mobile_number	mobile_number	string	Número de telemóvel
delivery_method	delivery_method	string	Método de entrega do destinatário Valores possíveis: EMAIL, SMS ou EMAIL_AND_SMS
user_photo_url	user_photo_url	string	endpoint API para aceder ao recurso, este será fornecido apenas para os signatários principais. Por exemplo, será nulo para grupo/delegador/gatekeeper, etc. Este URL não garante que a imagem do sinalizador existe. Se existir imagem, será fornecida ao clicar na URL definida, caso contrário será uma string vazia.
group_name	group_name	string	Nome do grupo do destinatário se o destinatário for um grupo.
group_members	group_members	array of GroupMemberResponse	Uma lista de endereços de email dos membros do grupo, caso o destinatário seja um grupo.
Delegado	delegatee	string	Endereço de email do delegado, se o destinatário não for um grupo.
delegatee_name	delegatee_name	string	Nome do utilizador delegado, se o destinatário não for um grupo.
função	role	string	Função de fluxo de trabalho em que o destinatário foi adicionado. Esta função não é a função empresarial. Os valores possíveis são "SIGNER", "REVIEWER", "CARBON_COPY" e "EDITOR".
razão	reason	string	Razão fornecida pelo utilizador ao recusar, aprovar ou submeter um documento.
process_status	process_status	string	Estado de processamento de documentos para o destinatário. Os valores possíveis são "UN_PROCESSED", "IN_PROGRESS", "ASSINADO", "REVISTO", "RECUSADO", "EDITADO" ou "INVÁLIDO".
processed_on	processed_on	string	Data e hora em que o documento foi processado.
processed_as	processed_as	string	O utilizador pode processar o campo como COLABORADOR, DELEGADOR, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do utilizador que processou o documento.
marcador de posição	placeholder	string	Texto temporário se o destinatário for um marcador
signing_order	signing_order	integer	Ordem em que o fluxo de trabalho será assinado pelos destinatários. Esta ordem de assinatura é importante quando o tipo de fluxo de trabalho está definido como "PERSONALIZADO".
user_national_id	user_national_id	string	Número de identidade nacional do utilizador. Isto ajuda a identificar o utilizador no fluxo de trabalho
guest_user	guest_user	boolean	Utilizador de Gest
email_language_code	email_language_code	string	Código da linguagem do email
electronic_seal	electronic_seal	ElectronicSealRecipient
Guardiões	gatekeepers	WorkflowGatekeeperResponse

WorkflowGatekeeperResposta

Name	Caminho	Tipo	Descrição
emails	emails	array of WorkflowGatekeeperUserResponse	Getekeepers

WorkflowGatekeeperUserResponse

Name	Caminho	Tipo	Descrição
user_email	user_email	string

EnterpriseAccessResponse

Name	Caminho	Tipo
autenticação	authentication	EnterpriseAuthenticationResponse
authentication_signing	authentication_signing	EnterpriseAuthenticationSigningResponse
access_duration	access_duration	PermissionAccessDurationResponse

EnterpriseAuthenticationResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação estiver ativada para o pacote.
palavra-passe	password	AccessSecurityPasswordResponse
sms_otp	sms_otp	EnterpriseAccessSecuritySmsOtpResponse
totp	totp	TotpPermissionResponse

EnterpriseAccessSecuritySmsOtpResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação OTP por SMS estiver ativada para o pacote.
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Número de telemóvel do destinatário. É necessário um número de telemóvel para enviar o SMS ao destinatário para a autenticação.

AutenticaçãoEmpresarialAssinaturaResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação estiver ativada para o pacote.
sms_otp	sms_otp	EnterpriseAuthenticationSigningSmsOtpResponse
totp	totp	TotpPermissionResponse

EnterpriseAuthenticationSigningSmsOtpResponse

Name	Caminho	Tipo	Descrição
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Número de telemóvel do destinatário. É necessário um número de telemóvel para enviar o SMS ao destinatário para a autenticação.

ObtémDetalhesPacoteResposta

Name	Caminho	Tipo	Descrição
Nome	name	string	Nome do pacote do documento.
proprietário	owner	DocumentOwner
read_only	read_only	boolean	É verdade se o modelo aplicado for apenas leitura. O utilizador não poderá fazer quaisquer alterações se for aplicado um modelo apenas de leitura.
document_status	document_status	string	Estado do documento para o utilizador atualmente logado. Os valores possíveis são "RASCUNHO", "EM PROGRESSO", "PENDENTE", "RECUSADO" ou "CONCLUÍDO".
Documentação	documents	array of DocumentDetails

DocumentOwner

Name	Caminho	Tipo	Descrição
Nome	name	string	Nome do proprietário do pacote do documento.
e-mail	email	string	Email do proprietário do pacote do documento.

DocumentDetalhes

Name	Caminho	Tipo	Descrição
id	id	integer	ID do documento recém-criado.
Nome	name	string	O nome do documento.
uploaded_on	uploaded_on	string	Data e hora em que o documento foi carregado.
modified_on	modified_on	string	Data e hora em que o documento foi modificado pela última vez.
size	size	integer	Tamanho do documento em bytes.
tipo	type	string	Tipo do documento, por exemplo, "PDF".
origem	source	string	Identifica onde o documento foi carregado, por exemplo, "A Minha App".

TemplateResponse

Name	Caminho	Tipo	Descrição
template_id	template_id	integer	O ID do modelo é devolto aqui
template_name	template_name	string	Nome do modelo.
template_public	template_public	boolean	A resposta é "verdadeira" se o modelo empresarial estiver marcado como público. Caso contrário, "falso" seria devolvido
read_only	read_only	boolean	Resposta de "verdadeiro" se o modelo for apenas leitura e o utilizador não puder fazer alterações ao fluxo de trabalho após aplicar este modelo. Caso contrário, "falso".
created_on	created_on	string	Data e hora em que o modelo foi criado
descrição	description	string	Descrição do modelo
empresa	enterprise	boolean	Verdade, se o utilizador pertencer a uma empresa.
Documentação	documents	array of TemplateDocumentResponse
smart_form	smart_form	TemplateSmartFormResponse

TemplateSmartFormResponse

Name	Caminho	Tipo	Descrição
active_count	active_count	integer	Contagem ativa
total_count	total_count	integer	Total

StartWorkflowResponse

Name	Caminho	Tipo	Descrição
package_id	package_id	integer	O ID do pacote acabei de ser partilhado. Em caso de partilha individual, são criados e partilhados mais do que um pacote com os destinatários. A API devolve um conjunto de pacotes juntamente com IDs de documentos recém-criados.
Documentação	documents	array of integer	Array de IDs de documentos que faziam parte do pacote antes de serem partilhados.

WorkflowDetalhesResposta

Name	Caminho	Tipo	Descrição
package_id	package_id	integer	ID do pacote do documento.
package_name	package_name	string	Nome do pacote do documento.
shared_package	shared_package	boolean	Pacote partilhado
package_owner	package_owner	string	Endereço de email do proprietário do pacote do documento.
owner_name	owner_name	string	Nome do proprietário do pacote do documento.
package_status	package_status	string	Estado do documento para o utilizador atualmente logado. Os valores possíveis são "RASCUNHO", "EM PROGRESSO", "PENDENTE", "RECUSADO", "APROVADO", "ATUALIZADO" ou "CONCLUÍDO".
pasta	folder	string	Nome da pasta que contém o pacote do documento.
folder_id	folder_id	integer	ID da pasta que contém o pacote do documento.
Guardião	gatekeeper	boolean
next_signer	next_signer	string	O nome do próximo signatário se o documento estiver em estado partilhado.
next_signer_email	next_signer_email	array of Next_signer_email	Um objeto que contém o nome de utilizador e endereço de email do próximo signatário. No caso do signatário do grupo, terá uma lista de endereços de email de todos os membros do grupo.
uploaded_on	uploaded_on	string	Data e hora em que o documento foi carregado.
modified_on	modified_on	string	Data e hora em que o documento foi modificado pela última vez.
fluxo de trabalho	workflow	WorkflowResponse
Documentação	documents	array of WorkflowDocumentsResponse	Lista de documentos que são carregados no pacote.
users	users	array of WorkflowUserResponse	Lista de destinatários para o fluxo de trabalho.

WorkflowResponse

Name	Caminho	Tipo	Descrição
workflow_type	workflow_type	string	Tipo de fluxo de trabalho, existem quatro tipos de fluxos de trabalho suportados na aplicação. Os valores possíveis são "SERIAL", "PARALLEL", "INDIVIDUAL" e "CUSTOM".
continue_on_decline	continue_on_decline	boolean	É verdade, se o fluxo de trabalho tiver de continuar mesmo depois de o destinatário recusar na sua vez.
workflow_status	workflow_status	string	Estado de processamento do fluxo de trabalho, os valores possíveis são "DRAFT", "IN_PRGORESS" e "CONCLUÍDO".
workflow_mode	workflow_mode	string	O modo do fluxo de trabalho é suportado por três tipos de modos de fluxo de trabalho na aplicação. Os valores possíveis são "ONLY_ME", "ME_AND_OTHERS" e "ONLY_OTHERS"
mensagem	message	string	Qualquer mensagem de string personalizada que deve ser enviada a todos os destinatários do fluxo de trabalho pelo proprietário do documento.
read_only	read_only	boolean	Se qualquer modelo aplicado aos documentos deste fluxo de trabalho for de apenas leitura ou bloqueado, então o fluxo de trabalho é só leitura. O SigningHub não permite que os utilizadores finais façam quaisquer alterações a este fluxo de trabalho em estado de rascunho e este fluxo deve ser partilhado tal como está.
post_process	post_process	PostProcessResponse
comments	comments	boolean	Comments

WorkflowDocumentosResposta

Name	Caminho	Tipo	Descrição
document_id	document_id	integer	ID do documento.
document_name	document_name	string	Nome do documento.
document_type	document_type	string	Extensão original do documento quando o documento foi carregado antes da conversão para PDF.
document_order	document_order	integer	Ordem do documento no pacote do documento.
document_source	document_source	string	Origem do documento de onde o documento foi carregado.
update_required	update_required	boolean	Verdade se o documento for necessário para ser atualizado
document_height	document_height	integer	Altura do documento PDF.
document_width	document_width	integer	Largura do documento PDF.
document_pages	document_pages	integer	Número total de páginas no documento.
created_on	created_on	string	A data e hora em que o documento foi carregado.
modified_on	modified_on	string	A data e hora em que o documento foi modificado pela última vez.
form_fields	form_fields	boolean	Verdade, se o documento tiver campos de formulário.
modelo	template	DocumentsTemplateResponse
certificar	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	Verdade, se o documento estiver definido para bloquear os campos do formulário com a última assinatura digital do documento.
bloqueado	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Meta info do documento PDF: verdade se o documento pdf tiver campos de assinatura assinados
attachments	attachments	boolean	Verdade, se o documento tiver anexos.
conformance_level	conformance_level	string	Nível de conformidade do documento
document_size	document_size	integer	Tamanho do documento.
formatado	formatted	boolean	Esta propriedade é para documentos XML, que ou estão formatados ou não

DocumentosModeloResposta

Name	Caminho	Tipo	Descrição
template_id	template_id	integer	ID do modelo aplicado ao documento.
template_name	template_name	string	Nome do modelo aplicado ao documento.
read_only	read_only	boolean	Verdade, se o template estiver configurado como apenas leitura. Não devem ser feitas alterações ao fluxo de trabalho após a aplicação de um modelo de apenas leitura.

WorkflowUserResponse

Name	Caminho	Tipo	Descrição
order	order	integer	Ordem do destinatário no fluxo de trabalho.
user_name	user_name	string	Nome do destinatário se o destinatário não for um grupo. Se o destinatário for um marcador de lugar, irá conter-se o nome do marcador de lugar.
user_email	user_email	string	Endereço de email do destinatário se o destinatário não for um grupo ou marcador de lugar.
mobile_number	mobile_number	string	Número de telemóvel
delivery_method	delivery_method	string	Método de entrega do destinatário Valores possíveis: EMAIL, SMS ou EMAIL_AND_SMS
user_photo_url	user_photo_url	string	endpoint API para aceder ao recurso, este será fornecido apenas para os signatários principais. Por exemplo, será nulo para grupo/delegador/gatekeeper, etc. Este URL não garante que a imagem do sinalizador existe. Se existir imagem, será fornecida ao clicar na URL definida, caso contrário será uma string vazia.
group_name	group_name	string	Nome do grupo se o destinatário for um grupo.
group_members	group_members	array of string	Lista de todos os endereços de email e nomes dos utilizadores.
Delegador	delegator	string	Endereço de email do utilizador que é delegador a este destinatário.
Guardião	gatekeeper	string	Endereço de email do utilizador que é o guardião deste destinatário.
Guardiões	gatekeepers	WorkflowGatekeeperResponse
função	role	string	Papel do destinatário, ou seja, "SIGNATÁRIO", "REVISOR", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST".
process_status	process_status	string	Estado de processamento de documentos para o destinatário. Os valores possíveis são "UN_PROCESSED", "IN_PROGRESS", "ASSINADO", "REVISTO", "RECUSADO", "EDITADO" ou "INVÁLIDO".
processed_on	processed_on	string	Data e hora em que o documento foi processado.
processed_as	processed_as	string	O utilizador pode processar o campo como COLABORADOR, DELEGADOR, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do utilizador que processou o documento.
razão	reason	string	Razão fornecida pelo utilizador ao recusar, aprovar ou submeter um documento.
marcador de posição	placeholder	string	Texto provisório se o destinatário for um marcador temporário.
permissão	permission	WorkflowPermissionResponse
authentications	authentications	AccessResponse
lembrete	reminder	ReminderResponse
signing_order	signing_order	integer	Ordem em que o fluxo de trabalho será assinado pelos destinatários. Esta ordem de assinatura é importante quando o tipo de fluxo de trabalho está definido como "PERSONALIZADO".
user_national_id	user_national_id	string	Número de identidade nacional do utilizador. Isto ajuda a identificar o utilizador no fluxo de trabalho
guest_user	guest_user	boolean	Utilizador de Gest
email_language_code	email_language_code	string	Código da linguagem do email
electronic_seal	electronic_seal	ElectronicSealRecipient

DocumentDetalhesResposta

Name	Caminho	Tipo	Descrição
document_id	document_id	integer	ID do documento recém-criado.
document_name	document_name	string	O nome do documento.
document_order	document_order	integer
document_type	document_type	string	Tipo do documento, por exemplo, "PDF".
document_width	document_width	integer	Largura do documento em formato PDF.
document_height	document_height	integer	Altura do documento em formato PDF.
document_source	document_source	string	Identifica onde o documento foi carregado, por exemplo, "A Minha App".
document_pages	document_pages	integer	Páginas totais do documento.
form_fields	form_fields	boolean	Verdade se o documento tiver campos de formulário.
lock_form_fields	lock_form_fields	boolean	É verdade se o bloqueio dos campos de formulário com a última assinatura estiver ativado.
uploaded_on	uploaded_on	string	A data e hora em que o documento foi carregado.
modified_on	modified_on	string	A data e hora em que o documento foi modificado pela última vez.
certificar	certify	DocumentCertifyResponse
modelo	template	DocumentTemplateResponse

DocumentarCertificarResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	É verdade se a assinatura de certificação estiver ativada para o documento.
permissão	permission	string	São as permissões de certificação a serem aplicadas no documento PDF quando a primeira assinatura é criada. Os valores possíveis são "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" e "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".

DocumentTemplateResposta

Name	Caminho	Tipo	Descrição
template_name	template_name	string	Nome do modelo aplicado no documento.
read_only	read_only	boolean	É verdade se o modelo aplicado for apenas leitura. O utilizador não poderá fazer quaisquer alterações se for aplicado um modelo apenas de leitura.

AddAttachmentResponse

Name	Caminho	Tipo	Descrição
attachment_id	attachment_id	integer	ID do anexo

ObtençãoRespostaAdjunta

Name	Caminho	Tipo	Descrição
attachment_id	attachment_id	integer	ID do anexo
attachment_name	attachment_name	string	Nome do anexo

AddPackageResponse

Name	Caminho	Tipo	Descrição
package_id	package_id	integer	O ID do pacote a ser usado posteriormente para partilhar, descarregar e obter o estado do documento.
workflow_mode	workflow_mode	string	O modo de fluxo de trabalho que é definido ao adicionar o pacote.
workflow_type	workflow_type	string	Tipo de fluxo de trabalho. Os valores possíveis são "SERIAL", "PARALLEL", "INDIVIDUAL" e "CUSTOM".

GetPackagesResponse

Name	Caminho	Tipo	Descrição
package_id	package_id	integer	ID do pacote do documento.
package_name	package_name	string	Nome do pacote do documento.
package_owner	package_owner	string	Endereço de email do proprietário do pacote do documento.
owner_name	owner_name	string	Nome do proprietário do pacote do documento.
shared_package	shared_package	boolean	Pacote Partilhado
gatekeeper_package	gatekeeper_package	boolean	Pacote Gatekeeper
package_status	package_status	string	Estado do documento para o utilizador atualmente logado. Os valores possíveis são "RASCUNHO", "EM PROGRESSO", "PENDENTE", "RECUSADO" ou "CONCLUÍDO".
extensão	extension	string	Extensão do Pacote de Documentos
workflow_mode	workflow_mode	string	Modo de Fluxo de Trabalho
pasta	folder	string	Nome da pasta que contém o pacote do documento.
folder_id	folder_id	integer	ID da pasta que contém o pacote do documento.
não lido	unread	boolean	Verdade, se o documento ainda não for lido pelo destinatário.
next_signer	next_signer	string	O nome do próximo signatário se o documento estiver em estado partilhado.
next_signer_email	next_signer_email	array of Next_signer_email	Um objeto que contém o nome de utilizador e endereço de email do próximo signatário. No caso do signatário do grupo, terá uma lista de endereços de email de todos os membros do grupo.
uploaded_on	uploaded_on	string	Data e hora em que o documento foi carregado.
modified_on	modified_on	string	Data e hora em que o documento foi modificado pela última vez.
access_duration	access_duration	RecipientAccessDurationDetails
Declínio	decline	RecipientDeclineDetails
size	size	integer	Tamanho do documento em bytes.

ReceçãoAcessoDuraçãoDetalhes

Name	Caminho	Tipo	Descrição
date_from	date_from	string	Data/hora de início para o destinatário aceder ao documento
date_to	date_to	string	Data/hora de término para o destinatário aceder ao documento

ReceçãoRecusaDetalhes

Name	Caminho	Tipo	Descrição
razão	reason	string	Defina a razão do declínio do documento
auto_decline	auto_decline	boolean	A indicação do documento é recusada manualmente/automaticamente
declined_by	declined_by	DeclineByDetails

DeclineByDetails

Name	Caminho	Tipo	Descrição
user_name	user_name	string	Nome do utilizador que recusou o fluxo de trabalho
user_email	user_email	string	Email de utilizador que recusou o fluxo de trabalho

DocumentResponse

Name	Caminho	Tipo	Descrição
package_name	package_name	string	Nome do Pacote do Documento

UploadDocument

Name	Caminho	Tipo	Descrição
documentId	documentId	integer	Esta propriedade mantém-se para compatibilidade retroativa e será removida em versões futuras. Usa document_id em vez disso.
ID do documento	documentid	integer	O ID do documento será usado posteriormente para partilhar, descarregar e obter o estado do documento. serão removidos mais tarde document_id serão usados
document_id	document_id	integer	O ID do documento será usado posteriormente para partilhar, descarregar e obter o estado do documento.
document_name	document_name	string	O nome do documento.
document_order	document_order	integer	Encomenda de documentos na embalagem
document_type	document_type	string	Tipo do documento, por exemplo, "PDF".
document_source	document_source	string	Identifica onde o documento foi carregado, por exemplo, "A Minha App".
document_width	document_width	integer	Largura do documento em formato PDF.
document_height	document_height	integer	Altura do documento em formato PDF.
document_pages	document_pages	integer	Páginas totais do documento.
uploaded_on	uploaded_on	date-time	A data e hora em que o documento foi carregado.
modified_on	modified_on	date-time	A data e hora em que o documento foi modificado pela última vez.
lock_form_fields	lock_form_fields	boolean	É verdade se o bloqueio dos campos de formulário com a última assinatura estiver ativado.
certificar	certify	CertifyPermissionResponse
document_size	document_size	integer	Tamanho do documento carregado em bytes
metadados	metadata	UploadDocumentMetaInfoDetail
package_name	package_name	string	O nome do pacote do documento

CertifyPermissionResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	É verdade se a assinatura de certificação estiver ativada para o documento.
allowed_permissions	allowed_permissions	array of string	Conjunto de níveis de permissão permitidos para o documento.
default_permission	default_permission	string	Nível de permissão selecionado para as definições de certificar assinatura.

UploadDocumentMetaInfoDetail

Name	Caminho	Tipo	Descrição
attachments	attachments	boolean	Verdade se o documento PDF tiver algum anexo
form_fields	form_fields	boolean	Verdade se o documento PDF tiver algum campo de formulário
blank_signatures	blank_signatures	boolean	Verdade se o documento PDF tiver algum campo de assinatura em branco
signed_signatures	signed_signatures	boolean	Verdade se o documento PDF tiver algum campo de assinatura assinado
conformidade	conformance	string	null/empty se o documento não contiver qualquer nível de conformidade, caso contrário contiver formação como 1A, 1B, etc
bloqueado	locked	boolean	Verdade se o documento PDF estiver bloqueado
certificar	certify	string	Nível de certificação do documento pdf. Valores Possíveis NotCertified, NoChangesAllowed, FormFilling, FormFillingAndAnnotations
qr_code	qr_code	boolean	verdadeiro se o documento pdf tiver algum código Qr, caso contrário é falso

CertificarPolíticaResposta

Name	Caminho	Tipo	Descrição
certificar	certify	CertifyPermissionResponse
lock_form_fields	lock_form_fields	boolean	É verdade se os campos de formulários forem bloqueados no PDF após a última assinatura digital no documento atual.

VerificaçãoResposta

Name	Caminho	Tipo	Descrição
field_name	field_name	string	Nome do campo para o qual a verificação foi solicitada.
signer_name	signer_name	string	Nome do signatário.
signature_status	signature_status	string	Se o estado geral da assinatura é válido ou não. Os valores possíveis são "VÁLIDO" ou "INVÁLIDO".
signing_reason	signing_reason	string	Razão fornecida pelo utilizador ao assinar o campo. No caso de assinatura por testemunha, seria definida a razão de assinatura personalizada
signing_location	signing_location	string	Localização introduzida pelo utilizador ao assinar o campo.
contact_information	contact_information	string	Informação de contacto introduzida pelo utilizador ao assinar o campo.
signing_time	signing_time	string	Data e hora de assinatura no formato 8601. O fuso horário padrão do SH Admin é seguido até à hora.
LTV	ltv	boolean	Verdade, se a assinatura for LTV.
qualificado	qualified	boolean	Verdade, se as assinaturas forem qualificadas.
Certificado	certified	boolean	Verdade, se as assinaturas forem certificadas.
certify_permission	certify_permission	string	Nível de permissão para assinatura digital certificada.
timestamp_at	timestamp_at	string	Data e hora em que a assinatura foi marcada com carimbo temporal.
timestamp_authority	timestamp_authority	string	Autoridade pela qual a assinatura foi marcada com carimbo temporal.
subject_dn	subject_dn	string	DN do sujeito do certificado usado ao assinar o campo.
issuer_dn	issuer_dn	string	Os emissores dão DN do certificado usado ao assinar o campo.
cert_valid_from	cert_valid_from	string	Data e hora a partir da validez do certificado.
cert_valid_to	cert_valid_to	string	Data e hora para a qual o certificado é válido.
signature_type	signature_type	string	Tipo de assinaturas, valores possíveis são "PADES_PART2" ou "PADES_PART4".
signature_algorithm	signature_algorithm	string	Algoritmo de assinatura usado ao assinar o campo.
signature_application	signature_application	string	Nome da candidatura do local onde o campo foi assinado.
signature_policy_id	signature_policy_id	integer	ID da apólice de assinatura.
signature_policy_uri	signature_policy_uri	string	URI da política de assinatura.
signer_photo	signer_photo	string	Imagem Base64 do avatar do signatário.
signer_photo_url	signer_photo_url	string
signed_hash	signed_hash	string	Hash do documento assinado na respetiva assinatura.
Ecrã	display	string
page_number	page_number	integer	Número de página do campo de assinatura
lei_number	lei_number	string	Número LEI se disponível no certificado
lei_role	lei_role	string	Função de LEI, se disponível no certificado
error_message	error_message	string	Aparece uma mensagem de erro caso a aplicação não consiga obter resultados de verificação.

BulkSignResponse

Name	Caminho	Tipo	Descrição
estado	status	string
identificador_de_transação	transaction_id	string

BulkSignStatusResposta

Name	Caminho	Tipo	Descrição
estado	status	string
Pacotes	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Name	Caminho	Tipo	Descrição
id	id	integer
Nome	name	string
estado	status	string
ação	action	string	Chave de ação necessária, se houver
erro	error	string
percentagem	percentage	integer
Documentação	documents	array of BulkSignActionDocumentModel	Documentos no pacote atual

BulkSignActionDocumentModel

Name	Caminho	Tipo	Descrição
id	id	integer
campos	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Name	Caminho	Tipo
Nome	name	string
hash	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Name	Caminho	Tipo	Descrição
field_name	field_name	string	Nome do campo para o qual a verificação foi solicitada.
estado	status	string	Devolve o estado do campo de assinatura. Os valores estão ASSINADOS, PENDENTES. O estado ajuda na assinatura remota autorizada ativada pelo eIDAS. Se o pedido de sinalização for enviado para o telemóvel, o estado está pendente.
identificador_de_transação	transaction_id	string	Este parâmetro é usado durante a assinatura RAS
verificação	verification	VerificationResponse
authentication_access_token	authentication_access_token	string	Conterá a id_token OIDC quando o utilizador for autenticado via OIDC

AutoPlaceFieldsResponse

Name	Caminho	Tipo	Descrição
field_name	field_name	string	Nome do campo que foi gerado automaticamente pela API.

ContactResponse

Name	Caminho	Tipo	Descrição
id	id	integer	ID do contacto.
user_name	user_name	string	Nome de utilizador do contacto.
user_email	user_email	string	Endereço de e-mail do contato.
mobile_number	mobile_number	string	Número de telemóvel do contacto.
empresa	enterprise	boolean	Verdade, se o contacto for empresarial.
user_national_id	user_national_id	string	Número de identidade nacional do contacto
created_on	created_on	string	DataHora em que o contacto é adicionado.

WorkSpaceMembers

Name	Caminho	Tipo	Descrição
Nome	name	string	Nome do membro do espaço de trabalho
e-mail	email	string	Endereço de email do membro do espaço de trabalho

WorkSpaceResponse

Name	Caminho	Tipo	Descrição
id	id	integer	Id do espaço partilhado
Nome	name	string	Nome do espaço partilhado
proprietário	owner	WorkSpaceOwner
Membros	members	array of WorkSpaceMembers	Membros do espaço partilhado

WorkSpaceOwner

Name	Caminho	Tipo	Descrição
Nome	name	string	Nome do proprietário do espaço de trabalho
e-mail	email	string	Endereço de email do proprietário do espaço de trabalho

UploadDocumentLibraryResponse

Name	Caminho	Tipo	Descrição
document_id	document_id	integer	ID do documento recém-criado.
document_name	document_name	string	O nome do documento.
document_size	document_size	integer	Tamanho do documento carregado em bytes
document_order	document_order	integer	Ordem do documento
document_type	document_type	string	Tipo do documento, por exemplo, "PDF".
document_source	document_source	string	Identifica onde o documento foi carregado, por exemplo, "A Minha App".
document_width	document_width	integer	Largura do documento em formato PDF.
document_height	document_height	integer	Altura do documento em formato PDF.
document_pages	document_pages	integer	Páginas totais do documento.
uploaded_on	uploaded_on	date-time	A data e hora em que o documento foi carregado.
modified_on	modified_on	date-time	A data e hora em que o documento foi modificado pela última vez.
form_fields	form_fields	boolean	Verdade se o documento tiver campos de formulário.
lock_form_fields	lock_form_fields	boolean	É verdade se o bloqueio dos campos de formulário com a última assinatura estiver ativado.
certificar	certify	UploadDocumentLibraryCertifyResponse
modelo	template	UploadDocumentLibraryTemplateResponse
package_name	package_name	string	Nome do pacote
metadados	metadata	UploadDocumentMetaInfoDetail

CarregarDocumentoBibliotecaCertificarResposta

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	É verdade se a assinatura de certificação estiver ativada para o documento.
allowed_permissions	allowed_permissions	array of string	Conjunto de níveis de permissão permitidos para o documento.
default_permission	default_permission	string	Nível de permissão selecionado para as definições de certificar assinatura.
permissão	permission	string	São as permissões de certificação a serem aplicadas no documento PDF quando a primeira assinatura é criada. Os valores possíveis são "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" e "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".

CarregarModeloBibliotecaDocumentoResposta

Name	Caminho	Tipo	Descrição
template_name	template_name	string	Nome do modelo aplicado no documento.
read_only	read_only	boolean	É verdade se o modelo aplicado for apenas leitura. O utilizador não poderá fazer quaisquer alterações se for aplicado um modelo apenas de leitura.

WorkflowHistoryResponse

Name	Caminho	Tipo	Descrição
package_id	package_id	integer	ID do pacote para o qual o histórico do fluxo de trabalho é solicitado.
package_name	package_name	string
package_owner	package_owner	string	Endereço de email do proprietário do pacote.
owner_name	owner_name	string	Nome do proprietário da embalagem.
package_status	package_status	string	Estado do pacote/documento com o utilizador atualmente logado. Os valores possíveis são "RASCUNHO", "EM PROGRESSO", "PENDENTE", "RECUSADO", "APROVADO", "ATUALIZADO" ou "CONCLUÍDO".
next_signer	next_signer	string	Nome do próximo destinatário.
next_signer_email	next_signer_email	array of Next_signer_email	O objeto tem o nome e o endereço de email do próximo destinatário.
Documentação	documents	array of WorkflowDocumentsResponse
ações	actions	array of DocumentLogsActions

DocumentLogsActions

Name	Caminho	Tipo	Descrição
log_id	log_id	integer	Identificação de uma ação realizada no documento.
date_time	date_time	string	Data e hora em que a ação foi realizada.
action_type	action_type	string
user_email	user_email	string	Email do utilizador que realizou a ação.
user_name	user_name	string	Nome do utilizador que realizou a ação.
enterprise_name	enterprise_name	string	O nome da Enterprise a que o utilizador pertence. Se o utilizador não pertence a uma empresa, então esse elemento não está presente.
Informação	information	DocumentLogsActionsInformation

DocumentRegistosAçõesInformação

Name	Caminho	Tipo	Descrição
tipo	type	string	O tipo de informação extra sobre a ação, por exemplo, "SIGNING_METHOD", que significa que método de assinatura o utilizador usou para assinar o documento.
valor	value	string	O valor da informação extra sobre a ação, por exemplo, "LOCAL", que significa que o utilizador assinou o documento usando credenciais locais.

UpdateCollaboratorResponse

Name	Caminho	Tipo	Descrição
user_email	user_email	string	E-mail do usuário
signing_order	signing_order	integer	Ordem de assinatura
guest_user	guest_user	boolean	É utilizador convidado
email_language_code	email_language_code	string	Código da linguagem do email

CollaboratorGroupResponse

Name	Caminho	Tipo	Descrição
permissão	permission	WorkflowPermissionResponse
lembrete	reminder	ReminderResponse
signing_order	signing_order	integer	Ordem de assinatura

ColaboradorPlaceholderResponse

Name	Caminho	Tipo	Descrição
permissão	permission	WorkflowPermissionResponse
lembrete	reminder	ReminderResponse
signing_order	signing_order	integer	Ordem de assinatura

FieldsResponse

Name	Caminho	Tipo	Descrição
assinatura	signature	array of DigitalSignatureFieldResponse	Uma lista de todas as assinaturas digitais no documento.
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
iniciais	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
itens	in_person_signature	object
enviar SMS	text	array of TextFieldResponse
radio	radio	array of RadioFieldResponse
Caixa de seleção	checkbox	array of CheckboxFieldResponse
lista suspensa	dropdown	array of DropdownFieldResponse
lista	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
Acessório	attachment	array of AttachmentFieldResponse
comentário	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalAssinaturaCampoResposta

Name	Caminho	Tipo	Descrição
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
tipo	type	string	Se o campo for atribuído ou não, os valores possíveis são ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Quer o campo seja processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSADOS.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Utilizador que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
created_on	created_on	string	Data-hora em que o campo é adicionado
processed_by	processed_by	string	Endereço de email do utilizador que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
verificação	verification	VerificationResponse
nid	nid	string
Ecrã	display	string	Devolve o valor de visibilidade do campo de assinatura digital, os valores possíveis são "VISIBLE" e "INVISIBLE".
level_of_assurance	level_of_assurance	array of string
autenticação	authentication	FieldAuthentication

FieldDimenssionResponse

Name	Caminho	Tipo	Descrição
campo	field	FieldResponse
página	page	PageResponse

FieldResponse

Name	Caminho	Tipo	Descrição
x	x	double	Localização esquerda do campo em pixel.
y	y	double	Localização superior do campo em pixel.
Largura	width	double	Largura do campo em pixel.
altura	height	double	Altura do campo em pixel.

PageResponse

Name	Caminho	Tipo	Descrição
Largura	width	float	Largura da página onde o campo está colocado no PDF.
altura	height	float	Altura da página onde o campo está colocado no PDF.

FieldAuthentication

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se as autenticações estiverem ativadas para os campos de assinatura eletrónica.
sms_otp	sms_otp	AccessSecuritySmsOtpResponse
totp	totp	AccessSecurityTOTPResponse

AccessSecurityTOTPResponse

Name	Caminho	Tipo	Descrição
enabled	enabled	boolean	Verdade, se a autenticação TOTP estiver ativada para o pacote.

HandSignatureFieldResponse

Name	Caminho	Tipo	Descrição
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
tipo	type	string	Se o campo for atribuído ou não, os valores possíveis são ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Quer o campo seja processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSADOS.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Utilizador que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do utilizador que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
nid	nid	string

EletrónicaAssinaturaDeCampoResposta

Name	Caminho	Tipo	Descrição
order	order	integer	Endereço de email do utilizador que processou o campo.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
tipo	type	string	Se o campo for atribuído ou não, os valores possíveis são ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Quer o campo seja processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSADOS.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Utilizador que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do utilizador que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	O subtipo de assinatura pode ser uma assinatura TESTEMUNHA. Se as assinaturas das testemunhas estiverem ativadas no plano de serviço, os campos de assinatura eletrónica são assinados com um certificado comum partilhado por todos os utilizadores do plano de serviço. Os valores possíveis são WITNESS ou NENHUM.
autenticação	authentication	FieldAuthentication
verificação	verification	VerificationResponse
nid	nid	string
Ecrã	display	string	Devolve o valor de visibilidade do campo de assinatura eletrónica, os valores possíveis são "VISIBLE" e "INVISIBLE".

InicialFieldResponse

Name	Caminho	Tipo	Descrição
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
process_status	process_status	string	Quer o campo seja processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSADOS.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Utilizador que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do utilizador que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.

TextFieldResponse

Name	Caminho	Tipo	Descrição
required	required	boolean	Verdade se for necessário um campo em pdf
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
tab_order	tab_order	integer	Ordem de tabulação no documento PDF
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
tipo	type	string	Tipo do campo de texto, os valores possíveis são "TEXTO", "NOME", "EMPRESA", "CARGO DO CARGO", "EMAIL", "DATA".
valor	value	string	Valor do campo. Para o tipo = DATA ou format_type = DATA, espera-se que o valor siga o formato ISO 8601. Seguindo o formato YYYY-MM-DD hh:mm:ss +00. Como os valores são para campos de data, as aplicações clientes podem enviar YYYY-MM-DD e ignorar hh:mm:ss +00. Se o valor não estiver no formato correto, será devolvido um erro.
read_only	read_only	boolean	Verdade, se o campo estiver marcado como apenas leitura no documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos campos, os valores possíveis são "OBRIGATÓRIO" ou "OPCIONAL".
validação	validation	FieldValidationValue
visível	visible	boolean	Verdade, se o campo não estiver escondido no documento PDF.
multilinha	multiline	boolean	Verdade, se o campo for multi-linha no documento PDF.
font	font	FontResponse
max_length	max_length	integer	Comprimento máximo de conteúdo permitido para ser preenchido no campo.
format_type	format_type	string	Se o campo for uma caixa de texto, pode seguir diferentes tipos de entrada. Os valores possíveis são ALFANUMÉRICO, NÚMERO, TEXTO, EMAIL, HORA ou DATA.
marcador de posição	placeholder	string	Texto provisório para o campo da caixa de texto.
format	format	string	Formato de texto do campo. Usado apenas para o campo do tipo de data. Os valores possíveis são M/D d/m/aa m/d/yyyy mm/dd/yy dd/mm/aaaa mm/yy mm/yyyy D-mmm M-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd AAAA-MM-DD mmm-yy Mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
cor	color	string	Cor do texto nos campos de formulário.
border_color	border_color	string	Cor da borda do campo do formulário.
descrição	tooltip	string	Dica de ferramenta do campo do formulário.
field_rotation	field_rotation	integer	Rotação de Campo
alinhar	align	string	Alinhamento de texto para o campo do formulário. Os valores possíveis são "DIREITA", "ESQUERDA", "CENTRO" ou "JUSTIFICAR"
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Name	Caminho	Tipo	Descrição
required	required	boolean	Verdade se for necessário um campo em pdf
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
tab_order	tab_order	integer	Ordem de tabulação no documento PDF.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
tipo	type	string
valor	value	boolean	Valor do campo.
read_only	read_only	boolean	Verdade, se o campo estiver marcado como apenas leitura no documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
radio_group_name	radio_group_name	string	O nome do grupo ao qual pertence o campo.
verificado	checked	boolean	Verdade, se o campo for selecionado
visível	visible	boolean	Verdade se o campo não estiver escondido no documento PDF.
dimensions	dimensions	FieldDimenssionResponse
cor	color	string	Cor do texto nos campos de formulário.
border_color	border_color	string	Cor da borda do campo do formulário.
descrição	tooltip	string	Dica de ferramenta do campo do formulário.
field_rotation	field_rotation	integer	Rotação de Campo

CheckboxFieldResposta

Name	Caminho	Tipo	Descrição
required	required	boolean	Verdade se for necessário um campo em pdf
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
tab_order	tab_order	integer	Ordem de tabulação no documento PDF
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
tipo	type	string
valor	value	boolean	Valor do campo.
read_only	read_only	boolean	Verdade, se o campo estiver marcado como apenas leitura no documento PDF.
verificado	checked	boolean	É verdade se o campo for selecionado.
visível	visible	boolean	Verdade se o campo não estiver escondido no documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
dimensions	dimensions	FieldDimenssionResponse
cor	color	string	Cor do texto nos campos de formulário.
border_color	border_color	string	Cor da borda do campo do formulário.
descrição	tooltip	string	Dica de ferramenta do campo do formulário.
field_rotation	field_rotation	integer	Rotação de Campo

DropdownFieldResponse

Name	Caminho	Tipo	Descrição
required	required	boolean	Verdade se for necessário um campo em pdf
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
tab_order	tab_order	integer	Ordem de tabulação no documento PDF.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
read_only	read_only	boolean	Verdade, se o campo estiver marcado como apenas leitura no documento PDF.
valor	value	string	Valor do campo .
choices	choices	array of string	Opções disponíveis para o menu suspenso escolher um valor.
visível	visible	boolean	Verdade, se o campo não estiver escondido no documento PDF.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
cor	color	string	Cor do texto nos campos de formulário.
border_color	border_color	string	Cor da borda do campo do formulário.
descrição	tooltip	string	Dica de ferramenta do campo do formulário.
field_rotation	field_rotation	integer	Rotação de Campo

ListaCaixaCampoResposta

Name	Caminho	Tipo	Descrição
order	order	integer	Ordem do destinatário a quem este campo está atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
tab_order	tab_order	integer	Ordem de tabulação no documento PDF.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
Embutidos	embedded	boolean	Verdade, se o campo faz parte do documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
read_only	read_only	boolean	Verdade, se o campo estiver marcado como apenas leitura no documento PDF.
valor	value	string	Valor do campo.
choices	choices	array of string	Opções disponíveis para o menu suspenso escolher um valor.
visível	visible	boolean	Verdade, se o campo não estiver escondido no documento PDF.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
cor	color	string	Cor do texto nos campos de formulário.
border_color	border_color	string	Cor da borda do campo do formulário.
descrição	tooltip	string	Dica de ferramenta do campo do formulário.
field_rotation	field_rotation	integer	Rotação de Campo

FontResponse

Name	Caminho	Tipo	Descrição
Nome	name	string	Nome da fonte para o campo de texto. Para campos definidos pelo utilizador, o SigningHub suporta apenas "COURIER", "HELVETICA". No caso de campos existentes num ficheiro PDF, o valor da fonte pode ser qualquer coisa definida no PDF.
size	size	integer	Tamanho da fonte para o campo de texto.
embedded_size	embedded_size	double	Tamanho da fonte no documento PDF original.

QrCodeResponse

Name	Caminho	Tipo	Descrição
field_name	field_name	string	Identificador único do campo.
tipo	type	string	Tipo de campo PDF_FIELD_TYPE como QR
page_no	page_no	integer	Número de página do documento onde o campo existe.
valor	value	string	O base64 gerado por QrCode será fornecido automaticamente em modo de rascunho
dimensions	dimensions	FieldDimenssionResponse
dados	data	string	Os dados em texto simples devem ser codificados no código QR. O padrão é URL gerado para aceder ao documento relacionado. por exemplo, {base_url}/document/{document_unique_id}
options	options	QrCodeOptions
cor	color	QrCodeColor
logótipo	logo	QrCodeLogo

AttachmentFieldResponse

Name	Caminho	Tipo	Descrição
order	order	integer	Ordem do destinatário a quem este campo está atribuído.
display_order	display_order	integer	Mostrar a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador único do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
process_status	process_status	string	Quer o campo seja processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSADOS.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Utilizador que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do utilizador que processou o campo.
attachmentRefId	attachmentRefId	integer	Attachmet ref id
Observação	note	string	Nota de anexo Só em caso de regra de anexo "OBRIGATÓRIO"
validation_rule	validation_rule	ValidationRule	Uma ou mais regras para validação dos valores possíveis dos campos são "OBRIGATÓRIO" ou "OPCIONAL".
dimensions	dimensions	FieldDimenssionResponse

ComentárioCampoResposta

Name	Caminho	Tipo	Descrição
id	id	integer	ID do campo de comentário
page_no	page_no	integer	Número de página do documento onde o campo existe.
unread_count	unread_count	integer	Comentários não lidos
privado	private	boolean	Privado
recipients	recipients	array of CommentFieldRecipientResponse	Destinatários
dimensions	dimensions	FieldDimenssionResponse

UniqueIdentifierFieldResponse

Name	Caminho	Tipo	Descrição
field_name	field_name	string	Identificador único do campo.
valor	value	string	Valor do campo.
page_no	page_no	integer	Número de página do documento onde o campo existe.
font	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

ComentárioCampoRecetorResposta

Name	Caminho	Tipo	Descrição
user_name	user_name	string	Nome de utilizador
user_email	user_email	string	E-mail do usuário

objecto

Este é o tipo 'objeto'.