Delen via

SignatureAPI

Verzend documenten voor ondertekening, houd de voortgang bij en werk sneller met SignatureAPI, het platform voor elektronische handtekeningen dat is gebouwd voor automatisering. https://signatureapi.com/docs/integrations/power-automate/getting-started

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 Signature-API, Inc.
URL https://signatureapi.com
E-mailen support@signatureapi.com
Connector-metagegevens
Uitgever SignatureAPI
Webpagina https://signatureapi.com/power-automate
Privacybeleid https://signatureapi.com/privacy
Categorieën Samenwerking; Productiviteit

SignatureAPI

SignatureAPI is een platform voor elektronische handtekeningen dat is gebouwd voor automatisering.

Documenten verzenden voor ondertekening en hun voortgang bijhouden met behulp van ons e-handtekeningplatform voor Power Automate, dat verschillende acties en triggers biedt om u te helpen zowel eenvoudige als complexe werkstromen te maken.

Elektronische handtekeningen die zijn gemaakt met SignatureAPI, zijn juridisch bindend en wereldwijd geaccepteerd, net als traditionele inkthandtekeningen in de meeste jurisdicties.

SignatureAPI biedt voordelige prijzen voor automatisering met grote volumes. Bekijk onze prijsgegevens.

Belangrijke functies

  • Meerdere geadresseerden: documenten verzenden naar maximaal 10 ondertekenaars in één transactie.
  • Parallel of sequentiële ondertekening: kies ervoor om documenten tegelijk of in een specifieke volgorde naar alle geadresseerden te verzenden.
  • Documentsjablonen: programmatisch documenten genereren met behulp van sjablonen en dynamische gegevens.
  • Talen en lokalisatie: pas de ondertekeningsinterface aan met verschillende talen, datum-/tijdnotaties en tijdzones.
  • Accountloze ondertekening: Ontvangers toestaan documenten te ondertekenen zonder een account te maken of zich aan te melden.
  • Auditlogboek: een gedetailleerd logboek met documenttoegang, controle en handtekeninggebeurtenissen onderhouden.
  • Controle van manipulatie: zorg ervoor dat documentintegriteit is geverifieerd, onherstelbaar bewijs na handtekening.
  • Enveloppen bijhouden: de voortgang van ondertekening bewaken via een gebruiksvriendelijk dashboard.
  • Real-Time Meldingen: ontvang directe updates over ondertekeningsactiviteiten via e-mail en webhooks.

Vereiste voorwaarden

Als u deze connector wilt gebruiken, meldt u zich aan voor een SignatureAPI-account en genereert u een API-sleutel. Haal een gratis test-API-sleutel op en stel uw verbinding in.

Aan de slag komen

De meest voorkomende werkstroom omvat het verzenden van een of meer documenten naar geadresseerden voor handtekening. De geadresseerden ontvangen een e-mailbericht met een koppeling voor toegang tot de ondertekeningsinterface.

SignatureAPI ondersteunt geavanceerde werkstromen. Bekijk onze connectorhandleidingen voor stapsgewijze instructies, use cases en automatiseringsstrategieën.

Stap 1: Een envelop maken

Begin met het maken van een lege envelop. Een envelop is een container die documenten bevat en het ondertekeningsproces beheert.

De volgende opties zijn beschikbaar:

Stap 2: Geadresseerden toevoegen

Geef op wie de documenten moet ondertekenen door geadresseerden toe te voegen aan uw envelop. Op dit moment worden alleen ondertekenaars ondersteund, maar in de toekomst zijn er extra typen geadresseerden beschikbaar.

Stap 3: Documenten toevoegen

Voeg de documenten toe die handtekeningen nodig hebben voor de envelop. U kunt PDF- of DOCX-bestanden uploaden of documenten genereren op basis van sjablonen met behulp van gegevens.

Stap 4: Locaties definiëren in de documenten

Locaties zijn aangewezen gebieden in een document waar een geadresseerde communiceert, zoals ondertekening, initialen opgegeven of tekst toevoegen. Ze kunnen ook statische of berekende waarden bevatten, zoals voltooiingsdatums.

Stap 5: het ondertekeningsproces starten

Zodra de envelop volledig is voorbereid, start u het ondertekeningsproces.

Stap 6: Wacht tot de envelop is voltooid

Als u de hele werkstroom binnen dezelfde stroom wilt houden, kunt u wachten totdat de envelop is voltooid. Dit zorgt ervoor dat alle geadresseerden zijn ondertekend en dat het product (ondertekend document) wordt gegenereerd.

U kunt ook een afzonderlijke werkstroom activeren wanneer de envelop is voltooid en het product wordt gegenereerd.

Stap 7: het ondertekende document ophalen

Zodra het proces is voltooid, haalt u het ondertekende document (product) op.

Werken met triggers

SignatureAPI biedt triggers voor het automatiseren van uw werkstromen en het stroomlijnen van processen. Meer informatie over de volledige lijst met triggers en hoe u deze kunt gebruiken.

Veelgebruikte triggers

Wanneer een product wordt gegenereerd

Geactiveerd wanneer de envelop is voltooid en het ondertekende document (product) gereed is.

Wanneer een geadresseerde een envelop heeft voltooid

Elke keer dat een geadresseerde het deel van het ondertekeningsproces voltooit, wordt geactiveerd.

Wanneer een e-mail van een geadresseerde niet wordt bezorgd

Geactiveerd wanneer het e-mailadres van een geadresseerde de aanvraag niet kan ontvangen.

Bekende problemen en beperkingen

Veelvoorkomende fouten en oplossingen

  • Zorg ervoor dat de actie Een product ophalen wordt uitgevoerd na de actie Wachten op envelop . Producten zijn alleen beschikbaar zodra alle geadresseerden hun deel hebben voltooid.
  • Als u overstapt van een test-API-sleutel naar een live-API-sleutel, werkt u de trigger bij om ervoor te zorgen dat de webhook wordt gemaakt in de juiste omgeving (live of test). Raadpleeg onze gids voor probleemoplossing voor meer informatie.

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
API-sleutel beveiligde string De API-sleutel voor uw SignatureAPI-account. Klopt

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Een ceremonie maken - Aangepaste verificatie

Hiermee maakt u een ceremonie waarin de ontvanger extern wordt geverifieerd bij SignatureAPI. Gebruik deze url om een ceremonie-URL te verkrijgen voor het delen met geadresseerden. Leesbewerkingen voor aangepaste verificatie https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Een ceremonie maken - Verificatie via e-mailkoppeling

Hiermee maakt u een ceremonie waarin de ontvanger wordt geverifieerd via een koppeling die naar zijn e-mail wordt verzonden. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Een document toevoegen - DOCX

Hiermee voegt u een DOCX-document toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Een document toevoegen - PDF

Hiermee voegt u een PDF-document toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Een envelop maken

Hiermee maakt u een nieuwe envelop waaraan u geadresseerden en documenten kunt toevoegen. Wanneer u klaar bent, gebruikt u de actie 'Een envelop starten' om het ondertekeningsproces te starten. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Een envelop ophalen

Hiermee worden envelopgegevens opgehaald op basis van de id. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Een envelop starten

Start het ondertekeningsproces voor een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Een envelop verwijderen

Hiermee verwijdert u een envelop en alle bijbehorende informatie. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Een geadresseerde ophalen

Hiermee worden de gegevens van de geadresseerde opgehaald op basis van hun id. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Een geadresseerde toevoegen - Ondertekenaar

Hiermee voegt u een geadresseerde toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Een locatie toevoegen - Datum waarop envelop is voltooid

Hiermee voegt u een voltooide datum voor een envelop toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Een locatie toevoegen - Datum waarop geadresseerde is voltooid

Hiermee voegt u een voltooide datum voor een geadresseerde toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Een locatie toevoegen - Handtekening

Hiermee voegt u een handtekeningplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Een locatie toevoegen - Initialen

Voegt een initialenplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Een plaats toevoegen — Tekst

Hiermee voegt u een tekstplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Een plaats toevoegen — Tekstinvoer

Hiermee voegt u een tekstinvoerplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Een product verkrijgen

Haalt een product op met behulp van de bijbehorende id. Gebruik deze om een ondertekend exemplaar van de envelop te downloaden. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Een sjabloon toevoegen - DOCX

Hiermee voegt u een DOCX-sjabloon toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Een vastgelegde waarde ophalen

Haalt tijdens de ondertekening een waarde op die door een geadresseerde op een invoerplaats is ingevoerd. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Gegevens toevoegen aan sjabloon

Hiermee voegt u gegevens toe aan een sjabloon. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Wachten op envelop

Wacht totdat een envelop een voltooide status of een andere uiteindelijke status heeft bereikt. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Een ceremonie maken - Aangepaste verificatie

Bewerkings-id:
CreateCeremonyCustom

Hiermee maakt u een ceremonie waarin de ontvanger extern wordt geverifieerd bij SignatureAPI. Gebruik deze url om een ceremonie-URL te verkrijgen voor het delen met geadresseerden. Leesbewerkingen voor aangepaste verificatie https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True string

De id van de ontvanger.
Verificatieprovider
 provider True string

De naam van de verificatieprovider. Deze waarde is willekeurig en wordt weergegeven in de auditlogboeken van de envelop.
Verificatiegegevens
 data True array of string

Sleutel: waardepaar met verificatiemetagegevens. Deze gegevens worden opgenomen in de auditlogboeken van de envelop.
Omleidings-URL
 redirect_url string

Een URL waarnaar de ontvanger wordt omgeleid nadat een ceremonie is voltooid. Meer informatie vindt u in: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Retouren

Body
CreateCeremonyCustomOutput

Een ceremonie maken - Verificatie via e-mailkoppeling

Bewerkings-id:
CreateCeremonyEmailLink

Hiermee maakt u een ceremonie waarin de ontvanger wordt geverifieerd via een koppeling die naar zijn e-mail wordt verzonden. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True string

De id van de ontvanger.
Omleidings-URL
 redirect_url string

Een URL waarnaar de ontvanger wordt omgeleid nadat een ceremonie is voltooid. Meer informatie vindt u in: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Retouren

response
object

Een document toevoegen - DOCX

Bewerkings-id:
AddDocumentDocx

Hiermee voegt u een DOCX-document toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.
Documenttitel
 title string

De titel van dit document. Dit kan worden weergegeven aan geadresseerden.
Bestandsinhoud
 file_content True byte

De inhoud van het documentbestand.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Retouren

Body
AddDocumentOutput

Een document toevoegen - PDF

Bewerkings-id:
AddDocument

Hiermee voegt u een PDF-document toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.
Documenttitel
 title string

De titel van dit document. Dit kan worden weergegeven aan geadresseerden.
Bestandsinhoud
 file_content True byte

De inhoud van het documentbestand.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Retouren

Body
AddDocumentOutput

Een envelop maken

Bewerkings-id:
CreateEnvelope

Hiermee maakt u een nieuwe envelop waaraan u geadresseerden en documenten kunt toevoegen. Wanneer u klaar bent, gebruikt u de actie 'Een envelop starten' om het ondertekeningsproces te starten. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parameters

Name Sleutel Vereist Type Description
Enveloptitel
 title True string

De titel van deze envelop. Dit kan worden weergegeven aan geadresseerden.
Enveloplabel
 label string

Aangepaste etiketten die aan de envelop worden gegeven voor een eenvoudigere identificatie. Labels zijn voor intern gebruik en worden niet weergegeven voor geadresseerden.
Envelopbericht
 message string

Een bericht dat naar de geadresseerden wordt verzonden.
Envelopmodus
 mode string

Enveloppen in de testmodus zijn niet-bindend en worden niet gefactureerd.
Enveloproutering
 routing string

De volgorde waarin geadresseerden de envelop ondertekenen. Dit kan parallel zijn, waarbij alle geadresseerden zich tegelijk kunnen ondertekenen of sequentieel, waarbij geadresseerden zich achter elkaar aanmelden.
Language
 language string

De standaardtaal die moet worden gebruikt in de ondertekeningsceremonie en producten. Als dit niet is opgegeven, wordt de standaardtaal van het account gebruikt. https://signatureapi.com/docs/localization/language
Tijdzone
 timezone string

De tijdzone die moet worden gebruikt voor tijdstempels in producten. Als dit niet is opgegeven, wordt de standaardtijdzone-offset van het account gebruikt. https://signatureapi.com/docs/localization/timezone
Tijdstempelindeling
 timestamp_format string

De datum- en tijdnotatie die moet worden gebruikt in tijdstempels voor producten. Als dit niet is opgegeven, wordt de standaardnotatie van de tijdstempel van het account gebruikt. https://signatureapi.com/docs/localization/timestamp_format
Envelop attestation
 attestation string

Attestation voor regelgeving of naleving
Naam
 name string

De naam van de afzender.
E-mailen
 email string

Het e-mailadres van de afzender.
Enveloponderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Retouren

Body
CreateEnvelopeOutput

Een envelop ophalen

Bewerkings-id:
GetEnvelope

Hiermee worden envelopgegevens opgehaald op basis van de id. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.

Retouren

Body
Envelope

Een envelop starten

Bewerkings-id:
StartEnvelope

Start het ondertekeningsproces voor een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.

Retouren

Body
StartEnvelopeOutput

Een envelop verwijderen

Bewerkings-id:
DeleteEnvelope

Hiermee verwijdert u een envelop en alle bijbehorende informatie. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.

Een geadresseerde ophalen

Bewerkings-id:
GetRecipient

Hiermee worden de gegevens van de geadresseerde opgehaald op basis van hun id. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True string

De id van de ontvanger.

Retouren

Body
Recipient

Een geadresseerde toevoegen - Ondertekenaar

Bewerkings-id:
AddRecipient

Hiermee voegt u een geadresseerde toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.
Naam van geadresseerde
 name True string

De naam van de geadresseerde.
E-mailadres van geadresseerde
 email True string

Het e-mailadres van de geadresseerde.
Geadresseerdesleutel
 key True string

Een sleutel waarmee een geadresseerde in een envelop wordt geïdentificeerd.
Ceremonie van geadresseerde maken
 ceremony_creation string

Hoe de ceremonies voor een ontvanger worden gemaakt.
Type geadresseerde bezorging
 delivery_type string

Hoe het product naar de ontvanger wordt verzonden.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Retouren

Body
AddRecipientSignerOutput

Een locatie toevoegen - Datum waarop envelop is voltooid

Bewerkings-id:
AddPlaceEnvelopeCompletedDate

Hiermee voegt u een voltooide datum voor een envelop toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parameters

Name Sleutel Vereist Type Description
Document-id
 documentId True string

De id van het document.
Sleutel plaatsen
 key True string

Een sleutel die deze locatie in het document identificeert.
Datumnotatie
 date_format string

Hiermee definieert u de notatie van de datum en tijd. Raadpleeg de documentatie voor toegestane waarden.
Paginanummer
 page number

Het paginanummer om deze plaats te plaatsen.
Afstand van bovenaf
 top number

De afstand (in punten) van de bovenkant van de pagina tot aan de onderkant van de plaats.
Afstand van links
 left number

De afstand (in punten) links van de pagina naar de plaats.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Een locatie toevoegen - Datum waarop geadresseerde is voltooid

Bewerkings-id:
AddPlaceRecipientCompletedDate

Hiermee voegt u een voltooide datum voor een geadresseerde toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parameters

Name Sleutel Vereist Type Description
Document-id
 documentId True string

De id van het document.
Sleutel plaatsen
 key True string

Een sleutel die deze locatie in het document identificeert.
Geadresseerdesleutel
 recipient_key True string

De sleutel van de ontvanger waarnaar deze plaats verwijst.
Datumnotatie
 date_format string

Hiermee definieert u de notatie van de datum en tijd. Raadpleeg de documentatie voor toegestane waarden.
Paginanummer
 page number

Het paginanummer om deze plaats te plaatsen.
Afstand van bovenaf
 top number

De afstand (in punten) van de bovenkant van de pagina tot aan de onderkant van de plaats.
Afstand van links
 left number

De afstand (in punten) links van de pagina naar de plaats.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Een locatie toevoegen - Handtekening

Bewerkings-id:
AddPlaceSignature

Hiermee voegt u een handtekeningplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parameters

Name Sleutel Vereist Type Description
Document-id
 documentId True string

De id van het document.
Sleutel plaatsen
 key True string

Een sleutel die deze locatie in het document identificeert.
Geadresseerdesleutel
 recipient_key True string

De sleutel van de ontvanger waarnaar deze plaats verwijst.
Hoogte plaatsen
 height number

Stel een aangepaste hoogte in, de breedte wordt proportioneel aangepast.
Paginanummer
 page number

Het paginanummer om deze plaats te plaatsen.
Afstand van bovenaf
 top number

De afstand (in punten) van de bovenkant van de pagina tot aan de onderkant van de plaats.
Afstand van links
 left number

De afstand (in punten) links van de pagina naar de plaats.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Een locatie toevoegen - Initialen

Bewerkings-id:
AddPlaceInitials

Voegt een initialenplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parameters

Name Sleutel Vereist Type Description
Document-id
 documentId True string

De id van het document.
Sleutel plaatsen
 key True string

Een sleutel die deze locatie in het document identificeert.
Geadresseerdesleutel
 recipient_key True string

De sleutel van de ontvanger waarnaar deze plaats verwijst.
Hoogte plaatsen
 height number

Stel een aangepaste hoogte in, de breedte wordt proportioneel aangepast.
Paginanummer
 page number

Het paginanummer om deze plaats te plaatsen.
Afstand van bovenaf
 top number

De afstand (in punten) van de bovenkant van de pagina tot aan de onderkant van de plaats.
Afstand van links
 left number

De afstand (in punten) links van de pagina naar de plaats.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Een plaats toevoegen — Tekst

Bewerkings-id:
AddPlaceText

Hiermee voegt u een tekstplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parameters

Name Sleutel Vereist Type Description
Document-id
 documentId True string

De id van het document.
Sleutel plaatsen
 key True string

Een sleutel die deze locatie in het document identificeert.
Waarde
 value True string

De waarde voor deze tekstplaats.
Tekengrootte
 font_size number

De tekengrootte in punten.
Tekstkleur
 font_color string

De tekstkleur in hexadecimale notatie.
Paginanummer
 page number

Het paginanummer om deze plaats te plaatsen.
Afstand van bovenaf
 top number

De afstand (in punten) van de bovenkant van de pagina tot aan de onderkant van de plaats.
Afstand van links
 left number

De afstand (in punten) links van de pagina naar de plaats.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Een plaats toevoegen — Tekstinvoer

Bewerkings-id:
AddPlaceTextInput

Hiermee voegt u een tekstinvoerplaats toe aan een document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parameters

Name Sleutel Vereist Type Description
Document-id
 documentId True string

De id van het document.
Sleutel plaatsen
 key True string

Een sleutel die deze locatie in het document identificeert.
Geadresseerdesleutel
 recipient_key True string

De sleutel van de ontvanger waarnaar deze plaats verwijst.
Vastleggen als
 capture_as string

Een sleutel waarmee de invoer van de geadresseerde wordt opgeslagen en wordt opgenomen in de envelopopnamen.
Hint
 hint string

Een knopinfobericht dat wordt weergegeven in het invoerveld voor de geadresseerde.
Snel
 prompt string

Een tijdelijke aanduiding die wordt weergegeven in het invoertekstveld tijdens de ondertekeningsceremonie.
Requirement
 requirement string

Hiermee geeft u op of de ontvanger dit veld moet invullen om de ondertekeningsceremonie te voltooien.
Formaat
 format string

Hiermee geeft u de geldige indeling voor gebruikersinvoer. Raadpleeg de documentatie voor toegestane waarden.
Bericht opmaken
 format_message string

Het bericht dat wordt weergegeven wanneer de invoer van de gebruiker niet overeenkomt met de vereiste indeling.
Paginanummer
 page number

Het paginanummer om deze plaats te plaatsen.
Afstand van bovenaf
 top number

De afstand (in punten) van de bovenkant van de pagina tot aan de onderkant van de plaats.
Afstand van links
 left number

De afstand (in punten) links van de pagina naar de plaats.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Een product verkrijgen

Bewerkings-id:
GetDeliverable

Haalt een product op met behulp van de bijbehorende id. Gebruik deze om een ondertekend exemplaar van de envelop te downloaden. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parameters

Name Sleutel Vereist Type Description
Product-id
 deliverableId True string

De id van het product.

Retouren

Body
Deliverable

Een sjabloon toevoegen - DOCX

Bewerkings-id:
AddTemplate

Hiermee voegt u een DOCX-sjabloon toe aan een envelop. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.
Documenttitel
 title string

De titel van dit document. Dit kan worden weergegeven aan geadresseerden.
Bestandsinhoud
 file_content True byte

De inhoud van het documentbestand.
Sjabloongegevens
 data array of string

Veld: Waardepaar met gegevens om in te vullen in de sjabloon.
Extra eigenschappen
 extra string

Extra eigenschappen voor uitbreidbaarheid

Retouren

Body
AddDocumentOutput

Een vastgelegde waarde ophalen

Bewerkings-id:
GetCapture

Haalt tijdens de ondertekening een waarde op die door een geadresseerde op een invoerplaats is ingevoerd. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.
Capture-sleutel
 captureKey True string

De sleutel van de vastgelegde waarde.

Retouren

Body
Capture

Gegevens toevoegen aan sjabloon

Bewerkings-id:
AddTemplateData

Hiermee voegt u gegevens toe aan een sjabloon. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parameters

Name Sleutel Vereist Type Description
Document-id
 documentId True string

De id van het document.
Veldnaam
 field_name True string

De naam van het veld in de sjabloon.
Waarde
 value True string

De waarde voor het veld in de sjabloon.

Wachten op envelop

Bewerkings-id:
WaitEnvelope

Wacht totdat een envelop een voltooide status of een andere uiteindelijke status heeft bereikt. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parameters

Name Sleutel Vereist Type Description
Envelop-id
 envelopeId True string

De id van de envelop.

Retouren

Body
Envelope

Triggers

Wanneer een envelop is gestart

Deze gebeurtenis treedt op wanneer een envelopstatus overgaat van verwerking naar in_progress, wat aangeeft dat deze gereed is om naar geadresseerden te worden verzonden.
Wanneer een envelop is voltooid

Deze gebeurtenis treedt op wanneer een envelopstatus overgaat van in_progress naar voltooid, wat aangeeft dat deze is voltooid door alle geadresseerden.
Wanneer een envelop mislukt

Deze gebeurtenis treedt op wanneer een envelop mislukt, wat resulteert in een envelopstatus van mislukt.
Wanneer een envelop wordt geannuleerd

Deze gebeurtenis treedt op wanneer het ondertekeningsproces opzettelijk is gestopt voordat het is voltooid, wat resulteert in een envelopstatus van geannuleerd.
Wanneer een envelop wordt gemaakt

Deze gebeurtenis vindt plaats wanneer er een envelop wordt gemaakt.
Wanneer een geadresseerde is voltooid

Deze gebeurtenis treedt op wanneer een geadresseerde het deel van het ondertekeningsproces heeft voltooid.
Wanneer een geadresseerde mislukt

Deze gebeurtenis treedt op wanneer er een fout optreedt die is gerelateerd aan een geadresseerde, wat resulteert in de status van een geadresseerde die is mislukt.
Wanneer een geadresseerde niet komt

Deze gebeurtenis treedt op wanneer een e-mailbericht niet kan worden bezorgd, hetzij tijdelijk (voorlopig stuiteren) of permanent (hard-bounce).
Wanneer een geadresseerde opnieuw wordt verzonden

Deze gebeurtenis treedt op wanneer een aanvraag opnieuw wordt verzonden naar een geadresseerde.
Wanneer een geadresseerde wordt geweigerd

Deze gebeurtenis treedt op wanneer een geadresseerde de envelop weigert.
Wanneer een geadresseerde wordt vervangen

Deze gebeurtenis treedt op wanneer een geadresseerde wordt vervangen door een nieuwe.
Wanneer een geadresseerde wordt verzonden

Deze gebeurtenis treedt op wanneer een aanvraag naar een geadresseerde wordt verzonden.
Wanneer een ontvanger wordt vrijgegeven

Deze gebeurtenis treedt op wanneer een geadresseerde klaar is om een aanvraag te verzenden om een envelop te voltooien.
Wanneer een product mislukt

Deze gebeurtenis treedt op wanneer het genereren van een product mislukt, wat resulteert in een productstatus van mislukt.
Wanneer een product wordt gegenereerd

Deze gebeurtenis treedt op wanneer een product, zoals een auditlogboek, is gegenereerd.

Wanneer een envelop is gestart

Bewerkings-id:
CreateEndpointForEnvelopeStarted

Deze gebeurtenis treedt op wanneer een envelopstatus overgaat van verwerking naar in_progress, wat aangeeft dat deze gereed is om naar geadresseerden te worden verzonden.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForEnvelopeStarted

Wanneer een envelop is voltooid

Bewerkings-id:
CreateEndpointForEnvelopeCompleted

Deze gebeurtenis treedt op wanneer een envelopstatus overgaat van in_progress naar voltooid, wat aangeeft dat deze is voltooid door alle geadresseerden.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForEnvelopeCompleted

Wanneer een envelop mislukt

Bewerkings-id:
CreateEndpointForEnvelopeFailed

Deze gebeurtenis treedt op wanneer een envelop mislukt, wat resulteert in een envelopstatus van mislukt.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForEnvelopeFailed

Wanneer een envelop wordt geannuleerd

Bewerkings-id:
CreateEndpointForEnvelopeCanceled

Deze gebeurtenis treedt op wanneer het ondertekeningsproces opzettelijk is gestopt voordat het is voltooid, wat resulteert in een envelopstatus van geannuleerd.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForEnvelopeCanceled

Wanneer een envelop wordt gemaakt

Bewerkings-id:
CreateEndpointForEnvelopeCreated

Deze gebeurtenis vindt plaats wanneer er een envelop wordt gemaakt.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForEnvelopeCreated

Wanneer een geadresseerde is voltooid

Bewerkings-id:
CreateEndpointForRecipientCompleted

Deze gebeurtenis treedt op wanneer een geadresseerde het deel van het ondertekeningsproces heeft voltooid.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientCompleted

Wanneer een geadresseerde mislukt

Bewerkings-id:
CreateEndpointForRecipientFailed

Deze gebeurtenis treedt op wanneer er een fout optreedt die is gerelateerd aan een geadresseerde, wat resulteert in de status van een geadresseerde die is mislukt.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientFailed

Wanneer een geadresseerde niet komt

Bewerkings-id:
CreateEndpointForRecipientBounced

Deze gebeurtenis treedt op wanneer een e-mailbericht niet kan worden bezorgd, hetzij tijdelijk (voorlopig stuiteren) of permanent (hard-bounce).

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientBounced

Wanneer een geadresseerde opnieuw wordt verzonden

Bewerkings-id:
CreateEndpointForRecipientResent

Deze gebeurtenis treedt op wanneer een aanvraag opnieuw wordt verzonden naar een geadresseerde.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientResent

Wanneer een geadresseerde wordt geweigerd

Bewerkings-id:
CreateEndpointForRecipientRejected

Deze gebeurtenis treedt op wanneer een geadresseerde de envelop weigert.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientRejected

Wanneer een geadresseerde wordt vervangen

Bewerkings-id:
CreateEndpointForRecipientReplaced

Deze gebeurtenis treedt op wanneer een geadresseerde wordt vervangen door een nieuwe.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientReplaced

Wanneer een geadresseerde wordt verzonden

Bewerkings-id:
CreateEndpointForRecipientSent

Deze gebeurtenis treedt op wanneer een aanvraag naar een geadresseerde wordt verzonden.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientSent

Wanneer een ontvanger wordt vrijgegeven

Bewerkings-id:
CreateEndpointForRecipientReleased

Deze gebeurtenis treedt op wanneer een geadresseerde klaar is om een aanvraag te verzenden om een envelop te voltooien.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForRecipientReleased

Wanneer een product mislukt

Bewerkings-id:
CreateEndpointForDeliverableFailed

Deze gebeurtenis treedt op wanneer het genereren van een product mislukt, wat resulteert in een productstatus van mislukt.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForDeliverableFailed

Wanneer een product wordt gegenereerd

Bewerkings-id:
CreateEndpointForDeliverableGenerated

Deze gebeurtenis treedt op wanneer een product, zoals een auditlogboek, is gegenereerd.

Parameters

Name Sleutel Vereist Type Description
Onderwerpen
 topics array of string

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Retouren

Body
NotificationForDeliverableGenerated

Definities

Envelop

Name Pad Type Description
Envelop-id
 id EnvelopeId

De id van de envelop.
Enveloptitel
 title EnvelopeTitle

De titel van deze envelop. Dit kan worden weergegeven aan geadresseerden.
Enveloplabel
 label EnvelopeLabel

Aangepaste etiketten die aan de envelop worden gegeven voor een eenvoudigere identificatie. Labels zijn voor intern gebruik en worden niet weergegeven voor geadresseerden.
Envelopbericht
 message EnvelopeMessage

Een bericht dat naar de geadresseerden wordt verzonden.
afzender
 sender EnvelopeSender
Envelopstatus
 status EnvelopeStatus

De status van de envelop.
Product
 deliverable EnvelopeDeliverable
Envelop voltooid op
 completed_at EnvelopeCompletedAt

Tijd waarop alle geadresseerden de envelop hebben voltooid.
Envelopmodus
 mode EnvelopeMode

Enveloppen in de testmodus zijn niet-bindend en worden niet gefactureerd.
Enveloproutering
 routing EnvelopeRouting

De volgorde waarin geadresseerden de envelop ondertekenen. Dit kan parallel zijn, waarbij alle geadresseerden zich tegelijk kunnen ondertekenen of sequentieel, waarbij geadresseerden zich achter elkaar aanmelden.
Tijdzone
 timezone EnvelopeTimezone

De tijdzone die moet worden gebruikt voor tijdstempels in producten. Als dit niet is opgegeven, wordt de standaardtijdzone-offset van het account gebruikt. https://signatureapi.com/docs/localization/timezone
Tijdstempelindeling
 timestamp_format EnvelopeTimestampFormat

De datum- en tijdnotatie die moet worden gebruikt in tijdstempels voor producten. Als dit niet is opgegeven, wordt de standaardnotatie van de tijdstempel van het account gebruikt. https://signatureapi.com/docs/localization/timestamp_format
Envelop attestation
 attestation EnvelopeAttestation

Attestation voor regelgeving of naleving
Enveloponderwerpen
 topics EnvelopeTopics

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Recipient

Name Pad Type Description
Geadresseerde-id
 id RecipientId

De id van de ontvanger.
Envelop-id
 envelope_id EnvelopeId

De id van de envelop.
Type geadresseerde
 type RecipientType

Het type geadresseerde.
Geadresseerdesleutel
 key RecipientKey

Een sleutel waarmee een geadresseerde in een envelop wordt geïdentificeerd.
Naam van geadresseerde
 name RecipientName

De naam van de geadresseerde.
E-mailadres van geadresseerde
 email RecipientEmail

Het e-mailadres van de geadresseerde.
Status van geadresseerde
 status RecipientStatus

De status van de ontvanger.
Ceremonie van geadresseerde maken
 ceremony_creation RecipientCeremonyCreation

Hoe de ceremonies voor een ontvanger worden gemaakt.
Type geadresseerde bezorging
 delivery_type RecipientDeliveryType

Hoe het product naar de ontvanger wordt verzonden.
Geadresseerde voltooid op
 completed_at RecipientCompletedAt

Tijdstip waarop de geadresseerde de envelop heeft voltooid.

Product

Name Pad Type Description
Product-id
 id DeliverableId

De id van het product.
Producttype
 type DeliverableType

Het type product.
Productstatus
 status DeliverableStatus

De status van het product.
Bestandsinhoud
 file_content DeliverableFileContent

De bestandsinhoud van het product. Gebruik deze om een ondertekend exemplaar van de envelop op te slaan.

Capture

Name Pad Type Description
Waarde vastleggen
 value CaptureValue

De waarde van de invoeropname van de ontvanger

CreateEnvelopeOutput

Name Pad Type Description
Envelop-id
 id EnvelopeId

De id van de envelop.
Enveloptitel
 title EnvelopeTitle

De titel van deze envelop. Dit kan worden weergegeven aan geadresseerden.
Enveloplabel
 label EnvelopeLabel

Aangepaste etiketten die aan de envelop worden gegeven voor een eenvoudigere identificatie. Labels zijn voor intern gebruik en worden niet weergegeven voor geadresseerden.
Envelopbericht
 message EnvelopeMessage

Een bericht dat naar de geadresseerden wordt verzonden.
afzender
 sender EnvelopeSender
Envelopmodus
 mode EnvelopeMode

Enveloppen in de testmodus zijn niet-bindend en worden niet gefactureerd.
Enveloproutering
 routing EnvelopeRouting

De volgorde waarin geadresseerden de envelop ondertekenen. Dit kan parallel zijn, waarbij alle geadresseerden zich tegelijk kunnen ondertekenen of sequentieel, waarbij geadresseerden zich achter elkaar aanmelden.
Tijdzone
 timezone EnvelopeTimezone

De tijdzone die moet worden gebruikt voor tijdstempels in producten. Als dit niet is opgegeven, wordt de standaardtijdzone-offset van het account gebruikt. https://signatureapi.com/docs/localization/timezone
Tijdstempelindeling
 timestamp_format EnvelopeTimestampFormat

De datum- en tijdnotatie die moet worden gebruikt in tijdstempels voor producten. Als dit niet is opgegeven, wordt de standaardnotatie van de tijdstempel van het account gebruikt. https://signatureapi.com/docs/localization/timestamp_format
Envelop attestation
 attestation EnvelopeAttestation

Attestation voor regelgeving of naleving
Enveloponderwerpen
 topics EnvelopeTopics

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

StartEnvelopeOutput

Name Pad Type Description
Envelopstatus
 status EnvelopeStatus

De status van de envelop.

AddDocumentOutput

Name Pad Type Description
Document-id
 id DocumentId

De id van het document

AddRecipientSignerOutput

Name Pad Type Description
Geadresseerde-id
 id RecipientId

De id van de ontvanger.
Naam van geadresseerde
 name RecipientName

De naam van de geadresseerde.
E-mailadres van geadresseerde
 email RecipientEmail

Het e-mailadres van de geadresseerde.
Geadresseerdesleutel
 key RecipientKey

Een sleutel waarmee een geadresseerde in een envelop wordt geïdentificeerd.
Ceremonie van geadresseerde maken
 ceremony_creation RecipientCeremonyCreation

Hoe de ceremonies voor een ontvanger worden gemaakt.
Type geadresseerde bezorging
 delivery_type RecipientDeliveryType

Hoe het product naar de ontvanger wordt verzonden.

CreateCeremonyCustomOutput

Name Pad Type Description
URL van ceremonie
 url CeremonyUrl

De URL die de ontvanger moet bezoeken om de ceremonie te starten

EnvelopeId

De id van de envelop.

De id van de envelop.

Envelop-id
string

Enveloptitel

De titel van deze envelop. Dit kan worden weergegeven aan geadresseerden.

De titel van deze envelop. Dit kan worden weergegeven aan geadresseerden.

Enveloptitel
string

Enveloplabel

Aangepaste etiketten die aan de envelop worden gegeven voor een eenvoudigere identificatie. Labels zijn voor intern gebruik en worden niet weergegeven voor geadresseerden.

Aangepaste etiketten die aan de envelop worden gegeven voor een eenvoudigere identificatie. Labels zijn voor intern gebruik en worden niet weergegeven voor geadresseerden.

Enveloplabel
string

EnvelopeMessage

Een bericht dat naar de geadresseerden wordt verzonden.

Een bericht dat naar de geadresseerden wordt verzonden.

Envelopbericht
string

Enveloprouting

De volgorde waarin geadresseerden de envelop ondertekenen. Dit kan parallel zijn, waarbij alle geadresseerden zich tegelijk kunnen ondertekenen of sequentieel, waarbij geadresseerden zich achter elkaar aanmelden.

De volgorde waarin geadresseerden de envelop ondertekenen. Dit kan parallel zijn, waarbij alle geadresseerden zich tegelijk kunnen ondertekenen of sequentieel, waarbij geadresseerden zich achter elkaar aanmelden.

Enveloproutering
string

EnvelopeTimezone

De tijdzone die moet worden gebruikt voor tijdstempels in producten. Als dit niet is opgegeven, wordt de standaardtijdzone-offset van het account gebruikt. https://signatureapi.com/docs/localization/timezone

De tijdzone die moet worden gebruikt voor tijdstempels in producten. Als dit niet is opgegeven, wordt de standaardtijdzone-offset van het account gebruikt. https://signatureapi.com/docs/localization/timezone

Tijdzone
string

EnvelopTimestampFormat

De datum- en tijdnotatie die moet worden gebruikt in tijdstempels voor producten. Als dit niet is opgegeven, wordt de standaardnotatie van de tijdstempel van het account gebruikt. https://signatureapi.com/docs/localization/timestamp_format

De datum- en tijdnotatie die moet worden gebruikt in tijdstempels voor producten. Als dit niet is opgegeven, wordt de standaardnotatie van de tijdstempel van het account gebruikt. https://signatureapi.com/docs/localization/timestamp_format

Tijdstempelindeling
string

Envelopsender

Name Pad Type Description
Naam van afzender
 name string

De naam van de afzender.
E-mail van afzender
 email string

Het e-mailadres van de afzender.

EnvelopeStatus

De status van de envelop.

De status van de envelop.

Envelopstatus
string

Envelopmode

Enveloppen in de testmodus zijn niet-bindend en worden niet gefactureerd.

Enveloppen in de testmodus zijn niet-bindend en worden niet gefactureerd.

Envelopmodus
string

Enveloptopics

Hiermee kunt u enveloppen classificeren en webhookmeldingen filteren.

Name Pad Type Description
Artikelen
 string

EnvelopeAttestation

Attestation voor regelgeving of naleving

Attestation voor regelgeving of naleving

Envelop attestation
string

Envelopverzendbaar

Name Pad Type Description
Product-id
 id string

De id van het product. Gebruik deze optie om een ondertekend exemplaar van de envelop te downloaden.

EnvelopCompletedAt

Tijd waarop alle geadresseerden de envelop hebben voltooid.

Tijd waarop alle geadresseerden de envelop hebben voltooid.

Envelop voltooid op
date-time

DocumentId

De id van het document

De id van het document

Document-id
string

RecipientId

De id van de ontvanger.

De id van de ontvanger.

Geadresseerde-id
string

RecipientType

Het type geadresseerde.

Het type geadresseerde.

Type geadresseerde
string

RecipientName

De naam van de geadresseerde.

De naam van de geadresseerde.

Naam van geadresseerde
string

RecipientEmail

Het e-mailadres van de geadresseerde.

Het e-mailadres van de geadresseerde.

E-mailadres van geadresseerde
string

RecipientKey

Een sleutel waarmee een geadresseerde in een envelop wordt geïdentificeerd.

Een sleutel waarmee een geadresseerde in een envelop wordt geïdentificeerd.

Geadresseerdesleutel
string

RecipientStatus

De status van de ontvanger.

De status van de ontvanger.

Status van geadresseerde
string

RecipientCeremonyCreation

Hoe de ceremonies voor een ontvanger worden gemaakt.

Hoe de ceremonies voor een ontvanger worden gemaakt.

Ceremonie van geadresseerde maken
string

RecipientDeliveryType

Hoe het product naar de ontvanger wordt verzonden.

Hoe het product naar de ontvanger wordt verzonden.

Type geadresseerde bezorging
string

RecipientCompletedAt

Tijdstip waarop de geadresseerde de envelop heeft voltooid.

Tijdstip waarop de geadresseerde de envelop heeft voltooid.

Geadresseerde voltooid op
date-time

DeliverableId

De id van het product.

De id van het product.

Product-id
string

DeliverableType

Het type product.

Het type product.

Producttype
string

DeliverableStatus

De status van het product.

De status van het product.

Productstatus
string

DeliverableFileContent

De bestandsinhoud van het product. Gebruik deze om een ondertekend exemplaar van de envelop op te slaan.

De bestandsinhoud van het product. Gebruik deze om een ondertekend exemplaar van de envelop op te slaan.

Bestandsinhoud
byte

CeremonyUrl

De URL die de ontvanger moet bezoeken om de ceremonie te starten

De URL die de ontvanger moet bezoeken om de ceremonie te starten

URL van ceremonie
string

CaptureValue

De waarde van de invoeropname van de ontvanger

De waarde van de invoeropname van de ontvanger

Waarde vastleggen
string

NotificationForEnvelopeCreated

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.

NotificationForEnvelopeStarted

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.

NotificationForEnvelopeCompleted

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.

NotificationForEnvelopeFailed

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Het detail
 data.detail string

Informatie over de fout.

NotificationForEnvelopeCanceled

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.

NotificationForRecipientReleased

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.

NotificationForRecipientSent

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.

NotificationForRecipientCompleted

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.

NotificationForRecipientRejected

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.
Reden
 data.reason string

De verklaring van de ontvanger voor de afwijzing.

NotificationForRecipientBounced

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.
Het detail
 data.detail string

Informatie over de bounce.

NotificationForRecipientFailed

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.
Het detail
 data.detail string

Informatie over de fout.

NotificationForRecipientReplaced

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.
Nieuwe geadresseerde-id
 data.new_recipient_id string

De id van de nieuwe ontvanger.

NotificationForRecipientResent

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Geadresseerde-id
 data.object_id EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.
Type geadresseerde
 data.recipient_type EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.
Geadresseerdesleutel
 data.recipient_key EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.

NotificationForDeliverableGenerated

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Product-id
 data.object_id EventDeliverableId

De id van het product waarnaar deze gebeurtenis verwijst.

NotificationForDeliverableFailed

Name Pad Type Description
Gebeurtenis-id
 id EventId

De ID van de gebeurtenis.
Tijdstempel van gebeurtenis
 timestamp EventTimestamp

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.
Gebeurtenistype
 type EventType

Het type gebeurtenis.
Envelop-id
 data.envelope_id EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.
Product-id
 data.object_id EventDeliverableId

De id van het product waarnaar deze gebeurtenis verwijst.
Het detail
 data.detail string

Informatie over de fout.

EventId

De ID van de gebeurtenis.

De ID van de gebeurtenis.

Gebeurtenis-id
string

Tijdstempel van gebeurtenis

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.

De datum en tijd van de gebeurtenis, in ISO 8601-indeling.

Tijdstempel van gebeurtenis
date-time

Type van evenement

Het type gebeurtenis.

Het type gebeurtenis.

Gebeurtenistype
string

EventEnvelopeId

De id van de envelop waarnaar deze gebeurtenis verwijst.

De id van de envelop waarnaar deze gebeurtenis verwijst.

Envelop-id
string

EventRecipientId

De id van de ontvanger waarnaar deze gebeurtenis verwijst.

De id van de ontvanger waarnaar deze gebeurtenis verwijst.

Geadresseerde-id
string

EventRecipientType

Het type ontvanger waarnaar deze gebeurtenis verwijst.

Het type ontvanger waarnaar deze gebeurtenis verwijst.

Type geadresseerde
string

EventRecipientKey

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.

De sleutel van de ontvanger waarnaar deze gebeurtenis verwijst.

Geadresseerdesleutel
string

EventDeliverableId

De id van het product waarnaar deze gebeurtenis verwijst.

De id van het product waarnaar deze gebeurtenis verwijst.

Product-id
string

Voorwerp

Dit is het type 'object'.