Taktikal Core (versão prévia)
Com o Taktikal Core, você tem a capacidade de assinar, lacrar, autenticar e obter informações detalhadas sobre seus processos de assinatura.
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 | Taktikal |
| URL | https://docs.taktikal.com/ |
| help@taktikal.com |
| Metadados do conector | |
|---|---|
| Publicador | Taktikal |
| Site | https://taktikal.com/ |
| Política de privacidade | https://www.taktikal.com/privacy |
| Categorias | Produtividade |
As APIs do Taktikal Core são uma maneira poderosa de criar novas soluções em sua própria interface e integrar-se às soluções que já estão em operação.
Os documentos podem ser enviados para assinatura diretamente de seus próprios sistemas e, após a assinatura, os documentos e metadados relacionados podem ser enviados automaticamente de volta ao sistema de documentos. Você também pode monitorar o status dos documentos no processo de assinatura e chamar o status com base em números de ID ou outros identificadores exclusivos.
Pré-requisitos
Para usar a API do Taktikal Core, entre em sales@taktikal.is contato com nossa equipe de vendas para 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 a ID e gerenciamento de todos os processos de assinatura
- Para autenticação, use /Auth/Start para iniciar um processo de autenticação e /Auth/Poll para verificar se o status da autenticação.
- Para assinar uma única chamada de documento /gerenciamento/assinatura para um único documento e /management/signing/sequencial para uma assinatura em massa de vários documentos.
- Para obter um log detalhado sobre uma chamada de processo de assinatura /signing/activity/{ProcessKey}.
Problemas e limitações conhecidos
- As solicitações precisam ter um cabeçalho de Autorização para Autenticação Básica. Essa é a companyKey e API-Key
- No momento, apenas assinaturas qualificadas estão com uma ID e-Id islandesa.
- O pdf fornecido deve ser uma cadeia de caracteres ab Base64.
- Os signatários devem ter um email válido e um número de telefone celular.
Erros e soluções comuns
Atualmente, somente PDF são aceitos para assinatura.
perguntas frequentes
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 Signees que precisam assinar o documento. Taktikal manipulará a exibição do documento para o signatário, também se um communicationDeliveryType estiver selecionado, Taktikal enviará ao signatário um SMS ou Email com um link para assinar. Depois que o documento for assinado por todos os participantes, o Taktikal enviará o documento para os caminhos de entrega relevantes registrados.
Uma flowKey é uma chave fornecida pelo Taktikal. Essa chave dirá a Taktikal como lidar com essa solicitação. Para alguns flowKeys Taktikal cuidará da criação do documento. Ele também controlará onde o documento assinado é entregue após a assinatura.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
|
Atualizar um Signatário para determinado Process |
As propriedades do signatário podem ser atualizadas com base em ter fornecido o ProcessKey e o SigneeKey. |
| Cancelar o processo de Assinatura Sequencial |
Cancele o processo de Assinatura sequencial com base em uma determinada Chave de Sequência. Um usuário (email) pode ser fornecido que cancela o processo sequencial. |
| Cancelar um processo de assinatura |
Cancele o processo de Assinatura com base em uma determinada Chave de Processo. |
| Cria um novo processo de Assinatura com um ou mais signos |
Cria um novo processo de Assinatura com um ou mais signos. |
| Cria um novo processo de assinatura sequencial (em massa) |
Cria um novo processo de Assinatura Sequencial (Bulk) com um ou mais Processos de Assinatura. Cada processo de Assinatura em uma sequência tem um ou mais signos. Exemplo:
A documentação detalhada pode ser encontrada em https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ |
| Inicia um processo de autenticação com id eletrônico islandês |
A autenticação com a id e-id islandesa pode ser feita com um telefone celular ou aplicativo Audkenni.
FlowKey sempre deve ser fornecido e pode ser acessado no portal taktikal. |
| Inicia um processo de autenticação com id eletrônico islandês para um processo de assinatura sequencial |
A autenticação com a id e-id islandesa pode ser feita com um telefone celular ou aplicativo Audkenni.
|
| Lacra um documento XML |
Sela um documento XML fornecido fornecido como uma cadeia de caracteres base64. |
| Lacrar um documento PDF |
Sela um documento PDF fornecido fornecido como uma cadeia de caracteres base64. |
| Obtém o log de atividades de um usuário (email) por um período específico |
Obtém o log de atividades de um usuário por um período. |
| Obtém o log de atividades de uma empresa |
Obtém o log de atividades de uma empresa |
| Obtém o log de atividades para o processo de assinatura |
Obtenha o Log de Atividades para um processo de Assinatura. |
|
Obtém o processo de assinatura por process |
Obtenha o processo de assinatura por processkey e signeeKey. |
| Verifica o status da autenticação de um usuário usando sua ID e-id islandesa |
Depois que uma resposta bem-sucedida de /Auth/Start a AuthRequestId é retornada e é usada 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 é recuperado para o Registro Nacional Islandês. Há três conjuntos de dados diferentes retornados dependendo do LookupType:
Se 'LookupType.NameAddressFamily' for selecionado, os valores extras retornados serão retornados em 'Meta'. Se a resposta tiver erros ou não estiver concluída, o objeto do cliente será nulo e um StatusMessage terá uma mensagem detalhada. |
Atualizar um Signatário para determinado ProcessKey e SigneeKey
As propriedades do signatário podem ser atualizadas com base em ter fornecido o ProcessKey e o SigneeKey.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma pessoa assinando um único processo de assinatura.
|
SigneeKey | True | string |
Identificador exclusivo de uma pessoa assinando um único processo de assinatura. |
|
Identificador exclusivo para um único processo de assinatura de documento.
|
ProcessKey | True | string |
Identificador exclusivo para um único processo de assinatura de documento. |
|
email
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
signeeKey
|
signeeKey | True | string | |
|
processKey
|
processKey | True | string | |
|
reason
|
reason | string | ||
|
usuário
|
user | string |
Retornos
Signee
- Signee
- Signee
Cancelar o processo de Assinatura Sequencial
Cancele o processo de Assinatura sequencial com base em uma determinada Chave de Sequência. Um usuário (email) pode ser fornecido que cancela o processo sequencial.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
SequencialSigning
- SequencialSigning
- SequentialSigning
Cancelar um processo de assinatura
Cancele o processo de Assinatura com base em uma determinada Chave de Processo.
Parâmetros
| Nome | Chave | Obrigató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 email do funcionário que tem acesso ao portal.
|
User | string |
Objeto String, geralmente o email do funcionário que tem acesso ao portal. |
Retornos
SigningProcess
- SigningProcess
- SigningProcess
Cria um novo processo de Assinatura com um ou mais signos
Cria um novo processo de Assinatura com um ou mais signos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
é uma cadeia de caracteres base64 do documento a ser assinado. Isso não será 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 precisará ser fornecido. |
|
|
flowKey
|
flowKey | True | string |
FlowKey é fornecido pelo Taktikal. Essa chave dirá a Taktikal como lidar com essa solicitação. Para alguns flowKeys Taktikal cuidará da criação do documento. Ele 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 | ||
|
email
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
reason
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
linguagem
|
language | string | ||
|
Dicionário
|
meta | object |
Cadeia de caracteres de dicionário<, cadeia de caracteres> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
tipo de conteúdo
|
contentType | string | ||
|
url
|
url | string | ||
|
descrição
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
O valor padrão é falso. Se definido como true, todos os signatários precisarão usar a ID e-there para autenticar antes de poder exibir o documento. |
|
|
signInOrder
|
signInOrder | boolean |
O valor padrão é falso. Controlará a ordem dos signatários. Ele enviará apenas uma solicitação de assinatura para a primeira pessoa na lista de signatários a começar. Depois que ele assinar o próximo signatário e assim por diante. |
|
|
signatureLocation
|
signatureLocation | string |
Pode ser BottomLastPage ou o valor padrão TopFirstPage. Controlará onde exibir a assinatura no documento. |
|
|
usuário
|
user | string |
endereço de email do usuário que envia a solicitação. Pode estar vazio. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
O valor padrão é falso. Se definido como true, tentaremos nivelar os campos de entrada de documentos. |
|
|
reminderRule
|
reminderRule | string |
Envia lembretes, deixe vazio para nenhum. o formato deve ser "firstReminder após x dias:Então, a cada y dias", 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 que o primeiro lembrete seja enviado entre 0 e 30 dias (0 significa nenhum lembrete) e, em seguida, enviará a cada 0-15 dias (0, novamente, o que significa que nenhum lembrete, portanto, 0:10 só enviaria lembrete a cada 10 dias, enquanto 12:0 enviaria apenas um lembrete após 12 dias |
Retornos
SigningProcess
- SigningProcess
- SigningProcess
Cria um novo processo de assinatura sequencial (em massa)
Cria um novo processo de Assinatura Sequencial (Bulk) com um ou mais Processos de Assinatura. Cada processo de Assinatura em uma sequência tem um ou mais signos.
Exemplo:
- Uma empresa quer o documento A e B assinados. O Signatário X deve assinar o documento A e B, o Signee 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. Signees X e Y são adicionados como signees para CreateSigningProcess para Documento A e os signos X e Z são adicionados como signes 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
é uma cadeia de caracteres base64 do documento a ser assinado. Isso não será 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 precisará ser fornecido. |
|
|
flowKey
|
flowKey | True | string |
FlowKey é fornecido pelo Taktikal. Essa chave dirá a Taktikal como lidar com essa solicitação. Para alguns flowKeys Taktikal cuidará da criação do documento. Ele 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 | ||
|
email
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
reason
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
linguagem
|
language | string | ||
|
Dicionário
|
meta | object |
Cadeia de caracteres de dicionário<, cadeia de caracteres> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
tipo de conteúdo
|
contentType | string | ||
|
url
|
url | string | ||
|
descrição
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
O valor padrão é falso. Se definido como true, todos os signatários precisarão usar a ID e-there para autenticar antes de poder exibir o documento. |
|
|
signInOrder
|
signInOrder | boolean |
O valor padrão é falso. Controlará a ordem dos signatários. Ele enviará apenas uma solicitação de assinatura para a primeira pessoa na lista de signatários a começar. Depois que ele assinar o próximo signatário e assim por diante. |
|
|
signatureLocation
|
signatureLocation | string |
Pode ser BottomLastPage ou o valor padrão TopFirstPage. Controlará onde exibir a assinatura no documento. |
|
|
usuário
|
user | string |
endereço de email do usuário que envia a solicitação. Pode estar vazio. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
O valor padrão é falso. Se definido como true, tentaremos nivelar os campos de entrada de documentos. |
|
|
reminderRule
|
reminderRule | string |
Envia lembretes, deixe vazio para nenhum. o formato deve ser "firstReminder após x dias:Então, a cada y dias", 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 que o primeiro lembrete seja enviado entre 0 e 30 dias (0 significa nenhum lembrete) e, em seguida, enviará a cada 0-15 dias (0, novamente, o que significa que nenhum lembrete, portanto, 0:10 só enviaria lembrete a cada 10 dias, enquanto 12:0 enviaria apenas um lembrete após 12 dias |
|
|
usuário
|
user | True | string |
O usuário que inicia o processo de assinatura sequencial |
|
requiresAuth
|
requiresAuth | boolean |
O valor padrão é falso. Se definido como true, todos os signatários precisarão usar a ID e-there para autenticar antes de poder exibir o documento. |
|
|
signInOrder
|
signInOrder | boolean |
O valor padrão é falso. Controlará a ordem dos signatários. Ele enviará apenas uma solicitação de assinatura para a primeira pessoa na lista de signatários a começar. Depois que ele assinar o próximo signatário e assim por diante. |
Retornos
SequencialSigning
- SequencialSigning
- SequentialSigning
Inicia um processo de autenticação com id eletrônico islandês
A autenticação com a id e-id islandesa pode ser feita com um telefone celular ou aplicativo Audkenni.
- Usando o telefone celular: o AuthenticationContextType deve ser definido como 'Sim' e o número de telefone 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 seguridade social Icdlandic. O phoneNumber é ignorado.
FlowKey sempre deve ser fornecido e pode ser acessado no portal taktikal.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Ssn
|
ssn | string | ||
|
número de telefone
|
phoneNumber | string | ||
|
flowKey
|
flowKey | True | string |
Identificador exclusivo para um Flow que pertence a uma Empresa. |
|
authenticationContextType
|
authenticationContextType | True | string |
Retornos
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Inicia um processo de autenticação com id eletrônico islandês para um processo de assinatura sequencial
A autenticação com a id e-id islandesa pode ser feita com um telefone celular ou aplicativo 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 seguridade social Icdlandic. O phoneNumber é ignorado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo para processos de assinatura de sequência (em massa).
|
SequenceKey | True | string |
Identificador exclusivo para processos de assinatura de sequência (em massa). |
|
sequenceKey
|
sequenceKey | True | string | |
|
loginHint
|
loginHint | True | string | |
|
authenticationContextType
|
authenticationContextType | True | string |
Retornos
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Lacra um documento XML
Sela um documento XML fornecido fornecido como uma cadeia de caracteres base64.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
xmlDocument
|
xmlDocument | True | string |
Base64String do documento XML a ser lacrado |
|
flowKey
|
flowKey | True | string |
Um flowKey válido fornecido pelo Taktikal que pode ser usado para lacrar |
Retornos
Object
- response
- object
Lacrar um documento PDF
Sela um documento PDF fornecido fornecido como uma cadeia de caracteres base64.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | True | string |
Uma Base64String do documento PDF a ser lacrado. |
|
flowKey
|
flowKey | True | string |
Identificador exclusivo para um Flow que pertence a uma Empresa. |
|
reason
|
reason | string |
definir o motivo a ser exibido no selo |
|
|
languageType
|
languageType | string |
Retornos
SealingResponse
- SealingResponse
- SealingResponse
Obtém o log de atividades de um usuário (email) por um período específico
Obtém o log de atividades de um usuário por um período.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O email do usuário.
|
User | string |
O email do usuário. |
|
|
A data de início do log a ser pesquisado deve ser uma data menor que EndDate.
|
StartDate | True | date-time |
A data de início do log a ser pesquisado deve ser uma data menor que EndDate. |
|
A data de término do log a ser pesquisado deve ser uma data maior que StartDate.
|
EndDate | True | date-time |
A data de término do log a ser pesquisado deve ser uma data maior que StartDate. |
|
Use se for filtrado em um único processo de assinatura.
|
ProcessKey | string |
Use se for filtrado em um único processo de assinatura. |
|
|
Pode ser usado apenas para obter atividades para um tipo de fluxo específico.
|
FlowType | string |
Pode ser usado apenas para obter atividades para um tipo de fluxo específico. |
|
|
Usado para páginar o conjunto de resultados e retornar apenas N muitos resultados.
|
Take | integer |
Usado para páginar o conjunto de resultados e retornar apenas N muitos resultados. |
|
|
Usado para páginar o conjunto de resultados e ignorar os primeiros N resultados.
|
Skip | integer |
Usado para páginar o conjunto de resultados e ignorar os primeiros N resultados. |
|
|
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. |
Retornos
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtém o log de atividades de uma empresa
Obtém o log de atividades de uma empresa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A data de início do log a ser pesquisado deve ser uma data menor que EndDate.
|
StartDate | True | date-time |
A data de início do log a ser pesquisado deve ser uma data menor que EndDate. |
|
A data de término do log a ser pesquisado deve ser uma data maior que StartDate.
|
EndDate | True | date-time |
A data de término do log a ser pesquisado deve ser uma data maior que StartDate. |
|
Usado para páginar o conjunto de resultados e retornar apenas N muitos resultados.
|
Take | integer |
Usado para páginar o conjunto de resultados e retornar apenas N muitos resultados. |
|
|
Usado para páginar o conjunto de resultados e ignorar os primeiros N resultados.
|
Skip | integer |
Usado para páginar o conjunto de resultados e ignorar os primeiros N resultados. |
|
|
O email do usuário.
|
User | string |
O email do usuário. |
|
|
Pode ser usado apenas para obter atividades para um tipo de fluxo específico.
|
FlowType | string |
Pode ser usado apenas para obter atividades 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. |
Retornos
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtém o log de atividades para o processo de assinatura
Obtenha o Log de Atividades para um processo de Assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O email do usuário.
|
User | string |
O email do usuário. |
|
|
A data de início do log a ser pesquisado deve ser uma data menor que EndDate.
|
StartDate | True | date-time |
A data de início do log a ser pesquisado deve ser uma data menor que EndDate. |
|
A data de término do log a ser pesquisado deve ser uma data maior que StartDate.
|
EndDate | True | date-time |
A data de término do log a ser pesquisado deve ser uma data maior que StartDate. |
|
Use se for filtrado em um único processo de assinatura.
|
ProcessKey | True | string |
Use se for filtrado em um único processo de assinatura. |
|
Pode ser usado apenas para obter atividades para um tipo de fluxo específico.
|
FlowType | string |
Pode ser usado apenas para obter atividades para um tipo de fluxo específico. |
|
|
usado para páginar o conjunto de resultados e retornar apenas N muitos resultados.
|
Take | integer |
usado para páginar o conjunto de resultados e retornar apenas N muitos resultados. |
|
|
usado para páginar o conjunto de resultados e ignorar os primeiros N resultados.
|
Skip | integer |
usado para páginar o conjunto de resultados e ignorar os primeiros N resultados. |
|
|
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. |
Retornos
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtém o processo de assinatura por processKey e signeeKey
Obtenha o processo de assinatura por processkey e signeeKey.
Parâmetros
| Nome | Chave | Obrigató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 assinando um único processo de assinatura.
|
SigneeKey | True | string |
Identificador exclusivo de uma pessoa assinando um único processo de assinatura. |
|
Um Agente de Usuário é um software que atua para um usuário, como um navegador da Web ou um cliente de email.
|
UserAgent | string |
Um Agente de Usuário é um software que atua para um usuário, como um navegador da Web ou um cliente de email. |
Retornos
SigningProcess
- SigningProcess
- SigningProcess
Verifica o status da autenticação de um usuário usando sua ID e-id islandesa
Depois que uma resposta bem-sucedida de /Auth/Start a AuthRequestId é retornada e é usada 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 é recuperado para o Registro Nacional Islandês.
Há três conjuntos de dados diferentes retornados dependendo do LookupType:
Nome: retornará apenas o SSN e o nome da pessoa autenticada. Isso não tem nenhum custo de pesquisa adicional.
NameAddress: retornará informações de nome, SSN e endereço. Isso tem um custo de pesquisa adicional. Esse será 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 de família.
Se 'LookupType.NameAddressFamily' for selecionado, os valores extras retornados serão retornados em 'Meta'.
Se a resposta tiver erros ou não estiver concluída, o objeto do cliente será nulo e um StatusMessage terá uma mensagem detalhada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
authRequestId
|
authRequestId | True | string | |
|
flowKey
|
flowKey | True | string |
Identificador exclusivo para um Flow que pertence a uma Empresa. |
|
tipo de pesquisa
|
lookupType | True | string |
Retornos
PollCustomer
- PollCustomer
- PollCustomer
Definições
Signee
Signee
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
Ssn
|
ssn | string | |
|
número de telefone
|
phoneNumber | string | |
|
email
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
chave
|
key | string | |
|
Assinado
|
signed | boolean | |
|
signedAt
|
signedAt | date-time | |
|
processKey
|
processKey | string | |
|
reason
|
reason | string | |
|
hidePersonalCode
|
hidePersonalCode | boolean | |
|
communicationDeliveryType
|
communicationDeliveryType | string | |
|
url
|
url | string | |
|
signatureType
|
signatureType | string | |
|
linguagem
|
language | string | |
|
customSmsText
|
customSmsText | string |
SigningAttachment
SigningAttachment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileContent
|
fileContent | string |
AttachmentReference
AttachmentReference
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
fileName
|
fileName | string | |
|
contentLength
|
contentLength | integer | |
|
tipo de conteúdo
|
contentType | string | |
|
url
|
url | string | |
|
descrição
|
description | string | |
|
processKey
|
processKey | string | |
|
attachmentType
|
attachmentType | string | |
|
signeeKey
|
signeeKey | string |
Dictionary_String_String_
Cadeia de caracteres de dicionário<, cadeia de caracteres>
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Dicionário
|
object |
Cadeia de caracteres de dicionário<, cadeia de caracteres> |
SigningProcessActivityLogWrapper
SigningProcessActivityLogWrapper
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
activityLog
|
activityLog | array of SigningProcessActivityLog | |
|
signees
|
signees | array of SigneeActivityLog | |
|
sequenceSignees
|
sequenceSignees | array of SequentialSigningSigneeActivityLog | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
activityDisplayName
|
activityDisplayName | string |
SigningProcessActivityLog
SigningProcessActivityLog
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
flowKey
|
flowKey | string |
Identificador exclusivo para um Flow que pertence a uma Empresa. |
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
status
|
status | string | |
|
descrição
|
description | string | |
|
userAgent
|
userAgent | string | |
|
fileName
|
fileName | string | |
|
createdAt
|
createdAt | date-time | |
|
createdBy
|
createdBy | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string |
SigneeActivityLog
SigneeActivityLog
| Nome | 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 | |
|
email
|
string | ||
|
createdAt
|
createdAt | date-time | |
|
createdBy
|
createdBy | string | |
|
updatedAt
|
updatedAt | date-time | |
|
signatureType
|
signatureType | string |
SequentialSigningSigneeActivityLog
SequentialSigningSigneeActivityLog
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sequenceKey
|
sequenceKey | string | |
|
signeeKey
|
signeeKey | string | |
|
url
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigneeKeys
SigneeKeys
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
signeeKey
|
signeeKey | string | |
|
processKey
|
processKey | string |
SequencialSigning
SequencialSigning
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
status
|
status | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
usuário
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signees
|
signees | array of SequentialSigningSignee | |
|
signingProcesses
|
signingProcesses | array of SigningProcess |
SequentialSigningSignee
SequentialSigningSignee
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
url
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigningProcess
SigningProcess
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
signees
|
signees | array of Signee | |
|
flowKey
|
flowKey | string |
Identificador exclusivo para um Flow que pertence a uma Empresa. |
|
status
|
status | string | |
|
Dicionário
|
meta | Dictionary_String_String_ |
Cadeia de caracteres de dicionário<, cadeia de caracteres> |
|
pdfFileName
|
pdfFileName | string | |
|
attachments
|
attachments | array of SigningAttachment | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
requiresAuth
|
requiresAuth | boolean | |
|
usuário
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string | |
|
flattenDocument
|
flattenDocument | boolean |
StartAuthResponse
StartAuthResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
authRequestId
|
authRequestId | string | |
|
verificationCode
|
verificationCode | string |
SealingResponse
SealingResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
Customer
Customer
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
Ssn
|
ssn | string | |
|
número de telefone
|
phoneNumber | string | |
|
email
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
símbolo
|
token | string | |
|
flowKey
|
flowKey | string |
Identificador exclusivo para um Flow que pertence a uma Empresa. |
|
Dicionário
|
meta | Dictionary_String_String_ |
Cadeia de caracteres de dicionário<, cadeia de caracteres> |
PollCustomer
PollCustomer
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Customer
|
customer | Customer |
Customer |
|
statusMessage
|
statusMessage | string | |
|
waitingForUserInput
|
waitingForUserInput | boolean |
objeto
Esse é o tipo 'object'.