Taktikal Core (Vorschau)
Mit Taktikal Core haben Sie die Möglichkeit, detaillierte Informationen zu Ihren Signierprozessen zu signieren, zu versiegeln, zu authentifizieren und zu erhalten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Taktikal |
| URL | https://docs.taktikal.com/ |
| help@taktikal.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Taktikal |
| Webseite | https://taktikal.com/ |
| Datenschutzrichtlinie | https://www.taktikal.com/privacy |
| Kategorien | Produktivität |
Taktikal Core-APIs sind eine leistungsstarke Möglichkeit, neue Lösungen in Ihrer eigenen Schnittstelle zu erstellen und in die bereits in Betrieb betreffenden Lösungen zu integrieren.
Dokumente können direkt von Ihren eigenen Systemen zur Signatur gesendet werden, und nach dem Signieren können die Dokumente und zugehörigen Metadaten automatisch an das Dokumentsystem zurückgesendet werden. Sie können auch den Status von Dokumenten im Signiervorgang überwachen und den Status basierend auf ID-Nummern oder anderen eindeutigen Bezeichnern aufrufen.
Voraussetzungen
Um die Taktikal Core-API zu verwenden, wenden Sie sich bitte an unser Vertriebsteam sales@taktikal.is , um die erforderlichen API-Anmeldeinformationen zu erwerben.
So erhalten Sie Anmeldeinformationen
Wenden Sie sich an unser Vertriebsteam, um Zugriff zu erstellen und Ihre API-Anmeldeinformationen abzurufen.
Erste Schritte mit Ihrem Connector
Die Kern-API kann Dokumente signiert, mit isländischer E-ID authentifizieren und alle Signaturprozesse verwalten.
- Verwenden Sie für die Authentifizierung /Auth/Start, um einen Authentifizierungsprozess zu initiieren, und dann /Auth/Poll, um zu überprüfen, ob der Status der Authentifizierung.
- Zum Signieren eines einzelnen Dokumentaufrufs /management/signing für ein einzelnes Dokument und /management/signing/sequenziell für eine Massensignatur mehrerer Dokumente.
- Um detailliertes Protokoll zu einem Signaturprozessaufruf /signing/activity/{ProcessKey} zu erhalten.
Bekannte Probleme und Einschränkungen
- Die Anforderungen müssen über einen Autorisierungsheader für die Standardauthentifizierung verfügen. Das ist der companyKey und API-Key
- Derzeit sind nur qualifizierte Signaturen mit einer isländischen e-ID.
- Die PDF-Bereitstellung sollte ab Base64-Zeichenfolge sein.
- Signierer müssen über eine gültige E-Mail und eine Mobiltelefonnummer verfügen.
Häufige Fehler und Abhilfemaßnahmen
Zurzeit werden nur PDF-Dateien zur Signatur akzeptiert.
Häufig gestellte Fragen
Weitere Informationen zur API finden Sie unter https://docs.taktikal.com
Das Starten eines Signaturvorgangs ist eine einzelne POST-Anforderung. Zum Starten eines Signaturvorgangs ist ein gültiges PDF-Dokument erforderlich und eine Liste der Signierer, die das Dokument signieren müssen. Taktikal behandelt die Anzeige des Dokuments an den Signierer, auch wenn ein communicationDeliveryType ausgewählt ist, sendet Taktikal dem Signierer eine SMS oder E-Mail mit einem Link zum Signieren. Nachdem das Dokument von allen Teilnehmern signiert wurde, sendet Taktikal das Dokument an die relevanten Übermittlungspfade, die registriert sind.
Ein FlowKey ist ein Schlüssel, der von Taktikal bereitgestellt wird. Dieser Schlüssel teilt Taktikal mit, wie diese Anforderung behandelt werden kann. Für einige flowKeys Taktikal kümmert sich um das Erstellen des Dokuments. Außerdem wird gesteuert, wo das signierte Dokument nach der Signatur übermittelt wird.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Unternehmensschlüssel | securestring | Der Unternehmensschlüssel für diese API | Richtig |
| API-Schlüssel | securestring | Der API-Schlüssel für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abbrechen des sequenziellen Signierungsprozesses |
Abbrechen des sequenziellen Signierungsprozesses basierend auf einem bestimmten Sequenzschlüssel. Ein Benutzer (E-Mail) kann bereitgestellt werden, der den sequenziellen Prozess abbricht. |
| Abbrechen eines Signierungsprozesses |
Abbrechen des Signierungsprozesses basierend auf einem bestimmten Prozessschlüssel. |
|
Aktualisieren eines Signee für den angegebenen Process |
Signee-Eigenschaften können basierend auf der Bereitstellung des ProcessKey und des SigneeKey aktualisiert werden. |
| Erstellt eine neue sequenzielle (Massen)-Signierungsprozesse. |
Erstellt einen neuen sequenziellen Signierungsprozess (Massenvorgang) mit einem oder mehreren Signaturprozessen. Jeder Signierungsprozess in einer Sequenz verfügt über ein oder mehrere Signierer. Beispiel:
Ausführliche Dokumentation finden Sie unter https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ |
| Erstellt einen neuen Signierungsprozess mit mindestens einem Signierer |
Erstellt einen neuen Signierungsprozess mit mindestens einem Signierer. |
| Initiiert einen Authentifizierungsprozess mit isländischer E-ID |
Die Authentifizierung mit der isländischen E-ID kann mit einem Mobiltelefon oder einer Audkenni-App erfolgen.
flowKey sollte immer bereitgestellt werden und ist im Taktikal-Portal verfügbar. |
| Ruft das Aktivitätsprotokoll für den Signierungsprozess ab. |
Rufen Sie das Aktivitätsprotokoll für einen Signierungsprozess ab. |
| Ruft das Aktivitätsprotokoll für ein Unternehmen ab. |
Ruft das Aktivitätsprotokoll für ein Unternehmen ab. |
| Ruft das Aktivitätsprotokoll für einen Benutzer (E-Mail) für einen bestimmten Zeitraum ab. |
Ruft das Aktivitätsprotokoll für einen Benutzer für einen Zeitraum ab. |
|
Ruft den Signierungsprozess nach process |
Rufen Sie den Signiervorgang nach Processkey und signeeKey ab. |
| Startet einen Authentifizierungsprozess mit isländischer E-ID für eine sequenzielle Signaturprozesse. |
Die Authentifizierung mit der isländischen E-ID kann mit einem Mobiltelefon oder einer Audkenni-App erfolgen.
|
| Versiegelt ein PDF-Dokument |
Siegelt ein bereitgestelltes PDF-Dokument, das als base64-Zeichenfolge bereitgestellt wird. |
| Versiegelt ein XML-Dokument |
Versiegelt ein bereitgestelltes XML-Dokument, das als base64-Zeichenfolge bereitgestellt wird. |
| Überprüft den Status der Authentifizierung für einen Benutzer, der seine isländische E-ID verwendet. |
Nach einer erfolgreichen Antwort von /Auth/Start wird eine AuthRequestId zurückgegeben und verwendet, um zu überprüfen, ob die Authentifizierung abgeschlossen ist. Wenn die Authentifizierung abgeschlossen ist und erfolgreich ist, wird das Kundenobjekt je nach LookupType aufgefüllt. Der Nachschlagetyp gibt an, welche Art von Informationen für die isländische nationale Registrierung abgerufen wird. Je nach LookupType werden drei verschiedene Datasets zurückgegeben:
Wenn "LookupType.NameAddressFamily" ausgewählt ist, werden die zurückgegebenen zusätzlichen Werte in 'Meta' zurückgegeben. Wenn die Antwort Fehler aufweist oder nicht abgeschlossen ist, ist das Kundenobjekt null, und eine StatusMessage enthält eine detaillierte Meldung. |
Abbrechen des sequenziellen Signierungsprozesses
Abbrechen des sequenziellen Signierungsprozesses basierend auf einem bestimmten Sequenzschlüssel. Ein Benutzer (E-Mail) kann bereitgestellt werden, der den sequenziellen Prozess abbricht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sequenzieller Signaturprozessbezeichner, der bereitgestellt werden muss.
|
SequenceKey | True | string |
Sequenzieller Signaturprozessbezeichner, der bereitgestellt werden muss. |
|
Nur der Benutzer, der den Signiervorgang gestartet hat, kann ihn abbrechen.
|
User | True | string |
Nur der Benutzer, der den Signiervorgang gestartet hat, kann ihn abbrechen. |
Gibt zurück
SequenziellesSigning
- SequenziellesSigning
- SequentialSigning
Abbrechen eines Signierungsprozesses
Abbrechen des Signierungsprozesses basierend auf einem bestimmten Prozessschlüssel.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutiger Bezeichner für einen einzelnen Dokumentsignierungsprozess.
|
ProcessKey | string |
Eindeutiger Bezeichner für einen einzelnen Dokumentsignierungsprozess. |
|
|
String-Objekt, in der Regel die E-Mail des Mitarbeiters, der Zugriff auf das Portal hat.
|
User | string |
String-Objekt, in der Regel die E-Mail des Mitarbeiters, der Zugriff auf das Portal hat. |
Gibt zurück
SigningProcess
- SigningProcess
- SigningProcess
Aktualisieren eines Signee für den angegebenen ProcessKey und SigneeKey
Signee-Eigenschaften können basierend auf der Bereitstellung des ProcessKey und des SigneeKey aktualisiert werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutiger Bezeichner einer Person, die einen einmaligen Signaturvorgang signiert.
|
SigneeKey | True | string |
Eindeutiger Bezeichner einer Person, die einen einmaligen Signaturvorgang signiert. |
|
Eindeutiger Bezeichner für einen einzelnen Dokumentsignierungsprozess.
|
ProcessKey | True | string |
Eindeutiger Bezeichner für einen einzelnen Dokumentsignierungsprozess. |
|
E-Mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
signeeKey
|
signeeKey | True | string | |
|
processKey
|
processKey | True | string | |
|
Grund
|
reason | string | ||
|
user
|
user | string |
Gibt zurück
Signee
- Signee
- Signee
Erstellt eine neue sequenzielle (Massen)-Signierungsprozesse.
Erstellt einen neuen sequenziellen Signierungsprozess (Massenvorgang) mit einem oder mehreren Signaturprozessen. Jeder Signierungsprozess in einer Sequenz verfügt über ein oder mehrere Signierer.
Beispiel:
- Ein Unternehmen möchte das Dokument A und B signiert haben. Signee X sollte Dokument A und B signieren, Signee Y sollte Dokument A und Signee Z signieren Dokument B.
- Anschließend ein neues CreateSequentalSigning mit Array von zwei CreateSigningProcess-Objekten. Signees X und Y werden als Signees für CreateSigningProcess für Document A und Signees X und Z als Signees für Document B hinzugefügt.
Ausführliche Dokumentation finden Sie unter https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
ist eine base64-Zeichenfolge des zu signierenden Dokuments. Dies ist nicht erforderlich, wenn der FlowKey das Erstellen des Dokuments übernimmt. |
|
|
pdfFileName
|
pdfFileName | string |
Wenn PdfDocument verwendet wird, muss ein Wert für den Dateinamen angegeben werden. |
|
|
flowKey
|
flowKey | True | string |
FlowKey wird von Taktikal bereitgestellt. Dieser Schlüssel teilt Taktikal mit, wie diese Anforderung behandelt werden kann. Für einige flowKeys Taktikal kümmert sich um das Erstellen des Dokuments. Außerdem wird gesteuert, wo das signierte Dokument nach der Signatur übermittelt wird. |
|
processKey
|
processKey | string | ||
|
name
|
name | string | ||
|
SSN
|
ssn | string | ||
|
Telefonnummer
|
phoneNumber | string | ||
|
E-Mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
Grund
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
language
|
language | string | ||
|
Wörterbuch
|
meta | object |
Wörterbuchzeichenfolge,Zeichenfolge<> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
Inhaltstyp
|
contentType | string | ||
|
URL
|
url | string | ||
|
Beschreibung
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
Der Standardwert ist „false“. Wenn dieser Wert auf "true" festgelegt ist, müssen alle Signierer die E-ID verwenden, um sich zu authentifizieren, bevor sie das Dokument anzeigen können. |
|
|
signInOrder
|
signInOrder | boolean |
Der Standardwert ist „false“. Steuert die Reihenfolge der Signierer. Sie sendet nur eine Signaturanforderung an die erste Person in der Signiererliste, mit der sie beginnen soll. Nachdem er das nächste Signee signiert hat usw. |
|
|
signatureLocation
|
signatureLocation | string |
Dies kann "BottomLastPage" oder der Standardwert "TopFirstPage" sein. Steuert, wo die Signatur im Dokument angezeigt werden soll. |
|
|
user
|
user | string |
E-Mail-Adresse des Benutzers, der die Anforderung sendet. Kann leer sein. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
Der Standardwert ist „false“. Wenn dieser Wert auf "true" festgelegt ist, versuchen wir, die Eingabefelder für Dokumente zu flachen. |
|
|
reminderRule
|
reminderRule | string |
Sendet Erinnerungen, lassen Sie keine Leerzeichen. Format sollte "firstReminder after x days:Then every y days" sein, z. B. "1:3" sendet eine Erinnerung nach 1 Tag und dann alle drei Tage danach. Lassen Sie leer oder null für keine Erinnerungen, gültige Werte werden für die erste Erinnerung zwischen 0 und 30 Tagen gesendet (0 bedeutet keine Erinnerung), und senden Sie dann alle 0 bis 15 Tage (0, wieder, was keine Erinnerungen bedeutet, 0:10 würde also nur alle 10 Tage Erinnerung senden, während 12:0 nur eine Erinnerung nach 12 Tagen senden würde. |
|
|
user
|
user | True | string |
Der Benutzer, der den sequenziellen Signierungsprozess startet |
|
requiresAuth
|
requiresAuth | boolean |
Der Standardwert ist „false“. Wenn dieser Wert auf "true" festgelegt ist, müssen alle Signierer die E-ID verwenden, um sich zu authentifizieren, bevor sie das Dokument anzeigen können. |
|
|
signInOrder
|
signInOrder | boolean |
Der Standardwert ist „false“. Steuert die Reihenfolge der Signierer. Sie sendet nur eine Signaturanforderung an die erste Person in der Signiererliste, mit der sie beginnen soll. Nachdem er das nächste Signee signiert hat usw. |
Gibt zurück
SequenziellesSigning
- SequenziellesSigning
- SequentialSigning
Erstellt einen neuen Signierungsprozess mit mindestens einem Signierer
Erstellt einen neuen Signierungsprozess mit mindestens einem Signierer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
ist eine base64-Zeichenfolge des zu signierenden Dokuments. Dies ist nicht erforderlich, wenn der FlowKey das Erstellen des Dokuments übernimmt. |
|
|
pdfFileName
|
pdfFileName | string |
Wenn PdfDocument verwendet wird, muss ein Wert für den Dateinamen angegeben werden. |
|
|
flowKey
|
flowKey | True | string |
FlowKey wird von Taktikal bereitgestellt. Dieser Schlüssel teilt Taktikal mit, wie diese Anforderung behandelt werden kann. Für einige flowKeys Taktikal kümmert sich um das Erstellen des Dokuments. Außerdem wird gesteuert, wo das signierte Dokument nach der Signatur übermittelt wird. |
|
processKey
|
processKey | string | ||
|
name
|
name | string | ||
|
SSN
|
ssn | string | ||
|
Telefonnummer
|
phoneNumber | string | ||
|
E-Mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
Grund
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
language
|
language | string | ||
|
Wörterbuch
|
meta | object |
Wörterbuchzeichenfolge,Zeichenfolge<> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
Inhaltstyp
|
contentType | string | ||
|
URL
|
url | string | ||
|
Beschreibung
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
Der Standardwert ist „false“. Wenn dieser Wert auf "true" festgelegt ist, müssen alle Signierer die E-ID verwenden, um sich zu authentifizieren, bevor sie das Dokument anzeigen können. |
|
|
signInOrder
|
signInOrder | boolean |
Der Standardwert ist „false“. Steuert die Reihenfolge der Signierer. Sie sendet nur eine Signaturanforderung an die erste Person in der Signiererliste, mit der sie beginnen soll. Nachdem er das nächste Signee signiert hat usw. |
|
|
signatureLocation
|
signatureLocation | string |
Dies kann "BottomLastPage" oder der Standardwert "TopFirstPage" sein. Steuert, wo die Signatur im Dokument angezeigt werden soll. |
|
|
user
|
user | string |
E-Mail-Adresse des Benutzers, der die Anforderung sendet. Kann leer sein. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
Der Standardwert ist „false“. Wenn dieser Wert auf "true" festgelegt ist, versuchen wir, die Eingabefelder für Dokumente zu flachen. |
|
|
reminderRule
|
reminderRule | string |
Sendet Erinnerungen, lassen Sie keine Leerzeichen. Format sollte "firstReminder after x days:Then every y days" sein, z. B. "1:3" sendet eine Erinnerung nach 1 Tag und dann alle drei Tage danach. Lassen Sie leer oder null für keine Erinnerungen, gültige Werte werden für die erste Erinnerung zwischen 0 und 30 Tagen gesendet (0 bedeutet keine Erinnerung), und senden Sie dann alle 0 bis 15 Tage (0, wieder, was keine Erinnerungen bedeutet, 0:10 würde also nur alle 10 Tage Erinnerung senden, während 12:0 nur eine Erinnerung nach 12 Tagen senden würde. |
Gibt zurück
SigningProcess
- SigningProcess
- SigningProcess
Initiiert einen Authentifizierungsprozess mit isländischer E-ID
Die Authentifizierung mit der isländischen E-ID kann mit einem Mobiltelefon oder einer Audkenni-App erfolgen.
- Verwenden des Mobiltelefons: Der AuthenticationContextType sollte auf "Sim" festgelegt werden, und die phoneNumber muss auf eine isländische Mobiltelefonnummer festgelegt werden. Der Ssn wird ignoriert.
- Verwenden der Audkenni-App: Die AuthenticationContextType sollte auf "App" festgelegt werden, und der ssn muss auf eine icdlandische Sozialversicherungsnummer festgelegt werden. Die phoneNumber wird ignoriert.
flowKey sollte immer bereitgestellt werden und ist im Taktikal-Portal verfügbar.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
SSN
|
ssn | string | ||
|
Telefonnummer
|
phoneNumber | string | ||
|
flowKey
|
flowKey | True | string |
Eindeutiger Bezeichner für einen Fluss, der zu einem Unternehmen gehört. |
|
authenticationContextType
|
authenticationContextType | True | string |
Gibt zurück
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Ruft das Aktivitätsprotokoll für den Signierungsprozess ab.
Rufen Sie das Aktivitätsprotokoll für einen Signierungsprozess ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die E-Mail des Benutzers.
|
User | string |
Die E-Mail des Benutzers. |
|
|
Das Startdatum des zu durchsuchenden Protokolls muss ein kleineres Datum als "EndDate" sein.
|
StartDate | True | date-time |
Das Startdatum des zu durchsuchenden Protokolls muss ein kleineres Datum als "EndDate" sein. |
|
Das Enddatum des zu durchsuchenden Protokolls muss ein größeres Datum als "StartDatum" sein.
|
EndDate | True | date-time |
Das Enddatum des zu durchsuchenden Protokolls muss ein größeres Datum als "StartDatum" sein. |
|
Verwenden Sie diese Funktion, wenn sie nach einem einzelnen Signaturprozess gefiltert werden soll.
|
ProcessKey | True | string |
Verwenden Sie diese Funktion, wenn sie nach einem einzelnen Signaturprozess gefiltert werden soll. |
|
Kann verwendet werden, um nur Aktivitäten für einen bestimmten Flusstyp abzurufen.
|
FlowType | string |
Kann verwendet werden, um nur Aktivitäten für einen bestimmten Flusstyp abzurufen. |
|
|
wird verwendet, um das Resultset zu blättern und nur N viele Ergebnisse zurückzugeben.
|
Take | integer |
wird verwendet, um das Resultset zu blättern und nur N viele Ergebnisse zurückzugeben. |
|
|
wird verwendet, um das Resultset zu blättern und die ersten N-Ergebnisse zu überspringen.
|
Skip | integer |
wird verwendet, um das Resultset zu blättern und die ersten N-Ergebnisse zu überspringen. |
|
|
Wenn ein Wert vorhanden ist, geben wir nur Datensätze zurück, die diesem FlowKey entsprechen.
|
FlowKey | string |
Wenn ein Wert vorhanden ist, geben wir nur Datensätze zurück, die diesem FlowKey entsprechen. |
Gibt zurück
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Ruft das Aktivitätsprotokoll für ein Unternehmen ab.
Ruft das Aktivitätsprotokoll für ein Unternehmen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Das Startdatum des zu durchsuchenden Protokolls muss ein kleineres Datum als "EndDate" sein.
|
StartDate | True | date-time |
Das Startdatum des zu durchsuchenden Protokolls muss ein kleineres Datum als "EndDate" sein. |
|
Das Enddatum des zu durchsuchenden Protokolls muss ein größeres Datum als "StartDatum" sein.
|
EndDate | True | date-time |
Das Enddatum des zu durchsuchenden Protokolls muss ein größeres Datum als "StartDatum" sein. |
|
Wird verwendet, um das Resultset zu blättern und nur N viele Ergebnisse zurückzugeben.
|
Take | integer |
Wird verwendet, um das Resultset zu blättern und nur N viele Ergebnisse zurückzugeben. |
|
|
Wird verwendet, um das Resultset zu blättern und die ersten N-Ergebnisse zu überspringen.
|
Skip | integer |
Wird verwendet, um das Resultset zu blättern und die ersten N-Ergebnisse zu überspringen. |
|
|
Die E-Mail des Benutzers.
|
User | string |
Die E-Mail des Benutzers. |
|
|
Kann verwendet werden, um nur Aktivitäten für einen bestimmten Flusstyp abzurufen.
|
FlowType | string |
Kann verwendet werden, um nur Aktivitäten für einen bestimmten Flusstyp abzurufen. |
|
|
Wenn ein Wert vorhanden ist, geben wir nur Datensätze zurück, die diesem FlowKey entsprechen.
|
FlowKey | string |
Wenn ein Wert vorhanden ist, geben wir nur Datensätze zurück, die diesem FlowKey entsprechen. |
Gibt zurück
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Ruft das Aktivitätsprotokoll für einen Benutzer (E-Mail) für einen bestimmten Zeitraum ab.
Ruft das Aktivitätsprotokoll für einen Benutzer für einen Zeitraum ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die E-Mail des Benutzers.
|
User | string |
Die E-Mail des Benutzers. |
|
|
Das Startdatum des zu durchsuchenden Protokolls muss ein kleineres Datum als "EndDate" sein.
|
StartDate | True | date-time |
Das Startdatum des zu durchsuchenden Protokolls muss ein kleineres Datum als "EndDate" sein. |
|
Das Enddatum des zu durchsuchenden Protokolls muss ein größeres Datum als "StartDatum" sein.
|
EndDate | True | date-time |
Das Enddatum des zu durchsuchenden Protokolls muss ein größeres Datum als "StartDatum" sein. |
|
Verwenden Sie diese Funktion, wenn sie nach einem einzelnen Signaturprozess gefiltert werden soll.
|
ProcessKey | string |
Verwenden Sie diese Funktion, wenn sie nach einem einzelnen Signaturprozess gefiltert werden soll. |
|
|
Kann verwendet werden, um nur Aktivitäten für einen bestimmten Flusstyp abzurufen.
|
FlowType | string |
Kann verwendet werden, um nur Aktivitäten für einen bestimmten Flusstyp abzurufen. |
|
|
Wird verwendet, um das Resultset zu blättern und nur N viele Ergebnisse zurückzugeben.
|
Take | integer |
Wird verwendet, um das Resultset zu blättern und nur N viele Ergebnisse zurückzugeben. |
|
|
Wird verwendet, um das Resultset zu blättern und die ersten N-Ergebnisse zu überspringen.
|
Skip | integer |
Wird verwendet, um das Resultset zu blättern und die ersten N-Ergebnisse zu überspringen. |
|
|
Wenn ein Wert vorhanden ist, werden nur Datensätze zurückgegeben, die diesem FlowKey entsprechen.
|
FlowKey | string |
Wenn ein Wert vorhanden ist, geben wir nur Datensätze zurück, die diesem FlowKey entsprechen. |
Gibt zurück
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Ruft den Signierungsprozess nach processKey und signeeKey ab.
Rufen Sie den Signiervorgang nach Processkey und signeeKey ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutiger Bezeichner für einen einzelnen Dokumentsignierungsprozess.
|
ProcessKey | True | string |
Eindeutiger Bezeichner für einen einzelnen Dokumentsignierungsprozess. |
|
Eindeutiger Bezeichner einer Person, die einen einmaligen Signaturvorgang signiert.
|
SigneeKey | True | string |
Eindeutiger Bezeichner einer Person, die einen einmaligen Signaturvorgang signiert. |
|
Ein Benutzer-Agent ist Software, die für einen Benutzer fungiert, z. B. einen Webbrowser oder einen E-Mail-Client.
|
UserAgent | string |
Ein Benutzer-Agent ist Software, die für einen Benutzer fungiert, z. B. einen Webbrowser oder einen E-Mail-Client. |
Gibt zurück
SigningProcess
- SigningProcess
- SigningProcess
Startet einen Authentifizierungsprozess mit isländischer E-ID für eine sequenzielle Signaturprozesse.
Die Authentifizierung mit der isländischen E-ID kann mit einem Mobiltelefon oder einer Audkenni-App erfolgen.
- Using Mobile Phone: The AuthenticationContextType should be set to 'Sim' and the phoneNumber must be set to an Ucelandic mobile phone number. Der Ssn wird ignoriert.
- Verwenden der Audkenni-App: Die AuthenticationContextType sollte auf "App" festgelegt werden, und der ssn muss auf eine icdlandische Sozialversicherungsnummer festgelegt werden. Die phoneNumber wird ignoriert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutiger Bezeichner für sequenzierende (Massen-)Signierungsprozesse.
|
SequenceKey | True | string |
Eindeutiger Bezeichner für sequenzierende (Massen-)Signierungsprozesse. |
|
sequenceKey
|
sequenceKey | True | string | |
|
loginHint
|
loginHint | True | string | |
|
authenticationContextType
|
authenticationContextType | True | string |
Gibt zurück
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Versiegelt ein PDF-Dokument
Siegelt ein bereitgestelltes PDF-Dokument, das als base64-Zeichenfolge bereitgestellt wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | True | string |
Eine Base64String des zu versiegelnden PDF-Dokuments. |
|
flowKey
|
flowKey | True | string |
Eindeutiger Bezeichner für einen Fluss, der zu einem Unternehmen gehört. |
|
Grund
|
reason | string |
Festlegen des Grunds für die Anzeige im Siegel |
|
|
languageType
|
languageType | string |
Gibt zurück
SealResponse
- SealResponse
- SealingResponse
Versiegelt ein XML-Dokument
Versiegelt ein bereitgestelltes XML-Dokument, das als base64-Zeichenfolge bereitgestellt wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
xmlDocument
|
xmlDocument | True | string |
Base64String des zu versiegelnden XML-Dokuments |
|
flowKey
|
flowKey | True | string |
Ein gültiger FlowKey, der von Taktikal bereitgestellt wird, der zum Versiegeln verwendet werden kann |
Gibt zurück
Object
- response
- object
Überprüft den Status der Authentifizierung für einen Benutzer, der seine isländische E-ID verwendet.
Nach einer erfolgreichen Antwort von /Auth/Start wird eine AuthRequestId zurückgegeben und verwendet, um zu überprüfen, ob die Authentifizierung abgeschlossen ist. Wenn die Authentifizierung abgeschlossen ist und erfolgreich ist, wird das Kundenobjekt je nach LookupType aufgefüllt. Der Nachschlagetyp gibt an, welche Art von Informationen für die isländische nationale Registrierung abgerufen wird.
Je nach LookupType werden drei verschiedene Datasets zurückgegeben:
Name: Gibt nur den SSN und den Namen der authentifizierten Person zurück. Dies hat keine zusätzlichen Nachschlagekosten.
NameAddress: Gibt Namen-, SSN- und Adressinformationen zurück. Dies hat zusätzliche Nachschlagekosten. Dies ist der Standardwert, wenn für LookupType kein Wert angegeben wird.
NameAddressFamily: Gibt Name, SSN, Adressdaten, Geschlechtscode und Familieninformationen zurück.
Wenn "LookupType.NameAddressFamily" ausgewählt ist, werden die zurückgegebenen zusätzlichen Werte in 'Meta' zurückgegeben.
Wenn die Antwort Fehler aufweist oder nicht abgeschlossen ist, ist das Kundenobjekt null, und eine StatusMessage enthält eine detaillierte Meldung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
authRequestId
|
authRequestId | True | string | |
|
flowKey
|
flowKey | True | string |
Eindeutiger Bezeichner für einen Fluss, der zu einem Unternehmen gehört. |
|
lookupType
|
lookupType | True | string |
Gibt zurück
PollCustomer
- PollCustomer
- PollCustomer
Definitionen
Signee
Signee
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string | |
|
SSN
|
ssn | string | |
|
Telefonnummer
|
phoneNumber | string | |
|
E-Mail
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
key
|
key | string | |
|
gezeichnet
|
signed | boolean | |
|
signedAt
|
signedAt | date-time | |
|
processKey
|
processKey | string | |
|
Grund
|
reason | string | |
|
hidePersonalCode
|
hidePersonalCode | boolean | |
|
communicationDeliveryType
|
communicationDeliveryType | string | |
|
URL
|
url | string | |
|
signatureType
|
signatureType | string | |
|
language
|
language | string | |
|
customSmsText
|
customSmsText | string |
SigningAttachment
SigningAttachment
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileContent
|
fileContent | string |
AttachmentReference
AttachmentReference
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
fileName
|
fileName | string | |
|
contentLength
|
contentLength | integer | |
|
Inhaltstyp
|
contentType | string | |
|
URL
|
url | string | |
|
Beschreibung
|
description | string | |
|
processKey
|
processKey | string | |
|
attachmentType
|
attachmentType | string | |
|
signeeKey
|
signeeKey | string |
Dictionary_String_String_
Wörterbuchzeichenfolge,Zeichenfolge<>
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wörterbuch
|
object |
Wörterbuchzeichenfolge,Zeichenfolge<> |
SigningProcessActivityLogWrapper
SigningProcessActivityLogWrapper
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
activityLog
|
activityLog | array of SigningProcessActivityLog | |
|
Unterzeichner
|
signees | array of SigneeActivityLog | |
|
sequenceSignees
|
sequenceSignees | array of SequentialSigningSigneeActivityLog | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
activityDisplayName
|
activityDisplayName | string |
SigningProcessActivityLog
SigningProcessActivityLog
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
flowKey
|
flowKey | string |
Eindeutiger Bezeichner für einen Fluss, der zu einem Unternehmen gehört. |
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
status
|
status | string | |
|
Beschreibung
|
description | string | |
|
userAgent
|
userAgent | string | |
|
fileName
|
fileName | string | |
|
ErstelltAm
|
createdAt | date-time | |
|
createdBy
|
createdBy | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string |
SigneeActivityLog
SigneeActivityLog
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
SSN
|
ssn | string | |
|
name
|
name | string | |
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
phone
|
phone | string | |
|
E-Mail
|
string | ||
|
ErstelltAm
|
createdAt | date-time | |
|
createdBy
|
createdBy | string | |
|
updatedAt
|
updatedAt | date-time | |
|
signatureType
|
signatureType | string |
SequentialSigningSigneeActivityLog
SequentialSigningSigneeActivityLog
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
sequenceKey
|
sequenceKey | string | |
|
signeeKey
|
signeeKey | string | |
|
URL
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigneeKeys
SigneeKeys
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
signeeKey
|
signeeKey | string | |
|
processKey
|
processKey | string |
SequenziellesSigning
SequenziellesSigning
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
key
|
key | string | |
|
status
|
status | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
user
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
Unterzeichner
|
signees | array of SequentialSigningSignee | |
|
signingProcesses
|
signingProcesses | array of SigningProcess |
SequentialSigningSignee
SequentialSigningSignee
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
key
|
key | string | |
|
URL
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigningProcess
SigningProcess
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
key
|
key | string | |
|
Unterzeichner
|
signees | array of Signee | |
|
flowKey
|
flowKey | string |
Eindeutiger Bezeichner für einen Fluss, der zu einem Unternehmen gehört. |
|
status
|
status | string | |
|
Wörterbuch
|
meta | Dictionary_String_String_ |
Wörterbuchzeichenfolge,Zeichenfolge<> |
|
pdfFileName
|
pdfFileName | string | |
|
attachments
|
attachments | array of SigningAttachment | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
requiresAuth
|
requiresAuth | boolean | |
|
user
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string | |
|
flattenDocument
|
flattenDocument | boolean |
StartAuthResponse
StartAuthResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
authRequestId
|
authRequestId | string | |
|
verificationCode
|
verificationCode | string |
SealResponse
SealResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
Customer
Customer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string | |
|
SSN
|
ssn | string | |
|
Telefonnummer
|
phoneNumber | string | |
|
E-Mail
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
token
|
token | string | |
|
flowKey
|
flowKey | string |
Eindeutiger Bezeichner für einen Fluss, der zu einem Unternehmen gehört. |
|
Wörterbuch
|
meta | Dictionary_String_String_ |
Wörterbuchzeichenfolge,Zeichenfolge<> |
PollCustomer
PollCustomer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Customer
|
customer | Customer |
Customer |
|
statusNachricht
|
statusMessage | string | |
|
waitingForUserInput
|
waitingForUserInput | boolean |
Objekt
Dies ist der Typ 'object'.