Taktikal Core (préversion)
Avec Taktikal Core, vous avez la possibilité de signer, d’authentifier, d’authentifier et d’obtenir des informations détaillées sur vos processus de signature.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Taktikal |
| URL | https://docs.taktikal.com/ |
| Messagerie électronique | help@taktikal.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Taktikal |
| Site internet | https://taktikal.com/ |
| Politique de confidentialité | https://www.taktikal.com/privacy |
| Catégories | Productivité |
Les API Taktikal Core sont un moyen puissant de créer de nouvelles solutions dans votre propre interface et d’intégrer les solutions déjà en cours d’opération.
Les documents peuvent être envoyés pour signature directement à partir de vos propres systèmes, et après la signature, les documents et les métadonnées associées peuvent être automatiquement renvoyés au système de documents. Vous pouvez également surveiller l’état des documents dans le processus de signature et appeler l’état en fonction des numéros d’ID ou d’autres identificateurs uniques.
Prerequisites
Pour utiliser l’API Taktikal Core, contactez notre équipe commerciale pour sales@taktikal.is acquérir les informations d’identification d’API nécessaires.
Comment obtenir des informations d’identification
Contactez notre équipe ventes pour créer l’accès et obtenir vos informations d’identification d’API.
Bien démarrer avec votre connecteur
L’API principale peut obtenir des documents signés, s’authentifier à l’aide de l’ID électronique islandais et gérer tous les processus de signature
- Pour l’authentification, utilisez /Auth/Start pour lancer un processus d’authentification, puis /Auth/Poll pour vérifier si l’état de l’authentification.
- Pour signer un seul appel de document /management/signature pour un document unique et /management/signature/séquentiel pour une signature en bloc de plusieurs documents.
- Pour obtenir un journal détaillé sur un appel de processus de signature /signature/activity/{ProcessKey}.
Problèmes connus et limitations
- Les demandes doivent avoir un en-tête d’autorisation pour l’authentification de base. C’est la sociétéKey et API-Key
- Pour le moment, seules les signatures qualifiées sont avec un e-ID islandais.
- Le fichier PDF fourni doit être une chaîne ab Base64.
- Les signataires doivent avoir un e-mail valide et un numéro de téléphone mobile.
Erreurs courantes et solutions
Actuellement, seul le fichier PDF est accepté pour la signature.
Questions fréquentes (FAQ)
Vous trouverez plus d’informations sur l’API sous https://docs.taktikal.com
Le démarrage d’un processus de signature est une requête POST unique. Pour démarrer un processus de signature, un document PDF valide est nécessaire et une liste de signes qui doivent signer le document. Taktikal gère l’affichage du document au signet, également si un communicationDeliveryType est sélectionné, Taktikal envoie le signet un SMS ou un e-mail avec un lien à signer. Une fois le document signé par tous les participants, Taktikal envoie le document aux chemins de remise appropriés inscrits.
Un flowKey est une clé fournie par Taktikal. Cette clé indique à Taktikal comment gérer cette demande. Pour certains flowKeys Taktikal s’occupera de la création du document. Il contrôle également l’emplacement où le document signé est remis après la signature.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Impossible à partager |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Ce n’est pas une connexion partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé d’entreprise | securestring | Clé d’entreprise pour cette API | Vrai |
| Clé d’API | securestring | Clé API pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Annuler le processus de signature séquentielle |
Annulez le processus de signature séquentiel en fonction d’une clé de séquence donnée. Un utilisateur (e-mail) peut être fourni pour annuler le processus séquentiel. |
| Annuler un processus de signature |
Annulez le processus de signature basé sur une clé de processus donnée. |
| Crée un nouveau processus de signature séquentielle (en bloc) |
Crée un processus de signature séquentielle (en bloc) avec un ou plusieurs processus de signature. Chaque processus de signature d’une séquence comporte un ou plusieurs signets. Exemple :
Vous trouverez une documentation détaillée sur https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ |
| Crée un processus de signature avec un ou plusieurs signes |
Crée un processus de signature avec un ou plusieurs signes. |
| Démarre un processus d’authentification avec e-id islandais pour un processus de signature séquentielle |
L’authentification avec l’id électronique islandais peut être effectuée avec un téléphone mobile ou une application Audkenni.
|
| Lance un processus d’authentification avec e-id islandais |
L’authentification avec l’id électronique islandais peut être effectuée avec un téléphone mobile ou une application Audkenni.
flowKey doit toujours être fourni et est accessible dans le portail Taktikal. |
|
Mettre à jour un signee pour process |
Les propriétés signee peuvent être mises à jour en fonction de la présence de ProcessKey et de SigneeKey. |
| Obtient le journal d’activité d’un utilisateur (e-mail) pendant une période spécifique |
Obtient le journal d’activité d’un utilisateur pendant une période. |
| Obtient le journal d’activité d’une entreprise |
Obtient le journal d’activité d’une entreprise |
| Obtient le journal d’activité pour le processus de signature |
Obtenez le journal d’activité d’un processus de signature. |
|
Obtient le processus de signature par process |
Obtenez le processus de signature par processkey et signeeKey. |
| Scelle un document PDF |
Seals a fourni un document PDF fourni sous forme de chaîne base64. |
| Scelle un document XML |
Scelle un document XML fourni sous la forme d’une chaîne base64. |
| Vérifie l’état d’authentification d’un utilisateur à l’aide de son e-id islandais |
Une fois qu’une réponse réussie de /Auth/Start a AuthRequestId est retournée et est utilisée pour vérifier si l’authentification est terminée. Si l’authentification est terminée et que l’objet client est rempli en fonction du LookupType. Le type de recherche indique que le type d’informations est récupéré pour le Registre national islandais. Il existe trois jeux de données différents retournés en fonction du LookupType :
Si « LookupType.NameAddressFamily » est sélectionné, les valeurs supplémentaires retournées sont retournées dans « Meta ». Si la réponse a des erreurs ou n’est pas terminée, l’objet client est null et un StatusMessage a un message détaillé. |
Annuler le processus de signature séquentielle
Annulez le processus de signature séquentiel en fonction d’une clé de séquence donnée. Un utilisateur (e-mail) peut être fourni pour annuler le processus séquentiel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur de processus de signature séquentiel à fournir.
|
SequenceKey | True | string |
Identificateur de processus de signature séquentiel à fournir. |
|
Seul l’utilisateur qui a démarré le processus de signature peut l’annuler.
|
User | True | string |
Seul l’utilisateur qui a démarré le processus de signature peut l’annuler. |
Retours
SéquentielSigning
- SéquentielSigning
- SequentialSigning
Annuler un processus de signature
Annulez le processus de signature basé sur une clé de processus donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur unique pour un processus de signature de document unique.
|
ProcessKey | string |
Identificateur unique pour un processus de signature de document unique. |
|
|
Objet string, généralement l’e-mail de l’employé qui a accès au portail.
|
User | string |
Objet string, généralement l’e-mail de l’employé qui a accès au portail. |
Retours
SigningProcess
- SigningProcess
- SigningProcess
Crée un nouveau processus de signature séquentielle (en bloc)
Crée un processus de signature séquentielle (en bloc) avec un ou plusieurs processus de signature. Chaque processus de signature d’une séquence comporte un ou plusieurs signets.
Exemple :
- Une entreprise souhaite un document A et B signé. Signe X doit signer le document A et B, Signee Y doit signer le document A et Signee Z doit signer le document B.
- Ensuite, un nouvel objet CreateSequentalSigning avec le tableau de deux objets CreateSigningProcess. Les signets X et Y sont ajoutés en tant que signes pour CreateSigningProcess pour le document A et les signets X et Z sont ajoutés en tant que signes pour le document B.
Vous trouverez une documentation détaillée sur https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
est une chaîne base64 du document à signer. Cela n’est pas nécessaire si flowKey s’occupe de la création du document. |
|
|
pdfFileName
|
pdfFileName | string |
Si PdfDocument est utilisé, une valeur pour le nom de fichier doit être fournie. |
|
|
flowKey
|
flowKey | True | string |
FlowKey est fourni par Taktikal. Cette clé indique à Taktikal comment gérer cette demande. Pour certains flowKeys Taktikal s’occupera de la création du document. Il contrôle également l’emplacement où le document signé est remis après la signature. |
|
processKey
|
processKey | string | ||
|
nom
|
name | string | ||
|
Ssn
|
ssn | string | ||
|
numéro de téléphone
|
phoneNumber | string | ||
|
Messagerie électronique
|
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 | ||
|
language
|
language | string | ||
|
Dictionnaire
|
meta | object |
Chaîne de<dictionnaire, chaîne> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
pièce d'identité
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
type de contenu
|
contentType | string | ||
|
URL
|
url | string | ||
|
descriptif
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
La valeur par défaut est False. Si la valeur est true, tous les signataires doivent utiliser l’id électronique pour s’authentifier avant d’être en mesure d’afficher le document. |
|
|
signInOrder
|
signInOrder | boolean |
La valeur par défaut est False. Contrôle l’ordre des signataires. Il envoie uniquement une demande de signature à la première personne de la liste des signataires pour commencer. Après avoir signé le signet suivant, et ainsi de suite. |
|
|
signatureLocation
|
signatureLocation | string |
Peut être BottomLastPage ou la valeur par défaut TopFirstPage. Contrôle l’emplacement d’affichage de la signature dans le document. |
|
|
utilisateur
|
user | string |
adresse e-mail de l’utilisateur qui envoie la demande. Peut être vide. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
La valeur par défaut est False. Si la valeur est true, nous tenterons d’aplatir les champs d’entrée de documents. |
|
|
reminderRule
|
reminderRule | string |
Envoie des rappels, laissez vides pour aucun. le format doit être « firstReminder after x days :Then every y days », par exemple « 1:3 » envoie un rappel après 1 jour, puis tous les trois jours après cela. Laissez vide ou null pour aucun rappel, les valeurs valides seront pour le premier rappel à envoyer entre 0 et 30 jours (0 signifie aucun rappel), puis envoyez tous les 0 à 15 jours (0 à nouveau, ce qui signifie qu’aucun rappel, donc 0:10 n’enverrait que le rappel tous les 10 jours, tandis que 12:0 n’envoyerait qu’un seul rappel après 12 jours |
|
|
utilisateur
|
user | True | string |
Utilisateur qui démarre le processus de signature séquentielle |
|
requiresAuth
|
requiresAuth | boolean |
La valeur par défaut est False. Si la valeur est true, tous les signataires doivent utiliser l’id électronique pour s’authentifier avant d’être en mesure d’afficher le document. |
|
|
signInOrder
|
signInOrder | boolean |
La valeur par défaut est False. Contrôle l’ordre des signataires. Il envoie uniquement une demande de signature à la première personne de la liste des signataires pour commencer. Après avoir signé le signet suivant, et ainsi de suite. |
Retours
SéquentielSigning
- SéquentielSigning
- SequentialSigning
Crée un processus de signature avec un ou plusieurs signes
Crée un processus de signature avec un ou plusieurs signes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
est une chaîne base64 du document à signer. Cela n’est pas nécessaire si flowKey s’occupe de la création du document. |
|
|
pdfFileName
|
pdfFileName | string |
Si PdfDocument est utilisé, une valeur pour le nom de fichier doit être fournie. |
|
|
flowKey
|
flowKey | True | string |
FlowKey est fourni par Taktikal. Cette clé indique à Taktikal comment gérer cette demande. Pour certains flowKeys Taktikal s’occupera de la création du document. Il contrôle également l’emplacement où le document signé est remis après la signature. |
|
processKey
|
processKey | string | ||
|
nom
|
name | string | ||
|
Ssn
|
ssn | string | ||
|
numéro de téléphone
|
phoneNumber | string | ||
|
Messagerie électronique
|
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 | ||
|
language
|
language | string | ||
|
Dictionnaire
|
meta | object |
Chaîne de<dictionnaire, chaîne> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
pièce d'identité
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
type de contenu
|
contentType | string | ||
|
URL
|
url | string | ||
|
descriptif
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
La valeur par défaut est False. Si la valeur est true, tous les signataires doivent utiliser l’id électronique pour s’authentifier avant d’être en mesure d’afficher le document. |
|
|
signInOrder
|
signInOrder | boolean |
La valeur par défaut est False. Contrôle l’ordre des signataires. Il envoie uniquement une demande de signature à la première personne de la liste des signataires pour commencer. Après avoir signé le signet suivant, et ainsi de suite. |
|
|
signatureLocation
|
signatureLocation | string |
Peut être BottomLastPage ou la valeur par défaut TopFirstPage. Contrôle l’emplacement d’affichage de la signature dans le document. |
|
|
utilisateur
|
user | string |
adresse e-mail de l’utilisateur qui envoie la demande. Peut être vide. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
La valeur par défaut est False. Si la valeur est true, nous tenterons d’aplatir les champs d’entrée de documents. |
|
|
reminderRule
|
reminderRule | string |
Envoie des rappels, laissez vides pour aucun. le format doit être « firstReminder after x days :Then every y days », par exemple « 1:3 » envoie un rappel après 1 jour, puis tous les trois jours après cela. Laissez vide ou null pour aucun rappel, les valeurs valides seront pour le premier rappel à envoyer entre 0 et 30 jours (0 signifie aucun rappel), puis envoyez tous les 0 à 15 jours (0 à nouveau, ce qui signifie qu’aucun rappel, donc 0:10 n’enverrait que le rappel tous les 10 jours, tandis que 12:0 n’envoyerait qu’un seul rappel après 12 jours |
Retours
SigningProcess
- SigningProcess
- SigningProcess
Démarre un processus d’authentification avec e-id islandais pour un processus de signature séquentielle
L’authentification avec l’id électronique islandais peut être effectuée avec un téléphone mobile ou une application Audkenni.
- Utilisation du téléphone mobile : AuthenticationContextType doit être défini sur « Sim » et le numéro de téléphone doit être défini sur un numéro de téléphone mobile Ucelandic. Le ssn est ignoré.
- Utilisation de l’application Audkenni : AuthenticationContextType doit être défini sur « App » et le ssn doit être défini sur un numéro de sécurité sociale Icdlandic. Le numéro de téléphone est ignoré.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur unique pour les processus de signature de séquence (en bloc).
|
SequenceKey | True | string |
Identificateur unique pour les processus de signature de séquence (en bloc). |
|
sequenceKey
|
sequenceKey | True | string | |
|
loginHint
|
loginHint | True | string | |
|
authenticationContextType
|
authenticationContextType | True | string |
Retours
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Lance un processus d’authentification avec e-id islandais
L’authentification avec l’id électronique islandais peut être effectuée avec un téléphone mobile ou une application Audkenni.
- Utilisation du téléphone mobile : AuthenticationContextType doit être défini sur « Sim » et le numéro de téléphone doit être défini sur un numéro de téléphone mobile islandais. Le ssn est ignoré.
- Utilisation de l’application Audkenni : AuthenticationContextType doit être défini sur « App » et le ssn doit être défini sur un numéro de sécurité sociale Icdlandic. Le numéro de téléphone est ignoré.
flowKey doit toujours être fourni et est accessible dans le portail Taktikal.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Ssn
|
ssn | string | ||
|
numéro de téléphone
|
phoneNumber | string | ||
|
flowKey
|
flowKey | True | string |
Identificateur unique d’un flux appartenant à une société. |
|
authenticationContextType
|
authenticationContextType | True | string |
Retours
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Mettre à jour un signee pour processKey et SigneeKey donnés
Les propriétés signee peuvent être mises à jour en fonction de la présence de ProcessKey et de SigneeKey.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur unique d’une personne qui signe un processus de signature unique.
|
SigneeKey | True | string |
Identificateur unique d’une personne qui signe un processus de signature unique. |
|
Identificateur unique pour un processus de signature de document unique.
|
ProcessKey | True | string |
Identificateur unique pour un processus de signature de document unique. |
|
Messagerie électronique
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
signeeKey
|
signeeKey | True | string | |
|
processKey
|
processKey | True | string | |
|
reason
|
reason | string | ||
|
utilisateur
|
user | string |
Retours
Signe
- Signe
- Signee
Obtient le journal d’activité d’un utilisateur (e-mail) pendant une période spécifique
Obtient le journal d’activité d’un utilisateur pendant une période.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
E-mail de l’utilisateur.
|
User | string |
E-mail de l’utilisateur. |
|
|
La date de début du journal à rechercher doit être une date inférieure à EndDate.
|
StartDate | True | date-time |
La date de début du journal à rechercher doit être une date inférieure à EndDate. |
|
La date de fin du journal à rechercher doit être plus grande que StartDate.
|
EndDate | True | date-time |
La date de fin du journal à rechercher doit être plus grande que StartDate. |
|
Utilisez si vous souhaitez filtrer sur un processus de signature unique.
|
ProcessKey | string |
Utilisez si vous souhaitez filtrer sur un processus de signature unique. |
|
|
Peut être utilisé pour obtenir uniquement l’activité d’un type de flux spécifique.
|
FlowType | string |
Peut être utilisé pour obtenir uniquement l’activité d’un type de flux spécifique. |
|
|
Utilisé pour pager le jeu de résultats et renvoyer uniquement N de nombreux résultats.
|
Take | integer |
Utilisé pour pager le jeu de résultats et renvoyer uniquement N de nombreux résultats. |
|
|
Permet de pager le jeu de résultats et d’ignorer les premiers résultats N.
|
Skip | integer |
Permet de pager le jeu de résultats et d’ignorer les premiers résultats N. |
|
|
S’il a une valeur, nous renvoyons uniquement les enregistrements qui correspondent à cette clé flowKey
|
FlowKey | string |
S’il a une valeur, nous renvoyons uniquement les enregistrements qui correspondent à cette clé flowKey. |
Retours
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtient le journal d’activité d’une entreprise
Obtient le journal d’activité d’une entreprise
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
La date de début du journal à rechercher doit être une date inférieure à EndDate.
|
StartDate | True | date-time |
La date de début du journal à rechercher doit être une date inférieure à EndDate. |
|
La date de fin du journal à rechercher doit être plus grande que StartDate.
|
EndDate | True | date-time |
La date de fin du journal à rechercher doit être plus grande que StartDate. |
|
Utilisé pour pager le jeu de résultats et renvoyer uniquement N de nombreux résultats.
|
Take | integer |
Utilisé pour pager le jeu de résultats et renvoyer uniquement N de nombreux résultats. |
|
|
Permet de pager le jeu de résultats et d’ignorer les premiers résultats N.
|
Skip | integer |
Permet de pager le jeu de résultats et d’ignorer les premiers résultats N. |
|
|
E-mail de l’utilisateur.
|
User | string |
E-mail de l’utilisateur. |
|
|
Peut être utilisé pour obtenir uniquement l’activité d’un type de flux spécifique.
|
FlowType | string |
Peut être utilisé pour obtenir uniquement l’activité d’un type de flux spécifique. |
|
|
S’il a une valeur, nous renvoyons uniquement les enregistrements qui correspondent à cette clé flowKey.
|
FlowKey | string |
S’il a une valeur, nous renvoyons uniquement les enregistrements qui correspondent à cette clé flowKey. |
Retours
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtient le journal d’activité pour le processus de signature
Obtenez le journal d’activité d’un processus de signature.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
E-mail de l’utilisateur.
|
User | string |
E-mail de l’utilisateur. |
|
|
La date de début du journal à rechercher doit être une date inférieure à EndDate.
|
StartDate | True | date-time |
La date de début du journal à rechercher doit être une date inférieure à EndDate. |
|
La date de fin du journal à rechercher doit être plus grande que StartDate.
|
EndDate | True | date-time |
La date de fin du journal à rechercher doit être plus grande que StartDate. |
|
Utilisez si vous souhaitez filtrer sur un processus de signature unique.
|
ProcessKey | True | string |
Utilisez si vous souhaitez filtrer sur un processus de signature unique. |
|
Peut être utilisé pour obtenir uniquement l’activité d’un type de flux spécifique.
|
FlowType | string |
Peut être utilisé pour obtenir uniquement l’activité d’un type de flux spécifique. |
|
|
utilisé pour pager le jeu de résultats et renvoyer uniquement N de nombreux résultats.
|
Take | integer |
utilisé pour pager le jeu de résultats et renvoyer uniquement N de nombreux résultats. |
|
|
utilisé pour pager le jeu de résultats et ignorer les premiers résultats N.
|
Skip | integer |
utilisé pour pager le jeu de résultats et ignorer les premiers résultats N. |
|
|
S’il a une valeur, nous renvoyons uniquement les enregistrements qui correspondent à cette clé flowKey.
|
FlowKey | string |
S’il a une valeur, nous renvoyons uniquement les enregistrements qui correspondent à cette clé flowKey. |
Retours
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Obtient le processus de signature par processKey et signeeKey
Obtenez le processus de signature par processkey et signeeKey.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur unique pour un processus de signature de document unique.
|
ProcessKey | True | string |
Identificateur unique pour un processus de signature de document unique. |
|
Identificateur unique d’une personne qui signe un processus de signature unique.
|
SigneeKey | True | string |
Identificateur unique d’une personne qui signe un processus de signature unique. |
|
Un agent utilisateur est un logiciel agissant pour un utilisateur, comme un navigateur web ou un client de messagerie.
|
UserAgent | string |
Un agent utilisateur est un logiciel agissant pour un utilisateur, comme un navigateur web ou un client de messagerie. |
Retours
SigningProcess
- SigningProcess
- SigningProcess
Scelle un document PDF
Seals a fourni un document PDF fourni sous forme de chaîne base64.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | True | string |
Base64String du document PDF à sealer. |
|
flowKey
|
flowKey | True | string |
Identificateur unique d’un flux appartenant à une société. |
|
reason
|
reason | string |
définir la raison de l’affichage dans le sceau |
|
|
languageType
|
languageType | string |
Retours
SealingResponse
- SealingResponse
- SealingResponse
Scelle un document XML
Scelle un document XML fourni sous la forme d’une chaîne base64.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
xmlDocument
|
xmlDocument | True | string |
Base64String du document XML à seal |
|
flowKey
|
flowKey | True | string |
FlowKey valide fourni par Taktikal qui peut être utilisé pour sceller |
Retours
Objet
- response
- object
Vérifie l’état d’authentification d’un utilisateur à l’aide de son e-id islandais
Une fois qu’une réponse réussie de /Auth/Start a AuthRequestId est retournée et est utilisée pour vérifier si l’authentification est terminée. Si l’authentification est terminée et que l’objet client est rempli en fonction du LookupType. Le type de recherche indique que le type d’informations est récupéré pour le Registre national islandais.
Il existe trois jeux de données différents retournés en fonction du LookupType :
Nom : retourne uniquement le SSN et le nom de la personne authentifiée. Cela n’a aucun coût de recherche supplémentaire.
NameAddress : retourne les informations nom, SSN et adresse. Cela a un coût de recherche supplémentaire. Il s’agit de la valeur par défaut si aucune valeur n’est donnée pour LookupType.
NameAddressFamily : renvoie le nom, le SSN, les données d’adresse, le code de genre et les informations de famille.
Si « LookupType.NameAddressFamily » est sélectionné, les valeurs supplémentaires retournées sont retournées dans « Meta ».
Si la réponse a des erreurs ou n’est pas terminée, l’objet client est null et un StatusMessage a un message détaillé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
authRequestId
|
authRequestId | True | string | |
|
flowKey
|
flowKey | True | string |
Identificateur unique d’un flux appartenant à une société. |
|
type de recherche
|
lookupType | True | string |
Retours
PollCustomer
- PollCustomer
- PollCustomer
Définitions
Signe
Signe
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
Ssn
|
ssn | string | |
|
numéro de téléphone
|
phoneNumber | string | |
|
Messagerie électronique
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
key
|
key | string | |
|
signé
|
signed | boolean | |
|
signedAt
|
signedAt | date-time | |
|
processKey
|
processKey | string | |
|
reason
|
reason | string | |
|
hidePersonalCode
|
hidePersonalCode | boolean | |
|
communicationDeliveryType
|
communicationDeliveryType | string | |
|
URL
|
url | string | |
|
signatureType
|
signatureType | string | |
|
language
|
language | string | |
|
customSmsText
|
customSmsText | string |
SigningAttachment
SigningAttachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileContent
|
fileContent | string |
AttachmentReference
AttachmentReference
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
fileName
|
fileName | string | |
|
contentLength
|
contentLength | integer | |
|
type de contenu
|
contentType | string | |
|
URL
|
url | string | |
|
descriptif
|
description | string | |
|
processKey
|
processKey | string | |
|
attachmentType
|
attachmentType | string | |
|
signeeKey
|
signeeKey | string |
Dictionary_String_String_
Chaîne de<dictionnaire, chaîne>
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Dictionnaire
|
object |
Chaîne de<dictionnaire, chaîne> |
SigningProcessActivityLogWrapper
SigningProcessActivityLogWrapper
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
activityLog
|
activityLog | array of SigningProcessActivityLog | |
|
signes
|
signees | array of SigneeActivityLog | |
|
sequenceSignees
|
sequenceSignees | array of SequentialSigningSigneeActivityLog | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
activityDisplayName
|
activityDisplayName | string |
SigningProcessActivityLog
SigningProcessActivityLog
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
flowKey
|
flowKey | string |
Identificateur unique d’un flux appartenant à une société. |
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
status
|
status | string | |
|
descriptif
|
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
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
Ssn
|
ssn | string | |
|
nom
|
name | string | |
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
phone
|
phone | string | |
|
Messagerie électronique
|
string | ||
|
createdAt
|
createdAt | date-time | |
|
createdBy
|
createdBy | string | |
|
updatedAt
|
updatedAt | date-time | |
|
signatureType
|
signatureType | string |
SequentialSigningSigneeActivityLog
SequentialSigningSigneeActivityLog
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
sequenceKey
|
sequenceKey | string | |
|
signeeKey
|
signeeKey | string | |
|
URL
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigneeKeys
SigneeKeys
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
signeeKey
|
signeeKey | string | |
|
processKey
|
processKey | string |
SéquentielSigning
SéquentielSigning
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
status
|
status | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
utilisateur
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signes
|
signees | array of SequentialSigningSignee | |
|
signingProcesses
|
signingProcesses | array of SigningProcess |
SequentialSigningSignee
SequentialSigningSignee
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
URL
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigningProcess
SigningProcess
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
signes
|
signees | array of Signee | |
|
flowKey
|
flowKey | string |
Identificateur unique d’un flux appartenant à une société. |
|
status
|
status | string | |
|
Dictionnaire
|
meta | Dictionary_String_String_ |
Chaîne de<dictionnaire, chaîne> |
|
pdfFileName
|
pdfFileName | string | |
|
attachments
|
attachments | array of SigningAttachment | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
requiresAuth
|
requiresAuth | boolean | |
|
utilisateur
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string | |
|
flattenDocument
|
flattenDocument | boolean |
StartAuthResponse
StartAuthResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
authRequestId
|
authRequestId | string | |
|
verificationCode
|
verificationCode | string |
SealingResponse
SealingResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
Client
Client
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
Ssn
|
ssn | string | |
|
numéro de téléphone
|
phoneNumber | string | |
|
Messagerie électronique
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
token
|
token | string | |
|
flowKey
|
flowKey | string |
Identificateur unique d’un flux appartenant à une société. |
|
Dictionnaire
|
meta | Dictionary_String_String_ |
Chaîne de<dictionnaire, chaîne> |
PollCustomer
PollCustomer
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Client
|
customer | Customer |
Client |
|
statusMessage
|
statusMessage | string | |
|
waitingForUserInput
|
waitingForUserInput | boolean |
objet
Il s’agit du type 'object'.