PKIsigning (preview)
Automatiseer uw behoeften voor documentondertekening met de PKIsigning-platformconnector. Documenten verzenden naar het PKIsigning-platform; uitnodigingen verzenden en de ondertekende documenten ophalen.
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 | ONDERSTEUNING voor PKIsigning |
| URL | https://pkisigning.nl/support |
| E-mailen | support@pkisigning.nl |
| Connectormetagegevens | |
|---|---|
| Uitgever | SBRS B.V. |
| Webpagina | https://pkisigning.nl |
| Privacybeleid | https://pkisigning.nl/privacy |
| Categorieën | Samenwerking; Productiviteit |
MET PKIsigning kunnen organisaties het proces voor het goedkeuren, ondertekenen en verzenden van documenten naar klanten en derden automatiseren, vereenvoudigen en beveiligen. Het platform ondersteunt alle eIDAS persoonlijke ondertekeningscertificaten van Nederlandse gekwalificeerde vertrouwde dienstverleners en is ISO27001 gecertificeerd. Dit maakt PKIsigning een ideale partner voor juridische, financiële en gezondheidszorgorganisaties en overheden. Maak verbinding met PKisigning om uw proces voor documentondertekening te automatiseren, vereenvoudigen en beveiligen.
Vereiste voorwaarden
Als u de PKIsigning-connector wilt gebruiken, is een account voor het PKIsigning-platform vereist binnen een 'professioneel' abonnement. Neem contact op met PKIsigning om u te registreren voor een betaald abonnement.
Referenties ophalen
Nadat ze zich hebben geregistreerd voor een abonnement, ontvangen gebruikers een e-mail met een uitnodiging om hun account in te stellen. Nadat u zich hebt geregistreerd, kan dat account rechtstreeks worden gebruikt met deze connector.
Aan de slag met uw connector
De standaardstroom voor het starten van ondertekeningsdocumenten is als volgt:
- Dossier maken
- Document(en) toevoegen
- Actor(s) toevoegen
- Werkstroom starten
- Een trigger gebruiken om op de hoogte te worden gesteld van statuswijzigingen
- Dossier downloaden
Dossiers
PKIsigning verwacht dat u altijd eerst een dossier maakt. Een dossier fungeert als een container voor documenten en actoren. Er kan een dossier worden gemaakt met de Dossiers_Create actie. Nadat een dossier is gemaakt, gebruikt u de geretourneerde PkisId als referentie voor toekomstige acties.
Documents
Nadat een dossier is gemaakt, kunt u documenten met de Documents_Add actie toevoegen met behulp van de juiste dossierId. De actie heeft geen andere parameters nodig omdat ze worden afgeleid van de documentbestanden zelf. Er is geen limiet voor het aantal documenten in een dossier. Alle documenten kunnen worden weergegeven en gedownload voor alle toegevoegde actoren.
Belangrijk: Het document heeft een of meer unieke tijdelijke aanduidingen voor tekst nodig, afhankelijk van het aantal handtekeningen, om aan te geven waar een handtekening moet worden geplaatst en door welke actor. Dit kan elke tekst op elke plaats in het document zijn. Wanneer u actoren toevoegt, kunt u de tijdelijke aanduiding definiëren met de parameter voor de tijdelijke aanduiding. Bijvoorbeeld: handtekening1, handtekening2, enzovoort...
Actors
De derde stap bestaat uit het toevoegen van actoren aan de documenten. Dit wordt gedaan met de Actor_Create Action met behulp van de juiste dossierId en documentId.
Werkstroom starten
Als u een werkstroom wilt starten en effectief uitnodigingen wilt verzenden naar alle actoren om documenten in de opgegeven volgorde te ondertekenen of te downloaden, gebruikt u de Dossiers_StartWorkflow actie met de juiste dossierId.
Een trigger gebruiken om op de hoogte te worden gesteld van statuswijzigingen
Als u het document wilt ophalen nadat het is ondertekend, abonneert u zich op meldingen met behulp van een trigger. Als u een statusmelding wilt ontvangen, geeft u 'status' op in het veld Gebeurtenissen.
Dossier downloaden
Wanneer de trigger wordt gewaarschuwd voor een statusupdate, controleert u of de status van het document is voltooid. Vanaf dat moment is het mogelijk om alle documenten in het dossier in één zipfile te downloaden. Als deze is opgegeven in de instellingen binnen het PKIsigning-platform dat een audittrail moet worden gegenereerd, wordt dit ook opgenomen.
Bekende problemen en beperkingen
Er zijn geen problemen bekend op het moment van publicatie.
Veelvoorkomende fouten en oplossingen
Geen statusupdates via trigger
Als de trigger niet reageert op statusupdates, controleert u of de waarde 'status' is opgegeven in het veld Gebeurtenissen.
HTTP-fout 402 Betaling vereist
Voor het PKIsigning-platform zijn tegoeden vereist om acties uit te voeren. Wanneer actoren worden toegevoegd, worden tegoeden gereserveerd om ervoor te zorgen dat de actie kan plaatsvinden en genodigden niet worden geconfronteerd met problemen met betrekking tot een onvoldoende aantal beschikbare kredieten. Als er veel uitnodigingen naar actoren worden verzonden, kan het gebeuren dat de kredietbundel geen tegoeden meer heeft om te worden gereserveerd. Op dat moment wordt een HTTP 402-fout geretourneerd.
Om het probleem op te lossen, ondersteunt PKIsigning om het tegoedsaldo op te halen of schoon eventuele niet-verzonden dossiers op met actoren in de prullenbak op het platform. Ongebruikte tegoeden worden vervolgens weer beschikbaar.
Veelgestelde vragen
Raadpleeg onze knowledgebase of neem contact met ons op via support@pkisigning.nl
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Aanvraag bijwerken |
Hiermee worden gegevens voor een specifieke aanvraag gewijzigd. |
| Aanvraag downloaden |
Hiermee downloadt u een aanvraag en de inhoud ervan als een .zip-bestand. |
| Aanvraag maken |
Maak een nieuwe aanvraag. |
| Aanvraag verzenden |
Hiermee start u de werkstroom en verzendt u een uitnodiging naar de eerste actor in de regel voor een specifieke aanvraag. |
| Aanvraaggegevens ophalen |
Retourneert alle (meta)gegevens voor een specifieke aanvraag. |
| Actor bijwerken |
Hiermee worden gegevens voor een specifieke actor gewijzigd. |
| Actor maken |
Hiermee maakt u een nieuwe actor en voegt u deze toe aan een document. |
| Actor verwijderen |
Hiermee verwijdert u een specifieke actor definitief. |
| Actorgegevens ophalen |
Retourneert alle gegevens voor een specifieke actor. |
| Actorgegevens ophalen op aanvraag |
Retourneert alle gegevens van alle actoren voor een specifieke aanvraag. |
| Actorgegevens ophalen per document |
Retourneert alle gegevens van alle actoren voor een specifiek document. |
| Document bijwerken |
Hiermee worden gegevens voor een specifiek document gewijzigd. |
| Document maken |
Hiermee maakt u een nieuw document en voegt u het toe aan een specifieke aanvraag. |
| Document verwijderen |
Hiermee verwijdert u een specifiek document definitief. |
| Documentgegevens ophalen |
Retourneert alle (meta)gegevens voor een specifiek document. |
| Een aanvraag verwijderen |
Hiermee verwijdert u een specifieke aanvraag definitief. |
| Uitnodiging intrekken |
Hiermee wordt de uitnodiging voor de huidige actor in de regel voor een specifieke aanvraag ingetrokken. |
| Uitnodiging opnieuw verzenden |
Hiermee wordt de uitnodiging voor de huidige actor opnieuw verzonden in de regel voor een specifieke aanvraag. |
| Werkgroepen voor gebruiker ophalen |
Retourneert een lijst met alle werkgroepen voor een specifieke gebruiker van een specifieke organisatie. |
| Werkgroepen voor organisatie ophalen |
Retourneert een lijst met alle werkgroepen voor een specifieke organisatie. |
Aanvraag bijwerken
Hiermee worden gegevens voor een specifieke aanvraag gewijzigd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Aanvraagnaam
|
name | True | string |
Naam voor een specifieke aanvraag. |
|
Werkgroep-id
|
workgroupId | guid |
Unieke id van een werkgroep. |
|
|
Beveiligingsmachtigingsniveau
|
clearancelevel | True | integer |
Beveiligingsmachtigingsniveau voor een specifieke aanvraag. |
|
Eigenaar aanvragen
|
owner |
Gebruiker die de eigenaar is van een specifieke aanvraag. |
Retouren
- Body
- RequestModel
Aanvraag downloaden
Hiermee downloadt u een aanvraag en de inhoud ervan als een .zip-bestand.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
Retouren
- response
- file
Aanvraag maken
Maak een nieuwe aanvraag.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraagnaam
|
name | True | string |
Naam voor een specifieke aanvraag. |
|
Werkgroep-id
|
workgroupId | guid |
Unieke id van een werkgroep. |
|
|
Beveiligingsmachtigingsniveau
|
clearancelevel | True | integer |
Beveiligingsmachtigingsniveau voor een specifieke aanvraag. |
|
Eigenaar aanvragen
|
owner |
Gebruiker die de eigenaar is van een specifieke aanvraag. |
Retouren
- Body
- RequestModel
Aanvraag verzenden
Hiermee start u de werkstroom en verzendt u een uitnodiging naar de eerste actor in de regel voor een specifieke aanvraag.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
Aanvraaggegevens ophalen
Retourneert alle (meta)gegevens voor een specifieke aanvraag.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Verificatiesleutel
|
callbackAuthenticationKey | string |
Verificatiesleutel zoals opgegeven door trigger. |
Retouren
- Body
- RequestModel
Actor bijwerken
Hiermee worden gegevens voor een specifieke actor gewijzigd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
|
Actor-id
|
actorId | True | guid |
Unieke id van een actor. |
|
Handeling
|
action | True | string |
Actie die de actor moet uitvoeren. |
|
Voornaam
|
firstname | True | string |
Voornaam van de acteur. |
|
Voorvoegsel
|
prefix | string |
Voorvoegsel van de actor. |
|
|
Achternaam
|
lastname | True | string |
Achternaam van de acteur. |
|
E-mailadres
|
True | string |
E-mailadres van de actor. |
|
|
Mobiel telefoonnummer
|
mobile | True | string |
Mobiel telefoonnummer van de acteur. |
|
Deadline
|
deadline | True | date-time |
De datum en tijd waarop de actie moet zijn uitgevoerd door de actor. |
|
Language
|
language | True | string |
Taal voor de uitnodiging. |
|
Sterke verificatie gebruiken
|
validateRealIdentity | True | boolean |
Gebruik een sterkere identificatiemethode voor deze actor. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string |
Retouren
- Body
- ExtendedSignerModel
Actor maken
Hiermee maakt u een nieuwe actor en voegt u deze toe aan een document.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
|
Handeling
|
action | True | string |
Actie die de actor moet uitvoeren. |
|
Voornaam
|
firstname | True | string |
Voornaam van de acteur. |
|
Voorvoegsel
|
prefix | string |
Voorvoegsel van de actor. |
|
|
Achternaam
|
lastname | True | string |
Achternaam van de acteur. |
|
E-mailadres
|
True | string |
E-mailadres van de actor. |
|
|
Mobiel telefoonnummer
|
mobile | True | string |
Mobiel telefoonnummer van de acteur. |
|
Deadline
|
deadline | True | date-time |
De datum en tijd waarop de actie moet zijn uitgevoerd door de actor. |
|
Language
|
language | True | string |
Taal voor de uitnodiging. |
|
Sterke verificatie gebruiken
|
validateRealIdentity | True | boolean |
Gebruik een sterkere identificatiemethode voor deze actor. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string | ||
|
Handtekeningveld
|
fieldName | string |
De naam van een bestaand handtekeningveld in het document om deze actor te ondertekenen. |
|
|
Placeholder
|
placeholder | string |
De tekst van een specifieke tijdelijke aanduiding in het document waar de actor een handtekening moet plaatsen. |
Retouren
- Body
- ExtendedSignerModel
Actor verwijderen
Hiermee verwijdert u een specifieke actor definitief.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
|
Actor-id
|
actorId | True | guid |
Unieke id van een actor. |
Actorgegevens ophalen
Retourneert alle gegevens voor een specifieke actor.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
|
Actor-id
|
actorId | True | guid |
Unieke id van een actor. |
Retouren
- Body
- ExtendedSignerModel
Actorgegevens ophalen op aanvraag
Retourneert alle gegevens van alle actoren voor een specifieke aanvraag.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Heeft acteur gereageerd op de aanvraag
|
hasActed | boolean |
Alleen-lezenwaarde om te controleren of een actor al actie heeft ondernomen op het document. |
Retouren
- response
- array of ExtendedSignerModel
Actorgegevens ophalen per document
Retourneert alle gegevens van alle actoren voor een specifiek document.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
|
Actie voltooid
|
hasActed | boolean |
Retourneert alleen actoren die hun actie hebben of niet hebben voltooid, laat leeg om alle actoren te retourneren. |
Retouren
- response
- array of ExtendedSignerModel
Document bijwerken
Hiermee worden gegevens voor een specifiek document gewijzigd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
|
Documentnaam
|
name | string |
Naam voor een specifiek document |
|
|
Documentbestandsnaam
|
filename | string |
Bestandsnaam voor een specifiek document |
|
|
Documenttype
|
documentType | True | string |
Het type voor een specifiek document. (Bijv. Reguliere PDF, fiscale verklaring, auditorsrapport, enz.). |
Retouren
Algemene metagegevens van het document
Document maken
Hiermee maakt u een nieuw document en voegt u het toe aan een specifieke aanvraag.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag waartoe dit document behoort. |
|
Bestand
|
file | True | file |
Het bestand dat moet worden verwerkt (alleen specifieke bestandstypen). |
Retouren
Algemene metagegevens van het document
Document verwijderen
Hiermee verwijdert u een specifiek document definitief.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
Documentgegevens ophalen
Retourneert alle (meta)gegevens voor een specifiek document.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
|
Document-id
|
documentId | True | guid |
Unieke id van een document. |
Retouren
Algemene metagegevens van het document
Een aanvraag verwijderen
Hiermee verwijdert u een specifieke aanvraag definitief.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
Uitnodiging intrekken
Hiermee wordt de uitnodiging voor de huidige actor in de regel voor een specifieke aanvraag ingetrokken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
Uitnodiging opnieuw verzenden
Hiermee wordt de uitnodiging voor de huidige actor opnieuw verzonden in de regel voor een specifieke aanvraag.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
requestId | True | guid |
Unieke id van een aanvraag. |
Werkgroepen voor gebruiker ophalen
Retourneert een lijst met alle werkgroepen voor een specifieke gebruiker van een specifieke organisatie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Organisatie-id
|
organisationId | True | guid |
Unieke id van een organisatie. |
|
Gebruikersnaam
|
username | True |
E-mailadres van de gebruiker |
Retouren
- response
- array of OrganisationWorkgroup
Werkgroepen voor organisatie ophalen
Retourneert een lijst met alle werkgroepen voor een specifieke organisatie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Organisatie-id
|
organisationId | True | guid |
Unieke id van een organisatie. |
Retouren
- response
- array of OrganisationWorkgroup
Triggers
| Wanneer een gebeurtenis optreedt in een aanvraag |
Registreer een URL voor callback bij een statuswijziging. Het PKIsigning-platform rapporteert alle statusupdates van dossiers binnen deze organisatie aan deze URL. |
Wanneer een gebeurtenis optreedt in een aanvraag
Registreer een URL voor callback bij een statuswijziging. Het PKIsigning-platform rapporteert alle statusupdates van dossiers binnen deze organisatie aan deze URL.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebeurtenistypen
|
Events | True | array of string |
Een lijst met gebeurtenistypen die optreden op een aanvraag waarvan deze trigger op de hoogte wordt gesteld |
|
Organisatie-id
|
organisationId | True | guid |
Unieke id van een organisatie. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Aanvraag-id
|
PkisId | guid |
Unieke id van een aanvraag. |
|
Aanvraagstatus
|
DossierStatus | string |
Status van het dossier. |
|
Reden
|
Reason | string |
Reden van de wijziging. |
|
Verificatiesleutel
|
AuthenticationKey | string |
Header voor het verkrijgen van metagegevens op de aanvraag. |
Definities
ExtendedSignerModel
| Name | Pad | Type | Description |
|---|---|---|---|
|
Handtekeningveld
|
fieldName | string |
De naam van een bestaand handtekeningveld in het document om deze actor te ondertekenen. |
|
Placeholder
|
placeholder | string |
De tekst van een specifieke tijdelijke aanduiding in het document waar de actor een handtekening moet plaatsen. |
|
Handeling
|
action | string |
Actie die de actor moet uitvoeren. |
|
Voornaam
|
firstname | string |
Voornaam van de acteur. |
|
Voorvoegsel
|
prefix | string |
Voorvoegsel van de actor. |
|
Achternaam
|
lastname | string |
Achternaam van de acteur. |
|
E-mailadres
|
string |
E-mailadres van de actor. |
|
|
Mobiel telefoonnummer
|
mobile | string |
Mobiel telefoonnummer van de acteur. |
|
Deadline
|
deadline | date-time |
De datum en tijd waarop de actie moet zijn uitgevoerd door de actor. |
|
Language
|
language | string |
Taal voor de uitnodiging. |
|
Sterke verificatie gebruiken
|
validateRealIdentity | boolean |
Gebruik een sterkere identificatiemethode voor deze actor. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
Actor-id
|
id | guid |
Unieke id van een specifieke actor. |
|
Datum van voltooiing
|
signingDate | date-time |
De datum en tijd waarop de actor de actie heeft uitgevoerd. |
|
Actie voltooid
|
hasSigned | boolean | |
|
Volledige naam
|
fullName | string |
Gecombineerde voornaam, voorvoegsel en achternaam van de actor. |
|
Statusinformatie
|
emailActivity | array of EmailActivity |
Statusinformatie over het proces van het uitvoeren van de actie door de actor. |
|
documentId
|
documentId | guid |
EmailActivity
Metagegevens van e-mailberichten die naar een actor worden verzonden
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mailactiviteit
|
event | string |
E-mailactiviteit voor een specifieke aanvraag en actor. |
|
SMTP-informatie
|
reason | string |
SMTP-informatie voor een e-mailbericht dat is verzonden naar een specifieke actor als onderdeel van een aanvraag. |
|
E-maildatum
|
timestamp | date-time |
Datum voor een e-mailbericht dat is verzonden naar een specifieke actor als onderdeel van een aanvraag. |
|
E-mailtype
|
pkisMessageType | string |
Typ een e-mailbericht dat is verzonden naar een specifieke actor als onderdeel van een aanvraag (bijvoorbeeld Uitnodigen, Herinnering, enzovoort). |
|
E-mailaanvraag-id
|
pkisInviteId | string |
Unieke id voor een e-mailbericht dat als onderdeel van een aanvraag naar een specifieke actor wordt verzonden. |
|
E-mailadres
|
string |
E-mailadres voor een e-mailbericht dat is verzonden naar een specifieke actor als onderdeel van een aanvraag. |
SignerModel
Speciaal type actor
| Name | Pad | Type | Description |
|---|---|---|---|
|
Handeling
|
action | string |
Actie die de actor moet uitvoeren. |
|
Voornaam
|
firstname | string |
Voornaam van de acteur. |
|
Voorvoegsel
|
prefix | string |
Voorvoegsel van de actor. |
|
Achternaam
|
lastname | string |
Achternaam van de acteur. |
|
E-mailadres
|
string |
E-mailadres van de actor. |
|
|
Mobiel telefoonnummer
|
mobile | string |
Mobiel telefoonnummer van de acteur. |
|
Deadline
|
deadline | date-time |
De datum en tijd waarop de actie moet zijn uitgevoerd door de actor. |
|
Language
|
language | string |
Taal voor de uitnodiging. |
|
Sterke verificatie gebruiken
|
validateRealIdentity | boolean |
Gebruik een sterkere identificatiemethode voor deze actor. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
Handtekeningveld
|
fieldName | string |
De naam van een bestaand handtekeningveld in het document om deze actor te ondertekenen. |
|
Placeholder
|
placeholder | string |
De tekst van een specifieke tijdelijke aanduiding in het document waar de actor een handtekening moet plaatsen. |
DocumentMetaDataModel
Algemene metagegevens van het document
| Name | Pad | Type | Description |
|---|---|---|---|
|
Documentnaam
|
name | string |
Naam voor een specifiek document. |
|
Laatste documentupdate
|
lastUpdate | date-time |
Datum van laatste update voor een specifiek document. |
|
Aantal documentpagina's
|
pages | integer |
Aantal pagina's voor een specifiek document. |
|
Aanmaakdatum van document
|
created | date-time |
De aanmaakdatum voor een specifiek document. |
|
Document-id
|
id | guid |
Unieke id van een document. |
|
Documentstatus
|
status | string |
Status voor een specifiek document. (Bijvoorbeeld nieuw, voltooid, enzovoort). |
|
Document bevat handtekening
|
signed | boolean |
Hiermee wordt aangegeven of een specifiek document al een of meer handtekeningen bevat. |
|
Documenthandtekeningen
|
signatures | array of SignatureData |
Lijst met alle handtekeningen voor een specifiek document. |
|
Lege handtekeningvelden voor documenten
|
emptySignatureFields | array of SignatureField |
Lijst met alle lege handtekeningvelden voor een specifiek document. |
|
Lege handtekeningvelden
|
containsBlankSignatureFields | boolean |
Hiermee wordt aangegeven of een specifiek document lege handtekeningvelden bevat. |
|
Documentacteurs
|
actors | array of ExtendedSignerModel |
Lijst met alle actoren voor een specifiek document. |
|
Aanvraag-id
|
requestId | guid |
Unieke id van een aanvraag. |
|
Index aanvragen
|
dossierIndex | integer |
De index van alle documenten die bij een specifieke aanvraag horen. |
|
documentSize
|
documentSize | integer |
De grootte van een document dat hoort bij een specifieke aanvraag. |
|
documentType
|
documentType | string |
Het type document dat hoort bij een specifieke aanvraag. |
SignatureData
| Name | Pad | Type | Description |
|---|---|---|---|
|
Certificaatonderwerpvelden
|
subject | array of KeyValuePairOfStringAndString |
Velden uit de onderwerpregel van het certificaat dat wordt gebruikt voor een specifieke handtekening. |
|
Velden voor certificaatverlener
|
issuer | array of KeyValuePairOfStringAndString |
Velden van de regel verlener van het certificaat dat wordt gebruikt voor een specifieke handtekening. |
|
Handtekeningdatum
|
date | date-time |
Datum en tijd waarop een specifieke handtekening is geplaatst. |
|
Locatie voor ondertekening
|
location | string |
De geografische locatie van een specifieke actor op het moment van ondertekening. |
|
Reden voor ondertekening
|
reason | string |
De reden voor ondertekening zoals opgegeven door een specifieke actor op het moment van ondertekening. |
|
Gekwalificeerde elektronische handtekening
|
euQualified | boolean |
Geeft aan of een specifieke handtekening is gekwalificeerd (QeS) voldoet aan eIDAS-voorschriften. |
|
Geavanceerde elektronische handtekening
|
advanced | boolean |
Hiermee wordt aangegeven of een specifieke handtekening geavanceerd is (AeS) voldoet aan eIDAS-voorschriften. |
|
Gekwalificeerde eSeal
|
eSeal | boolean |
Geeft aan of een specifiek certificaat dat wordt gebruikt voor ondertekening of verzegeling een gekwalificeerde eSeal-regelgeving is. |
|
IP-adres van actor
|
ipAddress | string |
Het IP-adres voor een specifieke actor |
|
Handtekeningveld
|
signatureField | string |
Het veld dat is ondertekend |
|
Handtekeningafbeelding
|
signatureImage | string |
Het afbeeldingsbestand dat is gebruikt voor een specifieke handtekening, zoals gekozen door een actor. |
KeyValuePairOfStringAndString
| Name | Pad | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
waarde
|
value | string |
SignatureField
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam van handtekeningveld
|
name | string |
Naam voor een specifiek handtekeningveld |
|
Pagina handtekeningveld
|
page | integer |
Pagina waarin een specifiek handtekeningveld wordt geplaatst voor een specifiek document. |
|
Coördinaat voor breedte van handtekeningveld
|
x | double |
Breedtewaarde van de positie voor een specifiek handtekeningveld ten opzichte van de pagina die in een specifiek document wordt geplaatst. |
|
Hightcoördinaat van handtekeningveld
|
y | double |
Hoge waarde van de positie voor een specifiek handtekeningveld ten opzichte van de pagina die in een specifiek document wordt geplaatst. |
|
Hight van handtekeningveld
|
height | double |
Hoge waarde voor een specifiek handtekeningveld. |
|
Breedte van handtekeningveld
|
width | double |
Breedtewaarde voor een specifiek handtekeningveld. |
OrganizationWorkgroup
Een werkgroep die in een dossier wordt gebruikt
| Name | Pad | Type | Description |
|---|---|---|---|
|
Werkgroep-id
|
id | guid |
Unieke id van een werkgroep |
|
Werkgroepnaam
|
name | string |
Naam voor een specifieke werkgroep |
RequestModel
| Name | Pad | Type | Description |
|---|---|---|---|
|
Aanvraag-id
|
id | guid |
Unieke id van een aanvraag |
|
Aanvraagnaam
|
dossierName | string |
Naam voor een specifieke aanvraag. |
|
Documenten aanvragen
|
documents | array of DocumentModel |
Lijst met documenten die zijn opgenomen in deze aanvraag. |
|
Aanvraagstatus
|
status | string |
Status voor een specifieke aanvraag. (Bijvoorbeeld nieuw, voltooid, enzovoort). |
|
Actoren aanvragen
|
actors | array of ExtendedSignerModel |
Lijst met alle actoren voor een specifieke aanvraag. |
|
Documenthandtekeningen
|
signatures | array of SignatureData |
Lijst met alle handtekeningen voor een specifieke aanvraag. |
|
Aanvraagtype
|
dossierType | string |
Het type voor een specifieke aanvraag. (E.g. PDF, SBR Assurance, enzovoort). |
|
Reden voor annuleren
|
reasons | string |
Reden van annulering voor een specifieke aanvraag door een gebruiker of een actor. |
|
Ondertekenaarnotitie
|
signerNote | string |
Opmerking voor een of meer actor(s) die geen andere actie hebben dan ondertekenen. |
|
Notitie van geadresseerde
|
recipientNote | string |
Opmerking voor een of meer actor(s) die geen andere actie hebben dan downloaden. |
|
Notitie fiatteur
|
accorderNote | string |
Opmerking voor een of meer actor(s) die geen andere actie hebben dan goedkeuringsaanvraag. |
|
Vervaldatum van aanvraag
|
expires | date-time |
Datum en tijd van vervaldatum voor een specifieke aanvraag. |
|
Statusinformatie
|
emailActivity | array of EmailActivity |
Statusinformatie over het proces van het uitvoeren van de actie door de actor. |
|
Mijn aanvraag
|
myDossier | boolean |
Geeft aan of u de eigenaar van een specifieke aanvraag bent. |
|
Werkgroep-id
|
workgroup | guid |
Unieke id van een werkgroep. |
|
Beveiligingsmachtigingsniveau
|
clearancelevel | integer |
Beveiligingsmachtigingsniveau voor een specifieke aanvraag. |
DocumentModel
| Name | Pad | Type | Description |
|---|---|---|---|
|
Document-id
|
id | guid |
Unieke id van een document |
|
Documentnaam
|
name | string |
Naam van een specifiek document |
|
Documenttype
|
documentType | string |
Typ voor een specifiek document. |
|
Index aanvragen
|
dossierIndex | integer |
De index van alle documenten die bij een specifieke aanvraag horen. |
|
Documentstatus
|
documentstatus | string |
Status voor een specifiek document. (Bijvoorbeeld nieuw, voltooid, enzovoort). |
|
Documentacteurs
|
actors | array of SignerModel |
Lijst met alle actoren voor een specifiek document. |
bestand
Dit is het basisgegevenstype 'bestand'.