Partilhar via

PKIsigning (Pré-visualização)

Automatize suas necessidades de assinatura de documentos com o conector da plataforma PKIsigning. Enviar documentos para a plataforma PKIsigning; enviar convites e recuperar os documentos assinados.

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte a PKIsigning
URL https://pkisigning.nl/support
Email support@pkisigning.nl
Metadados do conector
Editora SBRS Bv
Sítio Web https://pkisigning.nl
Política de privacidade https://pkisigning.nl/privacy
Categorias Colaboração; Produtividade

O PKIsigning permite que as organizações automatizem, simplifiquem e protejam o processo de aprovação, assinatura e envio de documentos para clientes e terceiros. A plataforma suporta todos os certificados de assinatura pessoal eIDAS de Provedores de Serviços Confiáveis Qualificados Holandêss e ISO27001 é certificada. Isso torna a PKIsigning um parceiro ideal para organizações jurídicas, financeiras e de saúde e governos. Conecte-se com PKisigning para automatizar, simplificar e proteger seu processo de assinatura de documentos.

Pré-requisitos

Para usar o conector PKIsigning, é necessária uma conta para a plataforma PKIsigning dentro de uma assinatura "profissional". Entre em contato com PKIsigning para se registrar para uma assinatura paga.

Como obter credenciais

Depois de se registrarem para uma assinatura, os usuários receberão um e-mail com um convite para configurar sua conta. Após o registo, essa conta pode ser utilizada diretamente com este conector.

Introdução ao conector

O fluxo padrão para começar a assinar documentos é o seguinte:

  1. Criar dossiê
  2. Adicionar documento(s)
  3. Adicionar ator(es)
  4. Iniciar fluxo de trabalho
  5. Use um gatilho para ser notificado sobre alterações de status
  6. Download do dossiê

Dossiês

PKIsigning espera que você sempre crie um dossiê primeiro. Um dossiê funciona como um recipiente para documentos e atores. Um dossiê pode ser criado com a ação Dossiers_Create. Depois que um dossiê for criado, use o PkisId retornado como referência para ações futuras.

Documents

Após a criação de um dossiê, você pode adicionar documentos com a ação Documents_Add usando o dossierId correto. A ação não precisa de outros parâmetros, pois eles são distraídos dos próprios arquivos de documentos. Não há limite para o número de documentos de um dossiê. Todos os documentos poderão ser visualizados e descarregados por todos os intervenientes adicionados.

Importante: O documento precisa de um ou mais espaços reservados textuais exclusivos, dependendo do número de assinaturas, para indicar onde uma assinatura deve ser colocada e por qual ator. Pode ser qualquer texto em qualquer lugar do documento. Ao adicionar atores, você pode definir o espaço reservado com o parâmetro placeholder. Ex: assinatura1, assinatura2, etc...

Actors

A terceira etapa consiste em adicionar atores aos documentos. Isso é feito com o Ator_Create Action usando o dossierId e documentId corretos.

Iniciar fluxo de trabalho

Para iniciar um fluxo de trabalho e enviar efetivamente convites a todos os intervenientes para assinar ou descarregar documentos pela ordem fornecida, utilize a ação Dossiers_StartWorkflow com o ID do dossiê correto.

Use um gatilho para ser notificado sobre alterações de status

Para obter o documento depois de assinado, assine as notificações usando um gatilho. Para receber a notificação de status, especifique 'status' no campo Eventos.

Download do dossiê

Quando o gatilho for notificado de uma atualização de status, verifique se o status do documento é 'Concluído'. A partir desse momento, é possível descarregar todos os documentos do dossiê num único ficheiro zip. Se for especificado nas configurações dentro da plataforma PKIsigning que uma trilha de auditoria deve ser gerada, isso também será incluído.

Problemas conhecidos e limitações

Nenhuma edição é conhecida no momento da publicação.

Erros e soluções comuns

Sem atualizações de status através do gatilho

Se o gatilho não responder às atualizações de status, verifique se o valor 'status' foi fornecido no campo Eventos.

Erro HTTP 402 Pagamento Necessário

A plataforma PKIsigning exigia créditos para executar ações. Quando os atores são adicionados, os créditos são reservados para garantir que a ação possa ocorrer e os convidados não sejam confrontados com questões relativas a um número insuficiente de créditos disponíveis. Se muitos convites forem enviados aos atores, pode ocorrer que o pacote de crédito não tenha mais créditos a serem reservados. Nesse momento, um erro HTTP 402 será retornado.

Para resolver o problema, suporte PKIsigning para recarregar o saldo de crédito ou limpar quaisquer dossiês não enviados com atores na lixeira na plataforma. Os créditos não utilizados voltarão a estar disponíveis.

FAQ

Consulte a nossa base de conhecimento ou contacte-nos em support@pkisigning.nl

Limites de Limitação

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

Ações

Atualizar ator

Altera dados de um ator específico.
Atualizar documento

Altera dados de um documento específico.
Criar ator

Cria um novo ator e o adiciona a um documento.
Criar documento

Cria um novo documento e adiciona-o a uma solicitação específica.
Criar pedido

Crie uma nova solicitação.
Eliminar documento

Exclui permanentemente um documento específico.
Eliminar um pedido

Exclui permanentemente uma solicitação específica.
Enviar pedido

Inicia o fluxo de trabalho e envia um convite para o primeiro ator na fila para uma solicitação específica.
Excluir ator

Exclui permanentemente um ator específico.
Obter dados de solicitação

Retorna todos os (meta)dados de uma solicitação específica.
Obter dados do ator

Retorna todos os dados de um ator específico.
Obter dados do ator por documento

Retorna todos os dados de todos os atores de um documento específico.
Obter dados do ator por solicitação

Retorna todos os dados de todos os atores para uma solicitação específica.
Obter dados do documento

Devolve todos os (meta)dados de um documento específico.
Obter grupos de trabalho para a organização

Devolve uma lista de todos os grupos de trabalho de uma organização específica.
Obter grupos de trabalho para o usuário

Retorna uma lista de todos os grupos de trabalho para um usuário específico de uma organização específica.
Pedido de atualização

Altera dados de uma solicitação específica.
Pedido de download

Descarrega um pedido e o seu conteúdo como um ficheiro .zip.
Reenviar convite

Reenvia o convite para o ator atual na fila para uma solicitação específica.
Retirar convite

Retira o convite para o ator atual na fila para um pedido específico.

Atualizar ator

ID da Operação:
Actors_Update

Altera dados de um ator específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.
ID do ator
 actorId True guid

ID exclusivo de um ator.
Ação
 action True string

Ação que o ator deve realizar.
Nome próprio
 firstname True string

Nome próprio do ator.
Prefixo
 prefix string

Prefixo do ator.
Apelido
 lastname True string

Sobrenome do ator.
Endereço de e-mail
 email True string

Endereço de e-mail do ator.
Número de telemóvel
 mobile True string

Número de telemóvel do ator.
Deadline
 deadline True date-time

A data e a hora em que a ação deve ter sido executada pelo ator.
Linguagem
 language True string

Idioma para o convite.
Use uma verificação forte
 validateRealIdentity True boolean

Use um método mais forte de identificação para este ator.
dossiêPersonId
 dossierPersonId integer
mensagem
 message string

Devoluções

Body
ExtendedSignerModel

Atualizar documento

ID da Operação:
Documents_Update

Altera dados de um documento específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.
Nome do documento
 name string

Nome de um documento específico
Nome do ficheiro do documento
 filename string

Nome do ficheiro para um documento específico
Tipo de documento
 documentType True string

O tipo de um documento específico. (Por exemplo, PDF regular, declaração fiscal, relatório de auditores, etc.).

Devoluções

Metadados gerais do documento

Body
DocumentMetaDataModel

Criar ator

ID da Operação:
Actors_Create

Cria um novo ator e o adiciona a um documento.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.
Ação
 action True string

Ação que o ator deve realizar.
Nome próprio
 firstname True string

Nome próprio do ator.
Prefixo
 prefix string

Prefixo do ator.
Apelido
 lastname True string

Sobrenome do ator.
Endereço de e-mail
 email True string

Endereço de e-mail do ator.
Número de telemóvel
 mobile True string

Número de telemóvel do ator.
Deadline
 deadline True date-time

A data e a hora em que a ação deve ter sido executada pelo ator.
Linguagem
 language True string

Idioma para o convite.
Use uma verificação forte
 validateRealIdentity True boolean

Use um método mais forte de identificação para este ator.
dossiêPersonId
 dossierPersonId integer
mensagem
 message string
Campo de assinatura
 fieldName string

O nome de um campo de assinatura existente no documento para este ator assinar.
Placeholder
 placeholder string

O texto de um espaço reservado específico no documento onde o ator deve colocar uma assinatura.

Devoluções

Body
ExtendedSignerModel

Criar documento

ID da Operação:
Documents_Create

Cria um novo documento e adiciona-o a uma solicitação específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de um pedido ao qual este documento pertencerá.
Ficheiro
 file True file

O ficheiro a processar (apenas tipos de ficheiros específicos).

Devoluções

Metadados gerais do documento

Body
DocumentMetaDataModel

Criar pedido

ID da Operação:
Requests_Create

Crie uma nova solicitação.

Parâmetros

Name Chave Necessário Tipo Description
Nome do pedido
 name True string

Nome para um pedido específico.
ID do grupo de trabalho
 workgroupId guid

ID exclusivo de um grupo de trabalho.
Nível de habilitação de segurança
 clearancelevel True integer

Nível de habilitação de segurança para um pedido específico.
Proprietário do pedido
 owner email

Usuário que é o proprietário de uma solicitação específica.

Devoluções

Body
RequestModel

Eliminar documento

ID da Operação:
Documents_Delete

Exclui permanentemente um documento específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.

Eliminar um pedido

ID da Operação:
Requests_Delete

Exclui permanentemente uma solicitação específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.

Enviar pedido

ID da Operação:
Requests_Send

Inicia o fluxo de trabalho e envia um convite para o primeiro ator na fila para uma solicitação específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.

Excluir ator

ID da Operação:
Actors_Delete

Exclui permanentemente um ator específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.
ID do ator
 actorId True guid

ID exclusivo de um ator.

Obter dados de solicitação

ID da Operação:
Requests_Get

Retorna todos os (meta)dados de uma solicitação específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
Chave de autenticação
 callbackAuthenticationKey string

Chave de autenticação fornecida pelo gatilho.

Devoluções

Body
RequestModel

Obter dados do ator

ID da Operação:
Actors_Get

Retorna todos os dados de um ator específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.
ID do ator
 actorId True guid

ID exclusivo de um ator.

Devoluções

Body
ExtendedSignerModel

Obter dados do ator por documento

ID da Operação:
Actors_List

Retorna todos os dados de todos os atores de um documento específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.
Ação concluída
 hasActed boolean

Só retorna atores que completaram ou não sua ação, deixe em branco para retornar todos os atores.

Devoluções

response
array of ExtendedSignerModel

Obter dados do ator por solicitação

ID da Operação:
Actors_RequestActors

Retorna todos os dados de todos os atores para uma solicitação específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
Ator já atendeu ao pedido
 hasActed boolean

Valor somente leitura para verificar se um ator já atuou no documento.

Devoluções

response
array of ExtendedSignerModel

Obter dados do documento

ID da Operação:
Documents_Get

Devolve todos os (meta)dados de um documento específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
ID do documento
 documentId True guid

ID exclusivo de um documento.

Devoluções

Metadados gerais do documento

Body
DocumentMetaDataModel

Obter grupos de trabalho para a organização

ID da Operação:
Organisations_GetWorkgroups

Devolve uma lista de todos os grupos de trabalho de uma organização específica.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização
 organisationId True guid

ID único de uma organização.

Devoluções

response
array of OrganisationWorkgroup

Obter grupos de trabalho para o usuário

ID da Operação:
Organisations_GetWorkgroupsByUser

Retorna uma lista de todos os grupos de trabalho para um usuário específico de uma organização específica.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização
 organisationId True guid

ID único de uma organização.
Nome de utilizador
 username True email

Endereço de e-mail do utilizador

Devoluções

response
array of OrganisationWorkgroup

Pedido de atualização

ID da Operação:
Requests_Update

Altera dados de uma solicitação específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.
Nome do pedido
 name True string

Nome para um pedido específico.
ID do grupo de trabalho
 workgroupId guid

ID exclusivo de um grupo de trabalho.
Nível de habilitação de segurança
 clearancelevel True integer

Nível de habilitação de segurança para um pedido específico.
Proprietário do pedido
 owner email

Usuário que é o proprietário de uma solicitação específica.

Devoluções

Body
RequestModel

Pedido de download

ID da Operação:
Requests_Download

Descarrega um pedido e o seu conteúdo como um ficheiro .zip.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.

Devoluções

response
file

Reenviar convite

ID da Operação:
Actors_ResendCurrentInvite

Reenvia o convite para o ator atual na fila para uma solicitação específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.

Retirar convite

ID da Operação:
Actors_WithdrawCurrentInvite

Retira o convite para o ator atual na fila para um pedido específico.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 requestId True guid

ID exclusivo de uma solicitação.

Acionadores

Quando um evento ocorre em uma solicitação

Registre um url para retorno de chamada após uma alteração de status. A plataforma PKIsigning comunicará quaisquer atualizações de estado de dossiês dentro desta organização a este url.

Quando um evento ocorre em uma solicitação

ID da Operação:
Webhooks_CreateWebhook

Registre um url para retorno de chamada após uma alteração de status. A plataforma PKIsigning comunicará quaisquer atualizações de estado de dossiês dentro desta organização a este url.

Parâmetros

Name Chave Necessário Tipo Description
Tipos de evento
 Events True array of string

Uma lista de tipos de eventos que ocorrem em uma solicitação da qual esse gatilho será notificado
ID da organização
 organisationId True guid

ID único de uma organização.

Devoluções

Name Caminho Tipo Description
ID de solicitação
 PkisId guid

ID exclusivo de uma solicitação.
Estado do pedido
 DossierStatus string

Situação do processo.
Reason
 Reason string

Motivo da alteração.
Chave de autenticação
 AuthenticationKey string

Cabeçalho para obter metadados na solicitação.

Definições

ExtendedSignerModel

Name Caminho Tipo Description
Campo de assinatura
 fieldName string

O nome de um campo de assinatura existente no documento para este ator assinar.
Placeholder
 placeholder string

O texto de um espaço reservado específico no documento onde o ator deve colocar uma assinatura.
Ação
 action string

Ação que o ator deve realizar.
Nome próprio
 firstname string

Nome próprio do ator.
Prefixo
 prefix string

Prefixo do ator.
Apelido
 lastname string

Sobrenome do ator.
Endereço de e-mail
 email string

Endereço de e-mail do ator.
Número de telemóvel
 mobile string

Número de telemóvel do ator.
Deadline
 deadline date-time

A data e a hora em que a ação deve ter sido executada pelo ator.
Linguagem
 language string

Idioma para o convite.
Use uma verificação forte
 validateRealIdentity boolean

Use um método mais forte de identificação para este ator.
dossiêPersonId
 dossierPersonId integer
mensagem
 message string
ID do ator
 id guid

ID exclusivo de um ator específico.
Data de conclusão
 signingDate date-time

A data e hora em que o ator realizou a sua ação.
Ação concluída
 hasSigned boolean
Nome completo
 fullName string

Combinação de nome, prefixo e sobrenome do ator.
Informações de status
 emailActivity array of EmailActivity

Informações de status sobre o processo de execução da ação pelo ator.
documentId
 documentId guid

EmailActivity

Metadados da mensagem de e-mail enviada a um ator

Name Caminho Tipo Description
Atividade de e-mail
 event string

Atividade de e-mail para um pedido e ator específicos.
Informações SMTP
 reason string

Informações SMTP para um e-mail enviado a um ator específico como parte de uma solicitação.
Data do e-mail
 timestamp date-time

Data de um e-mail enviado a um ator específico como parte de uma solicitação.
Tipo de e-mail
 pkisMessageType string

Digite um e-mail enviado a um ator específico como parte de uma solicitação (por exemplo, Convidar, Lembrete, etc.).
ID do pedido de e-mail
 pkisInviteId string

ID exclusivo para um e-mail enviado a um ator específico como parte de uma solicitação.
Endereço de e-mail
 email string

Endereço de e-mail para um e-mail enviado a um ator específico como parte de uma solicitação.

SignerModel

Tipo especial de ator

Name Caminho Tipo Description
Ação
 action string

Ação que o ator deve realizar.
Nome próprio
 firstname string

Nome próprio do ator.
Prefixo
 prefix string

Prefixo do ator.
Apelido
 lastname string

Sobrenome do ator.
Endereço de e-mail
 email string

Endereço de e-mail do ator.
Número de telemóvel
 mobile string

Número de telemóvel do ator.
Deadline
 deadline date-time

A data e a hora em que a ação deve ter sido executada pelo ator.
Linguagem
 language string

Idioma para o convite.
Use uma verificação forte
 validateRealIdentity boolean

Use um método mais forte de identificação para este ator.
dossiêPersonId
 dossierPersonId integer
mensagem
 message string
Campo de assinatura
 fieldName string

O nome de um campo de assinatura existente no documento para este ator assinar.
Placeholder
 placeholder string

O texto de um espaço reservado específico no documento onde o ator deve colocar uma assinatura.

DocumentMetaDataModel

Metadados gerais do documento

Name Caminho Tipo Description
Nome do documento
 name string

Nome de um documento específico.
Última atualização do documento
 lastUpdate date-time

Data da última atualização de um documento específico.
Número de páginas do documento
 pages integer

Número de páginas de um documento específico.
Data de criação do documento
 created date-time

Data de criação de um documento específico.
ID do documento
 id guid

ID exclusivo de um documento.
Estado do documento
 status string

Estado de um documento específico. (Por exemplo, novo, concluído, etc.).
Documento contém assinatura
 signed boolean

Indica se um documento específico já contém uma ou mais assinaturas.
Assinaturas de documentos
 signatures array of SignatureData

Lista de todas as assinaturas de um documento específico.
Campos de assinatura em branco do documento
 emptySignatureFields array of SignatureField

Lista de todos os campos de assinatura vazios de um documento específico.
Campos de assinatura em branco
 containsBlankSignatureFields boolean

Indica se um documento específico contém campos de assinatura em branco.
Intervenientes no documento
 actors array of ExtendedSignerModel

Lista de todos os intervenientes para um documento específico.
ID de solicitação
 requestId guid

ID exclusivo de uma solicitação.
Índice de pedidos
 dossierIndex integer

O índice de todos os documentos pertencentes a um pedido específico.
documentSize
 documentSize integer

O tamanho de um documento pertencente a um pedido específico.
Tipo de documento
 documentType string

O tipo de documento pertencente a um pedido específico.

SignatureData

Name Caminho Tipo Description
Campos de assunto do certificado
 subject array of KeyValuePairOfStringAndString

Campos da linha de assunto do certificado usado para uma assinatura específica.
Campos do emissor do certificado
 issuer array of KeyValuePairOfStringAndString

Campos da linha do emissor do certificado usado para uma assinatura específica.
Data de assinatura
 date date-time

Data e hora em que uma assinatura específica foi colocada.
Local de assinatura
 location string

A localização geográfica de um ator específico no momento da assinatura.
Motivo da assinatura
 reason string

O motivo da assinatura fornecido por um ator específico no momento da assinatura.
Assinatura Eletrónica Qualificada
 euQualified boolean

Indica se uma assinatura específica está qualificada (QeS) em conformidade com os regulamentos eIDAS.
Assinatura Electrónica Avançada
 advanced boolean

Indica se uma assinatura específica está em conformidade com os regulamentos eIDAS (AeS).
eSeal qualificado
 eSeal boolean

Indica se um certificado específico usado para assinatura ou selagem é um eIDAS qualificado em conformidade com os regulamentos eIDAS.
Endereço IP do ator
 ipAddress string

O endereço IP de um ator específico
Campo de assinatura
 signatureField string

O campo que foi assinado
Imagem de assinatura
 signatureImage string

O arquivo de imagem que foi usado para uma assinatura específica, conforme escolhido por um ator.

KeyValuePairOfStringAndString

Name Caminho Tipo Description
chave
 key string
valor
 value string

Campo de Assinatura

Name Caminho Tipo Description
Nome do campo de assinatura
 name string

Nome de um campo de assinatura específico
Página do campo de assinatura
 page integer

Página onde um campo de assinatura específico é colocado para um documento específico.
Coordenada de largura do campo de assinatura
 x double

Valor de largura da posição de um campo de assinatura específico em relação à página em que ele é colocado em um documento específico.
Coordenada hight do campo de assinatura
 y double

Valor mais alto da posição para um campo de assinatura específico em relação à página em que ele é colocado em um documento específico.
Altura do campo de assinatura
 height double

Valor mais alto para um campo de assinatura específico.
Largura do campo de assinatura
 width double

Valor de largura para um campo de assinatura específico.

OrganizaçãoGrupo de trabalho

Um grupo de trabalho que é usado dentro de um dossiê

Name Caminho Tipo Description
ID do grupo de trabalho
 id guid

ID exclusivo de um grupo de trabalho
Nome do grupo de trabalho
 name string

Nome de um grupo de trabalho específico

Modelo de solicitação

Name Caminho Tipo Description
ID de solicitação
 id guid

ID exclusivo de um pedido
Nome do pedido
 dossierName string

Nome para um pedido específico.
Solicitar documentos
 documents array of DocumentModel

Lista dos documentos incluídos neste pedido.
Estado do pedido
 status string

Status de uma solicitação específica. (Por exemplo, novo, concluído, etc.).
Solicitar intervenientes
 actors array of ExtendedSignerModel

Lista de todos os intervenientes para um pedido específico.
Assinaturas de documentos
 signatures array of SignatureData

Lista de todas as assinaturas para um pedido específico.
Tipo de pedido
 dossierType string

O tipo para uma solicitação específica. (E.g. PDF, SBR Assurance, etc.).
Motivo do cancelamento
 reasons string

Motivo do cancelamento de um pedido específico por parte de um utilizador ou de um interveniente.
Nota do signatário
 signerNote string

Nota para um ou mais atores que não têm outra ação senão sinal.
Nota do destinatário
 recipientNote string

Nota para um ou mais atores que não têm outra ação que não seja transferir.
Nota do aprovador
 accorderNote string

Nota para um ou mais atores que não têm outra ação além de aprovar solicitação.
Solicitar data de expiração
 expires date-time

Data e hora de expiração de um pedido específico.
Informações de status
 emailActivity array of EmailActivity

Informações de status sobre o processo de execução da ação pelo ator.
O meu pedido
 myDossier boolean

Indica se você é o proprietário de uma solicitação específica.
ID do grupo de trabalho
 workgroup guid

ID exclusivo de um grupo de trabalho.
Nível de habilitação de segurança
 clearancelevel integer

Nível de habilitação de segurança para um pedido específico.

Modelo de Documento

Name Caminho Tipo Description
ID do documento
 id guid

ID exclusivo de um documento
Nome do documento
 name string

Nome de um documento específico
Tipo de documento
 documentType string

Digite para um documento específico.
Índice de pedidos
 dossierIndex integer

O índice de todos os documentos pertencentes a um pedido específico.
Estado do documento
 documentstatus string

Estado de um documento específico. (Por exemplo, novo, concluído, etc.).
Intervenientes no documento
 actors array of SignerModel

Lista de todos os intervenientes para um documento específico.

ficheiro

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