Nitro Sign Enterprise Geverifieerd (preview)
Nitro Sign Enterprise Verified is een gerenommeerde digitale handtekeningoplossing die een grote hoeveelheid handtekeningmethoden en naleving biedt aan de strengste (inter)nationale regelgeving. Met NSEV 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.
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 | Nitro-ondersteuning |
| URL | https://www.gonitro.com/support |
| E-mailen | service@gonitro.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Nitro Software Belgium NV |
| Webpagina | https://www.gonitro.com |
| Privacybeleid | https://www.gonitro.com/legal/privacy-policy |
| Categorieën | IT-bewerkingen; Productiviteit |
Nitro Sign Enterprise-geverifieerde connector
Nitro Software, een specialist in Smart Document Solutions, heeft de Nitro Sign Enterprise Verified 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. Nitro Sign Enterprise Verified - voorheen bekend als Nitro Sign Premium en Connective eSignatures.
Vereiste voorwaarden
Als u de connector wilt gaan gebruiken, is een bestaand abonnement op Nitro Sign Enterprise Verified vereist. Neem contact op met uw contactpersoon bij Nitro Software of ga naar onze help- en ondersteuningspagina op onze website om de referenties te ontvangen.
Documentation
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 onze help- en ondersteuningspagina of het ondersteuningspostvak: mailto:service@gonitro.com. De API-documentatie is ook beschikbaar in Postman-indeling.
Er is een woordenlijst beschikbaar om de verschillende termen uit te leggen die in deze documentatie worden gebruikt
Ondersteunde bewerkingen
De Nitro Sign Enterprise Verified-connector is gebaseerd op API v4 van Nitro Sign Enterprise Verified. De 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 |
|---|---|
| Pakketten | Alle pakketten ophalen |
| Pakket ophalen op id | |
| Pakketstatus ophalen | |
| Een nieuw pakket maken (standaard of direct) | |
| Een pakket verwijderen op id | |
| De status van een pakket bijwerken | |
| De vervaldatum van een pakket ophalen | |
| De vervaldatum van een pakket bijwerken | |
| Ondertekenaars overslaan | |
| Herinneringen verzenden | |
| Een pakket downloaden | |
| Het audittrail van een pakket downloaden | |
| Documents | Een document toevoegen aan een pakket |
| Een ondertekend document downloaden uit een pakket | |
| Belanghebbenden | Een belanghebbende verwijderen op id |
| Alle belanghebbenden van een pakket ophalen | |
| Een belanghebbende toevoegen aan een pakket | |
| Proces | Alle processtappen van een pakket ophalen |
| Proces | Een stap toevoegen in het pakketproces |
| Proces | Processtappen van een pakket overschrijven |
| Proces | Alle acties van een processtap ophalen |
| Proces | Een processtap en alle bijbehorende actoren verwijderen |
| Proces | Een actor toevoegen aan een processtap |
| Proces | Alle acties ophalen in de huidige processtap |
| Other | Alle talen ophalen die zijn ingeschakeld in de toepassing |
| Alle thema's ophalen die kunnen worden toegewezen aan een pakket | |
| Alle documentgroepen ophalen waaraan een pakket kan worden toegewezen | |
| Alle geconfigureerde ondertekeningsmethoden ophalen |
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 |
|---|---|---|---|
| Nitro Sign-host | touw | host en pad naar uw Nitro Sign-omgeving, bijvoorbeeld contoso.sign.gonitro.com/esig | 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
| Alle acties ophalen in de huidige processtap |
Hiermee haalt u de huidige set acties op die parallel kunnen worden voltooid. |
| Alle acties van een processtap ophalen |
Hiermee haalt u een bepaalde set acties op die parallel vanuit het proces kunnen worden voltooid. |
| Alle belanghebbenden van een pakket ophalen |
Haalt de belanghebbenden van het pakket op |
| Alle documentgroepen ophalen waaraan pakketten kunnen worden toegewezen |
Hiermee worden alle documentgroepen opgehaald waaraan pakketten kunnen worden toegewezen |
| Alle ondertekeningsmethoden retourneren die momenteel zijn geconfigureerd |
Retourneert alle ondertekeningsmethoden die momenteel zijn geconfigureerd |
| Alle pakketten ophalen |
Hiermee worden alle pakketten opgehaald, deze worden gesorteerd op creationDate |
| Alle processtappen ophalen |
Hiermee haalt u alle acties op die op het pakket moeten worden uitgevoerd. |
| Alle talen ophalen die zijn ingeschakeld in de toepassing |
Haalt alle talen op die zijn ingeschakeld in de toepassing |
| Alle thema's ophalen die aan een pakket kunnen worden toegewezen |
Hiermee worden alle thema's opgehaald die aan een pakket kunnen worden toegewezen. Mogelijk om het resultaat te pagina's door een MaxQuantity en een vervolgToken op te geven |
| Belanghebbende verwijderen op id |
Hiermee verwijdert u een belanghebbende op basis van de id. |
| De vervaldatum van een pakket bijwerken |
De vervaldatum van een pakket bijwerken |
| De vervaldatum van een pakket ophalen |
De vervaldatum van een pakket ophalen |
| Document downloaden van pakket |
Download een ondertekend document uit een pakket. Elk document wordt gedownload als een PDF- of XML-bestand. |
| Download het audittrail van het pakket |
Download een ondertekend audittrail over de levensduur van een pakket. |
| Een actor toevoegen aan een processtap |
Hiermee voegt u een actor toe aan een processtap. |
| Een belanghebbende toevoegen aan een pakket |
Voegt een belanghebbende toe aan het pakket |
| Een document toevoegen aan een pakket |
Hiermee voegt u een document toe aan een bestaand pakket. |
| Een nieuw pakket maken (standaard of direct) |
Hiermee maakt u een nieuw pakket. Standaard wordt het pakket gemaakt als concept. Als u een direct gereed pakket wilt maken voor ondertekening, stelt u de
Notitie: Met |
| Een processtap en alle bijbehorende actoren verwijderen |
Hiermee verwijdert u een processtap en alle bijbehorende actoren. |
| Een stap toevoegen in het pakketproces |
Hiermee voegt u een set acties toe aan het pakketproces. |
| Ondertekenaars overslaan |
Met deze aanroep worden alle ondertekenaars overgeslagen die nog niet zijn voltooid en worden hun status ingesteld op 'Overgeslagen', wat resulteert in het volledige pakket dat wordt gemarkeerd als 'Voltooid'. |
| Pakket downloaden |
Wordt gebruikt voor het downloaden van alle documenten in een bepaald pakket als zip-bestand. |
| Pakket ophalen op id |
Hiermee wordt een pakket opgehaald op basis van de id. |
| Pakket verwijderen op id |
Hiermee verwijdert u een pakket op basis van de id. |
| 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. |
| Pakketstatus bijwerken |
Hiermee wordt de status van een pakket bijgewerkt. |
| Pakketstatus ophalen |
Haalt de huidige status van het pakket op. |
| Processtappen van een pakket overschrijven |
Overschrijft alle actoren in een pakket met behulp van een 2D-matrix, waarbij elke set actoren acties zijn die parallel kunnen worden uitgevoerd. |
Alle acties ophalen in de huidige processtap
Hiermee haalt u de huidige set acties op die parallel kunnen worden voltooid.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
Items | array of Response.Actor |
Alle acties van een processtap ophalen
Hiermee haalt u een bepaalde set acties op die parallel vanuit het proces kunnen worden voltooid.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
De index van de processtap
|
stepIndex | True | integer |
De index van de processtap |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
Items | array of Response.Actor |
Alle belanghebbenden van een pakket ophalen
Haalt de belanghebbenden van het pakket op
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor het pakket
|
packageId | True | string |
Unieke id voor het pakket |
Retouren
- response
- array of Response.Stakeholder
Alle documentgroepen ophalen waaraan pakketten kunnen worden toegewezen
Hiermee worden alle documentgroepen opgehaald waaraan pakketten kunnen worden toegewezen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De naam (of het onderdeel) van de documentgroep om naar te zoeken
|
name | string |
De naam (of het onderdeel) van de documentgroep om naar te zoeken |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
DocumentGroups
|
DocumentGroups | array of object |
De lijst met documentgroepen |
|
Code
|
DocumentGroups.Code | string |
De code van de documentgroep |
|
Naam
|
DocumentGroups.Name | string |
De naam van de documentgroep |
Alle ondertekeningsmethoden retourneren die momenteel zijn geconfigureerd
Retourneert alle ondertekeningsmethoden die momenteel zijn geconfigureerd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
alleen actieve/inactieve ondertekeningsmethoden retourneren
|
isActive | boolean |
alleen actieve/inactieve ondertekeningsmethoden retourneren |
Retouren
- response
- array of ConfiguredSigningMethod
Alle pakketten ophalen
Hiermee worden alle pakketten opgehaald, deze worden gesorteerd op creationDate
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Het paginanummer dat moet worden opgehaald
|
pageNumber | integer |
Het paginanummer dat moet worden opgehaald |
|
|
Aantal items per pagina
|
pageSize | integer |
Aantal items per pagina |
|
|
Pakketten retourneren die vóór deze datum zijn gemaakt
|
createdBefore | date-time |
Pakketten retourneren die vóór deze datum zijn gemaakt |
|
|
Pakketten retourneren die na deze datum zijn gemaakt
|
createdAfter | date-time |
Pakketten retourneren die na deze datum zijn gemaakt |
|
|
Status van de pakketten die moeten worden gefilterd
|
status | string |
Status van de pakketten die moeten worden gefilterd |
|
|
Code van documentgroep voor het filteren van pakketten
|
documentGroupCode | string |
Code van documentgroep voor het filteren van pakketten |
|
|
E-mail van de pakketinitiator die moet worden gefilterd
|
initiator |
E-mail van de pakketinitiator die moet worden gefilterd |
||
|
Naam van het pakket dat moet worden gefilterd
|
packageName | string |
Naam van het pakket dat moet worden gefilterd |
|
|
Externe verwijzing naar filterpakketten
|
externalReference | string |
Externe verwijzing naar filterpakketten |
|
|
Opgeven hoe het resultaat wordt gesorteerd, de standaardwaarde is aflopend
|
sort | string |
Opgeven hoe het resultaat wordt gesorteerd, de standaardwaarde is aflopend |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
PageNumber
|
PageNumber | integer |
Huidig paginanummer |
|
PageSize
|
PageSize | integer |
Aantal items per pagina |
|
TotalPages
|
TotalPages | integer |
Totaal aantal pagina's |
|
TotalItems
|
TotalItems | integer |
Totaal aantal items |
|
Artikelen
|
Items | array of Response.Package.Get |
Alle processtappen ophalen
Hiermee haalt u alle acties op die op het pakket moeten worden uitgevoerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of array | ||
|
items
|
array of Response.Actor |
Een set actoren in een processtap. |
Alle talen ophalen die zijn ingeschakeld in de toepassing
Haalt alle talen op die zijn ingeschakeld in de toepassing
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
EnabledLanguages
|
EnabledLanguages | array of object |
De lijst met ingeschakelde talen |
|
Schermnaam
|
EnabledLanguages.DisplayName | string |
De weergavenaam van de taal |
|
NativeName
|
EnabledLanguages.NativeName | string |
De systeemeigen naam van de taal |
|
IsoCultureCode
|
EnabledLanguages.IsoCultureCode | string |
De ISO-code van 2 letters (ISO 639-1) van de taal |
Alle thema's ophalen die aan een pakket kunnen worden toegewezen
Hiermee worden alle thema's opgehaald die aan een pakket kunnen worden toegewezen. Mogelijk om het resultaat te pagina's door een MaxQuantity en een vervolgToken op te geven
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Token om de volgende set resultaten op te halen
|
continuationToken | string |
Token om de volgende set resultaten op te halen |
|
|
Maximum aantal resultaten dat moet worden geretourneerd
|
maxQuantity | integer |
Maximum aantal resultaten dat moet worden geretourneerd |
|
|
De volgorde waarin de resultaten moeten worden gesorteerd
|
sortOrder | string |
De volgorde waarin de resultaten moeten worden gesorteerd |
|
|
opgeven op welk veld moet worden gesorteerd
|
sortField | string |
opgeven op welk veld moet worden gesorteerd |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Vervolgtoken
|
ContinuationToken | string |
Token voor het ophalen van de volgende pagina met resultaten |
|
Artikelen
|
Items | array of object |
De lijst met de thema's |
|
Code
|
Items.Code | string |
De code van het thema |
|
Naam
|
Items.Name | string |
De naam van het thema |
|
MaxQuantity
|
MaxQuantity | integer |
Het maximum aantal resultaten dat per aanvraag wordt geretourneerd |
|
Total
|
Total | integer |
Het totale aantal resultaten. |
Belanghebbende verwijderen op id
Hiermee verwijdert u een belanghebbende op basis van de id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
Unieke id van de belanghebbende
|
stakeholderId | True | string |
Unieke id van de belanghebbende |
De vervaldatum van een pakket bijwerken
De vervaldatum van een pakket bijwerken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Een datum/tijd-waarde in ISO 8601-indeling |
De vervaldatum van een pakket ophalen
De vervaldatum van een pakket ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
Retouren
Een datum/tijd-waarde in ISO 8601-indeling
- response
- Common.DateTime
Document downloaden van pakket
Download een ondertekend document uit een pakket. Elk document wordt gedownload als een PDF- of XML-bestand.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
Unieke id van het document in het pakket
|
documentId | True | string |
Unieke id van het document in het pakket |
Retouren
- response
- binary
Download het audittrail van het pakket
Download een ondertekend audittrail over de levensduur van een pakket.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
Een ISO-code van 2 letters (ISO 639-1)
|
culture | True | string |
Een ISO-code van 2 letters (ISO 639-1) |
Retouren
- response
- binary
Een actor toevoegen aan een processtap
Hiermee voegt u een actor toe aan een processtap.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
De index van de processtap
|
stepIndex | True | integer |
De index van de processtap |
|
Typologie
|
Type | True | string |
Type actie dat moet worden uitgevoerd op een pakket |
|
StakeholderId
|
StakeholderId | True | string |
Id van een belanghebbende in het pakket |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Meldingen voor de actor onderdrukken |
|
|
RedirectUrl
|
RedirectUrl | url |
Omleidings-URL nadat de actie van de actor is voltooid |
|
|
Identiteitsbewijs
|
Id | string |
Id van een bestaand element. Indien gebruikt, moeten alle andere velden leeg zijn. |
|
|
Typologie
|
Type | string |
Het type element |
|
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Page
|
Page | integer |
Paginanummer van het document |
|
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
|
Links
|
Left | number |
Positie links in pixels |
|
|
Breedte
|
Width | number |
Breedte van het element |
|
|
Hoogte
|
Height | number |
Hoogte van het element |
|
|
DocumentId
|
DocumentId | string |
Id van het document in het pakket |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Naam
|
Name | string |
De naam van de juridische kennisgeving die moet worden toegevoegd aan het handtekeningveld. |
|
|
Content
|
Content | string |
Inhoud van aangepaste juridische kennisgeving. |
|
|
Language
|
Language | string |
De ISO-code van twee letters van een land (ISO 639-1) |
Retouren
- Body
- Response.Actor
Een belanghebbende toevoegen aan een pakket
Voegt een belanghebbende toe aan het pakket
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor het pakket
|
packageId | True | string |
Unieke id voor het pakket |
|
Typologie
|
Type | True | string |
Het type belanghebbende |
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Language
|
Language | True | string |
De ISO-code van twee letters van een land (ISO 639-1) |
|
Voornaam
|
FirstName | string |
Voornaam van de belanghebbende |
|
|
Achternaam
|
LastName | True | string |
Achternaam van de belanghebbende |
|
E-mailadres
|
EmailAddress | True |
Een e-mailadres |
|
|
Geboortedatum
|
BirthDate | date | ||
|
Telefoonnummer
|
PhoneNumber | string |
Een telefoonnummer |
|
|
AdditionalProperties
|
AdditionalProperties | object |
De configureerbare aanvullende eigenschappen van de belanghebbende |
|
|
Typologie
|
Type | True | string |
Type actie dat moet worden uitgevoerd op een pakket |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Meldingen voor de actor onderdrukken |
|
|
RedirectUrl
|
RedirectUrl | url |
Omleidings-URL nadat de actie van de actor is voltooid |
|
|
RedirectType
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
URL waarnaar de gebruiker wordt verzonden na het sluiten van de sessie |
|
|
Identiteitsbewijs
|
Id | string |
Id van een bestaand element. Indien gebruikt, moeten alle andere velden leeg zijn. |
|
|
Typologie
|
Type | string |
Het type element |
|
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Page
|
Page | integer |
Paginanummer van het document |
|
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
|
Links
|
Left | number |
Positie links in pixels |
|
|
Breedte
|
Width | number |
Breedte van het element |
|
|
Hoogte
|
Height | number |
Hoogte van het element |
|
|
DocumentId
|
DocumentId | string |
Id van het document in het pakket |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Naam
|
Name | string |
De naam van de juridische kennisgeving die moet worden toegevoegd aan het handtekeningveld. |
|
|
Content
|
Content | string |
Inhoud van aangepaste juridische kennisgeving. |
|
|
Language
|
Language | string |
De ISO-code van twee letters van een land (ISO 639-1) |
Retouren
- Body
- Response.Stakeholder
Een document toevoegen aan een pakket
Hiermee voegt u een document toe aan een bestaand pakket.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke pakket-id
|
packageId | True | string |
Unieke pakket-id |
|
Naam
|
Name | True | string |
Naam van het document |
|
IsOptional
|
IsOptional | boolean |
Geeft aan of het document optioneel moet zijn voor ondertekening |
|
|
Language
|
Language | True | string |
De ISO-code van twee letters van een land (ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
Een wereldwijd unieke id |
|
|
Doeltype
|
TargetType | string |
Werkt alleen wanneer de server is geconfigureerd voor documentconversies. |
|
|
TargetFormat
|
TargetFormat | string |
De doelindeling definieert of er een extra conversie moet worden uitgevoerd. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Omgaan met PDF-bestanden met kleine fouten |
|
|
ContentType
|
ContentType | True | string |
MIME-type van het document |
|
Base64Data
|
Base64Data | True | byte |
Met Base64 gecodeerde documentinhoud |
|
Typologie
|
Type | True | string |
Het type element |
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Page
|
Page | integer |
Paginanummer van het document |
|
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
|
Links
|
Left | number |
Positie links in pixels |
|
|
Breedte
|
Width | number |
Breedte van het element |
|
|
Hoogte
|
Height | number |
Hoogte van het element |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Naam
|
Name | string |
De naam van de juridische kennisgeving die moet worden toegevoegd aan het handtekeningveld. |
|
|
Content
|
Content | string |
Inhoud van aangepaste juridische kennisgeving. |
|
|
Language
|
Language | string |
De ISO-code van twee letters van een land (ISO 639-1) |
Retouren
- Body
- Response.Document
Een nieuw pakket maken (standaard of direct)
Hiermee maakt u een nieuw pakket. Standaard wordt het pakket gemaakt als concept. Als u een direct gereed pakket wilt maken voor ondertekening, stelt u de status eigenschap in op Pending.
Notitie: Met POST /packages het eindpunt kunt u zowel standaard- als directe pakketten maken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
Name | True | string |
Naam van het pakket |
|
Initiator
|
Initiator | True |
Een e-mailadres |
|
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Toestand
|
Status | string |
De status van het gemaakte pakket.
|
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Documentgroepcode voor het pakket |
|
|
Vervaldatum
|
ExpiryDate | date-time |
Een datum/tijd-waarde in ISO 8601-indeling |
|
|
Naam
|
Name | True | string |
Naam van het document |
|
IsOptional
|
IsOptional | boolean |
Geeft aan of het document optioneel moet zijn voor ondertekening |
|
|
Language
|
Language | True | string |
De ISO-code van twee letters van een land (ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
Een wereldwijd unieke id |
|
|
Doeltype
|
TargetType | string |
Werkt alleen wanneer de server is geconfigureerd voor documentconversies. |
|
|
TargetFormat
|
TargetFormat | string |
De doelindeling definieert of er een extra conversie moet worden uitgevoerd. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Omgaan met PDF-bestanden met kleine fouten |
|
|
ContentType
|
ContentType | True | string |
MIME-type van het document |
|
Base64Data
|
Base64Data | True | byte |
Met Base64 gecodeerde documentinhoud |
|
Typologie
|
Type | True | string |
Het type element |
|
Page
|
Page | integer |
Paginanummer van het document |
|
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
|
Links
|
Left | number |
Positie links in pixels |
|
|
Breedte
|
Width | number |
Breedte van het element |
|
|
Hoogte
|
Height | number |
Hoogte van het element |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Naam
|
Name | string |
De naam van de juridische kennisgeving die moet worden toegevoegd aan het handtekeningveld. |
|
|
Content
|
Content | string |
Inhoud van aangepaste juridische kennisgeving. |
|
|
Typologie
|
Type | True | string |
Het type belanghebbende |
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Language
|
Language | True | string |
De ISO-code van twee letters van een land (ISO 639-1) |
|
Voornaam
|
FirstName | string |
Voornaam van de belanghebbende |
|
|
Achternaam
|
LastName | True | string |
Achternaam van de belanghebbende |
|
E-mailadres
|
EmailAddress | True |
Een e-mailadres |
|
|
Geboortedatum
|
BirthDate | date | ||
|
Telefoonnummer
|
PhoneNumber | string |
Een telefoonnummer |
|
|
AdditionalProperties
|
AdditionalProperties | object |
De configureerbare aanvullende eigenschappen van de belanghebbende |
|
|
Typologie
|
Type | True | string |
Type actie dat moet worden uitgevoerd op een pakket |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Meldingen voor de actor onderdrukken |
|
|
RedirectUrl
|
RedirectUrl | url |
Omleidings-URL nadat de actie van de actor is voltooid |
|
|
RedirectType
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
URL waarnaar de gebruiker wordt verzonden na het sluiten van de sessie |
|
|
ProcessStep
|
ProcessStep | integer |
Het nummer van de processtap |
|
|
DocumentIndex
|
DocumentIndex | True | integer |
Index van het document in het pakket (vanaf 0) - alleen beschikbaar in het eindpunt Pakket maken |
|
Typologie
|
Type | True | string |
Het type element |
|
Page
|
Page | integer |
Paginanummer van het document |
|
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
|
Links
|
Left | number |
Positie links in pixels |
|
|
Breedte
|
Width | number |
Breedte van het element |
|
|
Hoogte
|
Height | number |
Hoogte van het element |
|
|
SigningMethods
|
SigningMethods | True | array of string | |
|
Naam
|
Name | string |
De naam van de juridische kennisgeving die moet worden toegevoegd aan het handtekeningveld. |
|
|
Content
|
Content | string |
Inhoud van aangepaste juridische kennisgeving. |
|
|
ThemeCode
|
ThemeCode | string |
Id van het thema voor het pakket |
|
|
CallBackUrl
|
CallBackUrl | url |
URL voor callback nadat acties zijn uitgevoerd |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | url |
URL voor callback wanneer een ondertekenaar een nieuwe ondertekenings-URL aanvraagt |
|
|
DefaultRedirectUrl
|
DefaultRedirectUrl | url |
Omleidings-URL na voltooiing van de actie |
|
|
F2fRedirectUrl
|
F2fRedirectUrl | url |
Url omleiden na face-to-face-ondertekening |
|
|
IsUnsignedContentDownloadable
|
IsUnsignedContentDownloadable | boolean |
Of niet-ondertekende inhoud kan worden gedownload |
|
|
IsReassignEnabled
|
IsReassignEnabled | boolean |
Of opnieuw toewijzen is ingeschakeld |
Retouren
- Body
- Response.Package.Get
Een processtap en alle bijbehorende actoren verwijderen
Hiermee verwijdert u een processtap en alle bijbehorende actoren.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
De index van de processtap
|
stepIndex | True | integer |
De index van de processtap |
Een stap toevoegen in het pakketproces
Hiermee voegt u een set acties toe aan het pakketproces.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
Typologie
|
Type | True | string |
Type actie dat moet worden uitgevoerd op een pakket |
|
StakeholderId
|
StakeholderId | True | string |
Id van een belanghebbende in het pakket |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Meldingen voor de actor onderdrukken |
|
|
RedirectUrl
|
RedirectUrl | url |
Omleidings-URL nadat de actie van de actor is voltooid |
|
|
Identiteitsbewijs
|
Id | string |
Id van een bestaand element. Indien gebruikt, moeten alle andere velden leeg zijn. |
|
|
Typologie
|
Type | string |
Het type element |
|
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Page
|
Page | integer |
Paginanummer van het document |
|
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
|
Links
|
Left | number |
Positie links in pixels |
|
|
Breedte
|
Width | number |
Breedte van het element |
|
|
Hoogte
|
Height | number |
Hoogte van het element |
|
|
DocumentId
|
DocumentId | string |
Id van het document in het pakket |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Naam
|
Name | string |
De naam van de juridische kennisgeving die moet worden toegevoegd aan het handtekeningveld. |
|
|
Content
|
Content | string |
Inhoud van aangepaste juridische kennisgeving. |
|
|
Language
|
Language | string |
De ISO-code van twee letters van een land (ISO 639-1) |
Retouren
Een set actoren in een processtap.
- response
- array of Response.Actor
Ondertekenaars overslaan
Met deze aanroep worden alle ondertekenaars overgeslagen die nog niet zijn voltooid en worden hun status ingesteld op 'Overgeslagen', wat resulteert in het volledige pakket dat wordt gemarkeerd als 'Voltooid'.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
Pakket downloaden
Wordt gebruikt voor het downloaden van alle documenten in een bepaald pakket als zip-bestand.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
Retouren
- response
- binary
Pakket ophalen op id
Hiermee wordt een pakket opgehaald op basis van de id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
Retouren
- Body
- Response.Package.Get
Pakket verwijderen op id
Hiermee verwijdert u een pakket op basis van de id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | 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 |
Pakketstatus bijwerken
Hiermee wordt de status van een pakket bijgewerkt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor het pakket
|
packageId | True | string |
Unieke id voor het pakket |
|
body
|
body | True | string |
Pakketstatus ophalen
Haalt de huidige status van het pakket op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id voor het pakket
|
packageId | True | string |
Unieke id voor het pakket |
Retouren
Processtappen van een pakket overschrijven
Overschrijft alle actoren in een pakket met behulp van een 2D-matrix, waarbij elke set actoren acties zijn die parallel kunnen worden uitgevoerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Unieke id van het pakket
|
packageId | True | string |
Unieke id van het pakket |
|
Typologie
|
Type | True | string |
Type actie dat moet worden uitgevoerd op een pakket |
|
StakeholderId
|
StakeholderId | True | string |
Id van een belanghebbende in het pakket |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Meldingen voor de actor onderdrukken |
|
|
RedirectUrl
|
RedirectUrl | url |
Omleidings-URL nadat de actie van de actor is voltooid |
|
|
Identiteitsbewijs
|
Id | string |
Id van een bestaand element. Indien gebruikt, moeten alle andere velden leeg zijn. |
|
|
Typologie
|
Type | string |
Het type element |
|
|
ExternalReference
|
ExternalReference | string |
Externe verwijzing voor het pakket |
|
|
Page
|
Page | integer |
Paginanummer van het document |
|
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
|
Links
|
Left | number |
Positie links in pixels |
|
|
Breedte
|
Width | number |
Breedte van het element |
|
|
Hoogte
|
Height | number |
Hoogte van het element |
|
|
DocumentId
|
DocumentId | string |
Id van het document in het pakket |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Naam
|
Name | string |
De naam van de juridische kennisgeving die moet worden toegevoegd aan het handtekeningveld. |
|
|
Content
|
Content | string |
Inhoud van aangepaste juridische kennisgeving. |
|
|
Language
|
Language | string |
De ISO-code van twee letters van een land (ISO 639-1) |
Definities
ConfiguredSigningMethod
Een geconfigureerde ondertekeningsmethode in eSignatures
| Name | Pad | Type | Description |
|---|---|---|---|
|
IsActive
|
IsActive | boolean |
Of de signingMethod kan worden gebruikt voor het maken van nieuwe ondertekeningsvelden |
|
Naam
|
Name | string |
De geconfigureerde naam van de ondertekeningsmethode |
|
DisplayNames
|
DisplayNames | object |
De naam per taal die wordt weergegeven aan een ondertekenaar |
|
DisplayNamesInitiator
|
DisplayNamesInitiator | object |
De naam per taal die moet worden weergegeven aan de initiator bij het maken van het pakket. |
|
Beschrijvingen
|
Descriptions | object |
Beschrijving van de ondertekeningsmethode per taal voor meer informatie over de ondertekeningsmethode tijdens het maken van het pakket. |
|
RequiredProperties
|
RequiredProperties | array of string |
De vereiste eigenschappen voor verplicht ondertekenen |
|
KeyPairs
|
KeyPairs | array of KeyPair |
beschikbare KeyPairs die kunnen worden gebruikt voor het ondertekenen met deze methode |
KeyPair
weergave van een ondertekeningssleutelpaar
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam
|
Name | string |
Naam van het sleutelpaar |
|
DisplayNames
|
DisplayNames | object |
De naam per taal die wordt weergegeven aan een initiator |
Common.Guid
Common.EmailAddress
Common.Language
De ISO-code van twee letters van een land (ISO 639-1)
De ISO-code van twee letters van een land (ISO 639-1)
Common.PhoneNumber
Common.ExternalReference
Common.AdditionalProperties
De configureerbare aanvullende eigenschappen van de belanghebbende
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
object |
De configureerbare aanvullende eigenschappen van de belanghebbende |
Common.DateTime
Package.Status
Package.Name
Document.Name
Document.Status
Document.DocumentOptions
Definieert optionele documentparameters
| Name | Pad | Type | Description |
|---|---|---|---|
|
Doeltype
|
TargetType | string |
Werkt alleen wanneer de server is geconfigureerd voor documentconversies. |
|
TargetFormat
|
PdfOptions.TargetFormat | string |
De doelindeling definieert of er een extra conversie moet worden uitgevoerd. |
|
PdfErrorHandling
|
PdfOptions.PdfErrorHandling | string |
Omgaan met PDF-bestanden met kleine fouten |
Stakeholder.FirstName
Stakeholder.LastName
Actor.Type
Type actie dat moet worden uitgevoerd op een pakket
Type actie dat moet worden uitgevoerd op een pakket
Actor.Status
Element.Type
Element.Status
Element.Location
| Name | Pad | Type | Description |
|---|---|---|---|
|
Page
|
Page | integer |
Paginanummer van het document |
|
Boven
|
Top | number |
Bovenste positie in pixels |
|
Links
|
Left | number |
Positie links in pixels |
Element.Dimensions
| Name | Pad | Type | Description |
|---|---|---|---|
|
Breedte
|
Width | number |
Breedte van het element |
|
Hoogte
|
Height | number |
Hoogte van het element |
Response.Package.Get
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
Id | Common.Guid |
Een wereldwijd unieke id |
|
Naam
|
Name | Package.Name |
Naam van het pakket |
|
Initiator
|
Initiator | Common.EmailAddress |
Een e-mailadres |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externe verwijzing voor het pakket |
|
CreationDate
|
CreationDate | Common.DateTime |
Een datum/tijd-waarde in ISO 8601-indeling |
|
Toestand
|
Status | Package.Status |
De status van het pakket |
|
Vervaldatum
|
ExpiryDate | Common.DateTime |
Een datum/tijd-waarde in ISO 8601-indeling |
|
Documents
|
Documents | array of Response.Document | |
|
Belanghebbenden
|
Stakeholders | array of Response.Stakeholder |
Response.Document
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
Id | Common.Guid |
Een wereldwijd unieke id |
|
Toestand
|
Status | Document.Status |
De status van een document |
|
DocumentOptions
|
DocumentOptions | Document.DocumentOptions |
Definieert optionele documentparameters |
|
Naam
|
Name | Document.Name |
Naam van het document |
|
Language
|
Language | Common.Language |
De ISO-code van twee letters van een land (ISO 639-1) |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externe verwijzing voor het pakket |
|
ProofCorrelationId
|
ProofCorrelationId | Common.Guid |
Een wereldwijd unieke id |
Response.Stakeholder
| Name | Pad | Type | Description |
|---|---|---|---|
|
Typologie
|
Type | string |
Het type belanghebbende |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externe verwijzing voor het pakket |
|
Identiteitsbewijs
|
Id | Common.Guid |
Een wereldwijd unieke id |
|
Language
|
Language | Common.Language |
De ISO-code van twee letters van een land (ISO 639-1) |
|
Voornaam
|
FirstName | Stakeholder.FirstName |
Voornaam van de belanghebbende |
|
Achternaam
|
LastName | Stakeholder.LastName |
Achternaam van de belanghebbende |
|
E-mailadres
|
EmailAddress | Common.EmailAddress |
Een e-mailadres |
|
Geboortedatum
|
BirthDate | date | |
|
Telefoonnummer
|
PhoneNumber | Common.PhoneNumber |
Een telefoonnummer |
|
AdditionalProperties
|
AdditionalProperties | Common.AdditionalProperties |
De configureerbare aanvullende eigenschappen van de belanghebbende |
|
Actors
|
Actors | array of Response.Actor |
Response.Actor
| Name | Pad | Type | Description |
|---|---|---|---|
|
Typologie
|
Type | Actor.Type |
Type actie dat moet worden uitgevoerd op een pakket |
|
Identiteitsbewijs
|
Id | Common.Guid |
Een wereldwijd unieke id |
|
StakeholderId
|
StakeholderId | Common.Guid |
Een wereldwijd unieke id |
|
Toestand
|
Status | Actor.Status |
De status van een actor |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Meldingen voor de actor onderdrukken |
|
RedirectUrl
|
RedirectUrl | url |
Omleidings-URL nadat de actie van de actor is voltooid |
|
Elements
|
Elements | array of Response.Element |
Response.Element
| Name | Pad | Type | Description |
|---|---|---|---|
|
Typologie
|
Type | Element.Type |
Het type element |
|
Identiteitsbewijs
|
Id | Common.Guid |
Een wereldwijd unieke id |
|
ActorId
|
ActorId | Common.Guid |
Een wereldwijd unieke id |
|
DocumentId
|
DocumentId | integer |
Id van het document in het pakket |
|
Toestand
|
Status | Element.Status |
De status van een element |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externe verwijzing voor het pakket |
|
Locatie
|
Location | Element.Location | |
|
Afmetingen
|
Dimensions | Element.Dimensions | |
|
SigningMethods
|
SigningMethods | array of string | |
|
UsedSigningMethod
|
UsedSigningMethod | string |
De gebruikte ondertekeningsmethode |
Response.Package.Status
| Name | Pad | Type | Description |
|---|---|---|---|
|
Toestand
|
Status | Package.Status |
De status van het pakket |
binair
Dit is het basisgegevenstype 'binair'.