SigningHub (versão prévia)

O SigningHub by Ascertia fornece um pacote abrangente para assinaturas digitais de alta confiança e automação de fluxo de trabalho de documentos. Esse conector permite que as empresas autentiquem usuários com segurança, iniciem solicitações de assinatura de documentos e gerenciem ciclos de aprovação de ponta a ponta. Projetado para atender a rigorosos padrões de segurança global, ele garante que seus fluxos de trabalho automatizados permaneçam legalmente aplicáveis, transparentes e altamente seguros em toda a sua organização.

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

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Publisher	Ascertia Limited.
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Site	https://signinghub.com
Política de privacidade	https://www.signinghub.com/privacy-policy
Categories	Conteúdo e arquivos; Produtividade

Conector do SigningHub

O SigningHub fornece uma API REST abrangente que permite que as organizações automatizem e gerenciem fluxos de trabalho de assinatura de documentos digitais. Usando esse conector, você pode integrar o SigningHub ao Power Automate para simplificar os processos de aprovação de documentos e automatizar ações de assinatura em fluxos de trabalho personalizados.

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

Publisher: Ascertia

Pré-requisitos

Para usar esse conector, você deve ter:

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

Como obter credenciais

Preencha os campos formulário de logon com os seguintes valores:

Email: o email da conta do SigningHub.
Senha: a senha da conta do SigningHub.
ID do cliente da API: a Ascertia ou o administrador da empresa fornecerão a ID do cliente da API para usar o conector.
Segredo do Cliente da API: a Ascertia ou o administrador da empresa fornecerão o Segredo do Cliente da API para usar o conector.
URL da API: a URL da API do SigningHub, por padrão https://api.signinghub.com

Operações com suporte

Esse conector fornece alguma cobertura da API REST do SigningHub. Para obter uma lista de ações com suporte e seus parâmetros, consulte o Guia de API do SigningHub.

Suporte & Links

Limitações

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

Ações

Adicionar campo CheckBox	Aplicativos empresariais podem usar essa API de serviço para adicionar uma caixa de seleção a um documento em um pacote. Pelo menos um usuário deve existir em um fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho. Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários. Se os parâmetros de largura e altura não forem fornecidos, um tamanho padrão de 10x10 será atribuído. Se a largura ou a altura (ou ambas) forem fornecidas, o sistema comparará esses valores fornecidos uns com os outros. O valor maior entre largura e altura será atribuído a ambas as dimensões.
Adicionar campo de assinatura digital	Aplicativos empresariais podem usar essa API de serviço para adicionar um campo de assinatura digital a um documento em um pacote. Pelo menos um usuário deve existir em um fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho. Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários.
Adicionar campo in-person	Aplicativos empresariais podem usar essa API de serviço para um campo de assinatura de adição pessoal a um documento em um pacote. Pelo menos um usuário deve existir em um fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho. Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários. Para hospedar uma reunião pessoal, um usuário do SigningHub deve fazer parte do fluxo de trabalho. Eles devem ser adicionados com a função "INPERSON_HOST" ou "SIGNER". Para a opção de host, eles não exigem uma assinatura ou um campo de entrada no documento e o campo de assinatura pessoal pode ser assinado pelo usuário não registrado do SigningHub. Observe que este é um cenário de fluxo de trabalho especial pelo qual se espera que o usuário e o destinatário do SigningHub estejam no mesmo local. Esse tipo de assinatura não se destina a ser usado pelo qual um documento é compartilhado com destinatários por meio do link de email no método de integração flexível normal.
Adicionar campo inicial	Aplicativos empresariais podem usar essa API de serviço para adicionar um campo de iniciais a um documento em um pacote. Pelo menos um usuário deve existir em um fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho. Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários.
Adicionar campo RadioBox	Aplicativos empresariais podem usar essa API de serviço para adicionar uma caixa de seleção a um documento em um pacote. Pelo menos um usuário deve existir em um fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho. Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários. Se os parâmetros de largura e altura não forem fornecidos, um tamanho padrão de 10x10 será atribuído. Se a largura ou a altura (ou ambas) forem fornecidas, o sistema comparará esses valores fornecidos uns com os outros. O valor maior entre largura e altura será atribuído a ambas as dimensões.
Adicionar campo TextBox	Aplicativos empresariais podem usar essa API de serviço para adicionar um campo de entrada de texto a um documento em um pacote. Pelo menos um usuário deve existir em um fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho. Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários.
Adicionar código QR	Aplicativos empresariais podem usar essa API de serviço para adicionar um QR Code a um documento em um pacote.
Adicionar espaço reservado ao fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para adicionar espaço reservado a um fluxo de trabalho em um pacote. Um espaço reservado é necessário quando você não sabe a identidade do destinatário pretendido em um fluxo de trabalho. Observe que o espaço reservado será adicionado como o último usuário no fluxo de trabalho. Portanto, pode ser necessário mais trabalho para remover um usuário/grupo atual, já presente no fluxo de trabalho. A adição de um espaço reservado permite que você prossiga e adicione campos de assinatura e/ou de entrada ao documento, que podem ser atribuídos a usuários individuais em um estágio posterior. Enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
Adicionar grupos ao fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para adicionar grupos como um destinatário a um fluxo de trabalho. Um grupo do SigningHub significa que qualquer membro do grupo pode executar a ação, ou seja, assinar, em nome de todos os membros do grupo. Observe que o grupo será adicionado como o último usuário/grupo no fluxo de trabalho. Portanto, pode ser necessário mais trabalho para remover um usuário/grupo atual, já presente no fluxo de trabalho. Enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
Adicionar ou atualizar documento da biblioteca	Aplicativos empresariais podem usar essa API de serviço para adicionar um documento da biblioteca do usuário a um pacote. A ID do pacote é fornecida na URL, a ID do documento também deve ser fornecida como "document_id" na URL do recurso para identificar o documento da biblioteca a ser copiado. Observe que um pacote já deve existir antes de adicionar um documento usando essa chamada.
Adicionar Pacote	Essa API de serviço é usada para adicionar/criar um pacote de documentos para armazenar um ou mais documentos. Esse pacote pode ser usado para adicionar documentos e destinatários para iniciar um novo fluxo de trabalho. Conforme indicado anteriormente, essa chamada será obrigatória se você quiser trabalhar com documentos. Um pacote deve existir antes que você possa carregar ou adicionar documentos ao SigningHub.. Até mesmo um único documento faz parte de um pacote: um pacote que contém um documento. Observação: um pacote pode ser renomeado se necessário uma vez criado.
Adicionar usuários ao fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para adicionar destinatários a um fluxo de trabalho. Essa chamada só adicionará um destinatário ao fluxo de trabalho. Ou seja, nenhum campo atualmente no documento será atribuído automaticamente aos novos destinatários, nem isso criará novos campos. Observe que os destinatários serão adicionados como a última pessoa no fluxo de trabalho. Portanto, pode ser necessário mais trabalho para remover os destinatários atuais já presentes no fluxo de trabalho. Pelo menos um usuário deve existir em um fluxo de trabalho antes que os campos (entrada e assinatura) possam ser adicionados ao documento. Observe que a entrada aceita um ou mais usuários em uma única chamada. Nesta chamada específica, o usuário é uma pessoa natural conhecida. No entanto, as mesmas regras se aplicam a Grupos e Espaços Reservados. Em qualquer um desses casos, o destinatário se torna um grupo de usuários pelo qual qualquer membro do grupo pode assinar o documento ou um Espaço Reservado.O último caso é usado quando você não sabe a identidade do signatário pretendido. Observe que a ordem de assinatura do fluxo de trabalho do SigningHub começa em "1". Portanto, adicionar um usuário ao fluxo de trabalho sem destinatários atuais inicia uma nova contagem de pedidos de assinatura. O parâmetro "signing_order" será obrigatório se o tipo de fluxo de trabalho for "personalizado". Importante, usar essa chamada à API pode afetar o tipo de fluxo de trabalho. Se houver destinatários atuais em um fluxo de trabalho sequencial e um novo for adicionado com a mesma ordem de assinatura que um destinatário atual, essa parte do fluxo de trabalho será alterada automaticamente de sequencial para paralela. Portanto, o fluxo de trabalho em geral agora é do tipo personalizado em vez de puramente sequencial. Adicionar um destinatário com a mesma ordem de assinatura que dois ou destinatários paralelos não altera o fluxo de trabalho. Há apenas três ou mais destinatários nesse ponto específico do fluxo de trabalho; tudo em ordem paralela. Observe que, enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
Aplicar modelo de fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para aplicar um modelo de fluxo de trabalho a um documento. A ID do documento na qual o modelo deve ser aplicado é fornecida na URL do recurso. Quando a ID do documento for definida como 0, o modelo será aplicado a todos os doucments em um pacakge. Ao aplicar o modelo, é importante lembrar estes dois pontos importantes: Ponto 1 - Se o modelo que está sendo aplicado for criado usando um PDF que já contém campos de formulário, verifique se o documento no qual este modelo está sendo aplicado agora deve conter esses campos de formulário com antecedência e o SigningHub NÃO criará esses campos de formulário por meio do modelo, em vez disso, aplicará apenas os dados do formulário e atribuirá aos respectivos usuários. Ponto 2 – Se o modelo que está sendo aplicado for criado onde os campos de formulário são adicionados manualmente (portanto, não estão presentes no PDF originalmente) por meio do campo de assinatura, por exemplo, campo de assinatura, assinatura inicial, pessoal, caixas de seleção, botões de opção, campos de texto etc. Em seguida, ao aplicar esse modelo, esses campos de formulário serão criados no documento de destino mesmo se esses campos de formulário já estivessem presentes no documento.
Aprovar Documento	Aplicativos empresariais podem usar essa API de serviço para aprovar um documento por um usuário especificado na ordem.
Assinar Documento	Aplicativos empresariais podem usar essa API de serviço para assinar um documento (eletrônico e digital) sem exibir o documento para o usuário final usando o SigningHub. Por exemplo, um aplicativo de negócios pode ter outro método para exibir o documento para o usuário e somente a funcionalidade de assinatura do SigningHub é necessária ou, para operações em massa, pode ser justificado assinar sem exigir que o usuário exiba e aprove cada documento individualmente. Se houver alterações a serem salvas no documento antes de assinar, a API de Campos de Formulário de Preenchimento deverá ser chamada antes de chamar a API de Documento de Sinal. Observe que todos os campos de entrada obrigatórios em um documento exigem a conclusão antes que essa API seja concluída com êxito. O signatário é identificado pelo token de acesso apresentado na chamada. Portanto, a autenticação do signatário é necessária antes de fazer essa chamada. Você não pode se autenticar como um Administrador Corporativo com a variável de escopo e assinar um documento em nome de um usuário. O token de acesso deve ser emitido ao signatário como resultado da autenticação direta. Quando essa chamada for concluída, é importante que, se o signatário for o último signatário de um documento, a chamada à API concluir documento será invocada. O motivo é porque, sem chamar essa API, o documento permanecerá em um status de "Em andamento" para o proprietário do documento. Depois que a API tiver sido chamada, o status será alterado para "Concluído" para o proprietário do documento. Depois que o documento for assinado, a resposta de verificação poderá ser vista na API obter verificação de documento . Uso de OTP do primeiro ou segundo fator para autenticação Se a autenticação OTP estiver ativada para a operação de assinatura do lado do servidor, os aplicativos cliente precisarão gerar um OTP para o número móvel usando a Autenticação do Signatário por meio da chamada à API OTP. Os respectivos aplicativos de negócios devem recuperar o OTP do uso e enviá-lo ao fazer a chamada à API. Isso é feito usando o cabeçalho "x-otp" na solicitação.
Atribuir Campo de Documento	Aplicativos empresariais podem usar essa API de serviço para atribuir usuários a campos de entrada, por exemplo, campos de assinatura e, portanto, definir a ordem de assinatura. Os campos já devem estar presentes no documento e os usuários devem estar presentes no fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso, juntamente com o identificador do pacote. Quando os destinatários estão em um fluxo de trabalho, eles são numerados, começando em um e contando para cada um extra. Portanto, se houver três usuários em um fluxo de trabalho, eles serão numerados "1", "2" e "3" com respeito. Essa chamada à API permite que você atribua um usuário pelo número da ordem de fluxo de trabalho a um campo de entrada no documento.
Atualizar a Autenticação de Usuário do Fluxo de Trabalho (Abertura de Documento) do Pacote Enterprise	Os aplicativos empresariais podem usar essa API de serviço para atualizar as autenticações de pacote e a duração de acesso dos destinatários. Essa API também poderá ser usada pelo administrador da empresa ou pelo usuário da empresa se a variável "escopo" tiver sido usada na solicitação de autenticação
Atualizar a ordem dos usuários do fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para atualizar a ordem do destinatário no fluxo de trabalho.
Atualizar a Política de Certificação para um documento	Os aplicativos empresariais podem usar essa API de serviço para atualizar as configurações de assinatura de certificação de um documento em um pacote.
Atualizar campo de assinatura digital	Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de assinatura digital de um documento em um pacote. Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada. Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui.
Atualizar campo inicial	Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de iniciais de um documento em um pacote. Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada. Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui.
Atualizar campo TextBox	Aplicativos empresariais podem usar essa API de serviço para atualizar uma caixa de texto de um documento em um pacote. Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada. Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui.
Atualizar código QR	Aplicativos empresariais podem usar essa API de serviço para atualizar um QR Code de um documento em um pacote.
Atualizar detalhes do fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para atualizar os detalhes do fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento, mas os aplicativos empresariais querem substituir a permissão de certificação ou os detalhes de pós-processamento. A ID do pacote é fornecida na URL do recurso.
Atualizar espaço compartilhado	Aplicativos empresariais podem usar essa API de serviço para atualizar o espaço compartilhado. A disponibilidade de atualização de espaços compartilhados está sujeita à função de usuário empresarial atribuída. Para permitir esse provisionamento, o Administrador Corporativo habilitará a opção "Gerenciar Espaço Compartilhado" nas Configurações do Documento de Funções>.
Atualizar Espaço Reservado	Aplicativos empresariais podem usar essa API de serviço para atualizar um espaço reservado no fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir os detalhes de um titular de local específico dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o titular do local de fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho. Enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
Atualizar lembretes de fluxo de trabalho	Aplicativos empresariais podem usar essa 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, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir as configurações de lembretes dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o destinatário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho.
Atualizar o campo CheckBox	Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de caixa de seleção de um documento em um pacote. Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada. Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui. Não é possível atualizar a largura e a altura. Eles permanecerão iguais a quando foram adicionados.
Atualizar o campo pessoal	Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de assinatura pessoal de um documento em um pacote. Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada. Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui.
Atualizar o campo RadioBox	Aplicativos empresariais podem usar essa API de serviço para atualizar um botão de opção de um documento em um pacote. Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada. Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui. Não é possível atualizar a largura e a altura. Eles permanecerão iguais a quando foram adicionados.
Atualizar permissões de usuário do fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para atualizar as permissões de fluxo de trabalho para um usuário que já foi adicionado a um fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir as permissões dentro do fluxo de trabalho. A ID do pacote de documentos é fornecida na URL do recurso e o usuário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho.
Atualizar Pós-Processamento	Aplicativos empresariais podem usar essa API de serviço para adicionar espaço reservado a um fluxo de trabalho de um documento em um pacote.
Atualizar usuário do fluxo de trabalho	Os aplicativos empresariais podem usar essa API de serviço para atualizar os detalhes de um destinatário, grupo ou titular do local que já foi adicionado a um fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir os detalhes de um usuário específico dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o destinatário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho. Observe que, embora a preparação do documento do tipo XML dê suporte apenas aos tipos de função "SIGNER", "REVIEWER" e "CARBON_COPY".
Baixar anexo	Aplicativos empresariais podem usar essa API de serviço para baixar o anexo de um documento.
Baixar Documento	Aplicativos empresariais podem usar essa API de serviço para baixar os bytes do documento. A ID do pacote e a ID do documento são fornecidas na URL do recurso.
Baixar Pacote	Aplicativos empresariais podem usar essa API de serviço para baixar o pacote de documentos no formato binário. A ID do pacote é fornecida na URL do recurso. Se o pacote contiver apenas um documento, o download será o documento PDF binário. Como alternativa, se o pacote tiver mais de um documento, o download será o arquivo zip binário de todos os documentos. Os cabeçalhos x-password e x-otp são opcionais. Eles serão necessários se o proprietário do documento defini-los durante a fase de criação do fluxo de trabalho.
Campos de AutoPlace	Aplicativos empresariais podem chamar essa API para adicionar campos de formulário definidos pelo usuário ou assinatura a um documento com base no critério de pesquisa fornecido. As opções de posicionamento são: à esquerda, à direita, superior e inferior. O documento é uma pesquisa e todas as instâncias dos critérios de pesquisa atendidos são processadas. Isso permite que você adicione vários campos com uma chamada. Por exemplo, carregue um documento e coloque automaticamente um campo de assinatura à direita de todas as instâncias da palavra "Assinar aqui:". Isso economiza tempo e garante que nenhuma assinatura seja perdida do fluxo de trabalho. A chamada à API dá suporte a todos os tipos de campos; ou seja, eletrônico, digital, pessoal, inicial e campo de texto etc. Além disso, a chamada à API dá suporte à variável "order". Isso significa que você pode atribuir um conjunto de campos de assinatura automaticamente a um único usuário. Portanto, a chamada pode ser repetida para colocar e atribuir campos de assinatura a mais de um usuário no fluxo de trabalho. Pelo menos um usuário deve existir em um fluxo de trabalho antes que os campos de assinatura possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho. Essa chamada à API pode ser usada várias vezes no mesmo documento. A razão para fazer isso é atender a vários signatários em um documento. O destinatário ou signatário é identificado pela variável "order" passada na chamada. Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários.
Campos de formulário de preenchimento	Aplicativos empresariais podem usar essa API de serviço para preencher um ou mais campos de formulário em um documento por um usuário especificado na ordem.
Carregar anexo	Aplicativos empresariais podem usar essa API de serviço para carregar um anexo em um documento.
Carregar documento	Aplicativos empresariais podem usar essa API de serviço para adicionar um documento a um pacote de documentos vinculado à conta de um usuário corporativo. As informações do documento são enviadas no cabeçalho da solicitação HTTP e os bytes de documento são enviados no corpo da solicitação HTTP. Observe que o SigningHub converterá formatos de documento com suporte em PDF se o cabeçalho "x-convert-document" for definido como um valor de "true". O único caso com suporte em que esse valor é definido como "false" é manter Word formato e documentos XML. O SigningHub dá suporte a uma ampla variedade de formatos de documento, cada um deles pode ser convertido em formato PDF após o upload. Clique aqui para obter a lista completa. Observe que os documentos PDF não são alterados após o upload para o sistema. Observe que um pacote já deve existir antes de adicionar um documento usando essa chamada.
Compartilhar pacote de documentos	Aplicativos empresariais podem usar essa API de serviço para compartilhar 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 usuários e as ações definidas no modelo. A ID do pacote a ser compartilhada é fornecida na URL do recurso.
Concluir fluxo de trabalho no meio (encerrar fluxo de trabalho)	Aplicativos empresariais podem marcar o fluxo de trabalho concluído mesmo no meio do fluxo de trabalho. Use essa API de serviço para alterar o status do fluxo de trabalho a ser concluído. Se houver destinatários que ainda não assinaram o documento. Sua assinatura não será mais necessária e eles não poderão ver o documento em sua caixa de entrada mais adiante. O token de portador deve pertencer ao proprietário do documento ou o administrador corporativo pode usar a variável de escopo para obter o token de acesso em nome do proprietário do documento para executar essa ação.
Concluir o processamento	Os aplicativos empresariais podem usar essa API de serviço para concluir o processamento do documento depois de assinar todos os campos de assinatura. Esse método é usado principalmente por aplicativos móveis nativos do SigningHub para iOS e Android e casos de uso da Web móvel. Aplicativos comerciais gerais que empregam uma integração apertada em seu respectivo portal não precisam chamar esse método. No entanto, ao usar a API de Documento de Sinal (e, portanto, o usuário não é presenteado com uma representação visual do documento que é solicitado a assinar) chamar essa API é necessário para garantir que o respectivo fluxo de trabalho continue ou seja concluído. Por exemplo, depois que todas as assinaturas tiverem sido aplicadas usando a chamada "cega" da API do Documento de Assinatura, o documento não será exibido como status "Concluído" para o proprietário até que essa API seja invocada. O proprietário do documento verá um status de "Em andamento" até que essa API seja chamada. Em aplicativos móveis nativos do SigningHub e casos de uso da Web móvel, essa chamada é necessária para garantir que cada usuário conclua suas respectivas ações em relação ao SigningHub.Por exemplo, depois que um signatário assinou um documento no SigningHub App, esse método é invocado pelo aplicativo para garantir que o fluxo de trabalho continue a ser processado e que o próximo signatário seja notificado, e o status do documento está disponível por meio da URL de back de chamada configurada.
Documento de aprovação do gatekeeper	Aplicativos empresariais podem usar essa API de serviço para que o gatekeeper aprove um documento por um usuário especificado na ordem.
Documento de recall	Aplicativos empresariais podem usar essa API de serviço para interromper um fluxo de trabalho em andamento. A ID do documento é fornecida na URL do recurso. Após o recall, o status do documento é alterado automaticamente para "RASCUNHO".
Documento de recusa do gatekeeper	Os aplicativos empresariais podem usar essa API de serviço para recusar um documento por um usuário especificado na ordem.
Enviar Documento	Uma das funções do SigningHub é chamada de "Editor". Isso permite que um destinatário edite campos de entrada em um documento, mas não requer uma assinatura. Depois de concluído, o destinatário envia suas alterações. O botão usado na GUI é chamado "Enviar". Essa é a operação equivalente para um editor enviar suas alterações por meio de uma chamada à API. Clique em Funções do SigningHub para obter uma descrição de todas as funções de destinatário de fluxo de trabalho disponíveis.
Excluir anexo	Aplicativos empresariais podem usar essa API de serviço para excluir o anexo de um documento.
Excluir Campo de Documento	Aplicativos empresariais podem usar essa API de serviço para excluir um campo de documento em um pacote.
Excluir Documento	Aplicativos empresariais podem usar essa API de serviço para excluir um documento em um pacote.
Excluir Espaço Compartilhado	Aplicativos empresariais podem usar essa API de serviço para excluir o espaço compartilhado. A disponibilidade da exclusão de espaços compartilhados está sujeita à função de usuário empresarial atribuída. Para permitir esse provisionamento, o Administrador Corporativo habilitará a opção "Gerenciar Espaço Compartilhado" nas Configurações do Documento de Funções>.
Excluir Pacote	Aplicativos empresariais podem usar essa API de serviço para excluir um documento da caixa de entrada do usuário. A ID do pacote é fornecida na URL do recurso como "{package_id}". Se o status do documento estiver PENDENTE, ele será recusado automaticamente como resultado da operação de exclusão. Se o status do documento for SHARED, o documento será recuperado automaticamente e o fluxo de trabalho será interrompido antes que o documento seja excluído.
Excluir Usuário de Fluxo de Trabalho	Aplicativos empresariais podem usar essa API de serviço para excluir o destinatário do fluxo de trabalho.
Iniciais de preenchimento	Aplicativos empresariais podem usar essa API de serviço para preencher um campo de iniciais em um documento por um usuário especificado na ordem.
Mover o pacote para a pasta Espaço Personalizado ou Compartilhado	Aplicativos empresariais podem usar essa API de serviço para mover o pacote de documentos para um espaço compartilhado ou pasta personalizada do usuário.
Obter a Autenticação de Usuário do Fluxo de Trabalho (Abertura de Documento) do Pacote Enterprise	Os aplicativos empresariais podem usar essa API de serviço para habilitar as configurações de segurança de acesso para o pacote. Os destinatários para os quais a segurança está configurada são identificados pela ordem na URL. A ID do pacote também é identificada na URL da solicitação. Os destinatários não poderão acessar o pacote de documentos fora do escopo dessa duração se a segurança de acesso estiver habilitada. O proprietário do documento também pode configurar a segurança baseada em autenticação do pacote para um destinatário.
Obter a Política de Certificação para um documento	Aplicativos empresariais podem usar essa API de serviço para obter configurações de assinatura certificadas de um documento em um pacote.
Obter anexos	Aplicativos empresariais podem usar essa API de serviço para obter os anexos de um documento.
Obter campos de documento	Aplicativos empresariais podem usar essa API de serviço para obter campos de documento, ou seja, iniciais, pessoas, campos de assinatura ou campos de formulário.
Obter contatos	Aplicativos empresariais podem usar essa API de serviço para ressamarrar contatos de contatos pessoais e empresariais para o usuário atual. É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text". Além disso, é possível pesquisar os contatos específicos de um usuário ou o da empresa à qual o usuário pertence. As informações de resposta de pesquisa contêm o endereço de email do usuário e o respectivo nome de usuário.
Obter detalhes do documento	Aplicativos empresariais podem usar essa API de serviço para obter os detalhes do documento. A ID do documento é fornecida na URL como "{document_id}".
Obter detalhes do fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para obter detalhes de fluxo de trabalho para o pacote.
Obter detalhes do pacote	Aplicativos empresariais podem usar essa API de serviço para obter os detalhes de um pacote. Essa API também pode ser usada pelo aplicativo de negócios para executar uma ação em nome do usuário corporativo por meio da "Autenticação de Escopo".
Obter espaço compartilhado	Aplicativos empresariais podem usar essa API de serviço para obter um espaço compartilhado específico. Essa API retorna informações sobre o espaço compartilhado, seu proprietário e colaborador.
Obter histórico de fluxo de trabalho	Aplicativos empresariais podem utilizar essa API de serviço para recuperar a lista de ações executadas em um documento. A ID do pacote é fornecida 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.
Obter lembrete de fluxo de trabalho	Os aplicativos empresariais podem usar essa API de serviço para atualizar os lembretes para os destinatários que já foram adicionados a um fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir as configurações de lembretes dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o destinatário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho.
Obter modelos	Os aplicativos de negócios podem usar essa API de serviço para obter uma lista de modelos para o usuário 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 usuário ou os modelos corporativos, conforme permitido em relação à função de usuário por seu administrador corporativo.
Obter modelos empresariais	Aplicativos empresariais podem usar essa API de serviço para obter a lista de modelos empresariais do usuário atual. Isso significa que o administrador da empresa ou o usuário corporativo se a variável "escopo" foi usada na solicitação de autenticação. É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text".
Obter pacotes	Aplicativos empresariais podem usar essa API de serviço para obter uma lista de documentos filtrados por status diferentes. Os usuários podem dividir os registros em páginas fornecendo uma série de registros por página.
Obter permissões de usuário de fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para obter permissões de documento para um destinatário. O destinatário é identificado pela ordem no fluxo de trabalho. A ID do pacote é fornecida na URL do recurso.
Obter relatório de evidências do processo	Aplicativos empresariais podem usar essa API de serviço para baixar o relatório de evidências do processo de fluxo de trabalho de um documento.
Obter usuários de fluxo de trabalho	Aplicativos empresariais podem usar essa API de serviço para obter detalhes de fluxo de trabalho para o pacote.
Pacotes de logon em massa	Aplicativos empresariais podem usar essa API para assinar/compartilhar/assinar e compartilhar vários documentos (eletrônicos e digitais) sem exibir os documentos para o usuário final. Essa API precisa de informações do aplicativo de negócios sobre pacotes de documentos e os detalhes de assinaturas, campos pessoais e iniciais. Após a conclusão bem-sucedida da transação de assinatura em massa, a API retornará os status e as IDs de transação dos pacotes de documentos. Ao contrário da API de Documento de Assinatura, essa API não apenas assina um pacote de documentos, mas também o marca como aprovado e revisado com base em se o destinatário é um Signatário, Editor ou Revisor. Qualquer pacote de documentos para o qual o status retorna como COMPLETED foi assinado, aprovado ou revisado por essa API. A Assinatura em Massa funciona com todos os métodos de autenticação de tempo de assinatura. Se SIGN for passado como bulk_action e o pacote estiver no estado rascunho, Sign e Share serão executados automaticamente. Você deve chamar essa API após a API pré-assinar documentos em massa . Caso você precise fazer alterações em qualquer um dos documentos antes de assinar, a API de Campos de Formulário de Preenchimento deve ser chamada antes de chamar a API de Documento de Pré-Assinatura em Massa. Lembre-se de que todos os campos de entrada obrigatórios em um documento exigem a conclusão antes que essa API seja concluída com êxito; enquanto que os campos preenchidos automaticamente (como Nome, Email, Data, Cargo etc.) serão preenchidos automaticamente. O signatário é identificado pelo token de acesso apresentado na chamada. Portanto, a autenticação do signatário é necessária antes de fazer essa chamada. Você não pode se autenticar como um Administrador Corporativo com a variável de escopo e assinar um documento em nome de um usuário. O token de acesso deve ser emitido ao signatário como resultado da autenticação direta. Depois que o documento for assinado, a resposta de verificação poderá ser vista na API de Status de Assinatura em Massa . Uso de OTP do primeiro ou segundo fator para autenticação Caso a autenticação OTP esteja ativada para a operação de assinatura do lado do servidor, os aplicativos cliente precisarão gerar um OTP para o número móvel usando a Autenticação de Sinal em Massa por meio da chamada à API OTP. Os respectivos aplicativos de negócios devem recuperar o OTP do uso e enviá-lo ao fazer a chamada à API. Isso é feito usando o cabeçalho "x-otp" na solicitação.
Recusar Documento	Aplicativos empresariais podem usar essa API de serviço para recusar um documento por um usuário especificado na ordem.
Renomear Documento	Aplicativos empresariais podem usar essa API de serviço para renomear um documento em um pacote.
Renomear Pacote	Essa API de serviço é usada para renomear um pacote de documentos. O pacote de documentos é identificado por seu identificador exclusivo na URL da chamada.
Status de Assinatura em Massa	Os aplicativos empresariais podem usar essa API para obter o status de uma transação de assinatura em massa específica, juntamente com os detalhes dos pacotes de documentos que foram processados pela API de Pacotes de Assinatura em Massa . Você deve chamar essa API após a API de Pacotes de Assinatura em Massa. O signatário é identificado pelo token de acesso apresentado na chamada. Portanto, a autenticação do signatário é necessária antes de fazer essa chamada. Você não pode se autenticar como um Administrador Corporativo com a variável de escopo e assinar um documento em nome de um usuário. 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 a solicitação precisa ser autorizada usando o dispositivo móvel. Se o processo de assinatura falhar em algum documento devido a diferentes níveis de garantia configurados e o usuário quiser iniciar novamente o processo de assinatura para concluir o processo de assinatura em documentos com falha, a propriedade ACTION será REINITIATE_SIGNING_PROCESS e a propriedade STATUS estará PENDENTE.

Adicionar campo CheckBox

ID da operação:: V4_Checkbox_AddCheckBox

Aplicativos empresariais podem usar essa API de serviço para adicionar uma caixa de seleção a um documento em um pacote.

Pelo menos um usuário deve existir em um fluxo de trabalho antes que campos (entrada e assinatura) possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho.

Consulte Adicionar usuários ao fluxo de trabalho para obter mais informações. Observe que se você tiver um documento com um modelo aplicado ou tiver aplicado um usando as APIs, o fluxo de trabalho já conterá usuários.

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
ordem	order	True	integer	A ordem do usuário no fluxo de trabalho para o qual o campo está sendo adicionado.
page_no	page_no	True	integer	Número de página no qual o campo deve 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 gerado automaticamente exclusivo ao campo.
valor	value		string	Valor do campo. Os valores possíveis são "true" ou "false"
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	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 "MANDATORY" ou "OPTIONAL".

Retornos

Corpo: AddFieldResponse

Adicionar campo de assinatura digital

ID da operação:: V4_Signature_AddSignature

Aplicativos empresariais podem usar essa API de serviço para adicionar um campo de assinatura digital a um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual os detalhes do fluxo de trabalho precisam ser atualizados.
ID do documento	documentId	True	integer	A ID do documento em que o campo deve ser adicionado.
ordem	order	True	integer	Ordem do destinatário para o qual o campo está sendo criado.
page_no	page_no	True	integer	Número de página no qual o campo está prestes a ser criado.
field_name	field_name		string	Nome do campo que deve ser adicionado. Se não for fornecido, o sistema atribuirá um nome gerado automaticamente exclusivo 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	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.
exibir	display		string	Visibilidade do campo que deve ser adicionado, os valores possíveis são "VISIBLE" e "INVISIBLE"
authentication_signing	authentication_signing			Autenticação de Campo

Retornos

Corpo: SignatureFieldResponse

Adicionar campo in-person

ID da operação:: V4_InPerson_AddInPerson

Aplicativos empresariais podem usar essa API de serviço para um campo de assinatura de adição pessoal a um documento em um pacote.

Para hospedar uma reunião pessoal, um usuário do SigningHub deve fazer parte do fluxo de trabalho. Eles devem ser adicionados com a função "INPERSON_HOST" ou "SIGNER". Para a opção de host, eles não exigem uma assinatura ou um campo de entrada no documento e o campo de assinatura pessoal pode ser assinado pelo usuário não registrado do SigningHub.

Observe que este é um cenário de fluxo de trabalho especial pelo qual se espera que o usuário e o destinatário do SigningHub estejam no mesmo local. Esse tipo de assinatura não se destina a ser usado pelo qual um documento é compartilhado com destinatários por meio do link de email no método de integração flexível normal.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
ordem	order	True	integer	A ordem do usuário no fluxo de trabalho para o qual o campo está sendo adicionado.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
field_name	field_name		string	Nome do campo que deve ser adicionado. Se não for fornecido, o sistema atribuirá um nome gerado automaticamente exclusivo ao campo.
espaço reservado	placeholder	True	string	Identificador de cadeia de caracteres para o campo pessoal, pode ser Cliente, Jack, CEO etc.
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.
exibir	display		string	Visibilidade do campo que deve 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"
authentication_signing	authentication_signing			Autenticação de Campo

Retornos

Corpo: AddFieldResponse

Adicionar campo inicial

ID da operação:: V4_Initials_AddInitial

Aplicativos empresariais podem usar essa API de serviço para adicionar um campo de iniciais a um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
ordem	order	True	integer	A ordem do usuário no fluxo de trabalho para o qual o campo está sendo adicionado.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
field_name	field_name		string	Nome do campo que deve ser adicionado. Se não for fornecido, o sistema atribuirá um nome gerado automaticamente exclusivo ao campo.
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.

Retornos

Corpo: AddFieldResponse

Adicionar campo RadioBox

ID da operação:: V4_Radio_AddRadioBox

Aplicativos empresariais podem usar essa API de serviço para adicionar uma caixa de seleção a um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
ordem	order	True	integer	A ordem do usuário no fluxo de trabalho para o qual o campo está sendo adicionado.
page_no	page_no	True	integer	Número de página no qual o campo deve 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 gerado automaticamente exclusivo ao campo.
valor	value		string	Valor do campo. Os valores possíveis são "true" ou "false"
validation_rule	validation_rule	True		Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
radio_group_name	radio_group_name	True	string
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.

Retornos

Corpo: AddFieldResponse

Adicionar campo TextBox

ID da operação:: V4_TextBox_AddTextBox

Aplicativos empresariais podem usar essa API de serviço para adicionar um campo de entrada de texto a um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
ordem	order	True	integer	A ordem do usuário no fluxo de trabalho para o qual o campo está sendo adicionado.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
tipo	type	True		Tipo do campo, os valores possíveis são "TEXT", "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Todos os campos de texto outros, em seguida, TEXT são preenchidos automaticamente no modo pendente com os atributos/dados do destinatário.
valor	value		string	Valor do campo. Para o tipo = DATE, o valor deve seguir o formato ISO 8601. Seguindo o formato YYYY-MM-DD hh:mm:ss +00. Como os valores são para campos de data, os aplicativos cliente podem enviar YYYY-MM-DD e ignorar hh:mm:ss +00. Se o valor não estiver no formato adequado, um erro será retornado.
espaço reservado	placeholder		string	Texto do espaço reservado para o campo de texto. Para nome, email, empresa, cargo e data, o valor do espaço reservado pode ser "NOME", "EMAIL", "EMPRESA", "JOBTITLE", "DATE". Os desenvolvedores podem enviar seus próprios espaços reservados para substituir os valores padrão. Para desenvolvedores de "TEXTO" podem fornecer seus próprios textos de espaço reservado. Esses espaços reservados aparecem nos campos de texto ao exibir o documento no visualizador.
comprimento_máximo	max_length	True	integer	Comprimento máximo do valor permitido no campo. Deve entre 1 e 9999
format	format		string	Formato de texto do campo. Usado somente para o campo de tipo de data. Os valores possíveis são: m/d m/d/yyy m/d/yyyyy mm/dd/yy mm/dd/yyyyy mm/yy mm/yyyyy d-mmm d-mmm-yyy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd aaaa-mm-dd mmm-yyy mmm-yyyyy mmmm-yyy mmmm-yyyyy mmmm d, yyyyy dd/mm/yy ddmmmyyy
field_name	field_name		string	Nome do campo que deve ser adicionado. Se não for fornecido, o sistema atribuirá um nome gerado automaticamente exclusivo ao campo.
field_locale	field_locale		string	Local do campo. Os valores possíveis são ar-AE \| en-US. Opcional e padrão será en-US. Esse valor é importante para o tipo "DATE".
field_type	field_type	True		Tipo de campo em relação à aceitação do tipo de valores, os valores possíveis são "NUMBER" ou "TEXT".
validation_rule	validation_rule	True		Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
validação	validation			Validations
fonte	font	True		Fonte do texto de campos
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.
multilinha	multiline	True	boolean	Se definido como true, o campo de área de texto será criado

Retornos

Corpo: AddFieldResponse

Adicionar código QR

ID da operação:: V4_QR_AddQRCode

Aplicativos empresariais podem usar essa API de serviço para adicionar um QR Code a um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
page_no	page_no	True	integer	Número de página no qual o campo deve 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 gerado automaticamente exclusivo ao campo.
dimensions	dimensions	True		Dimensões de campo
dados	data		string	Os dados de texto sem formatação a serem codificados no código QR. O padrão é a URL gerada para acessar o documento relacionado. por exemplo, {base_url}/document/{document_unique_id}
Opções	options			Configurações relativas às opções
cor	color			Configurações relacionadas à cor
logotipo	logo			Configurações referentes ao logotipo

Retornos

Corpo: AddQrCodeResponse

Adicionar espaço reservado ao fluxo de trabalho

ID da operação:: V4_Workflow_WorkflowAddPlaceholder

Aplicativos empresariais podem usar essa API de serviço para adicionar espaço reservado a um fluxo de trabalho em um pacote. Um espaço reservado é necessário quando você não sabe a identidade do destinatário pretendido em um fluxo de trabalho.

Observe que o espaço reservado será adicionado como o último usuário no fluxo de trabalho. Portanto, pode ser necessário mais trabalho para remover um usuário/grupo atual, já presente no fluxo de trabalho.

A adição de um espaço reservado permite que você prossiga e adicione campos de assinatura e/ou de entrada ao documento, que podem ser atribuídos a usuários individuais em um estágio posterior. Enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote para o qual o espaço reservado deve ser adicionado.
espaço reservado	placeholder		string	O nome do novo espaço reservado a ser adicionado no fluxo de trabalho.
email_notification	email_notification	True	boolean	Definir seu valor como "true" envia uma notificação por email ao usuário quando sua vez chega no fluxo de trabalho. Definir seu valor como "false" não envia a notificação por email para o usuário por sua vez.
função	role	True		Função do grupo como um destinatário no fluxo de trabalho. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" e "INPERSON_HOST". No entanto, enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem na qual o fluxo de trabalho será assinado pelos destinatários. Essa ordem de assinatura é importante quando o tipo de fluxo de trabalho é definido como "CUSTOM".

Retornos

response: array of CollaboratorPlaceholderResponse

Adicionar grupos ao fluxo de trabalho

ID da operação:: V4_Workflow_WorkflowAddGroup

Aplicativos empresariais podem usar essa API de serviço para adicionar grupos como um destinatário a um fluxo de trabalho. Um grupo do SigningHub significa que qualquer membro do grupo pode executar a ação, ou seja, assinar, em nome de todos os membros do grupo.

Observe que o grupo será adicionado como o último usuário/grupo no fluxo de trabalho. Portanto, pode ser necessário mais trabalho para remover um usuário/grupo atual, já presente no fluxo de trabalho. Enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote para o qual o grupo deve 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 seu valor como "true" envia uma notificação por email ao usuário quando sua vez chega no fluxo de trabalho. Definir seu valor como "false" não envia a notificação por email para o usuário por sua vez. Se nenhum valor for fornecido, o valor padrão de "true" será definido.
função	role	True		Função do grupo como um destinatário no fluxo de trabalho. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" e "INPERSON_HOST". No entanto, enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem na qual o fluxo de trabalho será assinado pelos destinatários. Essa ordem de assinatura é importante quando o tipo de fluxo de trabalho é definido como "CUSTOM".

Retornos

response: array of CollaboratorGroupResponse

Adicionar ou atualizar documento da biblioteca

ID da operação:: V4_Documents_UploadFromLibrary

Aplicativos empresariais podem usar essa API de serviço para adicionar um documento da biblioteca do usuário a um pacote. A ID do pacote é fornecida na URL, a ID do documento também deve ser fornecida como "document_id" na URL do recurso para identificar o documento da biblioteca a ser copiado.

Observe que um pacote já deve existir antes de adicionar um documento usando essa chamada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote ao qual o documento está sendo adicionado.
ID do documento	documentId	True	integer	A ID do documento da biblioteca que precisa adicionar/atualizar
ID do documento antigo	x-document-id		string	ID do documento antigo do pacote atual que precisa ser atualizado

Retornos

Corpo: UploadDocumentLibraryResponse

Adicionar Pacote

ID da operação:: V4_Package_AddPackage

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

Conforme indicado anteriormente, essa chamada será obrigatória se você quiser trabalhar com documentos. Um pacote deve existir antes que você possa carregar ou adicionar documentos ao SigningHub..

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

Observação: um pacote pode ser renomeado se necessário uma vez criado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
package_name	package_name		string	O nome do pacote. O nome do pacote padrão sempre será "Sem título" se o package_name não for fornecido.
workflow_mode	workflow_mode	True		No modo do fluxo de trabalho, há três tipos de modos de fluxo de trabalho com suporte no aplicativo. Os valores possíveis são "ONLY_ME", "ME_AND_OTHERS" e "ONLY_OTHERS"
folder_name	folder_name		string	O nome da pasta. Ele será usado para carregar o pacote em qualquer pasta do usuário, seja uma pasta personalizada ou uma pasta compartilhada.

Retornos

Corpo: AddPackageResponse

Adicionar usuários ao fluxo de trabalho

ID da operação:: V4_Workflow_WorkflowAddUser

Aplicativos empresariais podem usar essa API de serviço para adicionar destinatários a um fluxo de trabalho. Essa chamada só adicionará um destinatário ao fluxo de trabalho. Ou seja, nenhum campo atualmente no documento será atribuído automaticamente aos novos destinatários, nem isso criará novos campos.

Observe que os destinatários serão adicionados como a última pessoa no fluxo de trabalho. Portanto, pode ser necessário mais trabalho para remover os destinatários atuais já presentes no fluxo de trabalho.

Pelo menos um usuário deve existir em um fluxo de trabalho antes que os campos (entrada e assinatura) possam ser adicionados ao documento.

Observe que a entrada aceita um ou mais usuários em uma única chamada.

Nesta chamada específica, o usuário é uma pessoa natural conhecida. No entanto, as mesmas regras se aplicam a Grupos e Espaços Reservados. Em qualquer um desses casos, o destinatário se torna um grupo de usuários pelo qual qualquer membro do grupo pode assinar o documento ou um Espaço Reservado.O último caso é usado quando você não sabe a identidade do signatário pretendido.

Observe que a ordem de assinatura do fluxo de trabalho do SigningHub começa em "1". Portanto, adicionar um usuário ao fluxo de trabalho sem destinatários atuais inicia uma nova contagem de pedidos de assinatura. O parâmetro "signing_order" será obrigatório se o tipo de fluxo de trabalho for "personalizado".

Importante, usar essa chamada à API pode afetar o tipo de fluxo de trabalho. Se houver destinatários atuais em um fluxo de trabalho sequencial e um novo for adicionado com a mesma ordem de assinatura que um destinatário atual, essa parte do fluxo de trabalho será alterada automaticamente de sequencial para paralela. Portanto, o fluxo de trabalho em geral agora é do tipo personalizado em vez de puramente sequencial. Adicionar um destinatário com a mesma ordem de assinatura que dois ou destinatários paralelos não altera o fluxo de trabalho. Há apenas três ou mais destinatários nesse ponto específico do fluxo de trabalho; tudo em ordem paralela.

Observe que, enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote Do SigningHub, à qual os destinatários devem ser adicionados.
user_email	user_email		string	Endereço de email do usuário 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	ID nacional do usuário do destinatário
email_notification	email_notification	True	boolean	Se definido como true, o SigningHub enviará notificações ao usuário por email de acordo com as configurações de notificação do usuário e do proprietário do documento. Um valor falso significa que nenhuma notificação será enviada ao usuário em todo o fluxo de trabalho.
função	role	True		Função do destinatário no fluxo de trabalho. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST". No entanto, enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem do destinatário no fluxo de trabalho. Essa ordem de assinatura é obrigatória quando o tipo de fluxo de trabalho é "CUSTOM".
delivery_method	delivery_method	True		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 do Celular

Retornos

response: array of CollaboratorResponse

Aplicar modelo de fluxo de trabalho

ID da operação:: V4_Workflow_ApplyTemplate

Aplicativos empresariais podem usar essa API de serviço para aplicar um modelo de fluxo de trabalho a um documento. A ID do documento na qual o modelo deve ser aplicado é fornecida na URL do recurso. Quando a ID do documento for definida como 0, o modelo será aplicado a todos os doucments em um pacakge.

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

Ponto 1 - Se o modelo que está sendo aplicado for criado usando um PDF que já contém campos de formulário, verifique se o documento no qual este modelo está sendo aplicado agora deve conter esses campos de formulário com antecedência e o SigningHub NÃO criará esses campos de formulário por meio do modelo, em vez disso, aplicará apenas os dados do formulário e atribuirá aos respectivos usuários.

Ponto 2 – Se o modelo que está sendo aplicado for criado onde os campos de formulário são adicionados manualmente (portanto, não estão presentes no PDF originalmente) por meio do campo de assinatura, por exemplo, campo de assinatura, assinatura inicial, pessoal, caixas de seleção, botões de opção, campos de texto etc. Em seguida, ao aplicar esse modelo, esses campos de formulário serão criados no documento de destino mesmo se esses campos de formulário já estivessem presentes no documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote ao qual o modelo precisa ser aplicado.
ID do documento	documentId	True	integer	A ID do documento na qual o modelo precisa ser aplicado. Se o valor for definido como 0, se o modelo for aplicado em 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	True, se o modelo deve ser aplicado em todos os documentos do pacote.

Retornos

Corpo: DocumentDetailsResponse

Aprovar Documento

ID da operação:: V4_Package_Approve

Aplicativos empresariais podem usar essa API de serviço para aprovar um documento por um usuário especificado na ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser aprovado.
reason	reason		string	O motivo da aprovação de um pacote.
Senha de Acesso ao Documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
Senha do One-Time do documento	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Assinar Documento

ID da operação:: V4_Signing_SignDocument

Aplicativos empresariais podem usar essa API de serviço para assinar um documento (eletrônico e digital) sem exibir o documento para o usuário final usando o SigningHub. Por exemplo, um aplicativo de negócios pode ter outro método para exibir o documento para o usuário e somente a funcionalidade de assinatura do SigningHub é necessária ou, para operações em massa, pode ser justificado assinar sem exigir que o usuário exiba e aprove cada documento individualmente. Se houver alterações a serem salvas no documento antes de assinar, a API de Campos de Formulário de Preenchimento deverá ser chamada antes de chamar a API de Documento de Sinal. Observe que todos os campos de entrada obrigatórios em um documento exigem a conclusão antes que essa API seja concluída com êxito.

O signatário é identificado pelo token de acesso apresentado na chamada. Portanto, a autenticação do signatário é necessária antes de fazer essa chamada. Você não pode se autenticar como um Administrador Corporativo com a variável de escopo e assinar um documento em nome de um usuário. O token de acesso deve ser emitido ao signatário como resultado da autenticação direta.

Quando essa chamada for concluída, é importante que, se o signatário for o último signatário de um documento, a chamada à API concluir documento será invocada. O motivo é porque, sem chamar essa API, o documento permanecerá em um status de "Em andamento" para o proprietário do documento. Depois que a API tiver sido chamada, o status será alterado para "Concluído" para o proprietário do documento.

Depois que o documento for assinado, a resposta de verificação poderá ser vista na API obter verificação de documento .

Uso de OTP do primeiro ou segundo fator para autenticação

Se a autenticação OTP estiver ativada para a operação de assinatura do lado do servidor, os aplicativos cliente precisarão gerar um OTP para o número móvel usando a Autenticação do Signatário por meio da chamada à API OTP. Os respectivos aplicativos de negócios devem recuperar o OTP do uso e enviá-lo ao fazer a chamada à API. Isso é feito usando o cabeçalho "x-otp" na solicitação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	O identificador do pacote que contém o documento para assinatura.
ID do documento	documentId	True	integer	Identificador do documento a ser assinado.
field_name	field_name	True	string	Identificador exclusivo do campo de assinatura no documento.
hand_signature_image	hand_signature_image		string	Imagem de cadeia de caracteres codificada em Base64 da aparência de assinatura visível, que é colocada no documento. Observe que isso pode ser recuperado das configurações pessoais do usuário usando essa chamada. (A resposta é binária, portanto, o aplicativo de negócios deve, em seguida, codificar base64 antes de enviar nesta chamada de API.)
hand_signature_method	hand_signature_method			Nome do método de assinatura manual por usuário para assinatura. Caso nenhum método de assinatura manual seja fornecido, o padrão será DRAW.
signing_reason	signing_reason		string	Motivo da assinatura fornecida pelo destinatário. Observação: Indicação de tipo de compromisso para documentos XML
signing_location	signing_location		string	Localidade do signatário fornecida pelo destinatário.
contact_information	contact_information		string	Informações de contato do signatário fornecidas pelo destinatário.
user_name	user_name		string	Nome do signatário fornecido pelo destinatário. Observe que isso se aplica somente a operações de assinatura pessoal.
user_password	user_password		string	Senha fornecida pelo usuário sujeito às configurações de assinatura do usuário.
appearance_design	appearance_design		string	Nome da aparência da assinatura fornecida pelo usuário para assinatura. Caso nenhum nome de aparência seja fornecido, a aparência selecionada padrão será usada. Os valores possíveis são "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_capacity	signing_capacity		string	Nome da capacidade de assinatura/perfil de certificação usando a qual o documento deve ser assinado. Se não for fornecido, a capacidade padrão será usada para assinar. O nome fornecido deve ser exatamente o mesmo do perfil real devido à confidencialidade de maiúsculas e minúsculas.
skip_verification	skip_verification	True	boolean	Nenhuma verificação de assinatura retorna no corpo da resposta quando ela é definida como true. Valor padrão para esse parâmetro definido como false.
signing_server	signing_server		string	Nome do servidor de assinatura usando o qual o documento deve ser assinado.
autenticação	authentication			O objeto de autenticação é opcional, contém opções de autenticação releadas
senha One-Time (OTP)	x-otp		string	OTP usado como uma autenticação de segundo fator para a operação de assinatura.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.
Originador móvel	x-mobile		string	Definir o originador (Web/Mobile) da solicitação/ação

Retornos

Corpo: SignDocumentResponse

Atribuir Campo de Documento

ID da operação:: V4_Fields_AutoAssignField

Aplicativos empresariais podem usar essa API de serviço para atribuir usuários a campos de entrada, por exemplo, campos de assinatura e, portanto, definir a ordem de assinatura. Os campos já devem estar presentes no documento e os usuários devem estar presentes no fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso, juntamente com o identificador do pacote.

Quando os destinatários estão em um fluxo de trabalho, eles são numerados, começando em um e contando para cada um extra. Portanto, se houver três usuários em um fluxo de trabalho, eles serão numerados "1", "2" e "3" com respeito. Essa chamada à API permite que você atribua um usuário pelo número da ordem de fluxo de trabalho a um campo de entrada no documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual o usuário do fluxo de trabalho precisa 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
ordem	order	True	integer	A ordem do usuário no fluxo de trabalho, à qual o campo está sendo 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"

Retornos

response: object

Atualizar a Autenticação de Usuário do Fluxo de Trabalho (Abertura de Documento) do Pacote Enterprise

ID da operação:: V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

Os aplicativos empresariais podem usar essa API de serviço para atualizar as autenticações de pacote e a duração de acesso dos destinatários. Essa API também poderá ser usada pelo administrador da empresa ou pelo usuário da empresa se a variável "escopo" tiver sido usada na solicitação de autenticação

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual a segurança e a autenticação de acesso ao fluxo de trabalho devem ser atualizadas.
Ordem do Destinatário	order	True	integer	Ordem do destinatário no fluxo de trabalho para o qual a segurança de acesso e a autenticação devem ser atualizadas.
apply_to_all	apply_to_all	True	boolean	True, se a segurança de acesso ou as autenticações devem ser aplicadas em todos os destinatários no fluxo de trabalho.
autenticação	authentication	True		Ele tem os dados de autenticação de acesso
authentication_signing	authentication_signing			Ele tem os dados de autenticação de assinatura
access_duration	access_duration	True		Ele tem a duração de acesso do fluxo de trabalho

Retornos

response: object

Atualizar a ordem dos usuários do fluxo de trabalho

ID da operação:: V4_Workflow_WorkflowUserUpdateOrder

Aplicativos empresariais podem usar essa API de serviço para atualizar a ordem do destinatário no fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual os destinatários devem ser adicionados.
Pedido	order	True	integer	Ordem existente do destinatário que deve ser atualizada.
ordem	order	True	integer	A ordem do destinatário que deve ser atualizada.

Retornos

response: object

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

ID da operação:: V4_Documents_UpdateCertifyPolicy

Os aplicativos empresariais podem usar essa API de serviço para atualizar as configurações de assinatura de certificação de um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento no qual a ação deve ser executada.
Certificar	certify			Certificar o objeto de configurações do documento.
lock_form_fields	lock_form_fields	True	boolean	True se os campos de formulário devem ser bloqueados após a última assinatura no documento atual.

Retornos

response: object

Atualizar campo de assinatura digital

ID da operação:: V4_Signature_UpdateSignature

Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de assinatura digital de um documento em um pacote.

Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada. Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome atual do campo, que deve 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 a renomeação do campo for pretendida.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.
exibir	display		string	Visibilidade do campo que deve ser atualizado, os valores possíveis são "VISIBLE" e "INVISIBLE"
authentication_signing	authentication_signing			Autenticação de Campo
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Atualizar campo inicial

ID da operação:: V4_Initials_UpdateInitial

Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de iniciais de um documento em um pacote.

Observe que todos os parâmetros de entrada podem ser alterados. Onde você deseja manter a configuração atual, envie-a na chamada inalterada.

Portanto, você pode usar os mesmos parâmetros que quando adicionou o campo de entrada ou as informações retornadas por Obter Campos de Documento. Este último pode ser usado quando um modelo foi aplicado ou o documento foi criado usando a interface gui.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome atual do campo, que deve ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se a renomeação for pretendida.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.

Retornos

response: object

Atualizar campo TextBox

ID da operação:: V4_TextBox_UpdateTextBox

Aplicativos empresariais podem usar essa API de serviço para atualizar uma caixa de texto de um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome atual do campo, que deve ser atualizado.
field_locale	field_locale		string	Local do campo. Os valores possíveis são ar-AE \| en-US. Opcional e padrão será en-US. Esse valor é importante para o tipo "DATE".
renamed_as	renamed_as		string	Nome atualizado do campo se a renomeação for pretendida.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
valor	value		string	Valor do campo. Para o tipo = DATE, o valor deve seguir o formato ISO 8601. Seguindo o formato YYYY-MM-DD hh:mm:ss +00. Como os valores são para campos de data, os aplicativos cliente podem enviar YYYY-MM-DD e ignorar hh:mm:ss +00. Se o valor não estiver no formato adequado, um erro será retornado.
comprimento_máximo	max_length	True	integer	Comprimento máximo do valor permitido no campo. Deve entre 1 e 9999
field_type	field_type	True		Tipo de campo em relação à aceitação do tipo de valores, os valores possíveis são "NUMBER" ou "TEXT".
validation_rule	validation_rule	True		Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
fonte	font			Fonte do texto de campos
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.
espaço reservado	placeholder		string	Os desenvolvedores podem fornecer seus próprios textos de espaço reservado. Esses espaços reservados aparecem nos campos de texto ao exibir o documento no visualizador.
format	format		string	Formato de texto do campo. Usado somente para o campo de tipo de data. Os valores possíveis são: m/d m/d/yyy m/d/yyyyy mm/dd/yy mm/dd/yyyyy mm/yy mm/yyyyy d-mmm d-mmm-yyy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd aaaa-mm-dd mmm-yyy mmm-yyyyy mmmm-yyy mmmm-yyyyy mmmm d, yyyyy dd/mm/yy ddmmmyyy
validação	validation			Validations

Retornos

response: object

Atualizar código QR

ID da operação:: V4_QR_UpdateQRCode

Aplicativos empresariais podem usar essa API de serviço para atualizar um QR Code de um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome atual do campo, que deve ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se a renomeação for pretendida.
page_no	page_no	True	integer	Número de página para o qual o campo precisa ser atualizado
dimensions	dimensions	True		Dimensões de campo
dados	data		string	Os dados de texto sem formatação a serem codificados no código QR. O padrão é a URL gerada para acessar o documento relacionado. por exemplo, {base_url}/document/{document_unique_id}
Opções	options			Configurações relativas às opções
cor	color			Configurações relacionadas à cor
logotipo	logo			Configurações referentes ao logotipo

Retornos

Corpo: UpdateQrCodeResponse

Atualizar detalhes do fluxo de trabalho

ID da operação:: V4_Workflow_UpdateWorkflow

Aplicativos empresariais podem usar essa API de serviço para atualizar os detalhes do fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento, mas os aplicativos empresariais querem substituir a permissão de certificação ou os detalhes de pós-processamento. A ID do pacote é fornecida na URL do recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual os detalhes do fluxo de trabalho precisam ser atualizados.
workflow_type	workflow_type			Tipo de fluxo de trabalho para o pacote, por exemplo, (SERIAL, PARALLEL, INDIVIDUAL, CUSTOM). Se nenhum valor for fornecido, o valor antigo será mantido.
workflow_mode	workflow_mode			Modo de fluxo de trabalho do pacote, por exemplo, (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). Se o modo de fluxo de trabalho estiver definido como ONLY_ME, nenhum colaborador poderá ser adicionado ao pacote de outro usuário autenticado em si
continue_on_decline	continue_on_decline		boolean	True, se o fluxo de trabalho precisar continuar mesmo se algum destinatário recusar o documento. Se nenhum valor for fornecido, o valor antigo será mantido.
mensagem	message		string	Uma mensagem de cadeia de caracteres personalizada do proprietário do documento para cada destinatário, essa mensagem aparece no email de compartilhamento, bem como na tela. Se nenhum valor for fornecido, o valor antigo será mantido.
comments	comments		boolean	Permitir comentários

Retornos

response: object

Atualizar espaço compartilhado

ID da operação:: V4_WorkSpace_UpdateSharedSpace

Aplicativos empresariais podem usar essa API de serviço para atualizar o espaço compartilhado. A disponibilidade de atualização de espaços compartilhados está sujeita à função de usuário empresarial atribuída. Para permitir esse provisionamento, o Administrador Corporativo habilitará a opção "Gerenciar Espaço Compartilhado" nas Configurações do Documento de Funções>.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de espaço compartilhado	id	True	integer	ID do espaço compartilhado que você deseja atualizar
nome	name		string	Nome do espaço compartilhado
nome	name	True	string	Nome do membro do espaço de trabalho
email	email	True	string	Endereço de email do membro do espaço de trabalho

Retornos

response: object

Atualizar Espaço Reservado

ID da operação:: V4_Workflow_WorkflowUpdatePlaceholder

Aplicativos empresariais podem usar essa API de serviço para atualizar um espaço reservado no fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir os detalhes de um titular de local específico dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o titular do local de fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho. Enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote para o qual o espaço reservado deve ser adicionado.
Pedido	order	True	integer	Ordem do destinatário no fluxo de trabalho.
espaço reservado	placeholder		string	O nome do novo espaço reservado a ser adicionado no fluxo de trabalho. Se nenhum valor for fornecido, o valor antigo será mantido.
email_notification	email_notification		boolean	Definir seu valor como "true" envia uma notificação por email ao usuário quando sua vez chega no fluxo de trabalho. Definir seu valor como "false" não envia a notificação por email para o usuário por sua vez. Se nenhum valor for fornecido, o valor antigo será mantido.
função	role	True		Função do grupo como um destinatário no fluxo de trabalho. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" e "INPERSON_HOST". Se nenhum valor for fornecido, o valor antigo será mantido. No entanto, enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem na qual o fluxo de trabalho será assinado pelos destinatários. Essa ordem de assinatura é importante quando o tipo de fluxo de trabalho é definido como "CUSTOM".

Retornos

response: object

Atualizar lembretes de fluxo de trabalho

ID da operação:: V4_Workflow_UpdateWorkflowReminder

Aplicativos empresariais podem usar essa 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, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir as configurações de lembretes dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o destinatário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual os lembretes de fluxo de trabalho serão atualizados.
Pedido	order	True	integer	A ordem do usuário para o qual os lembretes de fluxo de trabalho serão atualizados.
apply_to_all	apply_to_all	True	boolean	True, se as configurações de lembrete devem ser aplicadas em todos os destinatários no fluxo de trabalho.
enabled	enabled	True	boolean	True, se as configurações de lembrete devem ser habilitadas.
frequência	frequency		string	Frequência de lembrete. Os valores possíveis são DIAS \| HORAS.
remind_after	remind_after	True	integer	Obrigatório, no caso da propriedade habilitada será true. O número de dias após o qual o primeiro lembrete seria enviado ao usuário de fluxo de trabalho.
repetir	repeat			Os lembretes seriam enviados ao usuário repetidamente.

Retornos

response: object

Atualizar o campo CheckBox

ID da operação:: V4_Checkbox_UpdateCheckBox

Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de caixa de seleção de um documento em um pacote.

Não é possível atualizar a largura e a altura. Eles permanecerão iguais a quando foram adicionados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome atual do campo, que deve ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se a renomeação for pretendida.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
valor	value		string	Valor do campo. Os valores possíveis são "true" ou "false"
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	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 "MANDATORY" ou "OPTIONAL".
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Atualizar o campo pessoal

ID da operação:: V4_InPerson_UpdateInPerson

Aplicativos empresariais podem usar essa API de serviço para atualizar um campo de assinatura pessoal de um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome atual do campo, que deve ser atualizado.
renamed_as	renamed_as		string	nome atualizado do campo, se a renomeação for pretendida.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
espaço reservado	placeholder		string	Identificador de cadeia de caracteres para o campo pessoal, pode ser Cliente, Jack, CEO etc.
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.
exibir	display		string	Visibilidade do campo que deve ser atualizado, 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"
authentication_signing	authentication_signing			Autenticação de Campo
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Atualizar o campo RadioBox

ID da operação:: V4_Radio_UpdateRadioBox

Aplicativos empresariais podem usar essa API de serviço para atualizar um botão de opção de um documento em um pacote.

Não é possível atualizar a largura e a altura. Eles permanecerão iguais a quando foram adicionados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome atual do campo, que deve ser atualizado.
renamed_as	renamed_as		string	Nome atualizado do campo se a renomeação for pretendida.
page_no	page_no	True	integer	Número de página no qual o campo deve ser criado.
valor	value		string	Valor do campo. Os valores possíveis são "true" ou "false"
validation_rule	validation_rule	True		Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
radio_group_name	radio_group_name	True	string	O nome do grupo ao qual o campo pertence.
x	x	True	double	Local esquerdo do campo em pixel.
y	y	True	double	Localização superior do campo em pixel.
largura	width	True	double	Largura do campo em pixel.
height	height	True	double	Altura do campo em pixel.

Retornos

response: object

Atualizar permissões de usuário do fluxo de trabalho

ID da operação:: V4_WorkflowPermission_UpdateWorkflowPermissions

Aplicativos empresariais podem usar essa API de serviço para atualizar as permissões de fluxo de trabalho para um usuário que já foi adicionado a um fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir as permissões dentro do fluxo de trabalho. A ID do pacote de documentos é fornecida na URL do recurso e o usuário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual as permissões de fluxo de trabalho serão atualizadas.
Pedido	order	True	integer	A ordem do destinatário para o qual o fluxo de trabalho permite ser atualizado.
apply_to_all	apply_to_all	True	boolean	True, se as permissões devem ser aplicadas em todos os destinatários no fluxo de trabalho.
permissões	permissions	True		Ele tem todas as permissões a serem permitidas no fluxo de trabalho
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Atualizar Pós-Processamento

ID da operação:: V4_Workflow_UpdateWorkflowPostProcess

Aplicativos empresariais podem usar essa API de serviço para adicionar espaço reservado a um fluxo de trabalho de um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote de documentos para o qual o pós-processamento está sendo atualizado.
enabled	enabled	True	boolean	True, se o pós-processamento estiver ativado para o pacote.
contacts	contacts		array of string
nome	name	True	string
email	email	True	string
mensagem	message		string	Uma mensagem de cadeia de caracteres personalizada para todos os contatos. A mensagem torna-se parte do email enviado aos contatos.
google_drive	google_drive		boolean	True, se o documento deve ser carregado na conta do Google fornecida após a conclusão do fluxo de trabalho.
dropbox	dropbox		boolean	True, se o documento deve ser carregado na conta de dropbox fornecida após a conclusão do fluxo de trabalho.
onedrive	onedrive		boolean	True, se o documento deve ser carregado na conta do oneDrive fornecida após a conclusão do fluxo de trabalho.
workflow_recipients	workflow_recipients	True	boolean	True, 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 padrão é falso.
document_processing_report	document_processing_report	True	boolean	True, se Enviar o relatório de processamento de documentos (XML) for habilitado para o fluxo de trabalho

Retornos

response: object

Atualizar usuário do fluxo de trabalho

ID da operação:: V4_Workflow_WorkflowUserUpdate

Os aplicativos empresariais podem usar essa API de serviço para atualizar os detalhes de um destinatário, grupo ou titular do local que já foi adicionado a um fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir os detalhes de um usuário específico dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o destinatário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho. Observe que, embora a preparação do documento do tipo XML dê suporte apenas aos tipos de função "SIGNER", "REVIEWER" e "CARBON_COPY".

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual o usuário do fluxo de trabalho precisa ser atualizado.
Pedido	order	True	integer	A ordem do usuário no fluxo de trabalho.
user_email	user_email		string	O endereço de email do novo usuário a ser atualizado no fluxo de trabalho. Se nenhum valor for fornecido, o valor antigo será mantido.
user_name	user_name		string	Nome do destinatário a ser atualizado. Se nenhum valor for fornecido, o valor antigo será mantido.
email_notification	email_notification		boolean	Definir seu valor como "true" envia uma notificação por email ao usuário quando sua vez chega no fluxo de trabalho. Definir seu valor como "false" não envia a notificação por email para o usuário por sua vez. Se nenhum valor for fornecido, o valor antigo será mantido.
mobile_number	mobile_number		string	Número do celular. Se nenhum valor for fornecido, o valor antigo será mantido.
função	role	True		Função do destinatário a ser atualizado. Os valores possíveis são "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST". Se nenhum valor for fornecido, o valor antigo será mantido. No entanto, enquanto a preparação do documento do tipo XML, somente os tipos de função com suporte são "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordem na qual o fluxo de trabalho será assinado pelos destinatários. Essa ordem de assinatura é importante quando o tipo de fluxo de trabalho é definido como "CUSTOM".
email_language_code	email_language_code		string	código da linguagem de email
delivery_method	delivery_method	True		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 a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

Corpo: UpdateCollaboratorResponse

Baixar anexo

ID da operação:: V4_Attachment_DownloadAttachment

Aplicativos empresariais podem usar essa API de serviço para baixar o anexo de um documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo é adicionado.
ID do anexo	attachment_id	True	integer	ID do anexo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Baixar Documento

ID da operação:: V4_Documents_DownloadDocumentBytes

Aplicativos empresariais podem usar essa API de serviço para baixar os bytes do documento. A ID do pacote e a ID do documento são fornecidas na URL do recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento a ser baixado.
Senha do documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
senha One-Time (OTP)	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Baixar Pacote

ID da operação:: V4_Package_DownloadPackageBytes

Aplicativos empresariais podem usar essa API de serviço para baixar o pacote de documentos no formato binário.

A ID do pacote é fornecida na URL do recurso.

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

Como alternativa, se o pacote tiver mais de um documento, o download será o arquivo zip binário de todos os documentos.

Os cabeçalhos x-password e x-otp são opcionais. Eles serão necessários se o proprietário do documento defini-los durante a fase de criação do fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId_bulkAction	True	integer	A ID do pacote a ser baixada.
Identificadores de documento	document-ids		array	O parâmetro IDs do documento é opcional. Se x-combine-files for definido como true, os documentos serão mesclados com base nos documentos mencionados do pacote.
Senha de Acesso ao Documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
Senha do One-Time do documento	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
Combinar arquivos	x-combine-files		string	O valor padrão é false, Definido como "true" para combinar todo o pacote de documentos em um único arquivo PDF.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Campos de AutoPlace

ID da operação:: V4_Fields_AutoPlace

Aplicativos empresariais podem chamar essa API para adicionar campos de formulário definidos pelo usuário ou assinatura a um documento com base no critério de pesquisa fornecido. As opções de posicionamento são: à esquerda, à direita, superior e inferior. O documento é uma pesquisa e todas as instâncias dos critérios de pesquisa atendidos são processadas. Isso permite que você adicione vários campos com uma chamada. Por exemplo, carregue um documento e coloque automaticamente um campo de assinatura à direita de todas as instâncias da palavra "Assinar aqui:". Isso economiza tempo e garante que nenhuma assinatura seja perdida do fluxo de trabalho.

A chamada à API dá suporte a todos os tipos de campos; ou seja, eletrônico, digital, pessoal, inicial e campo de texto etc.

Além disso, a chamada à API dá suporte à variável "order". Isso significa que você pode atribuir um conjunto de campos de assinatura automaticamente a um único usuário. Portanto, a chamada pode ser repetida para colocar e atribuir campos de assinatura a mais de um usuário no fluxo de trabalho.

Pelo menos um usuário deve existir em um fluxo de trabalho antes que os campos de assinatura possam ser adicionados ao documento dessa forma. O número do pedido corresponde ao destinatário no fluxo de trabalho. Portanto, esse número deve ser igual ou menor que o número total de usuários no fluxo de trabalho. O exemplo abaixo atribui esse novo campo de assinatura à primeira pessoa no fluxo de trabalho.

Essa chamada à API pode ser usada várias vezes no mesmo documento. A razão para fazer isso é atender a vários signatários em um documento. O destinatário ou signatário é identificado pela variável "order" passada na chamada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para o qual os campos são solicitados.
search_text	search_text		string	Word que precisam ser pesquisados no documento.
ordem	order	True	integer	Ordem do usuário ao qual os campos serão atribuídos automaticamente. O fluxo de trabalho no SigningHub ordena 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 deverão ser colocados no documento. O posicionamento do campo pode ser mencionado neste atributo. Os valores possíveis de posicionamento de um campo são LEFT, RIGHT, TOP, BOTTOM. Se nenhum valor for fornecido, o valor padrão será LEFT.
field_type	field_type		string	Tipo de campo a ser criado no documento. Os valores possíveis são "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" "NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"
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"
dimensions	dimensions			Dimensões de um campo a ser criado no documento. O local X e Y é calculado automaticamente. A API só pode configurar largura e altura para o campo. Se as dimensões não forem fornecidas, as dimensões padrão serão seguidas. que é 200 x 80 em pixels.
espaço reservado	placeholder		string	Forneça nota no caso do Anexo Obrigatório
radio_group_name	radio_group_name		string	O nome do grupo necessário somente ao adicionar um campo de tipo de Caixa de Rádio para agrupar várias caixas de rádio.
format	format		string	Formato de texto do campo. Usado somente para o campo de tipo de data. Os valores possíveis são: m/d m/d/yyy m/d/yyyyy mm/dd/yy mm/dd/yyyyy mm/yy mm/yyyyy d-mmm d-mmm-yyy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd aaaa-mm-dd mmm-yyy mmm-yyyyy mmmm-yyy mmmm-yyyyy mmmm d, yyyyy dd/mm/yy ddmmmyyy
valor	value		string	Valor que o usuário deseja mostrar no campo.
comprimento_máximo	max_length	True	integer	Comprimento máximo do valor permitido no campo. Deve entre 1 e 9999
validation_rule	validation_rule		string	Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
validação	validation			Validations
fonte	font			Fonte do texto de campos
multilinha	multiline	True	boolean	Isso pertence ao tipo de campo Área de Texto e, se definido como true, o campo de área de texto seria criado com a opção de várias linhas.

Retornos

response: array of AutoPlaceFieldsResponse

Campos de formulário de preenchimento

ID da operação:: V4_Fields_FillFormFields

Aplicativos empresariais podem usar essa API de serviço para preencher um ou mais campos de formulário em um documento por um usuário especificado na ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento.
auto_save	auto_save	True	boolean	O valor padrão é falso. True, se os campos de formulário estiverem sendo salvos sem intervenção do usuário, por exemplo, ao fechar o documento ou pressionar novamente. Para Assinatura, Iniciais, In-persons, Revisão, Enviar ações, o valor é falso.
field_name	field_name	True	string	Identificador exclusivo do campo no documento.
valor	value		string	Valor do campo a ser salvo no documento.
field_name	field_name	True	string	Identificador exclusivo do campo no documento.
radio_group_name	radio_group_name		string	Nome do grupo ao qual o botão de opção pertence.
valor	value	True	boolean	Valor do campo a ser salvo no documento.
field_name	field_name	True	string	Identificador exclusivo do campo no documento.
valor	value	True	boolean	Valor do campo a ser salvo no documento.
field_name	field_name	True	string	Identificador exclusivo do campo no documento.
valor	value		string	Valor do campo a ser salvo no documento.
field_name	field_name	True	string	Identificador exclusivo do campo no documento.
valor	value		string	Valor do campo a ser salvo no documento.
Senha do documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
senha One-Time (OTP)	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Carregar anexo

ID da operação:: V4_Attachment_UploadAttachment

Aplicativos empresariais podem usar essa API de serviço para carregar um anexo em um documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo precisa ser adicionado.
Arquivo de anexo	file (binary Stream)		binary	Este é o documento no formato binário bruto.
Nome do campo	x-field-name		string	Nome do campo, se necessário. Isso é opcional e com o campo anexo de nome de campo é processado. Além disso, o valor recomendado para o parâmetro de nome de campo está no formato codificado em Base64.
Nome do arquivo	x-file-name	True	string	É o nome do arquivo com extensão.
Senha do documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
Senha do One-Time	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

Corpo: AddAttachmentResponse

Carregar documento

ID da operação:: V4_Documents_UploadStream

Aplicativos empresariais podem usar essa API de serviço para adicionar um documento a um pacote de documentos vinculado à conta de um usuário corporativo. As informações do documento são enviadas no cabeçalho da solicitação HTTP e os bytes de documento são enviados no corpo da solicitação HTTP. Observe que o SigningHub converterá formatos de documento com suporte em PDF se o cabeçalho "x-convert-document" for definido como um valor de "true". O único caso com suporte em que esse valor é definido como "false" é manter Word formato e documentos XML.

O SigningHub dá suporte a uma ampla variedade de formatos de documento, cada um deles pode ser convertido em formato PDF após o upload. Clique aqui para obter a lista completa.

Observe que os documentos PDF não são alterados após o upload para o sistema.

Observe que um pacote já deve existir antes de adicionar um documento usando essa chamada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento está sendo adicionado.
Documento (fluxo binário)	file (binary Stream)		binary	Este é o documento no formato binário bruto.
Nome do arquivo	x-file-name		string	É o nome do arquivo com extensão.
Converter Documento	x-convert-document		string	Isso identifica se o documento deve ser convertido em um PDF ou se ele deve ser mantido em seu formato original. Observe que o único formato original com suporte atualmente é Word & XML. Todos os outros tipos de documento resultarão em um erro se esse valor de cabeçalho for definido como "false". Se estiver carregando um documento PDF, esse Cabeçalho poderá ser omitido.
Fonte	x-source		string	Essa é a identificação da origem do documento de onde o documento é carregado, por exemplo, "Meu Aplicativo".

Retornos

Corpo: UploadDocument

Compartilhar pacote de documentos

ID da operação:: V4_Workflow_StartWorkflow

Aplicativos empresariais podem usar essa API de serviço para compartilhar 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 usuários e as ações definidas no modelo. A ID do pacote a ser compartilhada é fornecida na URL do recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	O pacote de documento a ser compartilhado.

Retornos

response: array of StartWorkflowResponse

Concluir fluxo de trabalho no meio (encerrar fluxo de trabalho)

ID da operação:: V4_Workflow_MarkWorkflowCompleted

Aplicativos empresariais podem marcar o fluxo de trabalho concluído mesmo no meio do fluxo de trabalho. Use essa API de serviço para alterar o status do fluxo de trabalho a ser concluído. Se houver destinatários que ainda não assinaram o documento. Sua assinatura não será mais necessária e eles não poderão ver o documento em sua caixa de entrada mais adiante. O token de portador deve pertencer ao proprietário do documento ou o administrador corporativo pode usar a variável de escopo para obter o token de acesso em nome do proprietário do documento para executar essa ação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote da qual o destinatário deve ser excluído.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Concluir o processamento

ID da operação:: V4_Package_Finish

Os aplicativos empresariais podem usar essa API de serviço para concluir o processamento do documento depois de assinar todos os campos de assinatura. Esse método é usado principalmente por aplicativos móveis nativos do SigningHub para iOS e Android e casos de uso da Web móvel. Aplicativos comerciais gerais que empregam uma integração apertada em seu respectivo portal não precisam chamar esse método. No entanto, ao usar a API de Documento de Sinal (e, portanto, o usuário não é presenteado com uma representação visual do documento que é solicitado a assinar) chamar essa API é necessário para garantir que o respectivo fluxo de trabalho continue ou seja concluído. Por exemplo, depois que todas as assinaturas tiverem sido aplicadas usando a chamada "cega" da API do Documento de Assinatura, o documento não será exibido como status "Concluído" para o proprietário até que essa API seja invocada. O proprietário do documento verá um status de "Em andamento" até que essa API seja chamada.

Em aplicativos móveis nativos do SigningHub e casos de uso da Web móvel, essa chamada é necessária para garantir que cada usuário conclua suas respectivas ações em relação ao SigningHub.Por exemplo, depois que um signatário assinou um documento no SigningHub App, esse método é invocado pelo aplicativo para garantir que o fluxo de trabalho continue a ser processado e que o próximo signatário seja notificado, e o status do documento está disponível por meio da URL de back de chamada configurada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser concluído.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Documento de aprovação do gatekeeper

ID da operação:: V4_Package_GatekeeperApprove

Aplicativos empresariais podem usar essa API de serviço para que o gatekeeper aprove um documento por um usuário especificado na ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser aprovado.
reason	reason		string	O motivo da aprovação de um pacote.
Senha de Acesso ao Documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
Senha do One-Time do documento	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.

Retornos

response: object

Documento de recall

ID da operação:: V4_Workflow_RecallWorkflow

Aplicativos empresariais podem usar essa API de serviço para interromper um fluxo de trabalho em andamento. A ID do documento é fornecida na URL do recurso. Após o recall, o status do documento é alterado automaticamente para "RASCUNHO".

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser recuperado.

Retornos

response: object

Documento de recusa do gatekeeper

ID da operação:: V4_Package_GatekeeperDecline

Os aplicativos empresariais podem usar essa API de serviço para recusar um documento por um usuário especificado na ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser recusado.
reason	reason		string	Motivo fornecido pelo usuário para o declínio.

Retornos

response: object

Enviar Documento

ID da operação:: V4_Package_Submit

Uma das funções do SigningHub é chamada de "Editor". Isso permite que um destinatário edite campos de entrada em um documento, mas não requer uma assinatura. Depois de concluído, o destinatário envia suas alterações. O botão usado na GUI é chamado "Enviar".

Essa é a operação equivalente para um editor enviar suas alterações por meio de uma chamada à API.

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote SigningHub que contém o documento a ser enviado.
Senha de Acesso ao Documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
Senha do One-Time do documento	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Excluir anexo

ID da operação:: V4_Attachment_DeleteAttachment

Aplicativos empresariais podem usar essa API de serviço para excluir o anexo de um documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo é adicionado.
ID do anexo	attachment_id	True	integer	ID do anexo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Excluir Campo de Documento

ID da operação:: V4_Fields_DeleteDocumentField

Aplicativos empresariais podem usar essa API de serviço para excluir um campo de documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual a ação deve ser executada.
field_name	field_name	True	string	Nome do campo a ser excluído.

Retornos

response: object

Excluir Documento

ID da operação:: V4_Documents_DeleteDocument

Aplicativos empresariais podem usar essa API de serviço para excluir um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	ID do documento a ser excluído.

Retornos

Corpo: DocumentResponse

Excluir Espaço Compartilhado

ID da operação:: V4_WorkSpace_DeleteSharedSpace

Aplicativos empresariais podem usar essa API de serviço para excluir o espaço compartilhado. A disponibilidade da exclusão de espaços compartilhados está sujeita à função de usuário empresarial atribuída. Para permitir esse provisionamento, o Administrador Corporativo habilitará a opção "Gerenciar Espaço Compartilhado" nas Configurações do Documento de Funções>.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de espaço compartilhado	id	True	integer	ID do espaço compartilhado que você deseja excluir

Retornos

response: object

Excluir Pacote

ID da operação:: V4_Package_DeletePackage

Aplicativos empresariais podem usar essa API de serviço para excluir um documento da caixa de entrada do usuário. A ID do pacote é fornecida na URL do recurso como "{package_id}". Se o status do documento estiver PENDENTE, ele será recusado automaticamente como resultado da operação de exclusão. Se o status do documento for SHARED, o documento será recuperado automaticamente e o fluxo de trabalho será interrompido antes que o documento seja excluído.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId_bulkAction	True	integer	ID do pacote que contém o documento.

Retornos

response: object

Excluir Usuário de Fluxo de Trabalho

ID da operação:: V4_Workflow_WorkflowDeleteUser

Aplicativos empresariais podem usar essa API de serviço para excluir o destinatário do fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote da qual o destinatário deve ser excluído.
Pedido	order	True	integer	Ordem do destinatário no fluxo de trabalho que deve ser excluído.

Retornos

response: object

Iniciais de preenchimento

ID da operação:: V4_Initials_Fill

Aplicativos empresariais podem usar essa API de serviço para preencher um campo de iniciais em um documento por um usuário especificado na ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote à qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento.
field_name	field_name	True	string	Identificador exclusivo do campo no documento.
imagem	image	True	string	Imagem base64 usada para o preenchimento das iniciais.
método	method			Nome do método de assinatura manual por usuário para assinatura. Caso nenhum método de assinatura manual seja fornecido, o padrão será DRAW. valores possíveis DRAW, TEXT, UPLOAD, SIGNATURE_PAD
apply_to_all	apply_to_all	True	boolean	True se todas as iniciais devem ser preenchidas.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Mover o pacote para a pasta Espaço Personalizado ou Compartilhado

ID da operação:: V4_Folder_MovePackage

Aplicativos empresariais podem usar essa API de serviço para mover o pacote de documentos para um espaço compartilhado ou pasta personalizada do usuário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote que precisa ser movida para pasta
folder_name	folder_name	True	string	Nome da pasta de destino no qual o pacote precisa ser movido

Retornos

response: object

Obter a Autenticação de Usuário do Fluxo de Trabalho (Abertura de Documento) do Pacote Enterprise

ID da operação:: V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

Os aplicativos empresariais podem usar essa API de serviço para habilitar as configurações de segurança de acesso para o pacote. Os destinatários para os quais a segurança está configurada são identificados pela ordem na URL. A ID do pacote também é identificada na URL da solicitação. Os destinatários não poderão acessar o pacote de documentos fora do escopo dessa duração se a segurança de acesso estiver habilitada. O proprietário do documento também pode configurar a segurança baseada em autenticação do pacote para um destinatário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual a segurança e a autenticação de acesso ao fluxo de trabalho devem ser atualizadas.
Ordem do Destinatário	order	True	integer	Ordem do destinatário no fluxo de trabalho para o qual a segurança de acesso e a autenticação devem ser atualizadas.

Retornos

Corpo: EnterpriseAccessResponse

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

ID da operação:: V4_Documents_GetCertifyPolicy

Aplicativos empresariais podem usar essa API de serviço para obter configurações de assinatura certificadas de um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento a ser baixado.

Retornos

Corpo: CertifyPolicyResponse

Obter anexos

ID da operação:: V4_Attachment_GetAttachments

Aplicativos empresariais podem usar essa API de serviço para obter os anexos de um documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	ID do documento ao qual o anexo é adicionado.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: array of GetAttachmentResponse

Obter campos de documento

ID da operação:: V4_Fields_GetAllDocumentFields

Aplicativos empresariais podem usar essa API de serviço para obter campos de documento, ou seja, iniciais, pessoas, campos de assinatura ou campos de formulário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para o qual os campos são solicitados.
Página Não	pageNo	True	integer	Página não do documento para o qual os campos são solicitados. Se o número da página não for fornecido, os campos de documento inteiro serão retornados.
Originador	x-mobile		string	Definir o originador (Web/Mobile) da solicitação/ação

Retornos

Corpo: FieldsResponse

Obter contatos

ID da operação:: V4_Contacts_Get

Aplicativos empresariais podem usar essa API de serviço para ressamarrar contatos de contatos pessoais e empresariais para o usuário atual.

É possível pesquisar com base no critério fornecido no cabeçalho "x-search-text". Além disso, é possível pesquisar os contatos específicos de um usuário ou o da empresa à qual o usuário pertence.

As informações de resposta de pesquisa contêm o endereço de email do usuário e o respectivo nome de usuário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Registros por Página	recordPerPage	True	integer	Número total de registros a serem recuperados em uma página.
Número da Página	pageNo	True	integer	Número da página a ser recuperado.
Classificar Por	sort-by		string	Classificar o resultado por valores possíveis é mencionado acima.
Crescente	asc		boolean	Ordene o conjunto de resultados subindo ou decrescente.
Pesquisar Texto	x-search-text		string	Pesquisar texto, se necessário. Isso é opcional e sem ela a lista inteira é retornada. Além disso, o valor recomendado para o parâmetro de texto de pesquisa está no formato codificado em Base64.
Somente contatos corporativos	x-enterprise		string	Quando definido como "true", somente a lista de contatos corporativos será retornada. No caso de "false", somente a lista de contatos do usuário será retornada. Se você não definir o cabeçalho, as listas de contatos da empresa e do usuário serão retornadas.
Total de registros	x-total-records		string	O número total de registros encontrados com os critérios de pesquisa fornecidos.

Retornos

response: array of ContactResponse

Obter detalhes do documento

ID da operação:: V4_Documents_GetDocumentDetails

Aplicativos empresariais podem usar essa API de serviço para obter os detalhes do documento. A ID do documento é fornecida na URL como "{document_id}".

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento para a qual os detalhes do documento são solicitados.
Senha do documento	x-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
senha One-Time (OTP)	x-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

Corpo: DocumentDetailsResponse

Obter detalhes do fluxo de trabalho

ID da operação:: V4_Workflow_GetWorkflowDetail

Aplicativos empresariais podem usar essa API de serviço para obter detalhes de fluxo de trabalho para o pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser baixado.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

Corpo: WorkflowDetailsResponse

Obter detalhes do pacote

ID da operação:: V4_Package_GetPackageDetails

Aplicativos empresariais podem usar essa API de serviço para obter os detalhes de um pacote. Essa API também pode ser usada pelo aplicativo de negócios para executar uma ação em nome do usuário corporativo por meio da "Autenticação de Escopo".

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote do documento.

Retornos

Corpo: GetPackageDetailsResponse

Obter espaço compartilhado

ID da operação:: V4_WorkSpace_GetSharedSpace

Aplicativos empresariais podem usar essa API de serviço para obter um espaço compartilhado específico. Essa API retorna informações sobre o espaço compartilhado, seu proprietário e colaborador.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de espaço compartilhado	id	True	integer	ID do espaço compartilhado que você deseja obter

Retornos

Corpo: WorkSpaceResponse

Obter histórico de fluxo de trabalho

ID da operação:: V4_Workflow_GetWorkflowHistory

Aplicativos empresariais podem utilizar essa API de serviço para recuperar a lista de ações executadas em um documento. A ID do pacote é fornecida 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

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do documento para o qual o log é necessário.
Número da Página	pageNo	True	integer	Número da página a ser recuperado.
Registros por Página	recordsPerPage	True	integer	Número total de registros a serem recuperados em uma 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.

Retornos

Corpo: WorkflowHistoryResponse

Obter lembrete de fluxo de trabalho

ID da operação:: V4_Workflow_GetWorkflowReminder

Os aplicativos empresariais podem usar essa API de serviço para atualizar os lembretes para os destinatários que já foram adicionados a um fluxo de trabalho. Normalmente, essa chamada é útil depois que um modelo é aplicado a um documento e os aplicativos de negócios desejam substituir as configurações de lembretes dentro do fluxo de trabalho. A ID do documento de fluxo de trabalho é fornecida na URL do recurso e o destinatário do fluxo de trabalho é identificado pela ordem na qual ele é adicionado ao fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote para a qual os lembretes de fluxo de trabalho serão atualizados.
Pedido	order	True	integer	A ordem do usuário para o qual os lembretes de fluxo de trabalho serão atualizados.

Retornos

Corpo: ReminderResponse

Obter modelos

ID da operação:: V4_Settings_GetTemplates

Os aplicativos de negócios podem usar essa API de serviço para obter uma lista de modelos para o usuário 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 usuário ou os modelos corporativos, conforme permitido em relação à função de usuário por seu administrador corporativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Número de registros por página	recordPerPage	True	integer	Número total de registros a serem recuperados em uma página.
Número da página a ser recuperado	pageNo	True	integer	Número da página a ser recuperado.
Classificar por coluna	sort-by		string	Classificar por coluna. Os valores possíveis são CREATED_ON e NAME. O padrão é classificar por CREATED_ON
Asc	asc		boolean	A ordem de lista resultante. A lista resultante padrão será decrescente
Pesquisar texto	x-search-text		string	Pesquisar texto, se necessário. Isso é opcional e sem ela a lista inteira é retornada. Além disso, o valor recomendado para o parâmetro de texto de pesquisa está no formato codificado em Base64.
Somente modelos empresariais	x-enterprise		string	Quando definido como "true", somente a lista de modelos empresariais será retornada. No caso de "false", somente a lista de modelos do usuário será retornada. Se você não definir o cabeçalho, as listas de modelos da empresa e do usuário serão retornadas.
Número total de registros	x-total-records		string	O número total de registros encontrados com os critérios de pesquisa fornecidos.

Retornos

response: array of TemplateResponse

Obter modelos empresariais

ID da operação:: V4_Template_GetEnterpriseTemplates

Aplicativos empresariais podem usar essa API de serviço para obter a lista de modelos empresariais do usuário atual. Isso significa que o administrador da empresa ou o usuário corporativo se a variável "escopo" foi usada na solicitação de autenticação.

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Número de registros por página	recordPerPage	True	integer	Número total de registros a serem recuperados em uma página.
Número da página a ser recuperado	pageNo	True	integer	Número da página a ser recuperado.
Classificar por coluna	sort-by		string	Classificar o resultado por valores possíveis é mencionado acima.
Ordenar o conjunto de resultados	asc		boolean	Ordene o conjunto de resultados subindo ou decrescente.
Filtrar por IDs de modelo	id		array	Pesquise por IDs de modelo.
Pesquisar texto	x-search-text		string	Pesquisar texto, se necessário. Isso é opcional e sem ela a lista inteira é retornada. Além disso, o valor recomendado para o parâmetro de texto de pesquisa está no formato codificado em Base64.
Número total de registros	x-total-records		string	O número total de registros encontrados com os critérios de pesquisa fornecidos.

Retornos

response: array of EnterpriseTemplateResponse

Obter pacotes

ID da operação:: V4_Package_GetAllPackages

Aplicativos empresariais podem usar essa API de serviço para obter uma lista de documentos filtrados por status diferentes. Os usuários podem dividir os registros em páginas fornecendo uma série de registros por página.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Status do documento	document_status	True	string	Filtrar por status de documento os valores possíveis são ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS.
Número da Página	pageNo	True	integer	Número da página, de acordo com a divisão de registros por página.
Registros por Página	recordPerPage	True	integer	Número de registros que precisam ser buscados em uma solicitação.
Nome do Pacote	package-name		string	Nome do Pacote
ID do Pacote	package-id		integer	ID do pacote
De	recipient-from		string	De
Para	recipient-to		string	Para
ID do documento	document-id		integer	ID do documento
Expiração (dias)	expiry		integer	Expiração (dias)
De Data Modificada	modified-from		date-time	De Data Modificada
Data da Modificação	modified-to		date-time	Data da Modificação
Do Tamanho (KB)	size-from		integer	Do Tamanho (KB)
Para Tamanho (KB)	size-to		integer	Para Tamanho (KB)
Documentos certificados	certified-documents		boolean	Somente documentos assinados certificados
Campos de formulário	form-fields		boolean	Somente documentos que têm campos de formulário
Anexos	attachments		boolean	Somente documentos que têm anexos
Tipo de documento	document-type		string	Tipo de documento como XML, PDF, DOCX etc.
Classificar Por	sort-by		string	Classificar os registros resultantes de acordo com sua escolha
Ordem crescente	asc		boolean	Classificar os registros resultantes por ordem crescente ou decrescente
Status do documento	document-statuses		array	Tipo de documento
Propriedade por	owned-by		string	Os valores possíveis de propriedade por filtro são ME_OTHERS, ME, OTHERS.
Nome do Formulário Inteligente	smart-form		string	Nome do formulário inteligente
Nome da Pasta	x-folder		string	Nome da pasta de onde os documentos devem ser buscados. Os valores possíveis são INBOX e ARCHIVE. Além disso, o valor recomendado para o parâmetro de pasta x está no formato codificado em Base64.
Pesquisar Texto	x-search-text		string	Pesquisar texto enviado em cabeçalhos para filtragem adicional dos documentos. A ID do pacote, o nome e o 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 registros	x-total-records		string	O número total de registros encontrados com os critérios de pesquisa fornecidos.
Fonte	x-source		string	Essa é a identificação da origem do documento de onde o documento é carregado, por exemplo, "Meu Aplicativo".
Detalhes do destinatário	x-recipient-details		string	Se "true" for passado detalhes do destinatário sobre a Duração do Acesso ao Documento serão fornecidos ao longo das informações de declínio

Retornos

response: array of GetPackagesResponse

Obter permissões de usuário de fluxo de trabalho

ID da operação:: V4_WorkflowPermission_GetWorkflowPermissions

Aplicativos empresariais podem usar essa API de serviço para obter permissões de documento para um destinatário. O destinatário é identificado pela ordem no fluxo de trabalho. A ID do pacote é fornecida na URL do recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do documento para a qual o usuário do fluxo de trabalho precisa ser atualizado.
Pedido	order	True	integer	A ordem do usuário no fluxo de trabalho para o qual as permissões são solicitadas. Ao fornecer o valor 0 em ordem, o serviço retornaria as permissões do colaborador adicionado mais recentemente no fluxo de trabalho.

Retornos

Corpo: WorkflowPermissionResponse

Obter relatório de evidências do processo

ID da operação:: V4_WorkflowEvidenceReport_DownloadBytes

Aplicativos empresariais podem usar essa API de serviço para baixar o relatório de evidências do processo de fluxo de trabalho de um documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do documento.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Obter usuários de fluxo de trabalho

ID da operação:: V4_Workflow_GetWorkflowUsers

Aplicativos empresariais podem usar essa API de serviço para obter detalhes de fluxo de trabalho para o pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser baixado.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: array of WorkflowRecipient

Pacotes de logon em massa

ID da operação:: V4_Signing_BulkSignDocuments

Aplicativos empresariais podem usar essa API para assinar/compartilhar/assinar e compartilhar vários documentos (eletrônicos e digitais) sem exibir os documentos para o usuário final. Essa API precisa de informações do aplicativo de negócios sobre pacotes de documentos e os detalhes de assinaturas, campos pessoais e iniciais. Após a conclusão bem-sucedida da transação de assinatura em massa, a API retornará os status e as IDs de transação dos pacotes de documentos.

Ao contrário da API de Documento de Assinatura, essa API não apenas assina um pacote de documentos, mas também o marca como aprovado e revisado com base em se o destinatário é um Signatário, Editor ou Revisor. Qualquer pacote de documentos para o qual o status retorna como COMPLETED foi assinado, aprovado ou revisado por essa API.

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

Se SIGN for passado como bulk_action e o pacote estiver no estado rascunho, Sign e Share serão executados automaticamente.

Você deve chamar essa API após a API pré-assinar documentos em massa .

Caso você precise fazer alterações em qualquer um dos documentos antes de assinar, a API de Campos de Formulário de Preenchimento deve ser chamada antes de chamar a API de Documento de Pré-Assinatura em Massa. Lembre-se de que todos os campos de entrada obrigatórios em um documento exigem a conclusão antes que essa API seja concluída com êxito; enquanto que os campos preenchidos automaticamente (como Nome, Email, Data, Cargo etc.) serão preenchidos automaticamente.

Depois que o documento for assinado, a resposta de verificação poderá ser vista na API de Status de Assinatura em Massa .

Uso de OTP do primeiro ou segundo fator para autenticação

Caso a autenticação OTP esteja ativada para a operação de assinatura do lado do servidor, os aplicativos cliente precisarão gerar um OTP para o número móvel usando a Autenticação de Sinal em Massa por meio da chamada à API OTP. Os respectivos aplicativos de negócios devem recuperar o OTP do uso e enviá-lo ao fazer a chamada à API. Isso é feito usando o cabeçalho "x-otp" na solicitação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ids	ids		array of integer	Uma matriz das IDs do pacote de documentos selecionadas para assinatura em massa.
hand_signature_initials_image	hand_signature_initials_image		string	Imagem base64 usada para o preenchimento das iniciais
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
hand_signature_image	hand_signature_image		string	Imagem da cadeia de caracteres codificada em Base64 da aparência da assinatura visível
hand_signature_method	hand_signature_method			Nome do método de assinatura manual por usuário para assinatura. Caso nenhum método de assinatura manual seja fornecido, o padrão será DRAW. valores possíveis DRAW, TEXT, UPLOAD, SIGNATURE_PAD
signing_reason	signing_reason		string	Motivo da assinatura fornecida pelo destinatário.
signing_location	signing_location		string	Localidade do signatário fornecido pelo destinatário
contact_information	contact_information		string	Informações de contato do signatário fornecidas pelo destinatário
appearance_design	appearance_design		string	Nome da aparência da assinatura fornecida pelo usuário para assinatura. Caso nenhum nome de aparência seja fornecido, a aparência selecionada padrão será usada. Os valores possíveis são "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_server	signing_server		string	Nome do servidor de assinatura usando o qual o documento deve ser assinado
signing_capacity	signing_capacity		string	Nome da capacidade de assinatura/perfil de certificação usando a qual o documento deve ser assinado
autenticação	authentication			O objeto de autenticação é opcional, contém opções de autenticação releadas
ID de transação	transaction_id		string	ID de transação do processo de assinatura iniciada novamente
ID do Pacote	packageId_bulkAction	True	string	Ação em massa a ser executada. Os valores possíveis são: SIGN \| COMPARTILHAR
Assinatura do OTP	x-otp		string	OTP/TOTP usado como uma segunda autenticação de assinatura de fator/documento para a operação de assinatura.
Senha de Acesso ao Documento	x-open-password		string	A senha definida pelo proprietário do documento para acessar o documento, se houver. Se a senha não tiver sido definida, o valor será nulo.
Senha do One-Time do documento	x-open-otp		string	O OTP (One-Time Password) definido pelo proprietário do documento para acessar o documento, se houver. Se o OTP não tiver sido definido, o valor será nulo.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.
Originador móvel	x-mobile		string	Definir o originador (Web/Mobile) da solicitação/ação

Retornos

Corpo: BulkSignResponse

Recusar Documento

ID da operação:: V4_Package_Decline

Aplicativos empresariais podem usar essa API de serviço para recusar um documento por um usuário especificado na ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	A ID do pacote a ser recusado.
reason	reason		string	Motivo fornecido pelo usuário para o declínio.
ID da pasta	x-folder-id		string	Especifique a ID da pasta, para recuperar os itens da pasta, quando uma pasta de espaço compartilhado estiver envolvida.

Retornos

response: object

Renomear Documento

ID da operação:: V4_Documents_RenameDocument

Aplicativos empresariais podem usar essa API de serviço para renomear um documento em um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId	True	integer	ID do pacote ao qual o documento é adicionado.
ID do documento	documentId	True	integer	A ID do documento no qual a ação deve ser executada.
document_name	document_name	True	string	Novo nome do documento.

Retornos

Corpo: DocumentResponse

Renomear Pacote

ID da operação:: V4_Package_RenamePackage

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

O pacote de documentos é identificado por seu identificador exclusivo na URL da chamada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	packageId_bulkAction	True	integer	ID do pacote do qual alterar o nome.
package_name	package_name	True	string	Novo nome do pacote de documentos.

Retornos

response: object

Status de Assinatura em Massa

ID da operação:: V4_Signing_BulkSignStatus

Os aplicativos empresariais podem usar essa API para obter o status de uma transação de assinatura em massa específica, juntamente com os detalhes dos pacotes de documentos que foram processados pela API de Pacotes de Assinatura em Massa .

Você deve chamar essa 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 a solicitação precisa ser autorizada usando o dispositivo móvel. Se o processo de assinatura falhar em algum documento devido a diferentes níveis de garantia configurados e o usuário quiser iniciar novamente o processo de assinatura para concluir o processo de assinatura em documentos com falha, a propriedade ACTION será REINITIATE_SIGNING_PROCESS e a propriedade STATUS estará PENDENTE.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID 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 ser executada. Os valores possíveis são: SIGN \| COMPARTILHAR

Retornos

Corpo: BulkSignStatusResponse

Definições

ElectronicSealRecipient

Nome	Caminho	Tipo	Description
nome	name	string
level_of_assurance	level_of_assurance	string

ReminderResponse

Nome	Caminho	Tipo	Description
enabled	enabled	boolean	True, se os lembretes estiverem habilitados para o destinatário
frequência	frequency	string	Frequência de lembrete. Os valores possíveis são DIAS \| HORAS.
remind_after	remind_after	integer	O número de dias após o qual o primeiro lembrete seria enviado ao usuário de fluxo de trabalho.
repetir	repeat		Repita o objeto com os detalhes do lembrete sendo repetidos ou não.

AddQrCodeResponse

Nome	Caminho	Tipo	Description
dados	data	string	Dados gerados pelo QR Code
field_name	field_name	string	Nome do campo criado no documento.
valor	value	string	O valor será a base64 da imagem QrCode

AddFieldResponse

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

SignatureFieldResponse

Nome	Caminho	Tipo	Description
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

Nome	Caminho	Tipo	Description
valor	value	string	O valor será a base64 da imagem QrCode

CertifyResponse

Nome	Caminho	Tipo	Description
enabled	enabled	boolean	True, se as configurações de assinatura de certificação estiverem habilitadas para o documento.
allowed_permissions	allowed_permissions	array of string	Certificar o nível de permissão definido para o documento com configurações de assinatura de certificação.
default_permission	default_permission	string

GroupMemberResponse

Nome	Caminho	Tipo	Description
user_email	user_email	string	Endereço de email do membro do grupo
user_name	user_name	string	Nome de usuário do membro do grupo

CollaboratorResponse

Nome	Caminho	Tipo	Description
user_email	user_email	string	Email do usuário
signing_order	signing_order	integer	Ordem de assinatura
guest_user	guest_user	boolean	É um usuário convidado
email_language_code	email_language_code	string	Código da linguagem de email
permissão	permission		Permissões para o destinatário no pacote de documentos
lembrete	reminder		Configurações de lembrete do destinatário.

WorkflowPermissionResponse

Nome	Caminho	Tipo	Description
imprimir	print	boolean	True, se a impressão for permitida para esse destinatário.
baixar	download	boolean	True, se o download for permitido.
add_text	add_text	boolean	True, se adicionar anotação de texto no documento for permitido.
change_recipients	change_recipients	boolean	True, se o destinatário na ordem atual puder alterar outros destinatários no fluxo de trabalho depois que o fluxo de trabalho for compartilhado.
add_attachment	add_attachment	boolean	True, se anexos e mesclagem de documentos PDF forem permitidos.
legal_notice	legal_notice		Aviso legal definido pelo proprietário do destinatário.
anexo	attachment		Anexos

EnterpriseTemplateResponse

Nome	Caminho	Tipo	Description
id	id	integer	ID do modelo
nome	name	string	Nome do modelo.
público	public	boolean	A resposta será "verdadeira" se o modelo da empresa estiver marcado como público. Caso contrário, "false" seria retornado
read_only	read_only	boolean	Resposta de "true" se o modelo for somente leitura e o usuário não puder fazer nenhuma alteração no fluxo de trabalho depois de aplicar esse modelo. Caso contrário, "false".
description	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
Documentos	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

Nome	Caminho	Tipo	Description
nome	name	string	Nome da função corporativa atribuída ao usuário.
id	id	integer	ID da função corporativa atribuída ao usuário.

TemplateDocumentResponse

Nome	Caminho	Tipo	Description
id	id	integer	ID do documento de modelo
nome	name	string	Nome do documento de modelo.

Next_signer_email

Nome	Caminho	Tipo	Description
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

Nome	Caminho	Tipo	Description
ordem	order	integer	Ordem do destinatário no fluxo de trabalho.
user_email	user_email	string	Endereço de email do destinatário se o usuário não for um grupo.
user_name	user_name	string	Nome do destinatário se o usuário não for um grupo.
mobile_number	mobile_number	string	Número do celular
delivery_method	delivery_method	string	Método de entrega de valores possíveis do destinatário: EMAIL, SMS ou EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Ponto de extremidade de API para acessar o recurso, isso será fornecido somente para os signatários principais. por exemplo, será nulo para grupo/delegador/gatekeeper etc. Essa URL não garante que a imagem do signatário exista. Se a imagem existir, ela será fornecida clicando na URL definida caso contrário, será uma cadeia de caracteres 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 se o destinatário for um grupo.
delegar	delegatee	string	Delegar o endereço de email, se o destinatário não for um grupo.
delegatee_name	delegatee_name	string	Nome do usuário delegado, se o destinatário não for um grupo.
função	role	string	Função de fluxo de trabalho na qual o destinatário foi adicionado. Essa função não é a função empresarial. Os valores possíveis são "SIGNER", "REVIEWER", "CARBON_COPY" e "EDITOR".
reason	reason	string	Motivo fornecido pelo usuário ao recusar, aprovar ou enviar um documento.
process_status	process_status	string	Status de processamento de documento para o destinatário. Os valores possíveis são "UN_PROCESSED", "IN_PROGRESS", "ASSINADO", "REVISADO", "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 usuário pode processar o campo como COLABORADOR, DELEGADOR, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do usuário que processou o documento.
espaço reservado	placeholder	string	Texto do espaço reservado se o destinatário for um espaço reservado
signing_order	signing_order	integer	Ordem na qual o fluxo de trabalho será assinado pelos destinatários. Essa ordem de assinatura é importante quando o tipo de fluxo de trabalho é definido como "CUSTOM".
user_national_id	user_national_id	string	Número de identidade nacional do usuário. Isso ajuda a identificar o usuário no fluxo de trabalho
guest_user	guest_user	boolean	Usuário de gest
email_language_code	email_language_code	string	código da linguagem de email
electronic_seal	electronic_seal	ElectronicSealRecipient
Gatekeepers	gatekeepers		Gatekeepers

EnterpriseAccessResponse

Nome	Caminho	Description
autenticação	authentication	Objeto de autenticação com os detalhes dos métodos de autenticação aplicados no documento para o destinatário.
authentication_signing	authentication_signing	Autenticação de assinatura para o pacote
access_duration	access_duration	Acesse o objeto de duração com os detalhes dos títulos de acesso para o destinatário.

GetPackageDetailsResponse

Nome	Caminho	Tipo	Description
nome	name	string	Nome do pacote do documento.
proprietário	owner	DocumentOwner
read_only	read_only	boolean	True se o modelo aplicado for somente leitura. O usuário não poderá fazer alterações se um modelo somente leitura for aplicado.
document_status	document_status	string	Status do documento para o usuário conectado atual. Os valores possíveis são "RASCUNHO", "INPROGRESS", "PENDENTE", "RECUSADO" ou "CONCLUÍDO".
Documentos	documents	array of DocumentDetails

DocumentOwner

Nome	Caminho	Tipo	Description
nome	name	string	Nome do proprietário do pacote do documento.
email	email	string	Email do proprietário do pacote de documentos.

DocumentDetails

Nome	Caminho	Tipo	Description
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".
fonte	source	string	Identifica onde o documento foi carregado, por exemplo, "Meu Aplicativo".

TemplateResponse

Nome	Caminho	Tipo	Description
template_id	template_id	integer	A ID do modelo é retornada aqui
template_name	template_name	string	Nome do modelo.
template_public	template_public	boolean	A resposta será "verdadeira" se o modelo da empresa estiver marcado como público. Caso contrário, "false" seria retornado
read_only	read_only	boolean	Resposta de "true" se o modelo for somente leitura e o usuário não puder fazer nenhuma alteração no fluxo de trabalho depois de aplicar esse modelo. Caso contrário, "false".
created_on	created_on	string	Data e hora em que o modelo foi criado
description	description	string	Descrição do modelo
empresa	enterprise	boolean	True, se o usuário pertencer a uma empresa.
Documentos	documents	array of TemplateDocumentResponse
smart_form	smart_form		Formulário inteligente

StartWorkflowResponse

Nome	Caminho	Tipo	Description
package_id	package_id	integer	A ID do pacote acabou de ser compartilhada. Incase de compartilhamento individual, mais de um pacote é criado e compartilhado com os destinatários. A API retorna uma matriz de pacotes junto com IDs de documentos recém-criados.
Documentos	documents	array of integer	Matriz de IDs de documento que faziam parte do pacote antes do compartilhamento.

WorkflowDetailsResponse

Nome	Caminho	Tipo	Description
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 compartilhado
package_owner	package_owner	string	Endereço de email do proprietário do pacote de documentos.
owner_name	owner_name	string	Nome do proprietário do pacote do documento.
package_status	package_status	string	Status do documento para o usuário conectado atual. Os valores possíveis são "RASCUNHO", "INPROGRESS", "PENDENTE", "RECUSADO", "APROVADO", "ATUALIZADO" ou "CONCLUÍDO".
pasta	folder	string	Nome da pasta que contém o pacote de documentos.
folder_id	folder_id	integer	ID da pasta que contém o pacote de documentos.
Gatekeeper	gatekeeper	boolean
next_signer	next_signer	string	O nome do próximo signatário se o documento estiver em estado compartilhado.
next_signer_email	next_signer_email	array of Next_signer_email	Um objeto que contém o nome de usuário e o endereço de email dos próximos signatários. No caso do signatário do grupo, ele 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		Objeto de fluxo de trabalho com os detalhes do fluxo de trabalho.
Documentos	documents	array of WorkflowDocumentsResponse	Lista de documentos carregados no pacote.
users	users	array of WorkflowUserResponse	Lista de destinatários para o fluxo de trabalho.

WorkflowDocumentsResponse

Nome	Caminho	Tipo	Description
document_id	document_id	integer	ID do documento.
document_name	document_name	string	Nome do documento.
document_type	document_type	string	Extensão de documento original quando o documento foi carregado antes da conversão para o 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	True se o documento for necessário para atualizar
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 a hora em que o documento foi carregado.
modified_on	modified_on	string	A data e a hora em que o documento foi modificado pela última vez.
form_fields	form_fields	boolean	True, se o documento tiver campos de formulário.
modelo	template		Objeto template que é aplicado no documento junto com os detalhes do modelo.
Certificar	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	True, se o documento estiver definido para bloquear os campos de formulário com a última assinatura digital no documento.
bloqueado	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Meta info do documento pdf: true se o documento pdf tiver assinado campos de assinatura
attachments	attachments	boolean	True, 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	Essa propriedade é para o documento XML, que está formatado ou não

WorkflowUserResponse

Nome	Caminho	Tipo	Description
ordem	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 espaço reservado, ele conterá o nome do espaço reservado.
user_email	user_email	string	Endereço de email do destinatário se o destinatário não for um grupo ou espaço reservado.
mobile_number	mobile_number	string	Número do celular
delivery_method	delivery_method	string	Método de entrega de valores possíveis do destinatário: EMAIL, SMS ou EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Ponto de extremidade de API para acessar o recurso, isso será fornecido somente para os signatários principais. por exemplo, será nulo para grupo/delegador/gatekeeper etc. Essa URL não garante que a imagem do signatário exista. Se a imagem existir, ela será fornecida clicando na URL definida caso contrário, será uma cadeia de caracteres 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 usuários.
delegador	delegator	string	Endereço de email do usuário que é delegador para esse destinatário.
Gatekeeper	gatekeeper	string	Endereço de email do usuário que é gatekeeper para este destinatário.
Gatekeepers	gatekeepers		Gatekeepers
função	role	string	Função do destinatário, ou seja, "SIGNER", "REVISOR", "EDITOR", "CARBON_COPY" ou "INPERSON_HOST".
process_status	process_status	string	Status de processamento de documento para o destinatário. Os valores possíveis são "UN_PROCESSED", "IN_PROGRESS", "ASSINADO", "REVISADO", "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 usuário pode processar o campo como COLABORADOR, DELEGADOR, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do usuário que processou o documento.
reason	reason	string	Motivo fornecido pelo usuário ao recusar, aprovar ou enviar um documento.
espaço reservado	placeholder	string	Texto do espaço reservado se o destinatário for um espaço reservado.
permissão	permission		Permissões para o destinatário definido pelo proprietário do pacote de documentos.
authentications	authentications		Objeto authentications com os detalhes de quaisquer autenticações e títulos de acesso configurados para o destinatário.
lembrete	reminder		Objeto reminder com os detalhes das configurações de lembrete.
signing_order	signing_order	integer	Ordem na qual o fluxo de trabalho será assinado pelos destinatários. Essa ordem de assinatura é importante quando o tipo de fluxo de trabalho é definido como "CUSTOM".
user_national_id	user_national_id	string	Número de identidade nacional do usuário. Isso ajuda a identificar o usuário no fluxo de trabalho
guest_user	guest_user	boolean	Usuário de gest
email_language_code	email_language_code	string	Código da linguagem de email
electronic_seal	electronic_seal		selo eletrônico

DocumentDetailsResponse

Nome	Caminho	Tipo	Description
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 no formato PDF.
document_height	document_height	integer	Altura do documento no formato PDF.
document_source	document_source	string	Identifica onde o documento foi carregado, por exemplo, "Meu Aplicativo".
document_pages	document_pages	integer	Total de páginas do documento.
form_fields	form_fields	boolean	True se o documento tiver campos de formulário.
lock_form_fields	lock_form_fields	boolean	True se o bloqueio de campos de formulário com a última assinatura estiver habilitado.
uploaded_on	uploaded_on	string	A data e a hora em que o documento foi carregado.
modified_on	modified_on	string	A data e a hora em que o documento foi modificado pela última vez.
Certificar	certify		Configurações de assinatura certificadas para o documento.
modelo	template		Detalhes do modelo, se o modelo for aplicado no documento.

AddAttachmentResponse

Nome	Caminho	Tipo	Description
attachment_id	attachment_id	integer	ID do anexo

GetAttachmentResponse

Nome	Caminho	Tipo	Description
attachment_id	attachment_id	integer	ID do anexo
attachment_name	attachment_name	string	Nome do anexo

AddPackageResponse

Nome	Caminho	Tipo	Description
package_id	package_id	integer	A ID do pacote a ser usada posteriormente para compartilhar, baixar e obter o status do documento.
workflow_mode	workflow_mode	string	O modo de fluxo de trabalho definido durante a adição do pacote.
workflow_type	workflow_type	string	Tipo do fluxo de trabalho. Os valores possíveis são "SERIAL", "PARALLEL", "INDIVIDUAL" e "CUSTOM".

GetPackagesResponse

Nome	Caminho	Tipo	Description
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 de documentos.
owner_name	owner_name	string	Nome do proprietário do pacote do documento.
shared_package	shared_package	boolean	Pacote Compartilhado
gatekeeper_package	gatekeeper_package	boolean	Pacote gatekeeper
package_status	package_status	string	Status do documento para o usuário conectado atual. Os valores possíveis são "RASCUNHO", "INPROGRESS", "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 de documentos.
folder_id	folder_id	integer	ID da pasta que contém o pacote de documentos.
Unread	unread	boolean	True, 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 compartilhado.
next_signer_email	next_signer_email	array of Next_signer_email	Um objeto que contém o nome de usuário e o endereço de email dos próximos signatários. No caso do signatário do grupo, ele 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		Especifique a data/hora de início e de término para um destinatário acessar o documento. O destinatário não poderá acessar o documento além dessa duração. Se o documento não for processado dentro do tempo especificado, o documento será considerado recusado.. Isso será fornecido se "x-recipient-details" for passado como true no cabeçalho
Declínio	decline		O documento recusará detalhes se ele tiver sido recusado manualmente ou automaticamente por meio do Core. Isso será fornecido se "x-recipient-details" for passado como true no cabeçalho
size	size	integer	Tamanho do documento em bytes.

DocumentResponse

Nome	Caminho	Tipo	Description
package_name	package_name	string	Nome do pacote do documento

UploadDocument

Nome	Caminho	Tipo	Description
documentId	documentId	integer	Essa propriedade é retida para compatibilidade com versões anteriores e será removida em versões posteriores. Em vez disso, use document_id.
documentid	documentid	integer	A ID do documento a ser usada posteriormente para compartilhar, baixar e obter o status do documento. serão removidos posteriormente document_id serão usados
document_id	document_id	integer	A ID do documento a ser usada posteriormente para compartilhar, baixar e obter o status do documento.
document_name	document_name	string	O nome do documento.
document_order	document_order	integer	Ordem do documento no pacote
document_type	document_type	string	Tipo do documento, por exemplo, "PDF".
document_source	document_source	string	Identifica onde o documento foi carregado, por exemplo, "Meu Aplicativo".
document_width	document_width	integer	Largura do documento no formato PDF.
document_height	document_height	integer	Altura do documento no formato PDF.
document_pages	document_pages	integer	Total de páginas do documento.
uploaded_on	uploaded_on	date-time	A data e a hora em que o documento foi carregado.
modified_on	modified_on	date-time	A data e a hora em que o documento foi modificado pela última vez.
lock_form_fields	lock_form_fields	boolean	True se o bloqueio de campos de formulário com a última assinatura estiver habilitado.
Certificar	certify		Configurações de assinatura certificadas para o documento.
document_size	document_size	integer	Tamanho do documento carregado em bytes
metadados	metadata		Informações de metadados em pdf do documento carregado
package_name	package_name	string	O nome do pacote do documento

CertifyPolicyResponse

Nome	Caminho	Tipo	Description
Certificar	certify		Certificar as configurações de assinatura do documento.
lock_form_fields	lock_form_fields	boolean	True se os campos de formulários devem ser bloqueados no PDF após a última assinatura digital no documento atual.

BulkSignResponse

Nome	Caminho	Tipo	Description
status	status	string
ID de transação	transaction_id	string

BulkSignStatusResponse

Nome	Caminho	Tipo	Description
status	status	string
packages	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Nome	Caminho	Tipo	Description
id	id	integer
nome	name	string
status	status	string
ação	action	string	Chave de ação necessária se houver
erro	error	string
porcentagem	percentage	integer
Documentos	documents	array of BulkSignActionDocumentModel	Documentos no pacote atual

BulkSignActionDocumentModel

Nome	Caminho	Tipo	Description
id	id	integer
Campos	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Nome	Caminho	Tipo
nome	name	string
hash	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Nome	Caminho	Tipo	Description
field_name	field_name	string	Nome do campo para o qual a verificação foi solicitada.
status	status	string	Retorna o status do campo de assinatura. Os valores são SIGNED, PENDING. O status ajuda na assinatura autorizada remota habilitada para eIDAS. Se a solicitação de sinal for enviada para o dispositivo móvel, o status estará pendente.
ID de transação	transaction_id	string	Esse parâmetro é usado durante a assinatura do RAS
verificação	verification		Verificação de assinatura
authentication_access_token	authentication_access_token	string	Ele conterá o id_token OIDC quando o usuário for autenticado via OIDC

AutoPlaceFieldsResponse

Nome	Caminho	Tipo	Description
field_name	field_name	string	Nome do campo que foi gerado automaticamente pela API.

ContactResponse

Nome	Caminho	Tipo	Description
id	id	integer	ID do contato.
user_name	user_name	string	Nome de usuário do contato.
user_email	user_email	string	Endereço de email do contato.
mobile_number	mobile_number	string	Número de celular do contato.
empresa	enterprise	boolean	True, se o contato for enterprise.
user_national_id	user_national_id	string	Número de identidade nacional do contato
created_on	created_on	string	DateTime quando o contato é adicionado.

WorkSpaceMembers

Nome	Caminho	Tipo	Description
nome	name	string	Nome do membro do espaço de trabalho
email	email	string	Endereço de email do membro do espaço de trabalho

WorkSpaceResponse

Nome	Caminho	Tipo	Description
id	id	integer	ID do espaço compartilhado
nome	name	string	Nome do espaço compartilhado
proprietário	owner		Proprietário do espaço compartilhado
Membros	members	array of WorkSpaceMembers	Membros do espaço compartilhado

UploadDocumentLibraryResponse

Nome	Caminho	Tipo	Description
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, "Meu Aplicativo".
document_width	document_width	integer	Largura do documento no formato PDF.
document_height	document_height	integer	Altura do documento no formato PDF.
document_pages	document_pages	integer	Total de páginas do documento.
uploaded_on	uploaded_on	date-time	A data e a hora em que o documento foi carregado.
modified_on	modified_on	date-time	A data e a hora em que o documento foi modificado pela última vez.
form_fields	form_fields	boolean	True se o documento tiver campos de formulário.
lock_form_fields	lock_form_fields	boolean	True se o bloqueio de campos de formulário com a última assinatura estiver habilitado.
Certificar	certify		Configurações de assinatura certificadas para o documento.
modelo	template		Detalhes do modelo, se o modelo for aplicado no documento.
package_name	package_name	string	Nome do pacote
metadados	metadata		Informações de metadados em pdf do documento carregado

WorkflowHistoryResponse

Nome	Caminho	Tipo	Description
package_id	package_id	integer	ID do pacote para o qual o histórico de 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 do pacote.
package_status	package_status	string	Status do pacote/documento com o usuário conectado atual. Os valores possíveis são "RASCUNHO", "INPROGRESS", "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	Objeto com nome e endereço de email do próximo destinatário.
Documentos	documents	array of WorkflowDocumentsResponse
Ações	actions	array of DocumentLogsActions

DocumentLogsActions

Nome	Caminho	Tipo	Description
log_id	log_id	integer	ID de uma ação executada no documento.
date_time	date_time	string	Data e hora em que a ação foi executada.
action_type	action_type	string
user_email	user_email	string	Email do usuário que executou a ação.
user_name	user_name	string	Nome do usuário que executou a ação.
enterprise_name	enterprise_name	string	O nome da Empresa à qual o usuário pertence. Se o usuário não pertencer a uma empresa, esse elemento não estará presente.
informações	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

Nome	Caminho	Tipo	Description
tipo	type	string	O tipo de informações extras sobre a ação, por exemplo, "SIGNING_METHOD", que significa qual usuário do método de assinatura usou para assinar o documento.
valor	value	string	O valor das informações extras sobre a ação, por exemplo, "LOCAL", o que significa que o usuário assinou o documento usando credenciais mantidas localmente.

UpdateCollaboratorResponse

Nome	Caminho	Tipo	Description
user_email	user_email	string	Email do usuário
signing_order	signing_order	integer	Ordem de assinatura
guest_user	guest_user	boolean	É um usuário convidado
email_language_code	email_language_code	string	Código da linguagem de email

CollaboratorGroupResponse

Nome	Caminho	Tipo	Description
permissão	permission		Permissões para o destinatário no pacote de documentos
lembrete	reminder		Configurações de lembrete do destinatário.
signing_order	signing_order	integer	Ordem de assinatura

CollaboratorPlaceholderResponse

Nome	Caminho	Tipo	Description
permissão	permission		Permissões para o destinatário no pacote de documentos
lembrete	reminder		Configurações de lembrete do destinatário.
signing_order	signing_order	integer	Ordem de assinatura

FieldsResponse

Nome	Caminho	Tipo	Description
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
items	in_person_signature	object
enviar SMS	text	array of TextFieldResponse
rádio	radio	array of RadioFieldResponse
caixa de seleção	checkbox	array of CheckboxFieldResponse
lista suspensa	dropdown	array of DropdownFieldResponse
Listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
anexo	attachment	array of AttachmentFieldResponse
comentário	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

Nome	Caminho	Tipo	Description
ordem	order	integer	Ordem do destinatário ao qual esse campo é atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
display_order	display_order	integer	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
tipo	type	string	Se o campo for atribuído ou não, os valores possíveis serão ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Se o campo é processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Usuário que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
created_on	created_on	string	Data e hora em que o campo é adicionado
processed_by	processed_by	string	Endereço de email do usuário que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
verificação	verification		Retorna a resposta de verificação do campo de assinatura. No caso de nenhuma verificação, nulo é retornado.
Nid	nid	string
exibir	display	string	Retorna 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		Authentication

FieldDimenssionResponse

Nome	Caminho	Tipo	Description
campo	field	FieldResponse
página	page	PageResponse

FieldResponse

Nome	Caminho	Tipo	Description
x	x	double	Local esquerdo do campo em pixel.
y	y	double	Localização superior do campo em pixel.
largura	width	double	Largura do campo em pixel.
height	height	double	Altura do campo em pixel.

PageResponse

Nome	Caminho	Tipo	Description
largura	width	float	Largura da página em que o campo é colocado no PDF.
height	height	float	Altura da página em que o campo é colocado no PDF.

HandSignatureFieldResponse

Nome	Caminho	Tipo	Description
ordem	order	integer	Ordem do destinatário ao qual esse campo é atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
display_order	display_order	integer	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
tipo	type	string	Se o campo for atribuído ou não, os valores possíveis serão ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Se o campo é processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Usuário que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do usuário que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
Nid	nid	string

ElectronicSignatureFieldResponse

Nome	Caminho	Tipo	Description
ordem	order	integer	Endereço de email do usuário que processou o campo.
display_order	display_order	integer	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
tipo	type	string	Se o campo for atribuído ou não, os valores possíveis serão ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Se o campo é processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Usuário que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do usuário que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	O sub-tipo de assinatura pode ser uma assinatura WITNESS. Se as assinaturas de testemunha estiverem habilitadas no plano de serviço, os campos E-Signature serão assinados com um certificado comum compartilhado por todos os usuários no plano de serviço. Os valores possíveis são WITNESS ou NONE.
autenticação	authentication		Authentication
verificação	verification		Retorna a resposta de verificação do campo. No caso de nenhuma verificação, nulo é retornado.
Nid	nid	string
exibir	display	string	Retorna o valor de visibilidade do campo de assinatura eletrônica, os valores possíveis são "VISIBLE" e "INVISIBLE".

InitialFieldResponse

Nome	Caminho	Tipo	Description
ordem	order	integer	Ordem do destinatário ao qual esse campo é atribuído. Se o campo não for atribuído a ninguém, o valor será nulo.
display_order	display_order	integer	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
process_status	process_status	string	Se o campo é processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Usuário que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do usuário que processou o campo.
dimensions	dimensions	FieldDimenssionResponse
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.

TextFieldResponse

Nome	Caminho	Tipo	Description
field_locale	field_locale	string	Local do campo. Os valores possíveis são ar-AE \| en-US. Opcional e padrão será en-US. Esse valor é importante para o tipo "DATE".
required	required	boolean	True se o campo for necessário em pdf
ordem	order	integer	Ordem do destinatário ao qual esse campo é 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	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
tipo	type	string	Tipo do campo de texto, os valores possíveis são "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".
valor	value	string	Valor do campo. Para tipo = DATE ou format_type = DATE, 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, os aplicativos cliente podem enviar YYYY-MM-DD e ignorar hh:mm:ss +00. Se o valor não estiver no formato adequado, um erro será retornado.
read_only	read_only	boolean	True, se o campo estiver marcado como somente leitura no documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos campos, os valores possíveis são "MANDATORY" ou "OPTIONAL".
validação	validation		Esse objeto é para que o Valor necessário seja passado
visible	visible	boolean	True, se o campo não estiver oculto no documento PDF.
multilinha	multiline	boolean	True, se o campo for de várias linhas no documento PDF.
fonte	font	FontResponse
comprimento_máximo	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, ele poderá seguir diferentes tipos de entrada. Os valores possíveis são ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME ou DATE.
espaço reservado	placeholder	string	Texto do espaço reservado para o campo de caixa de texto.
format	format	string	Formato de texto do campo. Usado somente para o campo de tipo de data. Os valores possíveis são: m/d m/d/yyy m/d/yyyyy mm/dd/yy mm/dd/yyyyy mm/yy mm/yyyyy d-mmm d-mmm-yyy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd aaaa-mm-dd mmm-yyy mmm-yyyyy mmmm-yyy mmmm-yyyyy mmmm d, yyyyy dd/mm/yy ddmmmyyy
cor	color	string	Cor do texto nos campos de formulário.
cor_da_borda	border_color	string	Cor da borda do campo de formulário.
dica de ferramenta	tooltip	string	dica de ferramenta do campo de formulário.
field_rotation	field_rotation	integer	Rotação de campo
alinhar	align	string	Alinhamento de texto para o campo de formulário. Os valores possíveis são "RIGHT", "LEFT", "CENTER" ou "JUSTIFY"
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Nome	Caminho	Tipo	Description
required	required	boolean	True se o campo for necessário em pdf
ordem	order	integer	Ordem do destinatário ao qual esse campo é 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	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
tipo	type	string
valor	value	boolean	Valor do campo.
read_only	read_only	boolean	True, se o campo for marcado somente leitura no documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
radio_group_name	radio_group_name	string	O nome do grupo ao qual o campo pertence.
verificado	checked	boolean	True, se o campo estiver selecionado
visible	visible	boolean	True se o campo não estiver oculto no documento PDF.
dimensions	dimensions	FieldDimenssionResponse
cor	color	string	Cor do texto nos campos de formulário.
cor_da_borda	border_color	string	Cor da borda do campo de formulário.
dica de ferramenta	tooltip	string	dica de ferramenta do campo de formulário.
field_rotation	field_rotation	integer	Rotação de campo

CheckboxFieldResponse

Nome	Caminho	Tipo	Description
required	required	boolean	True se o campo for necessário em pdf
ordem	order	integer	Ordem do destinatário ao qual esse campo é 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	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
tipo	type	string
valor	value	boolean	Valor do campo.
read_only	read_only	boolean	True, se o campo estiver marcado como somente leitura no documento PDF.
verificado	checked	boolean	True se o campo estiver selecionado.
visible	visible	boolean	True se o campo não estiver oculto no documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
dimensions	dimensions	FieldDimenssionResponse
cor	color	string	Cor do texto nos campos de formulário.
cor_da_borda	border_color	string	Cor da borda do campo de formulário.
dica de ferramenta	tooltip	string	dica de ferramenta do campo de formulário.
field_rotation	field_rotation	integer	Rotação de campo

DropdownFieldResponse

Nome	Caminho	Tipo	Description
required	required	boolean	True se o campo for necessário em pdf
ordem	order	integer	Ordem do destinatário ao qual esse campo é 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	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
read_only	read_only	boolean	True, se o campo estiver marcado como somente leitura no documento PDF.
valor	value	string	Valor do campo.
opções	choices	array of string	Opções disponíveis para a lista suspensa na qual escolher um valor.
visible	visible	boolean	True, se o campo não estiver oculto no documento PDF.
dimensions	dimensions	FieldDimenssionResponse
fonte	font	FontResponse
cor	color	string	Cor do texto nos campos de formulário.
cor_da_borda	border_color	string	Cor da borda do campo de formulário.
dica de ferramenta	tooltip	string	dica de ferramenta do campo de formulário.
field_rotation	field_rotation	integer	Rotação de campo

ListBoxFieldResponse

Nome	Caminho	Tipo	Description
ordem	order	integer	Ordem do destinatário ao qual esse campo é 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	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
Incorporado	embedded	boolean	True, se o campo fizer parte do documento PDF.
validation_rule	validation_rule	string	Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
read_only	read_only	boolean	True, se o campo estiver marcado como somente leitura no documento PDF.
valor	value	string	Valor do campo.
opções	choices	array of string	Opções disponíveis para a lista suspensa na qual escolher um valor.
visible	visible	boolean	True, se o campo não estiver oculto no documento PDF.
dimensions	dimensions	FieldDimenssionResponse
fonte	font	FontResponse
cor	color	string	Cor do texto nos campos de formulário.
cor_da_borda	border_color	string	Cor da borda do campo de formulário.
dica de ferramenta	tooltip	string	dica de ferramenta do campo de formulário.
field_rotation	field_rotation	integer	Rotação de campo

FontResponse

Nome	Caminho	Tipo	Description
nome	name	string	Nome da fonte para o campo de texto. Para campos definidos pelo usuário, o SigningHub só dá suporte a "COURIER", "HELVETICA". No caso de campos existentes em um arquivo 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

Nome	Caminho	Tipo	Description
field_name	field_name	string	Identificador exclusivo do campo.
tipo	type	string	Tipo de campo PDF_FIELD_TYPE como QR
page_no	page_no	integer	Número da página do documento no qual o campo existe.
valor	value	string	QrCode gerado base64 será fornecido inly no modo de rascunho
dimensions	dimensions	FieldDimenssionResponse
dados	data	string	Os dados de texto sem formatação a serem codificados no código QR. O padrão é a URL gerada para acessar o documento relacionado. por exemplo, {base_url}/document/{document_unique_id}
Opções	options		Configurações relativas às opções
cor	color		Configurações relacionadas à cor
logotipo	logo		Configurações referentes ao logotipo

AttachmentFieldResponse

Nome	Caminho	Tipo	Description
ordem	order	integer	Ordem do destinatário ao qual esse campo é atribuído.
display_order	display_order	integer	Exibir a ordem de acordo com o visualizador do SigningHub.
field_name	field_name	string	Identificador exclusivo do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
process_status	process_status	string	Se o campo é processado ou não. Os valores possíveis são UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data e hora em que o documento é processado.
processed_as	processed_as	string	Usuário que processou o campo como COLABORADOR, DELEGADO, GROUP_MEMBER ou PROPRIETÁRIO.
processed_by	processed_by	string	Endereço de email do usuário que processou o campo.
attachmentRefId	attachmentRefId	integer	ID do ref do attachmet
nota	note	string	Anotação de anexo somente no caso de regra de anexo "MANDATORY"
validation_rule	validation_rule		Uma ou mais regras para validação dos valores possíveis dos campos são "MANDATORY" ou "OPTIONAL".
dimensions	dimensions		Dimentions

CommentFieldResponse

Nome	Caminho	Tipo	Description
id	id	integer	ID do campo de comentário
page_no	page_no	integer	Número da página do documento no qual o campo existe.
unread_count	unread_count	integer	Comentários não lidos
particular	private	boolean	Privado
destinatários	recipients	array of CommentFieldRecipientResponse	Destinatários
dimensions	dimensions		Dimensões

UniqueIdentifierFieldResponse

Nome	Caminho	Tipo	Description
field_name	field_name	string	Identificador exclusivo do campo.
valor	value	string	Valor do campo.
page_no	page_no	integer	Número da página do documento no qual o campo existe.
fonte	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

Nome	Caminho	Tipo	Description
user_name	user_name	string	Nome de usuário
user_email	user_email	string	Email do usuário

objeto

Esse é o tipo 'object'.