Taktikal Core (Pré-visualização)
Com o Taktikal Core, você tem a capacidade de assinar, lacrar, autenticar e obter informações detalhadas sobre seus processos de assinatura.
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 | Taktikal |
| URL | https://docs.taktikal.com/ |
| help@taktikal.com |
| Metadados do conector | |
|---|---|
| Editora | Taktikal |
| Sítio Web | https://taktikal.com/ |
| Política de privacidade | https://www.taktikal.com/privacy |
| Categorias | Produtividade |
Taktikal Core APIs é uma maneira poderosa de construir novas soluções em sua própria interface e integrar com as soluções que já estão em operação.
Os documentos podem ser enviados para assinatura diretamente dos seus próprios sistemas e, após a assinatura, os documentos e metadados relacionados podem ser automaticamente enviados de volta para o sistema de documentos. Você também pode monitorar o status dos documentos no processo de assinatura e solicitar o status com base em números de identificação ou outros identificadores exclusivos.
Pré-requisitos
Para usar a API Taktikal Core, entre em contato com nossa equipe de vendas para sales@taktikal.is adquirir as credenciais de API necessárias.
Como obter credenciais
Entre em contato com nossa equipe de vendas para criar acesso e obter suas credenciais de API.
Introdução ao conector
A api principal pode obter documentos assinados, autenticar usando e-ID islandês e gerenciar todos os processos de assinatura
- Para autenticação, use /Auth/Start para iniciar um processo de autenticação e, em seguida, /Auth/Poll para verificar se o status da autenticação.
- Para assinar um único documento, chame /gerenciamento/assinatura para um único documento e /gerenciamento/assinatura/sequencial para uma assinatura em massa de vários documentos.
- Para obter um log detalhado sobre um processo de assinatura, chame /signing/activity/{ProcessKey}.
Problemas conhecidos e limitações
- As solicitações precisam ter um cabeçalho de autorização para autenticação básica. Essa é a empresaKey e API-Key
- No momento, apenas assinaturas qualificadas estão com um e-ID islandês.
- O PDF fornecido deve ser ab Base64 string.
- Os signatários devem ter um e-mail válido e um número de telefone celular.
Erros e soluções comuns
Atualmente, apenas PDF são aceitos para assinatura.
FAQ
Mais informações sobre a API podem ser encontradas em https://docs.taktikal.com
Iniciar um processo de assinatura é uma única solicitação POST. Para iniciar um processo de assinatura, é necessário um documento PDF válido e uma lista de signatários que precisam assinar o documento. Taktikal irá lidar com a exibição do documento para o signatário, também se um communicationDeliveryType for selecionado, Taktikal enviará ao signatário um SMS ou e-mail com um link para assinar. Depois que o documento for assinado por todos os participantes, a Taktikal enviará o documento para os caminhos de entrega relevantes que estão registrados.
Uma flowKey é uma chave fornecida pela Taktikal. Essa chave informará ao Taktikal como lidar com essa solicitação. Para alguns flowKeys, Taktikal cuidará da criação do documento. Também controlará onde o documento assinado é entregue após a assinatura.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave da Empresa | securestring | A chave da empresa para esta api | Verdade |
| Chave de API | securestring | A chave de API para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
|
Atualizar um signatário para determinados Process |
As propriedades do signatário podem ser atualizadas com base no fornecimento da ProcessKey e da SigneeKey. |
| Cancelar o processo de assinatura sequencial |
Cancele o processo de assinatura sequencial com base em uma determinada chave de sequência. Pode ser fornecido um usuário (e-mail) que cancela o processo sequencial. |
| Cancelar um processo de assinatura |
Cancele o processo de assinatura com base em uma determinada chave de processo. |
| Cria novos processos de assinatura sequencial (em massa) |
Cria um novo processo de Assinatura Sequencial (em massa) com um ou mais Processos de Assinatura. Cada processo de assinatura em uma sequência tem um ou mais signatários. Exemplo:
A documentação detalhada pode ser encontrada em https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ |
| Cria um novo processo de assinatura com um ou mais signatários |
Cria um novo processo de assinatura com um ou mais signatários. |
| Inicia um processo de autenticação com e-id islandês |
A autenticação com o e-id islandês pode ser feita com um telemóvel ou aplicação Audkenni.
flowKey deve ser sempre fornecido e é acessível no portal Taktikal. |
| Inicia um processo de autenticação com e-id islandês para um processo de assinatura sequencial |
A autenticação com o e-id islandês pode ser feita com um telemóvel ou aplicação Audkenni.
|
|
Obtém o processo de assinatura por process |
Get's o processo de assinatura por processkey e signeeKey. |
| Obtém o registro de atividades de um usuário (e-mail) por um período específico |
Obtém o registro de atividades de um usuário por um período. |
| Obtém o registro de atividades de uma empresa |
Obtém o registro de atividades de uma empresa |
| Obtém o registro de atividades para o processo de assinatura |
Obtenha o Registro de atividades para um processo de assinatura. |
| Sela um documento PDF |
Sela um documento PDF fornecido como uma cadeia de caracteres base64. |
| Sela um documento XML |
Sela um documento XML fornecido como uma cadeia de caracteres base64. |
| Verifica o status da autenticação de um usuário usando seu e-id islandês |
Após uma resposta bem-sucedida de /Auth/Start, um AuthRequestId é retornado e usado para verificar se a autenticação foi concluída. Se a autenticação for concluída e for bem-sucedida, o objeto do cliente será preenchido dependendo do LookupType. O tipo de pesquisa indica que o tipo de informação é recuperada para o Registo Nacional Islandês. Há três conjuntos de dados diferentes retornados dependendo do LookupType:
Se 'LookupType.NameAddressFamily' estiver selecionado, os valores extras retornados serão retornados em 'Meta'. Se a resposta tiver erros ou não for concluída, o objeto do cliente será nulo e um StatusMessage terá uma mensagem detalhada. |
Atualizar um signatário para determinados ProcessKey e SigneeKey
As propriedades do signatário podem ser atualizadas com base no fornecimento da ProcessKey e da SigneeKey.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma pessoa que assina um processo de assinatura única.
|
SigneeKey | True | string |
Identificador exclusivo de uma pessoa que assina um processo de assinatura única. |
|
Identificador exclusivo para um único processo de assinatura de documento.
|
ProcessKey | True | string |
Identificador exclusivo para um único processo de assinatura de documento. |
|
e-mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
signeeKey
|
signeeKey | True | string | |
|
processKey
|
processKey | True | string | |
|
razão
|
reason | string | ||
|
utilizador
|
user | string |
Devoluções
Signatário
- Signatário
- Signee
Cancelar o processo de assinatura sequencial
Cancele o processo de assinatura sequencial com base em uma determinada chave de sequência. Pode ser fornecido um usuário (e-mail) que cancela o processo sequencial.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador de processo de assinatura sequencial que deve ser fornecido.
|
SequenceKey | True | string |
Identificador de processo de assinatura sequencial que deve ser fornecido. |
|
Somente o usuário que iniciou o processo de assinatura pode cancelá-lo.
|
User | True | string |
Somente o usuário que iniciou o processo de assinatura pode cancelá-lo. |
Devoluções
Assinatura sequencial
- Assinatura sequencial
- SequentialSigning
Cancelar um processo de assinatura
Cancele o processo de assinatura com base em uma determinada chave de processo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo para um único processo de assinatura de documento.
|
ProcessKey | string |
Identificador exclusivo para um único processo de assinatura de documento. |
|
|
Objeto String, geralmente o e-mail do funcionário que tem acesso ao portal.
|
User | string |
Objeto String, geralmente o e-mail do funcionário que tem acesso ao portal. |
Devoluções
Processo de Assinatura
- Processo de Assinatura
- SigningProcess
Cria novos processos de assinatura sequencial (em massa)
Cria um novo processo de Assinatura Sequencial (em massa) com um ou mais Processos de Assinatura. Cada processo de assinatura em uma sequência tem um ou mais signatários.
Exemplo:
- Uma empresa quer os documentos A e B assinados. O signatário X deve assinar o documento A e B, o signatário Y deve assinar o documento A e o signatário Z deve assinar o documento B.
- Em seguida, um novo CreateSequentalSigning com matriz de dois objetos CreateSigningProcess. Os signatários X e Y são adicionados como signatários para CreateSigningProcess para o Documento A e os signatários X e Z são adicionados como signatários para o Documento B.
A documentação detalhada pode ser encontrada em https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
pdfDocumento
|
pdfDocument | string |
é uma cadeia de caracteres base64 do documento a ser assinado. Isso não é necessário se o flowKey cuidar da criação do documento. |
|
|
pdfFileName
|
pdfFileName | string |
Se PdfDocument estiver sendo usado, um valor para o nome do arquivo precisa ser fornecido. |
|
|
chave de fluxo
|
flowKey | True | string |
O FlowKey é fornecido pela Taktikal. Essa chave informará ao Taktikal como lidar com essa solicitação. Para alguns flowKeys, Taktikal cuidará da criação do documento. Também controlará onde o documento assinado é entregue após a assinatura. |
|
processKey
|
processKey | string | ||
|
nome
|
name | string | ||
|
SSN
|
ssn | string | ||
|
Número de telefone
|
phoneNumber | string | ||
|
e-mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
razão
|
reason | string | ||
|
ocultarCódigo Pessoal
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
linguagem
|
language | string | ||
|
Dicionário
|
meta | object |
Cadeia de dicionário,String<> |
|
|
fileName
|
fileName | string | ||
|
arquivoConteúdo
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
TipoDeConteúdo
|
contentType | string | ||
|
URL
|
url | string | ||
|
descrição
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
O valor predefinido é falso. Se definido como true, todos os signatários precisam usar o e-Id para autenticar antes de poderem visualizar o documento. |
|
|
signInOrder
|
signInOrder | boolean |
O valor predefinido é falso. Controlará a ordem dos signatários. Para começar, ele enviará apenas uma solicitação de assinatura para a primeira pessoa na lista de signatários. Depois de ter assinado o próximo signatário e assim por diante. |
|
|
assinaturaLocalização
|
signatureLocation | string |
Pode ser BottomLastPage ou o valor padrão TopFirstPage. Controlará onde exibir a assinatura no documento. |
|
|
utilizador
|
user | string |
endereço de e-mail do usuário que envia a solicitação. Pode estar vazio. |
|
|
seqüênciaChave
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
achatarDocumento
|
flattenDocument | boolean |
O valor predefinido é falso. Se definido como true, tentaremos nivelar os campos de entrada de documentos. |
|
|
reminderRule
|
reminderRule | string |
Envia lembretes, deixa vazio para nenhum. formato deve ser "firstReminder after x days:Then every y days", por exemplo, "1:3" enviará um lembrete após 1 dia e, em seguida, a cada três dias depois disso. Deixe vazio ou nulo para nenhum lembrete, os valores válidos serão para o primeiro lembrete a ser enviado entre 0-30 dias (0 significa sem lembrete) e, em seguida, enviar a cada 0-15 dias (0, novamente, significando sem lembretes, Então 0:10 só enviaria lembrete a cada 10 dias, enquanto 12:0 enviaria apenas um lembrete após 12 dias |
|
|
utilizador
|
user | True | string |
O usuário que inicia o processo de assinatura sequencial |
|
requiresAuth
|
requiresAuth | boolean |
O valor predefinido é falso. Se definido como true, todos os signatários precisam usar o e-Id para autenticar antes de poderem visualizar o documento. |
|
|
signInOrder
|
signInOrder | boolean |
O valor predefinido é falso. Controlará a ordem dos signatários. Para começar, ele enviará apenas uma solicitação de assinatura para a primeira pessoa na lista de signatários. Depois de ter assinado o próximo signatário e assim por diante. |
Devoluções
Assinatura sequencial
- Assinatura sequencial
- SequentialSigning
Cria um novo processo de assinatura com um ou mais signatários
Cria um novo processo de assinatura com um ou mais signatários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
pdfDocumento
|
pdfDocument | string |
é uma cadeia de caracteres base64 do documento a ser assinado. Isso não é necessário se o flowKey cuidar da criação do documento. |
|
|
pdfFileName
|
pdfFileName | string |
Se PdfDocument estiver sendo usado, um valor para o nome do arquivo precisa ser fornecido. |
|
|
chave de fluxo
|
flowKey | True | string |
O FlowKey é fornecido pela Taktikal. Essa chave informará ao Taktikal como lidar com essa solicitação. Para alguns flowKeys, Taktikal cuidará da criação do documento. Também controlará onde o documento assinado é entregue após a assinatura. |
|
processKey
|
processKey | string | ||
|
nome
|
name | string | ||
|
SSN
|
ssn | string | ||
|
Número de telefone
|
phoneNumber | string | ||
|
e-mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
razão
|
reason | string | ||
|
ocultarCódigo Pessoal
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
linguagem
|
language | string | ||
|
Dicionário
|
meta | object |
Cadeia de dicionário,String<> |
|
|
fileName
|
fileName | string | ||
|
arquivoConteúdo
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
TipoDeConteúdo
|
contentType | string | ||
|
URL
|
url | string | ||
|
descrição
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
O valor predefinido é falso. Se definido como true, todos os signatários precisam usar o e-Id para autenticar antes de poderem visualizar o documento. |
|
|
signInOrder
|
signInOrder | boolean |
O valor predefinido é falso. Controlará a ordem dos signatários. Para começar, ele enviará apenas uma solicitação de assinatura para a primeira pessoa na lista de signatários. Depois de ter assinado o próximo signatário e assim por diante. |
|
|
assinaturaLocalização
|
signatureLocation | string |
Pode ser BottomLastPage ou o valor padrão TopFirstPage. Controlará onde exibir a assinatura no documento. |
|
|
utilizador
|
user | string |
endereço de e-mail do usuário que envia a solicitação. Pode estar vazio. |
|
|
seqüênciaChave
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
achatarDocumento
|
flattenDocument | boolean |
O valor predefinido é falso. Se definido como true, tentaremos nivelar os campos de entrada de documentos. |
|
|
reminderRule
|
reminderRule | string |
Envia lembretes, deixa vazio para nenhum. formato deve ser "firstReminder after x days:Then every y days", por exemplo, "1:3" enviará um lembrete após 1 dia e, em seguida, a cada três dias depois disso. Deixe vazio ou nulo para nenhum lembrete, os valores válidos serão para o primeiro lembrete a ser enviado entre 0-30 dias (0 significa sem lembrete) e, em seguida, enviar a cada 0-15 dias (0, novamente, significando sem lembretes, Então 0:10 só enviaria lembrete a cada 10 dias, enquanto 12:0 enviaria apenas um lembrete após 12 dias |
Devoluções
Processo de Assinatura
- Processo de Assinatura
- SigningProcess
Inicia um processo de autenticação com e-id islandês
A autenticação com o e-id islandês pode ser feita com um telemóvel ou aplicação Audkenni.
- Usando o telefone celular: O AuthenticationContextType deve ser definido como 'Sim' e o phoneNumber deve ser definido como um número de telefone celular islandês. O ssn é ignorado.
- Usando o aplicativo Audkenni: O AuthenticationContextType deve ser definido como 'App' e o ssn deve ser definido como um número de segurança social Icdlandic. O número de telefone é ignorado.
flowKey deve ser sempre fornecido e é acessível no portal Taktikal.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
SSN
|
ssn | string | ||
|
Número de telefone
|
phoneNumber | string | ||
|
chave de fluxo
|
flowKey | True | string |
Identificador exclusivo de um Fluxo que pertence a uma Empresa. |
|
authenticationContextType
|
authenticationContextType | True | string |
Devoluções
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Inicia um processo de autenticação com e-id islandês para um processo de assinatura sequencial
A autenticação com o e-id islandês pode ser feita com um telemóvel ou aplicação Audkenni.
- Usando o telefone celular: O AuthenticationContextType deve ser definido como 'Sim' e o phoneNumber deve ser definido como um número de telefone celular Ucelandic. O ssn é ignorado.
- Usando o aplicativo Audkenni: O AuthenticationContextType deve ser definido como 'App' e o ssn deve ser definido como um número de segurança social Icdlandic. O número de telefone é ignorado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo para processos de assinatura de uma sequência (em massa).
|
SequenceKey | True | string |
Identificador exclusivo para processos de assinatura de uma sequência (em massa). |
|
seqüênciaChave
|
sequenceKey | True | string | |
|
loginDica
|
loginHint | True | string | |
|
authenticationContextType
|
authenticationContextType | True | string |
Devoluções
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Obtém o processo de assinatura por processKey e signeeKey
Get's o processo de assinatura por processkey e signeeKey.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo para um único processo de assinatura de documento.
|
ProcessKey | True | string |
Identificador exclusivo para um único processo de assinatura de documento. |
|
Identificador exclusivo de uma pessoa que assina um processo de assinatura única.
|
SigneeKey | True | string |
Identificador exclusivo de uma pessoa que assina um processo de assinatura única. |
|
Um User Agent é um software que atua para um usuário, como um navegador da Web ou cliente de e-mail.
|
UserAgent | string |
Um User Agent é um software que atua para um usuário, como um navegador da Web ou cliente de e-mail. |
Devoluções
Processo de Assinatura
- Processo de Assinatura
- SigningProcess
Obtém o registro de atividades de um usuário (e-mail) por um período específico
Obtém o registro de atividades de um usuário por um período.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O e-mail do usuário.
|
User | string |
O e-mail do usuário. |
|
|
A data de início do log a ser pesquisado, deve ser uma data menor do que EndDate.
|
StartDate | True | date-time |
A data de início do log a ser pesquisado, deve ser uma data menor do que EndDate. |
|
Data de término do log a ser pesquisado, deve ser uma data maior do que StartDate.
|
EndDate | True | date-time |
Data de término do log a ser pesquisado, deve ser uma data maior do que StartDate. |
|
Use se a ser filtrado em um único processo de assinatura.
|
ProcessKey | string |
Use se a ser filtrado em um único processo de assinatura. |
|
|
Pode ser usado apenas para obter atividade para um tipo de fluxo específico.
|
FlowType | string |
Pode ser usado apenas para obter atividade para um tipo de fluxo específico. |
|
|
Usado para paginar o conjunto de resultados e retornar apenas N muitos resultados.
|
Take | integer |
Usado para paginar o conjunto de resultados e retornar apenas N muitos resultados. |
|
|
Usado para paginar o conjunto de resultados e ignorar os primeiros resultados N.
|
Skip | integer |
Usado para paginar o conjunto de resultados e ignorar os primeiros resultados N. |
|
|
Se tiver um valor, só retornamos registros que correspondam a essa flowKey
|
FlowKey | string |
Se ele tiver um valor, retornaremos apenas registros que correspondam a esse flowKey. |
Devoluções
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtém o registro de atividades de uma empresa
Obtém o registro de atividades de uma empresa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
A data de início do log a ser pesquisado, deve ser uma data menor do que EndDate.
|
StartDate | True | date-time |
A data de início do log a ser pesquisado, deve ser uma data menor do que EndDate. |
|
Data de término do log a ser pesquisado, deve ser uma data maior do que StartDate.
|
EndDate | True | date-time |
Data de término do log a ser pesquisado, deve ser uma data maior do que StartDate. |
|
Usado para paginar o conjunto de resultados e retornar apenas N muitos resultados.
|
Take | integer |
Usado para paginar o conjunto de resultados e retornar apenas N muitos resultados. |
|
|
Usado para paginar o conjunto de resultados e ignorar os primeiros resultados N.
|
Skip | integer |
Usado para paginar o conjunto de resultados e ignorar os primeiros resultados N. |
|
|
O e-mail do usuário.
|
User | string |
O e-mail do usuário. |
|
|
Pode ser usado apenas para obter atividade para um tipo de fluxo específico.
|
FlowType | string |
Pode ser usado apenas para obter atividade para um tipo de fluxo específico. |
|
|
Se ele tiver um valor, retornaremos apenas registros que correspondam a esse flowKey.
|
FlowKey | string |
Se ele tiver um valor, retornaremos apenas registros que correspondam a esse flowKey. |
Devoluções
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtém o registro de atividades para o processo de assinatura
Obtenha o Registro de atividades para um processo de assinatura.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O e-mail do usuário.
|
User | string |
O e-mail do usuário. |
|
|
A data de início do log a ser pesquisado, deve ser uma data menor do que EndDate.
|
StartDate | True | date-time |
A data de início do log a ser pesquisado, deve ser uma data menor do que EndDate. |
|
Data de término do log a ser pesquisado, deve ser uma data maior do que StartDate.
|
EndDate | True | date-time |
Data de término do log a ser pesquisado, deve ser uma data maior do que StartDate. |
|
Use se a ser filtrado em um único processo de assinatura.
|
ProcessKey | True | string |
Use se a ser filtrado em um único processo de assinatura. |
|
Pode ser usado apenas para obter atividade para um tipo de fluxo específico.
|
FlowType | string |
Pode ser usado apenas para obter atividade para um tipo de fluxo específico. |
|
|
usado para paginar o conjunto de resultados e retornar apenas N muitos resultados.
|
Take | integer |
usado para paginar o conjunto de resultados e retornar apenas N muitos resultados. |
|
|
usado para paginar o conjunto de resultados e ignorar os primeiros resultados N.
|
Skip | integer |
usado para paginar o conjunto de resultados e ignorar os primeiros resultados N. |
|
|
Se ele tiver um valor, retornaremos apenas registros que correspondam a esse flowKey.
|
FlowKey | string |
Se ele tiver um valor, retornaremos apenas registros que correspondam a esse flowKey. |
Devoluções
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Sela um documento PDF
Sela um documento PDF fornecido como uma cadeia de caracteres base64.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
pdfDocumento
|
pdfDocument | True | string |
Um Base64String do documento PDF a ser lacrado. |
|
chave de fluxo
|
flowKey | True | string |
Identificador exclusivo de um Fluxo que pertence a uma Empresa. |
|
razão
|
reason | string |
definir o motivo para exibir no selo |
|
|
languageType
|
languageType | string |
Devoluções
SelagemResposta
- SelagemResposta
- SealingResponse
Sela um documento XML
Sela um documento XML fornecido como uma cadeia de caracteres base64.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
xmlDocument
|
xmlDocument | True | string |
Base64String do documento XML a selar |
|
chave de fluxo
|
flowKey | True | string |
Uma flowKey válida fornecida pela Taktikal que pode ser usada para selagem |
Devoluções
Objeto
- response
- object
Verifica o status da autenticação de um usuário usando seu e-id islandês
Após uma resposta bem-sucedida de /Auth/Start, um AuthRequestId é retornado e usado para verificar se a autenticação foi concluída. Se a autenticação for concluída e for bem-sucedida, o objeto do cliente será preenchido dependendo do LookupType. O tipo de pesquisa indica que o tipo de informação é recuperada para o Registo Nacional Islandês.
Há três conjuntos de dados diferentes retornados dependendo do LookupType:
Nome: Só devolverá o SSN e o Nome da pessoa autenticada. Isso não tem custo adicional de pesquisa.
NameAddress: retornará informações de nome, SSN e endereço. Isso tem um custo de pesquisa adicional. Este é o valor padrão se nenhum valor for fornecido para LookupType.
NameAddressFamily: retorna nome, SSN, dados de endereço, código de gênero e informações da família.
Se 'LookupType.NameAddressFamily' estiver selecionado, os valores extras retornados serão retornados em 'Meta'.
Se a resposta tiver erros ou não for concluída, o objeto do cliente será nulo e um StatusMessage terá uma mensagem detalhada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
authRequestId
|
authRequestId | True | string | |
|
chave de fluxo
|
flowKey | True | string |
Identificador exclusivo de um Fluxo que pertence a uma Empresa. |
|
lookupType
|
lookupType | True | string |
Devoluções
PollCustomer
- PollCustomer
- PollCustomer
Definições
Signatário
Signatário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
SSN
|
ssn | string | |
|
Número de telefone
|
phoneNumber | string | |
|
e-mail
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
chave
|
key | string | |
|
assinado
|
signed | boolean | |
|
assinadoEm
|
signedAt | date-time | |
|
processKey
|
processKey | string | |
|
razão
|
reason | string | |
|
ocultarCódigo Pessoal
|
hidePersonalCode | boolean | |
|
communicationDeliveryType
|
communicationDeliveryType | string | |
|
URL
|
url | string | |
|
signatureType
|
signatureType | string | |
|
linguagem
|
language | string | |
|
customSmsText
|
customSmsText | string |
AssinandoAnexo
AssinandoAnexo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
arquivoConteúdo
|
fileContent | string |
AttachmentReference
AttachmentReference
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
fileName
|
fileName | string | |
|
contentLength
|
contentLength | integer | |
|
TipoDeConteúdo
|
contentType | string | |
|
URL
|
url | string | |
|
descrição
|
description | string | |
|
processKey
|
processKey | string | |
|
attachmentType
|
attachmentType | string | |
|
signeeKey
|
signeeKey | string |
Dictionary_String_String_
Cadeia de dicionário,String<>
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Dicionário
|
object |
Cadeia de dicionário,String<> |
AssinaturaProcessoAtividadeLogWrapper
AssinaturaProcessoAtividadeLogWrapper
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
activityLog
|
activityLog | array of SigningProcessActivityLog | |
|
signatários
|
signees | array of SigneeActivityLog | |
|
sequenceSignatários
|
sequenceSignees | array of SequentialSigningSigneeActivityLog | |
|
anexoReferências
|
attachmentReferences | array of AttachmentReference | |
|
activityDisplayName
|
activityDisplayName | string |
AssinandoProcessoActivityLog
AssinandoProcessoActivityLog
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave de fluxo
|
flowKey | string |
Identificador exclusivo de um Fluxo que pertence a uma Empresa. |
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
estado
|
status | string | |
|
descrição
|
description | string | |
|
userAgent
|
userAgent | string | |
|
fileName
|
fileName | string | |
|
criadosAt
|
createdAt | date-time | |
|
criado por
|
createdBy | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
signInOrder
|
signInOrder | boolean | |
|
assinaturaLocalização
|
signatureLocation | string | |
|
seqüênciaChave
|
sequenceKey | string |
SigneeActivityLog
SigneeActivityLog
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
SSN
|
ssn | string | |
|
nome
|
name | string | |
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
phone
|
phone | string | |
|
e-mail
|
string | ||
|
criadosAt
|
createdAt | date-time | |
|
criado por
|
createdBy | string | |
|
atualizadoem
|
updatedAt | date-time | |
|
signatureType
|
signatureType | string |
SequentialSigningSigneeActivityLog
SequentialSigningSigneeActivityLog
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
seqüênciaChave
|
sequenceKey | string | |
|
signeeKey
|
signeeKey | string | |
|
URL
|
url | string | |
|
assinaturaChaves
|
signingKeys | array of SigneeKeys |
SigneeKeys
SigneeKeys
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
signeeKey
|
signeeKey | string | |
|
processKey
|
processKey | string |
Assinatura sequencial
Assinatura sequencial
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
estado
|
status | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
utilizador
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signatários
|
signees | array of SequentialSigningSignee | |
|
assinaturaProcessos
|
signingProcesses | array of SigningProcess |
SequentialSigningSignee
SequentialSigningSignee
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
URL
|
url | string | |
|
assinaturaChaves
|
signingKeys | array of SigneeKeys |
Processo de Assinatura
Processo de Assinatura
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
signatários
|
signees | array of Signee | |
|
chave de fluxo
|
flowKey | string |
Identificador exclusivo de um Fluxo que pertence a uma Empresa. |
|
estado
|
status | string | |
|
Dicionário
|
meta | Dictionary_String_String_ |
Cadeia de dicionário,String<> |
|
pdfFileName
|
pdfFileName | string | |
|
attachments
|
attachments | array of SigningAttachment | |
|
anexoReferências
|
attachmentReferences | array of AttachmentReference | |
|
requiresAuth
|
requiresAuth | boolean | |
|
utilizador
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
assinaturaLocalização
|
signatureLocation | string | |
|
seqüênciaChave
|
sequenceKey | string | |
|
achatarDocumento
|
flattenDocument | boolean |
StartAuthResponse
StartAuthResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
authRequestId
|
authRequestId | string | |
|
Código de verificação
|
verificationCode | string |
SelagemResposta
SelagemResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
pdfDocumento
|
pdfDocument | string |
Cliente
Cliente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
SSN
|
ssn | string | |
|
Número de telefone
|
phoneNumber | string | |
|
e-mail
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
token
|
token | string | |
|
chave de fluxo
|
flowKey | string |
Identificador exclusivo de um Fluxo que pertence a uma Empresa. |
|
Dicionário
|
meta | Dictionary_String_String_ |
Cadeia de dicionário,String<> |
PollCustomer
PollCustomer
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Cliente
|
customer | Customer |
Cliente |
|
statusMensagem
|
statusMessage | string | |
|
esperandoForUserInput
|
waitingForUserInput | boolean |
objecto
Este é o tipo 'objeto'.