PKIsigning (versão prévia)
Automatize suas necessidades de assinatura de documento com o conector da plataforma PKIsigning. Enviar documentos para a plataforma PKIsigning; envie convites e recupere os documentos assinados.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao PKIsigning |
| URL | https://pkisigning.nl/support |
| support@pkisigning.nl |
| Metadados do conector | |
|---|---|
| Publicador | SBRS B.V. |
| Site da 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 dá suporte a todos os certificados de assinatura pessoal do eIDAS de provedores de serviços confiáveis qualificados holandeses e é ISO27001 certificada. Isso torna a PKIsigning um parceiro ideal para organizações legais, financeiras e de saúde e governos. Conecte-se ao PKisigning para automatizar, simplificar e proteger o processo de assinatura do documento.
Pré-requisitos
Para usar o conector PKIsigning, uma conta para a plataforma PKIsigning é necessária em uma assinatura "profissional". Entre em contato com o PKIsigning para se registrar em uma assinatura paga.
Como obter credenciais
Depois de se registrar em uma assinatura, os usuários receberão um email com um convite para configurar sua conta. Após o registro, essa conta pode ser usada diretamente com esse conector.
Introdução ao conector
O fluxo padrão para iniciar a assinatura de documentos é o seguinte:
- Criar dossiê
- Adicionar documentos
- Adicionar atores
- Iniciar fluxo de trabalho
- Usar um gatilho para ser notificado sobre alterações de status
- Baixar o dossiê
Processos
PKIsigning espera que você sempre crie um dossiê primeiro. Um dossiê atua como um contêiner 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.
Documentos
Depois que um dossiê for criado, você poderá adicionar documentos com a ação Documents_Add usando a dossierId correta. A ação não precisa de outros parâmetros, pois eles estão distraídos com os próprios arquivos de documento. Não há limite para o número de documentos em um dossiê. Todos os documentos poderão ser exibidos e baixados para todos os atores 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. Isso pode ser qualquer texto em qualquer lugar do documento. Ao adicionar atores, você pode definir o espaço reservado com o parâmetro de espaço reservado. Por exemplo: signature1, signature2 etc...
Actors
A terceira etapa consiste em adicionar atores aos documentos. Isso é feito com a Ação Actor_Create usando o dossierId e documentId corretos.
Iniciar fluxo de trabalho
Para iniciar um fluxo de trabalho e enviar efetivamente convites a todos os atores para assinar ou baixar documentos na ordem fornecida, use a ação Dossiers_StartWorkflow com a dossierId correta.
Usar um gatilho para ser notificado sobre alterações de status
Para obter o documento depois de assinado, assine notificações usando um gatilho. Para receber a notificação de status, especifique 'status' no campo Eventos.
Baixar o dossiê
Quando o gatilho for notificado de uma atualização de status, verifique se o status do documento está "Concluído". A partir desse momento, é possível baixar todos os documentos no dossiê em um único zipfile. Se for especificado nas configurações dentro da plataforma PKIsigning que um audittrail deve ser gerado, isso também será incluído.
Problemas e limitações conhecidos
Nenhum problema é conhecido no momento da publicação.
Erros e soluções comuns
Nenhuma atualização de status por meio 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 que os convites não sejam confrontados com problemas relacionados 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, pkisigning suporte para completar o saldo de crédito ou limpar quaisquer dossiês não relacionados com atores na lixeira na plataforma. Os créditos não utilizados ficarão disponíveis novamente.
perguntas frequentes
Consulte nossa base de dados de conhecimento ou entre em contato conosco em support@pkisigning.nl
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar ator |
Altera os dados de um ator específico. |
| Atualizar documento |
Altera os dados de um documento específico. |
| Atualizar solicitação |
Altera os dados de uma solicitação específica. |
| Criar ator |
Cria um novo ator e adiciona-o a um documento. |
| Criar documento |
Cria um novo documento e o adiciona a uma solicitação específica. |
| Criar solicitação |
Crie uma nova solicitação. |
| Enviar solicitação |
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. |
| Excluir documento |
Exclui permanentemente um documento específico. |
| Excluir uma solicitação |
Exclui permanentemente uma solicitação específica. |
| Obter dados de solicitação |
Retorna todos os dados (meta)para uma solicitação específica. |
| Obter dados do ator |
Retorna todos os dados para um ator específico. |
| Obter dados do ator por documento |
Retorna todos os dados de todos os atores para 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 |
Retorna todos os dados (meta)de um documento específico. |
| Obter grupos de trabalho para a organização |
Retorna uma lista de todos os grupos de trabalho para 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. |
| 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 uma solicitação específica. |
| Solicitação de download |
Baixa uma solicitação e seu conteúdo como um arquivo .zip. |
Atualizar ator
Altera os dados de um ator específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
|
ID do ator
|
actorId | True | guid |
ID exclusiva de um ator. |
|
Ação
|
action | True | string |
Ação que o ator deve executar. |
|
Nome
|
firstname | True | string |
Nome do ator. |
|
Prefixo
|
prefix | string |
Prefixo do ator. |
|
|
Sobrenome
|
lastname | True | string |
Sobrenome do ator. |
|
Endereço de email
|
True | string |
Endereço de email do ator. |
|
|
Número de telefone celular
|
mobile | True | string |
Número de telefone celular do ator. |
|
Data limite
|
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. |
|
Usar verificação forte
|
validateRealIdentity | True | boolean |
Use um método mais forte de identificação para este ator. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
mensagem
|
message | string |
Retornos
- Corpo
- ExtendedSignerModel
Atualizar documento
Altera os dados de um documento específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
|
Nome do documento
|
name | string |
Nome de um documento específico |
|
|
Nome do arquivo do documento
|
filename | string |
Nome do arquivo para um documento específico |
|
|
Tipo de documento
|
documentType | True | string |
O tipo de um documento específico. (Por exemplo, PDF regular, instrução fiscal, relatório de auditores etc.). |
Retornos
Metadados gerais do documento
- Corpo
- DocumentMetaDataModel
Atualizar solicitação
Altera os dados de uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
Nome da solicitação
|
name | True | string |
Nome de uma solicitação específica. |
|
ID do grupo de trabalho
|
workgroupId | guid |
ID exclusiva de um grupo de trabalho. |
|
|
Nível de liberação de segurança
|
clearancelevel | True | integer |
Nível de liberação de segurança para uma solicitação específica. |
|
Proprietário da solicitação
|
owner |
Usuário que é o proprietário de uma solicitação específica. |
Retornos
- Corpo
- RequestModel
Criar ator
Cria um novo ator e adiciona-o a um documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
|
Ação
|
action | True | string |
Ação que o ator deve executar. |
|
Nome
|
firstname | True | string |
Nome do ator. |
|
Prefixo
|
prefix | string |
Prefixo do ator. |
|
|
Sobrenome
|
lastname | True | string |
Sobrenome do ator. |
|
Endereço de email
|
True | string |
Endereço de email do ator. |
|
|
Número de telefone celular
|
mobile | True | string |
Número de telefone celular do ator. |
|
Data limite
|
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. |
|
Usar verificação forte
|
validateRealIdentity | True | boolean |
Use um método mais forte de identificação para este ator. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
mensagem
|
message | string | ||
|
Campo de assinatura
|
fieldName | string |
O nome de um campo de assinatura existente no documento para esse ator assinar. |
|
|
Placeholder
|
placeholder | string |
O texto de um espaço reservado específico no documento em que o ator deve colocar uma assinatura. |
Retornos
- Corpo
- ExtendedSignerModel
Criar documento
Cria um novo documento e o adiciona a uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação à qual este documento pertencerá. |
|
File
|
file | True | file |
O arquivo a ser processado (somente tipos de arquivo específicos). |
Retornos
Metadados gerais do documento
- Corpo
- DocumentMetaDataModel
Criar solicitação
Crie uma nova solicitação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da solicitação
|
name | True | string |
Nome de uma solicitação específica. |
|
ID do grupo de trabalho
|
workgroupId | guid |
ID exclusiva de um grupo de trabalho. |
|
|
Nível de liberação de segurança
|
clearancelevel | True | integer |
Nível de liberação de segurança para uma solicitação específica. |
|
Proprietário da solicitação
|
owner |
Usuário que é o proprietário de uma solicitação específica. |
Retornos
- Corpo
- RequestModel
Enviar solicitação
Inicia o fluxo de trabalho e envia um convite para o primeiro ator na fila para uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
Excluir ator
Exclui permanentemente um ator específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
|
ID do ator
|
actorId | True | guid |
ID exclusiva de um ator. |
Excluir documento
Exclui permanentemente um documento específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
Excluir uma solicitação
Exclui permanentemente uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
Obter dados de solicitação
Retorna todos os dados (meta)para uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
Chave de autenticação
|
callbackAuthenticationKey | string |
Chave de autenticação, conforme fornecido pelo gatilho. |
Retornos
- Corpo
- RequestModel
Obter dados do ator
Retorna todos os dados para um ator específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
|
ID do ator
|
actorId | True | guid |
ID exclusiva de um ator. |
Retornos
- Corpo
- ExtendedSignerModel
Obter dados do ator por documento
Retorna todos os dados de todos os atores para um documento específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
|
Ação concluída
|
hasActed | boolean |
Retorna apenas atores que tenham ou não completaram sua ação, deixe em branco para retornar todos os atores. |
Retornos
- response
- array of ExtendedSignerModel
Obter dados do ator por solicitação
Retorna todos os dados de todos os atores para uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
O ator agiu sob a solicitação
|
hasActed | boolean |
Leia apenas o valor para verificar se um ator já atuou no documento. |
Retornos
- response
- array of ExtendedSignerModel
Obter dados do documento
Retorna todos os dados (meta)de um documento específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
|
ID do documento
|
documentId | True | guid |
ID exclusiva de um documento. |
Retornos
Metadados gerais do documento
- Corpo
- DocumentMetaDataModel
Obter grupos de trabalho para a organização
Retorna uma lista de todos os grupos de trabalho para uma organização específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organisationId | True | guid |
ID exclusiva de uma organização. |
Retornos
- response
- array of OrganisationWorkgroup
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.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organisationId | True | guid |
ID exclusiva de uma organização. |
|
Nome de usuário
|
username | True |
Emailaddress do usuário |
Retornos
- response
- array of OrganisationWorkgroup
Reenviar convite
Reenvia o convite para o ator atual na fila para uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
Retirar convite
Retira o convite para o ator atual na fila para uma solicitação específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
Solicitação de download
Baixa uma solicitação e seu conteúdo como um arquivo .zip.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
requestId | True | guid |
ID exclusiva de uma solicitação. |
Retornos
- response
- file
Gatilhos
| Quando um evento ocorre em uma solicitação |
Registre uma URL para retorno de chamada após uma alteração de status. A plataforma PKIsigning relatará quaisquer statusupdates de dossiês dentro dessa organização para esta url. |
Quando um evento ocorre em uma solicitação
Registre uma URL para retorno de chamada após uma alteração de status. A plataforma PKIsigning relatará quaisquer statusupdates de dossiês dentro dessa organização para esta url.
Parâmetros
| Nome | Chave | Obrigató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 exclusiva de uma organização. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Solicitação
|
PkisId | guid |
ID exclusiva de uma solicitação. |
|
Status de solicitação
|
DossierStatus | string |
Status do dossiê. |
|
Reason
|
Reason | string |
Motivo da alteração. |
|
Chave de autenticação
|
AuthenticationKey | string |
Cabeçalho para obter metadados na solicitação. |
Definições
ExtendedSignerModel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campo de assinatura
|
fieldName | string |
O nome de um campo de assinatura existente no documento para esse ator assinar. |
|
Placeholder
|
placeholder | string |
O texto de um espaço reservado específico no documento em que o ator deve colocar uma assinatura. |
|
Ação
|
action | string |
Ação que o ator deve executar. |
|
Nome
|
firstname | string |
Nome do ator. |
|
Prefixo
|
prefix | string |
Prefixo do ator. |
|
Sobrenome
|
lastname | string |
Sobrenome do ator. |
|
Endereço de email
|
string |
Endereço de email do ator. |
|
|
Número de telefone celular
|
mobile | string |
Número de telefone celular do ator. |
|
Data limite
|
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. |
|
Usar verificação forte
|
validateRealIdentity | boolean |
Use um método mais forte de identificação para este ator. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
mensagem
|
message | string | |
|
ID do ator
|
id | guid |
ID exclusiva de um ator específico. |
|
Data de conclusão
|
signingDate | date-time |
A data e a hora em que o ator executou sua ação. |
|
Ação concluída
|
hasSigned | boolean | |
|
Nome completo
|
fullName | string |
Nome combinado, 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 de envio de mensagem de email para um ator
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Atividade de email
|
event | string |
Atividade de email para uma solicitação e ator específicos. |
|
Informações do SMTP
|
reason | string |
Informações de SMTP para um email enviado a um ator específico como parte de uma solicitação. |
|
Data do email
|
timestamp | date-time |
Data de um email enviado a um ator específico como parte de uma solicitação. |
|
Tipo de email
|
pkisMessageType | string |
Digite um email enviado a um ator específico como parte de uma solicitação (por exemplo, Convidar, Lembrete etc.). |
|
ID da solicitação de email
|
pkisInviteId | string |
ID exclusiva de um email enviado a um ator específico como parte de uma solicitação. |
|
Endereço de email
|
string |
Endereço de email para um email enviado a um ator específico como parte de uma solicitação. |
SignerModel
Tipo especial de ator
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Ação
|
action | string |
Ação que o ator deve executar. |
|
Nome
|
firstname | string |
Nome do ator. |
|
Prefixo
|
prefix | string |
Prefixo do ator. |
|
Sobrenome
|
lastname | string |
Sobrenome do ator. |
|
Endereço de email
|
string |
Endereço de email do ator. |
|
|
Número de telefone celular
|
mobile | string |
Número de telefone celular do ator. |
|
Data limite
|
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. |
|
Usar verificação forte
|
validateRealIdentity | boolean |
Use um método mais forte de identificação para este ator. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
mensagem
|
message | string | |
|
Campo de assinatura
|
fieldName | string |
O nome de um campo de assinatura existente no documento para esse ator assinar. |
|
Placeholder
|
placeholder | string |
O texto de um espaço reservado específico no documento em que o ator deve colocar uma assinatura. |
DocumentMetaDataModel
Metadados gerais do documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do documento
|
name | string |
Nome de um documento específico. |
|
Última atualização de documento
|
lastUpdate | date-time |
Data da última atualização de um documento específico. |
|
Número de páginas de documentos
|
pages | integer |
Número de páginas para um documento específico. |
|
Data de criação do documento
|
created | date-time |
Data da criação de um documento específico. |
|
ID do documento
|
id | guid |
ID exclusiva de um documento. |
|
Status do documento
|
status | string |
Status 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 documento
|
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 para um documento específico. |
|
Campos de assinatura em branco
|
containsBlankSignatureFields | boolean |
Indica se um documento específico contém campos de assinatura em branco. |
|
Atores de documentos
|
actors | array of ExtendedSignerModel |
Lista de todos os atores de um documento específico. |
|
ID da Solicitação
|
requestId | guid |
ID exclusiva de uma solicitação. |
|
Índice de solicitação
|
dossierIndex | integer |
O índice de todos os documentos que pertencem a uma solicitação específica. |
|
documentSize
|
documentSize | integer |
O tamanho de um documento que pertence a uma solicitação específica. |
|
documentType
|
documentType | string |
O tipo de um documento que pertence a uma solicitação específica. |
SignatureData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos de entidade de 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 da 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, conforme fornecido por um ator específico no momento da assinatura. |
|
Assinatura eletrônica qualificada
|
euQualified | boolean |
Indica se uma assinatura específica é qualificada (QeS) em conformidade com as regulamentações do eIDAS. |
|
Assinatura Eletrônica Avançada
|
advanced | boolean |
Indica se uma assinatura específica é avançada (AeS) em conformidade com regulamentos eIDAS. |
|
ESeal qualificado
|
eSeal | boolean |
Indica se um certificado específico usado para assinatura ou vedação é um regulamento eIDAS qualificado em conformidade com eSeal. |
|
Endereço IP do ator
|
ipAddress | string |
O endereço IP de um ator específico |
|
Campo 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
value
|
value | string |
SignatureField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do campo de assinatura
|
name | string |
Nome de um campo de assinatura específico |
|
Página de campo de assinatura
|
page | integer |
Página em que 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 ela é colocada 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 ela é colocada em um documento específico. |
|
Campo de assinatura hight
|
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. |
OrganizationWorkgroup
Um grupo de trabalho usado em um dossiê
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do grupo de trabalho
|
id | guid |
ID exclusiva de um grupo de trabalho |
|
Nome do grupo de trabalho
|
name | string |
Nome de um grupo de trabalho específico |
RequestModel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Solicitação
|
id | guid |
ID exclusiva de uma solicitação |
|
Nome da solicitação
|
dossierName | string |
Nome de uma solicitação específica. |
|
Solicitar documentos
|
documents | array of DocumentModel |
Lista de documentos incluídos nesta solicitação. |
|
Status de solicitação
|
status | string |
Status de uma solicitação específica. (Por exemplo, novo, concluído, etc.). |
|
Solicitar atores
|
actors | array of ExtendedSignerModel |
Lista de todos os atores para uma solicitação específica. |
|
Assinaturas de documento
|
signatures | array of SignatureData |
Lista de todas as assinaturas para uma solicitação específica. |
|
Tipo de solicitação
|
dossierType | string |
O tipo para uma solicitação específica. (E.g. PDF, SBR Assurance etc.). |
|
Motivo de cancelamento
|
reasons | string |
Motivo do cancelamento de uma solicitação específica por um usuário ou um ator. |
|
Anotação do signatário
|
signerNote | string |
Observe para um ou mais atores que não têm outra ação além de assinar. |
|
Nota do destinatário
|
recipientNote | string |
Observe um ou mais atores que não têm outra ação a não ser baixar. |
|
Nota do aprovador
|
accorderNote | string |
Observe um ou mais atores que não têm outra ação além de aprovar a solicitação. |
|
Data de expiração da solicitação
|
expires | date-time |
Data e hora de expiração para uma solicitação específica. |
|
Informações de status
|
emailActivity | array of EmailActivity |
Informações de status sobre o processo de execução da ação pelo ator. |
|
Minha solicitação
|
myDossier | boolean |
Indica se você é o proprietário de uma solicitação específica. |
|
ID do grupo de trabalho
|
workgroup | guid |
ID exclusiva de um grupo de trabalho. |
|
Nível de liberação de segurança
|
clearancelevel | integer |
Nível de liberação de segurança para uma solicitação específica. |
DocumentModel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
id | guid |
ID exclusiva 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 solicitação
|
dossierIndex | integer |
O índice de todos os documentos que pertencem a uma solicitação específica. |
|
Status do documento
|
documentstatus | string |
Status de um documento específico. (Por exemplo, novo, concluído, etc.). |
|
Atores de documentos
|
actors | array of SignerModel |
Lista de todos os atores de um documento específico. |
arquivo
Esse é o tipo de dados básico 'file'.