Connective eSignatures
Connective eSignatures is een gerenommeerde digitale handtekeningoplossing die een grote hoeveelheid handtekeningmethoden en naleving biedt aan de strengste (inter)nationale regelgeving. Met eSignatures kunt u elk op papier gebaseerd proces transformeren in een end-to-end digitale stroom met een ongeëvenaarde gebruikerservaring. Stroomlijn het ondertekeningsproces precies zoals u dat wilt en onderteken alle typen documenten rechtstreeks vanuit uw favoriete zakelijke toepassingen. Neem deel aan meer dan 500 tevreden klanten.
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 | Connective Support |
| URL | https://connective.eu/contact-support/ |
| E-mailen | service@connective.eu |
| Connectormetagegevens | |
|---|---|
| Uitgever | Connective |
| Webpagina | https://www.connective.eu |
| Privacybeleid | https://connective.eu/privacy-policy/ |
| Categorieën | IT-bewerkingen; Productiviteit |
Connective, een specialist in digitale handtekeningen, identiteitsservices en het genereren van slimme documenten, heeft de Connective eSignatures Connector voor Power Automate beschikbaar gemaakt voor gebruik. Met de connector kunnen bedrijven documenten die een digitale handtekening vereisen rechtstreeks vanuit hun favoriete Microsoft 365-toepassingen doorsturen, van Microsoft Teams naar Word, SharePoint, Dynamics, OneDrive en vele andere.
De connector gaan gebruiken
Als u gebruik wilt maken van de connector, neemt u contact op met uw Relatiebeheerder bij Connective of gaat u naar onze contactpagina op onze website om de referenties te ontvangen.
Op deze pagina vindt u meer informatie over de verschillende beschikbare acties en krijgt u inzicht in de verschillende manieren waarop deze acties kunnen worden geïmplementeerd.
Aarzel niet om onze documentatiewebsite te bekijken voor meer informatie of neem contact op met het ondersteuningsteam via het formulier of het ondersteuningspostvak: service@connective.eu
Er is een woordenlijst beschikbaar om de verschillende termen uit te leggen die in deze documentatie worden gebruikt
Acties
De connector Connective eSignatures is gebaseerd op API v3 van eSignatures. De eSignatures-API is een REST API waarmee externe toepassingen kunnen worden geïntegreerd met en de functies in dit document kunnen gebruiken om ondertekeningsstromen te maken en te beheren.
De beschikbare acties kunnen worden gegroepeerd in verschillende groepen
| Actiegroep | Beschikbare acties |
|---|---|
| Documenten uploaden | Pakket maken |
| Document toevoegen aan pakket | |
| Ondertekeningslocaties ophalen | |
| Procesgegevens instellen | |
| Pakketstatus instellen | |
| Direct pakket maken | |
| De status van een document ophalen | Pakketstatus ophalen |
| Pakketlijst ophalen | |
| Diverse acties | Ondertekenaars overslaan |
| Pakket downloaden | |
| Extensie voor verlopen van pakket | |
| Pakketherinnering verzenden | |
| Pakket verwijderen | |
| Controlebewijs ophalen | Controlecontroleprogramma's voor pakketten ophalen |
| Controleprogramma's voor documentcontrole ophalen | |
| Controleprogramma's voor pakketten ophalen met correlatie-id | |
| Controleprogramma's voor documentcontrole ophalen met correlatie-id | |
| Bewijs toevoegen vanuit een externe bron |
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 |
|---|---|---|---|
| Url van connective eSignatures-omgeving | touw | URL naar uw Connective eSignatures-omgeving, bijvoorbeeld esignatures.connective.eu | Klopt |
| API-gebruikersnaam | beveiligde string | API-gebruikersnaam voor toegang tot de API | Klopt |
| API-wachtwoord | beveiligde string | API-wachtwoord voor toegang tot de API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Bewijs toevoegen vanuit externe bron |
Met deze aanroep kunnen API-gebruikers extra controle van een externe bron toevoegen aan een locatie in een document. |
| Controlebewijs pakket met document-id |
De XML-controlecontrole van een pakket kan worden opgehaald wanneer het pakket volledig is ondertekend. Hetzelfde geldt voor een document: dit werkt alleen wanneer het pakket volledig is ondertekend. |
| Controlebewijs van pakket |
De XML-controlecontrole van een pakket kan worden opgehaald wanneer het pakket volledig is ondertekend. Hetzelfde geldt voor een document: dit werkt alleen wanneer het pakket volledig is ondertekend. |
| Controlebewijs voor pakketcorrelatie downloaden |
Correlatie-id's worden gebruikt om pakketten of documenten op verschillende manieren bij te houden via de toepassing eSignatures. |
| Direct pakket maken |
Met deze aanroep maakt u een pakket met één document en bereidt u het direct voor op ondertekening |
| Document Correlation Audit Proof Download |
Correlatie-id's worden gebruikt om pakketten of documenten op verschillende manieren bij te houden via de toepassing eSignatures. |
| Document downloaden van pakket |
De ondertekende documenten in een pakket kunnen één voor één worden gedownload door een extern systeem met behulp van deze aanroep. Elk document wordt gedownload als pdf of als een XML-bestandsstroom, afhankelijk van de waarde van de parameter DocumentType. |
| Document toevoegen aan pakket |
Met deze aanroep wordt een document aan een bestaand pakket toegevoegd. |
| Ondertekenaars overslaan |
Met deze aanroep worden alle ondertekenaars overgeslagen die nog niet zijn ondertekend en worden hun status ingesteld op 'Overgeslagen', wat ertoe leidt dat het volledige pakket wordt gemarkeerd als 'Voltooid'. |
| Ondertekeningslocaties ophalen |
Deze aanroep biedt een overzicht van alle ondertekeningslocaties in de documenten binnen een pakket. |
| Pakket downloaden |
Het pakket met de ondertekende documenten kan worden gedownload door een extern systeem met behulp van deze aanroep. |
| Pakket maken |
Met deze aanroep wordt een leeg pakket gemaakt, zodat er documenten aan kunnen worden toegevoegd |
| Pakket verwijderen |
Met eSignatures worden pakketten niet automatisch uit de database verwijderd zodra ze de definitieve status hebben bereikt. Ze worden voor onbepaalde tijd opgeslagen. Als u pakketten uit de database wilt verwijderen, kunnen gebruikers de aanroep Pakket verwijderen gebruiken. |
| Pakketherinneringen verzenden |
Het bedrijfsbeleid vereist mogelijk dat een document binnen een bepaalde periode wordt verwerkt. Als u de oproep 'Herinneringen verzenden' activeert, wordt iedereen opgezoekt die niet is ondertekend en een extra melding als herinnering verzenden. |
| Pakketlijst |
Een lijst met pakketten met hun huidige status ophalen |
| Pakketstatus instellen |
Met behulp van de aanroep Pakketstatus instellen kunt u de status van een pakket wijzigen. |
| Pakketstatus ophalen |
Haalt de huidige status van het pakket en de bijbehorende documenten op. |
| Procesgegevens instellen |
Deze webservicemethode werkt de personen bij die betrokken zijn bij het proces (belanghebbenden) en wijst deze stappen toe die moeten worden uitgevoerd. |
| Verlooptijdstempel |
Een pakket heeft mogelijk de status Verlopen wanneer een pakket een waarde heeft doorgegeven voor de parameter ExpireTimestamp in de aanroep Package maken. Een dergelijk pakket kan niet meer worden ondertekend. |
Bewijs toevoegen vanuit externe bron
Met deze aanroep kunnen API-gebruikers extra controle van een externe bron toevoegen aan een locatie in een document.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De unieke id van het pakket
|
packageId | True | string |
De unieke id van het pakket |
|
Content
|
Content | string |
De werkelijke inhoud van het bewijs. |
|
|
LocationId
|
LocationId | string |
Locatie van de handtekening waarvoor de proof-inhoud is gegenereerd. |
|
|
Naam
|
Name | string |
Naam van het bewijs. |
|
|
Typologie
|
Type | string |
Een machineleesbare 'type'-sleutel. Kan vrijelijk worden gekozen. |
|
|
Description
|
Description | string |
Korte door mensen leesbare beschrijving van het bewijs. |
|
|
IP-adres
|
IpAddress | string |
IP-adres van de eindgebruiker van de externe bron waarvoor het bewijs is toegevoegd. |
Controlebewijs pakket met document-id
De XML-controlecontrole van een pakket kan worden opgehaald wanneer het pakket volledig is ondertekend. Hetzelfde geldt voor een document: dit werkt alleen wanneer het pakket volledig is ondertekend.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
Unieke id van het document
|
documentId | True | string |
Unieke id van het document |
Retouren
- Body
- Content
Controlebewijs van pakket
De XML-controlecontrole van een pakket kan worden opgehaald wanneer het pakket volledig is ondertekend. Hetzelfde geldt voor een document: dit werkt alleen wanneer het pakket volledig is ondertekend.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
Retouren
- Body
- Content
Controlebewijs voor pakketcorrelatie downloaden
Correlatie-id's worden gebruikt om pakketten of documenten op verschillende manieren bij te houden via de toepassing eSignatures.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De correlatie-id.
|
correlationId | True | string |
De correlatie-id. |
Retouren
- Body
- Content
Direct pakket maken
Met deze aanroep maakt u een pakket met één document en bereidt u het direct voor op ondertekening
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document
|
Document | byte |
Bijgevoegd document in gecodeerde base64-indeling. Vereist, tenzij de indeling Meerdere onderdelen wordt gebruikt. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Taal die moet worden gebruikt in handtekeningteksten. Momenteel ondersteund: nl, nl, de, fr, es. |
|
|
DocumentName
|
DocumentName | string |
De naam van het document en pakket dat moet worden weergegeven in de eSignatures-portal. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
E-mailadres van een geregistreerde gebruiker |
|
|
Typologie
|
Type | string |
Ondertekenaar/ontvanger |
|
|
OrderIndex
|
OrderIndex | integer |
Dit nummer geeft aan in welke volgorde actoren hun actie moeten uitvoeren. |
|
|
PageNumber
|
PageNumber | integer |
Nummer van de pagina waarop een ondertekeningslocatie moet worden toegevoegd |
|
|
Breedte
|
Width | string |
Breedte |
|
|
Hoogte
|
Height | string |
Hoogte |
|
|
Links
|
Left | string |
Positie vanaf de linkerkant van de pagina |
|
|
Boven
|
Top | string |
Positie boven aan de pagina |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Unieke verwijzing naar een tekenveld, tekstmarkering of tekstveld. |
|
|
SigningType
|
SigningType | string |
Het ondertekeningstype dat wordt gebruikt in de sessie van deze actor. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Een of meer OID's van toezeggingstypen. Kan alleen worden doorgegeven wanneer handtekeningbeleid wordt gebruikt. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Type validatie dat moet worden uitgevoerd tijdens een andere smartcard of itsme-ondertekeningssessie. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Hiermee definieert u welke eID of andere smartcards tijdens deze sessie mogen worden ondertekend. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Details van ondertekeningsbeleid voor de handtekening. |
|
|
Telefoonnummer
|
Phonenumber | string |
Telefoonnummer om een SMS OTP te ontvangen. |
|
|
RedirectUrl
|
RedirectUrl | string |
Url waarnaar de eindgebruiker wordt omgeleid na ondertekening. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures kunnen e-mailberichten verzenden naar alle personen die zich mogen ondertekenen. |
|
|
UserRoles
|
UserRoles | array of string |
Rol of functie van de ondertekenaar. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Juridische kennisgeving |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Aangepaste tekst van juridische kennisgeving voor het geval geen van de drie vooraf gedefinieerde juridische kennisgevingen van toepassing is. |
|
|
E-mailadres
|
EmailAddress | string |
E-mailadres |
|
|
Voornaam
|
FirstName | string |
Voornaam |
|
|
Achternaam
|
LastName | string |
Achternaam |
|
|
Geboortedatum
|
BirthDate | string |
Geboortedatum |
|
|
Language
|
Language | string |
Language |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
REST API-URL die wordt aangeroepen telkens wanneer een actie is voltooid voor dit pakket |
|
|
CorrelationId
|
CorrelationId | string |
Id die aangeeft welke pakketten of documenten zijn gecorreleerd |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
De code waarmee een documentgroep wordt geïdentificeerd waarin het document moet worden weergegeven |
|
|
ThemeCode
|
ThemeCode | string |
Thema dat moet worden toegepast op het pakket |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Met deze parameter wordt bepaald of pakketten kunnen worden gedownload van WYSIWYS voordat deze worden ondertekend |
|
|
Opnieuw toewijzenEnabled
|
ReassignEnabled | boolean |
Deze parameter bepaalt of pakketten opnieuw kunnen worden toegewezen van de WYSIWYS aan een andere fiatteur/ondertekenaar. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Deze parameter bepaalt na hoeveel dagen de actie-URL's moeten verlopen wanneer ze niet worden gebruikt. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Verwijzing die is opgegeven door de aanroepende toepassing. Deze parameter wordt niet gebruikt door de eSignatures-portal |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Verwijzing die wordt opgegeven door de aanroepende toepassing, wordt deze parameter niet gebruikt door de eSignatures-portal |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Verwijzing die wordt opgegeven door de aanroepende toepassing, wordt deze parameter niet gebruikt door de eSignatures-portal |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Url waarnaar de eindgebruiker wordt omgeleid nadat alle velden zijn ondertekend met 'face-to-face'-ondertekening of wanneer alle velden zijn geweigerd. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST API-URL die wordt aangeroepen wanneer een eindgebruiker een melding wil ontvangen. Als er geen URL wordt opgegeven, wordt er geen terugbeloproep uitgevoerd |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Omgaan met PDF-bestanden met kleine fouten |
|
|
Vertegenwoordiging
|
Representation | string |
Bijgevoegd weergavedocument in base64-indeling |
|
|
RepresentationType
|
RepresentationType | string |
Het type weergavedocument moet aanwezig zijn wanneer de weergave is ingevuld. Alleen 'application/pdf' wordt ondersteund. |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
De sjabloon die in de portal is geconfigureerd, bevat alle benodigde informatie |
|
|
Doeltype
|
TargetType | string |
Het TargetType bepaalt of een extra conversie naar PDF/A moet worden uitgevoerd voordat u zich ondertekent |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Unieke id van het pakket. |
|
CreationTimestamp
|
CreationTimestamp | string |
De datum en tijd waarop het pakket is gemaakt op basis van de server. |
Document Correlation Audit Proof Download
Correlatie-id's worden gebruikt om pakketten of documenten op verschillende manieren bij te houden via de toepassing eSignatures.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De correlatie-id.
|
correlationId | True | string |
De correlatie-id. |
Retouren
- Body
- Content
Document downloaden van pakket
De ondertekende documenten in een pakket kunnen één voor één worden gedownload door een extern systeem met behulp van deze aanroep. Elk document wordt gedownload als pdf of als een XML-bestandsstroom, afhankelijk van de waarde van de parameter DocumentType.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor het ondertekeningspakket
|
id | True | string |
Unieke id voor het ondertekeningspakket |
|
Unieke id van het document in het pakket
|
documentId | True | string |
Unieke id van het document in het pakket |
Retouren
- response
- binary
Document toevoegen aan pakket
Met deze aanroep wordt een document aan een bestaand pakket toegevoegd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De pakket-id.
|
PackageId | True | string |
Unieke id van pakket |
|
Document
|
Document | string |
Bijgevoegd document in gecodeerde base64-indeling. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Taal die moet worden gebruikt in handtekeningteksten. |
|
|
DocumentName
|
DocumentName | string |
De naam van het document dat moet worden weergegeven in de eSignatures-portal. |
|
|
PageNumber
|
PageNumber | integer |
Nummer van de pagina waarop een ondertekeningslocatie moet worden toegevoegd |
|
|
Breedte
|
Width | string |
Breedte |
|
|
Hoogte
|
Height | string |
Hoogte |
|
|
Links
|
Left | string |
Positie vanaf de linkerkant van de pagina |
|
|
Boven
|
Top | string |
Positie boven aan de pagina |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Unieke verwijzing naar een tekenveld, tekstmarkering of tekstveld. |
|
|
CorrelationId
|
CorrelationId | string |
Id die aangeeft welke documenten in dit pakket zijn gecorreleerd met documenten die in het verleden in andere pakketten zijn aangemeld. |
|
|
DocumentType
|
DocumentType | string |
Type document dat wordt ondertekend. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Verwijzing die is opgegeven door de aanroepende toepassing. |
|
|
ErrorCode
|
ErrorCode | string |
Foutcode met variabele informatie. |
|
|
Message
|
Message | string |
Detailtekst van foutbericht, niet gelokaliseerd |
|
|
Vertegenwoordiging
|
Representation | string |
Bijgevoegd weergavedocument in base64-indeling. Dit moeten PDF-gegevens zijn. |
|
|
RepresentationType
|
RepresentationType | string |
Type van het weergavedocument. |
|
|
Doeltype
|
TargetType | string |
Het TargetType bepaalt of een extra conversie naar PDF/A moet worden uitgevoerd voordat u zich ondertekent. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Unieke id voor het document |
|
CreationTimestamp
|
CreationTimestamp | string |
De datum en tijd waarop de stroom is gemaakt. Indeling: JJJJ-MM-DDThh:mm:ss+zz:zz |
|
Locaties
|
Locations | array of object |
Vertegenwoordigt een mogelijke locatie voor een handtekening |
|
Identiteitsbewijs
|
Locations.Id | string |
Unieke id voor deze locatie |
|
Etiket
|
Locations.Label | string |
Gedetecteerd of opgegeven label |
|
PageNumber
|
Locations.PageNumber | integer |
De pagina waarop de locatie is gevonden. |
Ondertekenaars overslaan
Met deze aanroep worden alle ondertekenaars overgeslagen die nog niet zijn ondertekend en worden hun status ingesteld op 'Overgeslagen', wat ertoe leidt dat het volledige pakket wordt gemarkeerd als 'Voltooid'.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
PackageId | True | string |
Unieke id van het pakket |
Ondertekeningslocaties ophalen
Deze aanroep biedt een overzicht van alle ondertekeningslocaties in de documenten binnen een pakket.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id van het handtekeningveld
|
Id | True | string |
Id van het handtekeningveld |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Documents
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
Unieke id voor het document |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Externe verwijzing voor identificatie. Zorg ervoor dat u een unieke waarde gebruikt. |
|
Locaties
|
Documents.Locations | array of object |
Vertegenwoordigt een mogelijke locatie voor een handtekening |
|
Identiteitsbewijs
|
Documents.Locations.Id | string |
Unieke id voor deze locatie. |
|
Etiket
|
Documents.Locations.Label | string |
Waarde die u hebt ingevoerd als aanvraagparameter. |
|
PageNumber
|
Documents.Locations.PageNumber | integer |
Nummer van de pagina waarop de handtekening kan worden gevonden. |
Pakket downloaden
Het pakket met de ondertekende documenten kan worden gedownload door een extern systeem met behulp van deze aanroep.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
id | True | string |
Unieke id van het pakket |
Retouren
- response
- binary
Pakket maken
Met deze aanroep wordt een leeg pakket gemaakt, zodat er documenten aan kunnen worden toegevoegd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Inhoudstype
|
Content-Type | True | string |
Inhoudstype |
|
Initiator
|
Initiator | string |
E-mailadres van een geregistreerde gebruiker. |
|
|
PackageName
|
PackageName | string |
Pakketnaam, te zien in de eSignatures-portal en bij het downloaden als zip-bestand. |
|
|
CallBackUrl
|
CallBackUrl | string |
REST API-URL die wordt aangeroepen telkens wanneer een actie is voltooid voor dit pakket. |
|
|
CorrelationId
|
CorrelationId | string |
Id die aangeeft welke pakketten zijn gecorreleerd. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
De code waarmee een documentgroep wordt geïdentificeerd waarin het pakket moet worden weergegeven. |
|
|
ThemeCode
|
ThemeCode | string |
Thema dat moet worden toegepast op het pakket |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Met deze parameter wordt bepaald of pakketten kunnen worden gedownload van WYSIWYS voordat u zich ondertekent. |
|
|
Opnieuw toewijzenEnabled
|
ReassignEnabled | boolean |
Deze parameter bepaalt of pakketten opnieuw kunnen worden toegewezen van de WYSIWYS aan een andere fiatteur/ondertekenaar. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Deze parameter bepaalt na hoeveel dagen de actie-URL's moeten verlopen wanneer ze niet worden gebruikt. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
De datum en tijd waarop dit pakket verloopt en niet meer kunnen worden ondertekend. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Verwijzing die is opgegeven door de aanroepende toepassing. Deze parameter wordt niet gebruikt door de eSignatures-portal. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Dit veld is gereserveerd voor toekomstig gebruik. Het kan worden gebruikt voor klantspecifieke extensies om te integreren met services van derden, zoals debitcard-ondertekening. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL waarnaar de eindgebruiker wordt omgeleid nadat alle velden zijn ondertekend met 'face-to-face'-ondertekening of wanneer alle velden zijn geweigerd. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST API-URL die wordt aangeroepen wanneer een eindgebruiker een melding wil ontvangen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Unieke id van het pakket. |
|
CreationTimestamp
|
CreationTimestamp | string |
De datum en tijd waarop het pakket is gemaakt op basis van de server. |
Pakket verwijderen
Met eSignatures worden pakketten niet automatisch uit de database verwijderd zodra ze de definitieve status hebben bereikt. Ze worden voor onbepaalde tijd opgeslagen. Als u pakketten uit de database wilt verwijderen, kunnen gebruikers de aanroep Pakket verwijderen gebruiken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
id | True | string |
Unieke id van het pakket |
Pakketherinneringen verzenden
Het bedrijfsbeleid vereist mogelijk dat een document binnen een bepaalde periode wordt verwerkt. Als u de oproep 'Herinneringen verzenden' activeert, wordt iedereen opgezoekt die niet is ondertekend en een extra melding als herinnering verzenden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
PackageId | True | string |
Unieke id van het pakket |
Pakketlijst
Een lijst met pakketten met hun huidige status ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Het vervolgtoken/guid om te weten welke pagina moet worden geretourneerd.
|
ContinuationToken | string |
Het vervolgtoken/guid om te weten welke pagina moet worden geretourneerd. MOET LEEG ZIJN of het token dat is geretourneerd door een VORIGE aanroep. |
|
|
Hiermee haalt u de maximumhoeveelheid op of stelt u deze in.
|
MaxQuantity | integer |
Hiermee haalt u de maximumhoeveelheid op of stelt u deze in. |
|
|
Hiermee wordt het sorteerveld opgehaald of ingesteld.
|
SortField | string |
Hiermee wordt het sorteerveld opgehaald of ingesteld. |
|
|
Hiermee wordt het sorteerveld opgehaald of ingesteld.
|
SortOrder | string |
Hiermee wordt het sorteerveld opgehaald of ingesteld. |
|
|
Hiermee haalt u de gemaakte datum op of stelt u deze in.
|
CreatedBeforeDate | string |
Hiermee haalt u de gemaakte datum op of stelt u deze in. |
|
|
Hiermee haalt u de status op of stelt u deze in.
|
Status | string |
Hiermee haalt u de status op of stelt u deze in. |
|
|
Hiermee haalt u de gemaakte na datum op of stelt u deze in.
|
createdAfterDate | string |
Hiermee haalt u de gemaakte na datum op of stelt u deze in. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Vervolgtoken
|
ContinuationToken | string |
Vervolgtoken |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Artikelen
|
Items | array of Package |
Pakketstatus instellen
Met behulp van de aanroep Pakketstatus instellen kunt u de status van een pakket wijzigen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor het ondertekeningspakket
|
Id | True | string |
Unieke id voor het ondertekeningspakket |
|
Toestand
|
Status | string |
In behandeling/ingetrokken |
Retouren
Beschrijving voor het pakket dat wordt weergegeven aan de gebruiker van de eSignatures-portal als bestandsnaam.
- Body
- PackageStatus
Pakketstatus ophalen
Haalt de huidige status van het pakket en de bijbehorende documenten op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor het ondertekeningspakket
|
Id | True | string |
Unieke id voor het ondertekeningspakket |
Retouren
Beschrijving voor het pakket dat wordt weergegeven aan de gebruiker van de eSignatures-portal als bestandsnaam.
- Body
- PackageStatus
Procesgegevens instellen
Deze webservicemethode werkt de personen bij die betrokken zijn bij het proces (belanghebbenden) en wijst deze stappen toe die moeten worden uitgevoerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
id | True | string |
Unieke id van het pakket |
|
Typologie
|
Type | string |
Typologie |
|
|
OrderIndex
|
OrderIndex | string |
Dit nummer geeft aan in welke volgorde actoren hun actie moeten uitvoeren. |
|
|
LocationIds
|
LocationIds | array of string |
De locatie-id's waar een handtekening door deze persoon moet worden geplaatst. |
|
|
SigningType
|
SigningType | string |
Het ondertekeningstype dat wordt gebruikt in de sessie van deze actor. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Een of meer OID's van toezeggingstypen. Kan alleen worden doorgegeven wanneer handtekeningbeleid wordt gebruikt. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Type validatie dat moet worden uitgevoerd tijdens een andere smartcard of itsme-ondertekeningssessie. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Hiermee definieert u welke eID of andere smartcards tijdens deze sessie mogen worden ondertekend. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Details van ondertekeningsbeleid voor de handtekening. |
|
|
Telefoonnummer
|
Phonenumber | string |
Telefoonnummer om een SMS OTP te ontvangen. |
|
|
RedirectURL
|
RedirectURL | string |
Url waarnaar de eindgebruiker wordt omgeleid na ondertekening of weigeren. De omleiding vindt direct plaats na ondertekening of weigeren. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures kunnen e-mailberichten verzenden naar de actoren waarvan de actie is vereist, zoals ondertekening |
|
|
UserRoles
|
UserRoles | array of string |
De locatie-id's waar een handtekening door deze persoon moet worden geplaatst. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
De 3 waarden verwijzen naar de 3 juridische kennisgevingen die zijn ingebouwd in de toepassing. Deze kunnen worden gewijzigd in de configuratie-index. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Aangepaste tekst voor juridische kennisgeving voor het geval geen van de drie vooraf gedefinieerde juridische kennisgevingen van toepassing is |
|
|
E-mailadres
|
EmailAddress | string |
E-mailadres |
|
|
Voornaam
|
FirstName | string |
Voornaam |
|
|
Language
|
Language | string |
Gebruikersinterfacetaal van deze belanghebbende. Momenteel ondersteund: nl, nl, de, fr, es. |
|
|
Achternaam
|
LastName | string |
Achternaam |
|
|
Geboortedatum
|
BirthDate | string |
Geboortedatum in notatie: JJJJ-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Verwijzing die is opgegeven door de aanroepende toepassing. Deze parameter wordt niet gebruikt door de eSignatures-portal. |
Verlooptijdstempel
Een pakket heeft mogelijk de status Verlopen wanneer een pakket een waarde heeft doorgegeven voor de parameter ExpireTimestamp in de aanroep Package maken. Een dergelijk pakket kan niet meer worden ondertekend.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
id | True | string |
Unieke id van het pakket |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Definities
Package
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Details voor elk van de documenten in het pakket
| Name | Pad | Type | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Unieke id van het document |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Retourneert de externe verwijzing van dit document terwijl het is doorgegeven via het document Toevoegen aan pakketoproep. |
|
DocumentName
|
DocumentName | string |
Naam van het document |
|
DocumentType
|
DocumentType | string |
Type document in het pakket. |
PackageStatus
Beschrijving voor het pakket dat wordt weergegeven aan de gebruiker van de eSignatures-portal als bestandsnaam.
| Name | Pad | Type | Description |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Beschrijving voor het pakket dat wordt weergegeven aan de gebruiker van de eSignatures-portal als bestandsnaam. |
|
CreationTimestamp
|
CreationTimestamp | string |
De datum en tijd waarop het pakket is gemaakt op basis van de server. |
|
Initiator
|
Initiator | string |
Het veld Initiator van het pakket zoals het tijdens het maken is doorgegeven. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Tijd waarop het document verloopt, is opgemaakt door UTC. Kan null zijn. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Retourneert de externe referentie-id van het pakket zoals het is doorgegeven tijdens het maken. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Maak een koppeling naar het pakket waarmee u kunt kiezen uit alle ondertekeningssessies tegelijk. |
|
PackageStatus
|
PackageStatus | string |
Status van het pakket als geheel: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Details voor elk van de documenten in het pakket. |
|
Belanghebbenden
|
Stakeholders | array of object |
Details voor elk van de personen die met het pakket zullen communiceren. |
|
Typologie
|
Stakeholders.Type | string |
Type belanghebbende: Person, PersonGroup of ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Naam van de persoonsgroep. Alleen geretourneerd als Type is ingesteld op PersonGroup in de aanvraag. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Code van de groep contactpersonen. Alleen geretourneerd als Type is ingesteld op ContactGroup in de aanvraag. |
|
E-mailadres
|
Stakeholders.EmailAddress | string |
E-mailadres van de ondertekenaar. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Externe verwijzing waarmee deze persoon in het externe systeem wordt geïdentificeerd. |
|
StakeholderId
|
Stakeholders.StakeholderId | string |
Unieke id. |
|
Actors
|
Stakeholders.Actors | array of object |
Details van alle stappen die moeten worden uitgevoerd. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
Unieke id voor deze combinatie van actie, belanghebbende en document. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
URL die deze persoon kan openen om met het pakket te communiceren. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Matrix van URL's die de verschillende personen van de PersonGroup of ContactGroup kunnen openen om met het pakket te communiceren. |
|
E-mailadres
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
E-mailadres van de persoon. |
|
URL
|
Stakeholders.Actors.ActionUrls.Url | string |
URL die deze persoon kan openen om met het pakket te communiceren. |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Concept (pakket heeft status Concept) |
|
Typologie
|
Stakeholders.Actors.Type | string |
Ondertekenaar/ontvanger |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
De naam van de eindgebruiker die de actie heeft voltooid. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Tijdstempel van het moment waarop deze actie is voltooid. |
|
Reden
|
Stakeholders.Actors.Reason | string |
Retourneert de tekst die is ingevoerd door de persoon die de status van een pakket heeft gewijzigd in een definitieve status (bijvoorbeeld een weigering). |
|
Locaties
|
Stakeholders.Actors.Locations | array of object |
Vertegenwoordigt een mogelijke locatie voor een handtekening. |
|
Identiteitsbewijs
|
Stakeholders.Actors.Locations.Id | string |
Unieke id voor deze locatie |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Retourneert het ondertekeningstype dat is gebruikt om het document te ondertekenen. |
Content
| Name | Pad | Type | Description |
|---|---|---|---|
|
Uploads
|
uploads | array of object | |
|
uploaden
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
einde
|
uploads.upload.end | date-time | |
|
Handtekeningen
|
uploads.upload.signatures | array of object | |
|
Bewijzen
|
uploads.upload.signatures.proofs | array of object | |
|
naam
|
uploads.upload.signatures.proofs.proof.name | string | |
|
type
|
uploads.upload.signatures.proofs.proof.type | string | |
|
index
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
Indexen
|
uploads.indexes | array of object | |
|
Id
|
uploads.indexes.index.identifier | boolean | |
|
inhoud
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
pakket-ID
|
uploads.packageId | string |
binair
Dit is het basisgegevenstype 'binair'.