Taktikal Core (preview)
Met Taktikal Core kunt u gedetailleerde informatie over uw ondertekeningsprocessen ondertekenen, verzegelen, verifiëren en verkrijgen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Taktikal |
| URL | https://docs.taktikal.com/ |
| E-mailen | help@taktikal.com |
| Connector-metagegevens | |
|---|---|
| Uitgever | Taktikal |
| Webpagina | https://taktikal.com/ |
| Privacybeleid | https://www.taktikal.com/privacy |
| Categorieën | Productiviteit |
Taktikal Core-API's is een krachtige manier om nieuwe oplossingen in uw eigen interface te bouwen en te integreren met de oplossingen die al in gebruik zijn.
Documenten kunnen rechtstreeks vanuit uw eigen systemen worden verzonden voor handtekening en na ondertekening kunnen de documenten en gerelateerde metagegevens automatisch worden teruggestuurd naar het documentsysteem. U kunt ook de status van documenten in het ondertekeningsproces controleren en de status op basis van id-nummers of andere unieke id's aanroepen.
Vereiste voorwaarden
Als u de Taktikal Core-API wilt gebruiken, neemt u contact op met ons verkoopteam sales@taktikal.is om de benodigde API-referenties te verkrijgen.
Referenties ophalen
Neem contact op met ons verkoopteam om toegang te maken en uw API-referenties te verkrijgen.
Aan de slag met uw connector
De kern-API kan documenten ophalen die zijn ondertekend, verifiëren met IJslandse e-ID en alle ondertekeningsprocessen beheren
- Voor verificatie gebruikt u /Auth/Start om een verificatieproces te starten en vervolgens /Auth/Poll om te controleren of de status van de verificatie.
- Als u één documentoproep /management/ondertekening wilt ondertekenen voor één document en /management/signing/sequentiële voor een bulkhandtekening van meerdere documenten.
- Als u een gedetailleerd logboek wilt ophalen over een aanroep /signing/activity/{ProcessKey}.
Bekende problemen en beperkingen
- De aanvragen moeten beschikken over een autorisatieheader voor basisverificatie. Dat is de companyKey en API-Key
- Op dit moment zijn alleen gekwalificeerde handtekeningen met een IJslandse e-id.
- De PDF-opgegeven moet ab Base64-tekenreeks zijn.
- Ondertekenaars moeten een geldig e-mailadres en een mobiel telefoonnummer hebben.
Veelvoorkomende fouten en oplossingen
Momenteel worden alleen PDF-bestanden geaccepteerd voor handtekening.
Veelgestelde vragen
Meer informatie over de API vindt u onder https://docs.taktikal.com
Het starten van een ondertekeningsproces is één POST-aanvraag. Als u een handtekeningproces wilt starten, hebt u een geldig PDF-document nodig en een lijst met ondertekeners die het document moeten ondertekenen. Taktikal verwerkt het weergeven van het document naar de ondertekening, ook als een communicationDeliveryType is geselecteerd, stuurt Taktikal de ondertekening een sms of e-mail met een koppeling om te ondertekenen. Nadat het document is ondertekend door alle deelnemers stuurt Taktikal het document naar de relevante leveringspaden die zijn geregistreerd.
Een flowKey is een sleutel van Taktikal. Deze sleutel vertelt Taktikal hoe deze aanvraag moet worden verwerkt. Voor sommige flowKeys Taktikal wordt het document gemaakt. Het bepaalt ook waar het ondertekende document wordt bezorgd na ondertekening.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Bedrijfssleutel | beveiligde string | De bedrijfssleutel voor deze API | Klopt |
| API-sleutel | beveiligde string | De API-sleutel voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Controleert de status van verificatie voor een gebruiker met behulp van hun IJslandse e-id |
Nadat een geslaagd antwoord van /Auth/Start een AuthRequestId is geretourneerd en wordt gebruikt om te controleren of de verificatie is voltooid. Als de verificatie is voltooid en het klantobject is ingevuld, is afhankelijk van het LookupType. Het opzoektype geeft aan welk type informatie wordt opgehaald voor het IJslands nationaal register. Er worden drie verschillende gegevenssets geretourneerd, afhankelijk van het LookupType:
Als LookupType.NameAddressFamily is geselecteerd, worden de geretourneerde extra waarden geretourneerd in 'Meta'. Als het antwoord fouten bevat of niet is voltooid, is het klantobject null en krijgt een StatusMessage een gedetailleerd bericht. |
|
Een onderteken voor de opgegeven Process |
Signee-eigenschappen kunnen worden bijgewerkt op basis van het opgeven van de ProcessKey en de SigneeKey. |
| Een ondertekeningsproces annuleren |
Annuleer het ondertekeningsproces op basis van een bepaalde processleutel. |
| Een PDF-document verzegelen |
Een geleverd PDF-document verzegelen als een base64-tekenreeks. |
| Een XML-document verzegelen |
Hiermee wordt een opgegeven XML-document als een base64-tekenreeks verzegeld. |
| Het sequentiële ondertekeningsproces annuleren |
Annuleer het sequentiële ondertekeningsproces op basis van een bepaalde reekssleutel. Er kan een gebruiker (e-mail) worden opgegeven die het sequentiële proces annuleert. |
| Hiermee haalt u het activiteitenlogboek op voor een gebruiker (e-mail) voor een specifieke periode |
Hiermee wordt een activiteitenlogboek voor een gebruiker voor een periode ophaalt. |
| Hiermee haalt u het activiteitenlogboek op voor het ondertekeningsproces |
Haal het activiteitenlogboek voor een ondertekeningsproces op. |
| Hiermee haalt u het activiteitenlogboek voor een bedrijf op |
Hiermee haalt u het activiteitenlogboek voor een bedrijf op |
|
Hiermee haalt u het ondertekeningsproces op door process |
Get's the signing process by processkey and signeeKey. |
| Hiermee maakt u een nieuw ondertekeningsproces met een of meer ondertekeners |
Hiermee maakt u een nieuw ondertekeningsproces met een of meer ondertekentekens. |
| Hiermee maakt u een nieuwe sequentiële (bulk) ondertekeningsprocessen |
Hiermee maakt u een nieuw sequentiële ondertekeningsproces (bulk) met een of meer ondertekeningsprocessen. Elk ondertekeningsproces in een reeks heeft een of meer ondertekeners. Voorbeeld:
Gedetailleerde documentatie vindt u op https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ |
| Start een verificatieproces met IJslandse e-id |
Verificatie met de IJslandse e-id kan worden gedaan met een mobiele telefoon of Audkenni-app.
flowKey moet altijd worden opgegeven en is toegankelijk in de Taktikal-portal. |
| Start een verificatieproces met IJslandse e-id voor een sequentiële ondertekeningsprocessen |
Verificatie met de IJslandse e-id kan worden gedaan met een mobiele telefoon of Audkenni-app.
|
Controleert de status van verificatie voor een gebruiker met behulp van hun IJslandse e-id
Nadat een geslaagd antwoord van /Auth/Start een AuthRequestId is geretourneerd en wordt gebruikt om te controleren of de verificatie is voltooid. Als de verificatie is voltooid en het klantobject is ingevuld, is afhankelijk van het LookupType. Het opzoektype geeft aan welk type informatie wordt opgehaald voor het IJslands nationaal register.
Er worden drie verschillende gegevenssets geretourneerd, afhankelijk van het LookupType:
Naam: retourneert alleen de SSN en de naam van de geverifieerde persoon. Dit heeft geen extra opzoekkosten.
NameAddress: retourneert naam, SSN en adresgegevens. Dit heeft extra opzoekkosten. Dit is de standaardwaarde als er geen waarde wordt gegeven voor LookupType.
NameAddressFamily: retourneert naam, SSN, adresgegevens, geslachtscode en familiegegevens.
Als LookupType.NameAddressFamily is geselecteerd, worden de geretourneerde extra waarden geretourneerd in 'Meta'.
Als het antwoord fouten bevat of niet is voltooid, is het klantobject null en krijgt een StatusMessage een gedetailleerd bericht.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
authRequestId
|
authRequestId | True | string | |
|
flowKey
|
flowKey | True | string |
Unieke id voor een stroom die deel uitmaakt van een bedrijf. |
|
opzoeken
|
lookupType | True | string |
Retouren
PollCustomer
- PollCustomer
- PollCustomer
Een onderteken voor de opgegeven ProcessKey en SigneeKey bijwerken
Signee-eigenschappen kunnen worden bijgewerkt op basis van het opgeven van de ProcessKey en de SigneeKey.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van een persoon die één ondertekeningsproces ondertekent.
|
SigneeKey | True | string |
Unieke id van een persoon die één ondertekeningsproces ondertekent. |
|
Unieke id voor één documentondertekeningsproces.
|
ProcessKey | True | string |
Unieke id voor één documentondertekeningsproces. |
|
e-mailadres
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
signeeKey
|
signeeKey | True | string | |
|
processKey
|
processKey | True | string | |
|
reden
|
reason | string | ||
|
user
|
user | string |
Retouren
Signee
- Signee
- Signee
Een ondertekeningsproces annuleren
Annuleer het ondertekeningsproces op basis van een bepaalde processleutel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor één documentondertekeningsproces.
|
ProcessKey | string |
Unieke id voor één documentondertekeningsproces. |
|
|
Tekenreeksobject, meestal het e-mailadres van de werknemer die toegang heeft tot de portal.
|
User | string |
Tekenreeksobject, meestal het e-mailadres van de werknemer die toegang heeft tot de portal. |
Retouren
SigningProcess
- SigningProcess
- SigningProcess
Een PDF-document verzegelen
Een geleverd PDF-document verzegelen als een base64-tekenreeks.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | True | string |
Een Base64String van het PDF-document om af te sluiten. |
|
flowKey
|
flowKey | True | string |
Unieke id voor een stroom die deel uitmaakt van een bedrijf. |
|
reden
|
reason | string |
de reden instellen om weer te geven in de afdichting |
|
|
languageType
|
languageType | string |
Retouren
SealResponse
- SealResponse
- SealingResponse
Een XML-document verzegelen
Hiermee wordt een opgegeven XML-document als een base64-tekenreeks verzegeld.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
xmlDocument
|
xmlDocument | True | string |
Base64String van het XML-document om af te sluiten |
|
flowKey
|
flowKey | True | string |
Een geldige flowKey geleverd door Taktikal die kan worden gebruikt voor het verzegelen |
Retouren
Object
- response
- object
Het sequentiële ondertekeningsproces annuleren
Annuleer het sequentiële ondertekeningsproces op basis van een bepaalde reekssleutel. Er kan een gebruiker (e-mail) worden opgegeven die het sequentiële proces annuleert.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sequentiële ondertekeningsproces-id die moet worden opgegeven.
|
SequenceKey | True | string |
Sequentiële ondertekeningsproces-id die moet worden opgegeven. |
|
Alleen de gebruiker die het ondertekeningsproces heeft gestart, kan het annuleren.
|
User | True | string |
Alleen de gebruiker die het ondertekeningsproces heeft gestart, kan het annuleren. |
Retouren
Sequentiële toewijzing
- Sequentiële toewijzing
- SequentialSigning
Hiermee haalt u het activiteitenlogboek op voor een gebruiker (e-mail) voor een specifieke periode
Hiermee wordt een activiteitenlogboek voor een gebruiker voor een periode ophaalt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Het e-mailadres van de gebruiker.
|
User | string |
Het e-mailadres van de gebruiker. |
|
|
De begindatum van het logboek dat moet worden doorzocht, moet een kleinere datum zijn dan Einddatum.
|
StartDate | True | date-time |
De begindatum van het logboek dat moet worden doorzocht, moet een kleinere datum zijn dan Einddatum. |
|
De einddatum van het logboek dat moet worden doorzocht, moet een grotere datum zijn dan Begindatum.
|
EndDate | True | date-time |
De einddatum van het logboek dat moet worden doorzocht, moet een grotere datum zijn dan Begindatum. |
|
Gebruik deze optie als u wilt filteren op één ondertekeningsproces.
|
ProcessKey | string |
Gebruik deze optie als u wilt filteren op één ondertekeningsproces. |
|
|
Kan worden gebruikt om alleen activiteit op te halen voor een specifiek stroomtype.
|
FlowType | string |
Kan worden gebruikt om alleen activiteit op te halen voor een specifiek stroomtype. |
|
|
Wordt gebruikt om de resultatenset te pagina's en retourneert alleen N veel resultaten.
|
Take | integer |
Wordt gebruikt om de resultatenset te pagina's en retourneert alleen N veel resultaten. |
|
|
Wordt gebruikt om de resultatenset te pagina's te bekijken en de eerste N-resultaten over te slaan.
|
Skip | integer |
Wordt gebruikt om de resultatenset te pagina's te bekijken en de eerste N-resultaten over te slaan. |
|
|
Als het een waarde heeft, retourneren we alleen records die overeenkomen met deze flowKey
|
FlowKey | string |
Als het een waarde heeft, retourneren we alleen records die overeenkomen met deze flowKey. |
Retouren
- Lijst<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Hiermee haalt u het activiteitenlogboek op voor het ondertekeningsproces
Haal het activiteitenlogboek voor een ondertekeningsproces op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Het e-mailadres van de gebruiker.
|
User | string |
Het e-mailadres van de gebruiker. |
|
|
De begindatum van het logboek dat moet worden doorzocht, moet een kleinere datum zijn dan Einddatum.
|
StartDate | True | date-time |
De begindatum van het logboek dat moet worden doorzocht, moet een kleinere datum zijn dan Einddatum. |
|
De einddatum van het logboek dat moet worden doorzocht, moet een grotere datum zijn dan Begindatum.
|
EndDate | True | date-time |
De einddatum van het logboek dat moet worden doorzocht, moet een grotere datum zijn dan Begindatum. |
|
Gebruik deze optie als u wilt filteren op één ondertekeningsproces.
|
ProcessKey | True | string |
Gebruik deze optie als u wilt filteren op één ondertekeningsproces. |
|
Kan worden gebruikt om alleen activiteit op te halen voor een specifiek stroomtype.
|
FlowType | string |
Kan worden gebruikt om alleen activiteit op te halen voor een specifiek stroomtype. |
|
|
wordt gebruikt om de resultatenset te pagina's en retourneert alleen N veel resultaten.
|
Take | integer |
wordt gebruikt om de resultatenset te pagina's en retourneert alleen N veel resultaten. |
|
|
wordt gebruikt om de resultatenset te pagina's te bekijken en de eerste N-resultaten over te slaan.
|
Skip | integer |
wordt gebruikt om de resultatenset te pagina's te bekijken en de eerste N-resultaten over te slaan. |
|
|
Als het een waarde heeft, retourneren we alleen records die overeenkomen met deze flowKey.
|
FlowKey | string |
Als het een waarde heeft, retourneren we alleen records die overeenkomen met deze flowKey. |
Retouren
- Lijst<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Hiermee haalt u het activiteitenlogboek voor een bedrijf op
Hiermee haalt u het activiteitenlogboek voor een bedrijf op
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De begindatum van het logboek dat moet worden doorzocht, moet een kleinere datum zijn dan Einddatum.
|
StartDate | True | date-time |
De begindatum van het logboek dat moet worden doorzocht, moet een kleinere datum zijn dan Einddatum. |
|
De einddatum van het logboek dat moet worden doorzocht, moet een grotere datum zijn dan Begindatum.
|
EndDate | True | date-time |
De einddatum van het logboek dat moet worden doorzocht, moet een grotere datum zijn dan Begindatum. |
|
Wordt gebruikt om de resultatenset te pagina's en retourneert alleen N veel resultaten.
|
Take | integer |
Wordt gebruikt om de resultatenset te pagina's en retourneert alleen N veel resultaten. |
|
|
Wordt gebruikt om de resultatenset te pagina's te bekijken en de eerste N-resultaten over te slaan.
|
Skip | integer |
Wordt gebruikt om de resultatenset te pagina's te bekijken en de eerste N-resultaten over te slaan. |
|
|
Het e-mailadres van de gebruiker.
|
User | string |
Het e-mailadres van de gebruiker. |
|
|
Kan worden gebruikt om alleen activiteit op te halen voor een specifiek stroomtype.
|
FlowType | string |
Kan worden gebruikt om alleen activiteit op te halen voor een specifiek stroomtype. |
|
|
Als het een waarde heeft, retourneren we alleen records die overeenkomen met deze flowKey.
|
FlowKey | string |
Als het een waarde heeft, retourneren we alleen records die overeenkomen met deze flowKey. |
Retouren
- Lijst<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Hiermee haalt u het ondertekeningsproces op door processKey en signeeKey
Get's the signing process by processkey and signeeKey.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor één documentondertekeningsproces.
|
ProcessKey | True | string |
Unieke id voor één documentondertekeningsproces. |
|
Unieke id van een persoon die één ondertekeningsproces ondertekent.
|
SigneeKey | True | string |
Unieke id van een persoon die één ondertekeningsproces ondertekent. |
|
Een gebruikersagent fungeert voor een gebruiker, zoals een webbrowser of e-mailclient.
|
UserAgent | string |
Een gebruikersagent fungeert voor een gebruiker, zoals een webbrowser of e-mailclient. |
Retouren
SigningProcess
- SigningProcess
- SigningProcess
Hiermee maakt u een nieuw ondertekeningsproces met een of meer ondertekeners
Hiermee maakt u een nieuw ondertekeningsproces met een of meer ondertekentekens.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
is een base64-tekenreeks van het document dat moet worden ondertekend. Dit is niet vereist als de flowKey het document maakt. |
|
|
pdfFileName
|
pdfFileName | string |
Als PdfDocument wordt gebruikt, moet een waarde voor de bestandsnaam worden opgegeven. |
|
|
flowKey
|
flowKey | True | string |
FlowKey wordt geleverd door Taktikal. Deze sleutel vertelt Taktikal hoe deze aanvraag moet worden verwerkt. Voor sommige flowKeys Taktikal wordt het document gemaakt. Het bepaalt ook waar het ondertekende document wordt bezorgd na ondertekening. |
|
processKey
|
processKey | string | ||
|
naam
|
name | string | ||
|
Ssn
|
ssn | string | ||
|
telefoonnummer
|
phoneNumber | string | ||
|
e-mailadres
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
reden
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
language
|
language | string | ||
|
Woordenboek
|
meta | object |
Woordenlijsttekenreeks<, tekenreeks> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
identiteitskaart
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
inhoudstype
|
contentType | string | ||
|
url
|
url | string | ||
|
beschrijving
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
vereistAuth
|
requiresAuth | boolean |
De standaardwaarde is onwaar. Als deze optie is ingesteld op waar, moeten alle ondertekenaars daar e-id gebruiken om te verifiëren voordat ze het document kunnen bekijken. |
|
|
signInOrder
|
signInOrder | boolean |
De standaardwaarde is onwaar. Hiermee bepaalt u de volgorde van ondertekenaars. Er wordt alleen een handtekeningaanvraag verzonden naar de eerste persoon in de lijst met ondertekenaars om mee te beginnen. Nadat hij de volgende ondertekening heeft getekend, enzovoort. |
|
|
signatureLocation
|
signatureLocation | string |
Kan BottomLastPage of de standaardwaarde TopFirstPage zijn. Hiermee bepaalt u waar de handtekening in het document moet worden weergegeven. |
|
|
user
|
user | string |
e-mailadres van de gebruiker die de aanvraag verzendt. Kan leeg zijn. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
De standaardwaarde is onwaar. Als deze optie is ingesteld op true, proberen we de invoervelden voor documenten af te vlakken. |
|
|
reminderRule
|
reminderRule | string |
Hiermee worden herinneringen verzonden, laat u leeg voor geen. de notatie moet 'firstReminder na x dagen zijn:Vervolgens wordt elke y dagen' bijvoorbeeld '1:3' één herinnering na 1 dag verzonden en vervolgens om de drie dagen daarna. Laat leeg of null voor geen herinneringen, geldige waarden zijn dat de eerste herinnering tussen 0 en 30 dagen wordt verzonden (0 betekent geen herinnering) en vervolgens elke 0-15 dagen (0, opnieuw, wat betekent dat er geen herinneringen worden verzonden, dus 0:10 zou slechts elke 10 dagen herinnering verzenden, terwijl 12:0 slechts één herinnering na 12 dagen zou verzenden |
Retouren
SigningProcess
- SigningProcess
- SigningProcess
Hiermee maakt u een nieuwe sequentiële (bulk) ondertekeningsprocessen
Hiermee maakt u een nieuw sequentiële ondertekeningsproces (bulk) met een of meer ondertekeningsprocessen. Elk ondertekeningsproces in een reeks heeft een of meer ondertekeners.
Voorbeeld:
- Een bedrijf wil document A en B ondertekend hebben. Signee X moet document A en B ondertekenen, Signee Y moet document A ondertekenen en Signee Z moet document B ondertekenen.
- Vervolgens A new CreateSequentalSigning with array of two CreateSigningProcess object. Signees X en Y worden toegevoegd als ondertekeningen voor CreateSigningProcess voor Document A en ondertekent X en Z worden toegevoegd als ondertekeningen voor Document B.
Gedetailleerde documentatie vindt u op https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
is een base64-tekenreeks van het document dat moet worden ondertekend. Dit is niet vereist als de flowKey het document maakt. |
|
|
pdfFileName
|
pdfFileName | string |
Als PdfDocument wordt gebruikt, moet een waarde voor de bestandsnaam worden opgegeven. |
|
|
flowKey
|
flowKey | True | string |
FlowKey wordt geleverd door Taktikal. Deze sleutel vertelt Taktikal hoe deze aanvraag moet worden verwerkt. Voor sommige flowKeys Taktikal wordt het document gemaakt. Het bepaalt ook waar het ondertekende document wordt bezorgd na ondertekening. |
|
processKey
|
processKey | string | ||
|
naam
|
name | string | ||
|
Ssn
|
ssn | string | ||
|
telefoonnummer
|
phoneNumber | string | ||
|
e-mailadres
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
reden
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
language
|
language | string | ||
|
Woordenboek
|
meta | object |
Woordenlijsttekenreeks<, tekenreeks> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
identiteitskaart
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
inhoudstype
|
contentType | string | ||
|
url
|
url | string | ||
|
beschrijving
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
vereistAuth
|
requiresAuth | boolean |
De standaardwaarde is onwaar. Als deze optie is ingesteld op waar, moeten alle ondertekenaars daar e-id gebruiken om te verifiëren voordat ze het document kunnen bekijken. |
|
|
signInOrder
|
signInOrder | boolean |
De standaardwaarde is onwaar. Hiermee bepaalt u de volgorde van ondertekenaars. Er wordt alleen een handtekeningaanvraag verzonden naar de eerste persoon in de lijst met ondertekenaars om mee te beginnen. Nadat hij de volgende ondertekening heeft getekend, enzovoort. |
|
|
signatureLocation
|
signatureLocation | string |
Kan BottomLastPage of de standaardwaarde TopFirstPage zijn. Hiermee bepaalt u waar de handtekening in het document moet worden weergegeven. |
|
|
user
|
user | string |
e-mailadres van de gebruiker die de aanvraag verzendt. Kan leeg zijn. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
De standaardwaarde is onwaar. Als deze optie is ingesteld op true, proberen we de invoervelden voor documenten af te vlakken. |
|
|
reminderRule
|
reminderRule | string |
Hiermee worden herinneringen verzonden, laat u leeg voor geen. de notatie moet 'firstReminder na x dagen zijn:Vervolgens wordt elke y dagen' bijvoorbeeld '1:3' één herinnering na 1 dag verzonden en vervolgens om de drie dagen daarna. Laat leeg of null voor geen herinneringen, geldige waarden zijn dat de eerste herinnering tussen 0 en 30 dagen wordt verzonden (0 betekent geen herinnering) en vervolgens elke 0-15 dagen (0, opnieuw, wat betekent dat er geen herinneringen worden verzonden, dus 0:10 zou slechts elke 10 dagen herinnering verzenden, terwijl 12:0 slechts één herinnering na 12 dagen zou verzenden |
|
|
user
|
user | True | string |
De gebruiker die het sequentiële ondertekeningsproces start |
|
vereistAuth
|
requiresAuth | boolean |
De standaardwaarde is onwaar. Als deze optie is ingesteld op waar, moeten alle ondertekenaars daar e-id gebruiken om te verifiëren voordat ze het document kunnen bekijken. |
|
|
signInOrder
|
signInOrder | boolean |
De standaardwaarde is onwaar. Hiermee bepaalt u de volgorde van ondertekenaars. Er wordt alleen een handtekeningaanvraag verzonden naar de eerste persoon in de lijst met ondertekenaars om mee te beginnen. Nadat hij de volgende ondertekening heeft getekend, enzovoort. |
Retouren
Sequentiële toewijzing
- Sequentiële toewijzing
- SequentialSigning
Start een verificatieproces met IJslandse e-id
Verificatie met de IJslandse e-id kan worden gedaan met een mobiele telefoon of Audkenni-app.
- Met mobiele telefoon: Het AuthenticationContextType moet worden ingesteld op Sim en het telefoonnummer moet worden ingesteld op een IJslands mobiel telefoonnummer. De ssn wordt genegeerd.
- Audkenni-app gebruiken: Het AuthenticationContextType moet worden ingesteld op 'App' en de ssn moet worden ingesteld op een Icdlandisch burgerservicenummer. Het telefoonnummer wordt genegeerd.
flowKey moet altijd worden opgegeven en is toegankelijk in de Taktikal-portal.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Ssn
|
ssn | string | ||
|
telefoonnummer
|
phoneNumber | string | ||
|
flowKey
|
flowKey | True | string |
Unieke id voor een stroom die deel uitmaakt van een bedrijf. |
|
authenticationContextType
|
authenticationContextType | True | string |
Retouren
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Start een verificatieproces met IJslandse e-id voor een sequentiële ondertekeningsprocessen
Verificatie met de IJslandse e-id kan worden gedaan met een mobiele telefoon of Audkenni-app.
- Met mobiele telefoon: Het AuthenticationContextType moet worden ingesteld op Sim en het telefoonnummer moet worden ingesteld op een Ucelandisch mobiel telefoonnummer. De ssn wordt genegeerd.
- Audkenni-app gebruiken: Het AuthenticationContextType moet worden ingesteld op 'App' en de ssn moet worden ingesteld op een Icdlandisch burgerservicenummer. Het telefoonnummer wordt genegeerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor een reeks (bulksgewijs) ondertekeningsprocessen.
|
SequenceKey | True | string |
Unieke id voor een reeks (bulksgewijs) ondertekeningsprocessen. |
|
sequenceKey
|
sequenceKey | True | string | |
|
loginHint
|
loginHint | True | string | |
|
authenticationContextType
|
authenticationContextType | True | string |
Retouren
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Definities
Signee
Signee
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string | |
|
Ssn
|
ssn | string | |
|
telefoonnummer
|
phoneNumber | string | |
|
e-mailadres
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
key
|
key | string | |
|
Ondertekend
|
signed | boolean | |
|
signedAt
|
signedAt | date-time | |
|
processKey
|
processKey | string | |
|
reden
|
reason | string | |
|
hidePersonalCode
|
hidePersonalCode | boolean | |
|
communicationDeliveryType
|
communicationDeliveryType | string | |
|
url
|
url | string | |
|
signatureType
|
signatureType | string | |
|
language
|
language | string | |
|
customSmsText
|
customSmsText | string |
Ondertekeningsbijlage
Ondertekeningsbijlage
| Name | Pad | Type | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileContent
|
fileContent | string |
AttachmentReference
AttachmentReference
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string | |
|
fileName
|
fileName | string | |
|
contentLength
|
contentLength | integer | |
|
inhoudstype
|
contentType | string | |
|
url
|
url | string | |
|
beschrijving
|
description | string | |
|
processKey
|
processKey | string | |
|
attachmentType
|
attachmentType | string | |
|
signeeKey
|
signeeKey | string |
Dictionary_String_String_
Woordenlijsttekenreeks<, tekenreeks>
| Name | Pad | Type | Description |
|---|---|---|---|
|
Woordenboek
|
object |
Woordenlijsttekenreeks<, tekenreeks> |
SigningProcessActivityLogWrapper
SigningProcessActivityLogWrapper
| Name | Pad | Type | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
activityLog
|
activityLog | array of SigningProcessActivityLog | |
|
ondertekens
|
signees | array of SigneeActivityLog | |
|
sequenceSignees
|
sequenceSignees | array of SequentialSigningSigneeActivityLog | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
activityDisplayName
|
activityDisplayName | string |
SigningProcessActivityLog
SigningProcessActivityLog
| Name | Pad | Type | Description |
|---|---|---|---|
|
flowKey
|
flowKey | string |
Unieke id voor een stroom die deel uitmaakt van een bedrijf. |
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
status
|
status | string | |
|
beschrijving
|
description | string | |
|
userAgent
|
userAgent | string | |
|
fileName
|
fileName | string | |
|
createdAt
|
createdAt | date-time | |
|
gemaakt door
|
createdBy | string | |
|
vereistAuth
|
requiresAuth | boolean | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string |
SigneeActivityLog
SigneeActivityLog
| Name | Pad | Type | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
Ssn
|
ssn | string | |
|
naam
|
name | string | |
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
phone
|
phone | string | |
|
e-mailadres
|
string | ||
|
createdAt
|
createdAt | date-time | |
|
gemaakt door
|
createdBy | string | |
|
updatedAt
|
updatedAt | date-time | |
|
signatureType
|
signatureType | string |
SequentialSigningSigneeActivityLog
SequentialSigningSigneeActivityLog
| Name | Pad | Type | Description |
|---|---|---|---|
|
sequenceKey
|
sequenceKey | string | |
|
signeeKey
|
signeeKey | string | |
|
url
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigneeKeys
SigneeKeys
| Name | Pad | Type | Description |
|---|---|---|---|
|
signeeKey
|
signeeKey | string | |
|
processKey
|
processKey | string |
Sequentiële toewijzing
Sequentiële toewijzing
| Name | Pad | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
status
|
status | string | |
|
vereistAuth
|
requiresAuth | boolean | |
|
user
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
ondertekens
|
signees | array of SequentialSigningSignee | |
|
signingProcesses
|
signingProcesses | array of SigningProcess |
SequentialSigningSignee
SequentialSigningSignee
| Name | Pad | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
url
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigningProcess
SigningProcess
| Name | Pad | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
ondertekens
|
signees | array of Signee | |
|
flowKey
|
flowKey | string |
Unieke id voor een stroom die deel uitmaakt van een bedrijf. |
|
status
|
status | string | |
|
Woordenboek
|
meta | Dictionary_String_String_ |
Woordenlijsttekenreeks<, tekenreeks> |
|
pdfFileName
|
pdfFileName | string | |
|
attachments
|
attachments | array of SigningAttachment | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
vereistAuth
|
requiresAuth | boolean | |
|
user
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string | |
|
flattenDocument
|
flattenDocument | boolean |
StartAuthResponse
StartAuthResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
authRequestId
|
authRequestId | string | |
|
verificationCode
|
verificationCode | string |
SealResponse
SealResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
Customer
Customer
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string | |
|
Ssn
|
ssn | string | |
|
telefoonnummer
|
phoneNumber | string | |
|
e-mailadres
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
token
|
token | string | |
|
flowKey
|
flowKey | string |
Unieke id voor een stroom die deel uitmaakt van een bedrijf. |
|
Woordenboek
|
meta | Dictionary_String_String_ |
Woordenlijsttekenreeks<, tekenreeks> |
PollCustomer
PollCustomer
| Name | Pad | Type | Description |
|---|---|---|---|
|
Customer
|
customer | Customer |
Customer |
|
statusBericht
|
statusMessage | string | |
|
waitingForUserInput
|
waitingForUserInput | boolean |
Voorwerp
Dit is het type 'object'.