Delen via

Legalesign (preview)

De connector van Legalesign is ontworpen voor nalevingsgerichte juridische teams en operationele teams en koppelt het Microsoft Power Platform met het Legalesign eSignature om werkstromen voor documenten en geadresseerden te activeren, herinneringen te verzenden, PDF-bestanden op te halen en formuliergegevens op te halen. Vereist een actief Legalesign-abonnement dat is goedgekeurd voor API-gebruik.

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 API-ondersteuning
URL https://legalesign.com/contact/
E-mailen sales@legalesign.com
Connectormetagegevens
Uitgever Legalesign
Meer informatie over Legalesign https://docs.microsoft.com/connectors/legalesign
Webpagina https://legalesign.com
Privacybeleid https://legalesign.com/opn/privacy/
Categorieën Inhoud en bestanden; Productiviteit

Legalesign eSignature REST Connector

De Legalesign REST API voorziet in eSignature-werkstromen. Deze connector biedt volledige API-toegang en realtime triggers, waardoor naadloze integratie mogelijk is met Microsoft Power Automate, Logic Apps en gerelateerde platforms.

Vereiste voorwaarden

U hebt een Legalesign-account en API-sleutel nodig om aan de slag te gaan: 1. Meld u aan voor een gratis proefversie. 2. Maak een groep (een afzonderlijke omgeving, bijvoorbeeld een voor ontwikkeling en een andere voor productie). 3. Vraag een API-sleutel aan door een ondersteuningsticket te maken. Neem uw use-case, bedrijf en rol op, zodat ondersteuning uw identiteit kan verifiëren. 4. Meld u na verificatie aan bij het API-dashboard om uw sleutel op te halen.

Uitrol

Nieuwe accounts worden gestart in de sandboxmodus met de volgende beperkingen: • Documenten kunnen alleen worden verzonden om e-mailadressen te testen die u configureert in het API-dashboard. • Aanvragen worden beperkt tot 100/minuut.

Wanneer u klaar bent om live te gaan, maakt u een ondersteuningsticket om uw account over te schakelen van sandbox naar productie. Op dat moment worden de beperkingen opgeheven. Zie de implementatiehandleiding voor meer informatie.

Triggers

De connector ondersteunt twee realtime triggers:

  • Documentgebeurtenissen (bijvoorbeeld gemaakt, geweigerd, ondertekend, definitief PDF gemaakt)
  • Gebeurtenissen van geadresseerden (bijvoorbeeld voltooid, geweigerd, e-mail geopend, niet bezorgd, verzonden herinneringen)

U kunt alle documenten of geadresseerden ontvangen, van het filter op groep of gebeurtenistype. Alle gekoppelde Legalesign-webhooks kunnen worden beheerd en bewaakt in het API-dashboard.

Operations

Legalesign REST API-bewerkingen worden ondersteund. De meest voorkomende zijn het downloaden van een ondertekend PDF-bestand, het beheren van sjablonen, documenten, geadresseerden en veldplaatsing. Zie de volledige API-documentatie voor de volledige specificatie.

In Legalesign wordt een geüpload document een 'sjabloon' genoemd. Wanneer een sjabloon naar een of meer geadresseerden wordt verzonden, wordt deze een 'document'. Meestal uploadt u een sjabloon, herstelt u de id en verzendt u deze vervolgens naar een of meer geadresseerden.

Veelvoorkomende bewerkingen zijn:

Sjablonen

  • Create PDF template - upload een sjabloon (elk bestandstype, zoals PDF, Word of afbeelding).
  • Get PDF embeddable link - een eenmalige koppeling om de sjablooneditor weer te geven aan een gebruiker

Documents

  • Location to download PDF - retourneert het BINAIRE PDF-bestand van een ondertekend document
  • Create signing document - een document verzenden (selecteer een sjabloon en geadresseerden)
  • Void/archive signing document - voorkomen dat een document wordt ondertekend
  • Permanently delete signing document - een document voor altijd verwijderen

Geadresseerden (ondertekenaars)

  • Send signer reminder email - de geadresseerde eraan herinneren om uw document te voltooien
  • Get signer rejection reason - Als het document wordt geweigerd, bekijkt u waarom

Veldplaatsing

Legalesign heeft een geavanceerd formuliersysteem met velden. Als u ondertekenaars hebt, moet elke ondertekenaar ten minste één handtekeningveld hebben.

Er zijn vier manieren om velden in uw sjabloon te definiëren:

  1. Upload een PDF met ingesloten velden (automatisch geconverteerd door Legalesign).
  2. Gebruik tekstlabels voor Legalesign.
  3. Definieer x/y-coördinaten.
  4. Gebruik de Legalesign-formuliereditor (via de insluitkoppeling of de web-app).

Klik hier voor de gids

Query's en ondersteuning

Voor aanvullende ondersteuning of query's meldt u zich aan bij uw Legalesign-account en maakt u een ondersteuningsticket.

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_key voor deze API Klopt

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Bijlage ophalen

Een bijlage ophalen.
Bijlagen ophalen

Bijlagen weergeven.
Document definitief verwijderen

Hiermee worden gegevens en bestanden definitief verwijderd.
Document leegmaken en archiveren

Hiermee stelt u een document met de status 40 - verwijderd - en archiveert u het.
Document ophalen

Een specifiek document retourneren.
Document verzenden

Een document verzenden voor handtekening of goedkeuring.
Documenten ophalen

Niet-gearchiveerde ondertekeningsdocumenten weergeven.
Documentvelden ophalen

De velden uit het document.
E-mail met geadresseerdeherinnering verzenden

Stuur een geadresseerde een herinneringsmail.
Een bijlage verwijderen

Een bijlage verwijderen.
Formuliervelden voor geadresseerden ophalen

Retourneert de formuliervelden van een specifieke geadresseerde.
Geadresseerde ophalen

De status en details van een afzonderlijke geadresseerde ophalen.
Gebruiker ophalen

Gebruikersgegevens ophalen.
Groepen ophalen

Lijstgroepen waartoe de API-gebruiker behoort.
Het auditlogboek van het document downloaden

PDF van alleen het auditlogboek van het document.
Koppeling geadresseerde ophalen

Een gebruikskoppeling voor geadresseerde om naar ondertekeningspagina's te gaan.
Koppeling voor insluitbare PDF-bestanden ophalen

Retourneer een eenmalige koppeling om pdf-editor in te sluiten.
Leden van groepen

Vermeldingen van alle leden van uw groepen.
Lid van een groep

Details van een specifieke gebruiker binnen een groep.
PDF-bijlage uploaden

Sla een pdf op als bijlage bij een e-mail van een geadresseerde.
PDF dowloaden

Haal het concept- of definitieve PDF-bestand op voor een ondertekeningsdocument, afhankelijk van de status. Let op: een reactie van 200 of 302 is mogelijk.
PDF-sjablonen ophalen

PDF-sjablonen weergeven
PDF-sjabloon ophalen

Details van een specifieke PDF-sjabloon
PDF-sjabloon uploaden

Upload een PDF-document dat u wilt verzenden om te worden ondertekend.
Reden voor afwijzing van geadresseerde ophalen

Retourneert de reden die de ondertekenaar heeft gegeven voor het weigeren van een document.

Bijlage ophalen

Bewerkings-id:
GetAttachment

Een bijlage ophalen.

Parameters

Name Sleutel Vereist Type Description
Bijlage-id
 attachId True uuid

Bijlage-id

Retouren

Item bijvoegen.

Body
AttachmentResponse

Bijlagen ophalen

Bewerkings-id:
GetAttachments

Bijlagen weergeven.

Parameters

Name Sleutel Vereist Type Description
Groeps-id
 group string

Filteren op een specifieke groep.
Querylimiet
 limit integer

Gebruik met offset om de resultaten te herhalen.
Verschuiving van query
 offset integer

Gebruik deze met limiet om de resultaten te herhalen.

Retouren

Bijlagevermelding

Body
AttachmentListResponse

Document definitief verwijderen

Bewerkings-id:
DeleteDocument

Hiermee worden gegevens en bestanden definitief verwijderd.

Parameters

Name Sleutel Vereist Type Description
Document-id
 docId True uuid

Document-id

Document leegmaken en archiveren

Bewerkings-id:
UpdateArchiveDocument

Hiermee stelt u een document met de status 40 - verwijderd - en archiveert u het.

Parameters

Name Sleutel Vereist Type Description
Document-id
 docId True uuid

Document-id
E-mailmelding verzenden naar geadresseerde
 email string

Als dit is ingesteld op waar of 1, krijgen de geadresseerden een melding dat het document ongeldig is.

Document ophalen

Bewerkings-id:
GetDocument

Een specifiek document retourneren.

Parameters

Name Sleutel Vereist Type Description
Document-id
 docId True uuid

Document-id

Retouren

Documentdetails

Body
DocumentResponseDetail

Document verzenden

Bewerkings-id:
PostDocument

Een document verzenden voor handtekening of goedkeuring.

Parameters

Name Sleutel Vereist Type Description
Groep
 group True string

Resource-URI groeperen
Naam
 name True string

Geef de naam van het document op
PDF-sjabloon
 templatepdf True string

Het geüploade PDF-bestand dat moet worden verzonden.
e-mailadres
 email True email

E-mailen
voornaam
 firstname True string

Voornaam
achternaam
 lastname True string

Achternaam
attachments
 attachments array of string

Lijst met bijlageresource-uris.
Verloopt
 expires date-time

ISO8601 gevormde datum/tijd, ingesteld op TZ van afzender of tijdzone indien gebruikt
message
 message string

Uw persoonlijke bericht voor de partij, ingevoerd in het midden van de groeps-e-mailsjabloon. Gebruik de naam van een opgeslagen e-mailsjabloon die vooraf gaat door een hash-symbool om die sjabloon te gebruiken. Als er meer dan één sjabloon met dezelfde naam is, selecteert u de sjabloon die voor het laatst is gewijzigd.
voornaam
 firstname string

Voornaam
achternaam
 lastname string

Achternaam
e-mailadres
 email True email

E-mailen
include_link
 include_link boolean

Een koppeling naar de ondertekeningspagina's opnemen, zodat een revisor zich kan ondertekenen
sms-bericht
 sms string

Gebruik het nummer van de internationale notatie om sms-verificatie toe te voegen. Vereist als een getuige of een getuige-ondertekenaar.
Onderwerp
 subject string

Onderwerpregel voor uitgaande e-mail
timezone
 timezone string

TZ van de ondertekenaar moet geldig TZ zijn op basis van tijdzoneenum (zie Gebruiker voor tijdzoneenumgegevens). Als leeg is, wordt tz van de afzender gebruikt.
Handtekeningtype
 signature_type integer

Gebruik 4 om uw uitgevoerde PDF-gecertificeerd te krijgen. Aanbevolen. Standaard ingesteld op 1 (maakt gebruik van een sha256-hash voor documentintegriteit).
PDF toevoegen
 append_pdf boolean

Voeg validatiegegevens voor Legalesign toe aan het uiteindelijke PDF-bestand.
auto_archive
 auto_archive boolean

Verzenden naar archief kort na ondertekening. Zorgt ervoor dat web-app onbelangrijke e-mail vrij blijft
Legalesign-e-mailberichten gebruiken
 do_email boolean

Gebruik Legalesign-e-mail om e-mailberichten met meldingen te verzenden. Als onwaar alle e-mailberichten onderdrukt.
CC na voltooiing
 cc_emails string

Door komma's gescheiden tekenreeks van e-mailadressen die op de hoogte worden gesteld van ondertekening of afwijzing.
Lege afzendervelden converteren naar eerste geadresseerdevelden
 convert_sender_to_signer boolean

Als er afzendervelden leeg blijven, converteert u deze naar velden voor de eerste geadresseerde.
PDF-wachtwoord
 pdf_password string

Stel een wachtwoord in. Moet ascii-codering mogelijk zijn, u moet ook signature_type instellen op 4 en een pdf_password_type kiezen.
PDF-wachtwoordinstellingen
 pdf_password_type integer

1 om het wachtwoord op te slaan, 2 voor het verwijderen uit onze records bij definitieve ondertekening.
pdftext
 pdftext object

Wijs waarden toe aan pdf-afzendervelden, gebruik het veldlabel van de sjabloon of de uuid als objectsleutels. Zie templatepdf/:id/fields/ en filter voor element_type="admin", om relevante velden met hun label of uuid op te halen. Zie ook strict_fields.
Omleidings-URL
 redirect string

URL waarnaar de ondertekenaar moet worden verzonden na ondertekening (in plaats van downloadpagina). Uw URL bevat als volgt queryparameters met id- en statusgegevens: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Herinneringsschema
 reminders string

Plaats 'standaard' als u het standaardherinneringsschema in de groep wilt gebruiken (ga naar de web-app om het standaardschema in te stellen)
Koppelingen voor ondertekenaar retourneren
 return_signer_links boolean

Retourneer documentkoppelingen voor ondertekenaars in de hoofdtekst van het antwoord.
sequentiëren verzenden
 signers_in_order boolean

Informeer ondertekenaars in hun volgorde. Als onwaar is, worden alle simulatanely op de hoogte gesteld.
ondertekentekst
 signertext object

Voeg aangepaste tijdelijke aanduidingen toe aan ondertekenvelden. Gebruik veldlabels of uuid als sleutels in het object (zoals voor PDF-tekst). Zie templatepdf/:id/fields/ en filter voor element_type = "text" om relevante velden met hun labels of uuid op te halen.
Veldvalidatie afdwingen
 strict_fields boolean

Pdftext mislukt validatiecontroles op de achtergrond, stel waar in om te valideren.
Uw verwijzing
 tag string

Tag
Uw verwijzing
 tag1 string

Tag
Uw verwijzing
 tag2 string

Tag
user
 user string

Wijs een andere gebruiker toe aan het document in de groep.

Documenten ophalen

Bewerkings-id:
GetDocuments

Niet-gearchiveerde ondertekeningsdocumenten weergeven.

Parameters

Name Sleutel Vereist Type Description
Groeps-id
 group True string

Filter op een specifieke groep, vereist.
Neem gearchiveerde documenten op
 archived string

Filter op gearchiveerde status, standaard is niet gearchiveerd, gebruik alle waarden in deze parameter om een query uit te voeren op alle documenten.
Filteren op e-mailadres van geadresseerde
 email string

Filter op e-mailadres van geadresseerde.
Querylimiet
 limit integer

De lengte van de gegevensset die moet worden geretourneerd. Gebruiken met offsetquery om resultaten te doorlopen.
Verschuiving van query
 offset integer

Verschuiving van het begin van de gegevensset. Gebruik deze query met de limietquery om de gegevensset te herhalen.
Filteren op documentstatus
 status integer

Filter op documentstatus.
Geadresseerden verwijderen uit antwoord
 nosigners string

Voeg waarde 1 toe om gegevens van geadresseerden te verwijderen voor een snellere query.
Filteren op gemaakt na deze datum
 created_gt date-time

Filter op die documenten die na een bepaalde tijd zijn gemaakt.
Filteren op wijziging na deze datum
 modified_gt date-time

Filter op deze documenten die na een bepaalde tijd zijn gewijzigd.

Retouren

Documentvermeldingen

Body
DocumentListResponse

Documentvelden ophalen

Bewerkings-id:
GetDocumentFields

De velden uit het document.

Parameters

Name Sleutel Vereist Type Description
Document-id
 docId True uuid

Document-id

Retouren

Name Pad Type Description
array of object

Lijst met documentvelden
element_type
 element_type string

Elementtype
veldvolgorde
 fieldorder integer

Veldvolgorde
label
 label string

Etiket
label_extra
 label_extra string

Extra label
ondertekenaar
 signer integer

Recipient
state
 state boolean
validering
 validation integer

Validatie-id
waarde
 value string

Waarde

E-mail met geadresseerdeherinnering verzenden

Bewerkings-id:
PostSignerReminder

Stuur een geadresseerde een herinneringsmail.

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True uuid

Geadresseerde-id
Tekst
 text string

Aangepaste berichttekst

Een bijlage verwijderen

Bewerkings-id:
DeleteAttachment

Een bijlage verwijderen.

Parameters

Name Sleutel Vereist Type Description
Bijlage-id
 attachId True uuid

Id bijvoegen

Formuliervelden voor geadresseerden ophalen

Bewerkings-id:
GetSignerFields

Retourneert de formuliervelden van een specifieke geadresseerde.

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True uuid

Geadresseerde-id

Retouren

Name Pad Type Description
array of object
label
 label string

Etiket
label_extra
 label_extra string

Extra label
state
 state boolean

Staat
veldvolgorde
 fieldorder integer

Veldvolgorde
waarde
 value string

Als het veld een ondertekenaarbestand is, is deze waarde een download-URL met een korte levensduur.

Geadresseerde ophalen

Bewerkings-id:
GetRecipient

De status en details van een afzonderlijke geadresseerde ophalen.

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True uuid

Geadresseerde-id

Retouren

Details van geadresseerde

Body
SignerResponse

Gebruiker ophalen

Bewerkings-id:
GetUser

Gebruikersgegevens ophalen.

Parameters

Name Sleutel Vereist Type Description
Gebruikers-ID
 userId True uuid

Gebruikers-ID

Retouren

Details van de gebruiker.

Body
UserDetailResponse

Groepen ophalen

Bewerkings-id:
GetGroups

Lijstgroepen waartoe de API-gebruiker behoort.

Parameters

Name Sleutel Vereist Type Description
Verschuiving van query
 offset integer

Verschuiving van het begin van de gegevensset. Gebruik deze query met de limietquery om de gegevensset te herhalen.
Querylimiet
 limit integer

De lengte van de gegevensset die moet worden geretourneerd. Gebruiken met offsetquery om resultaten te doorlopen.

Retouren

Lijst met groepen

Body
GroupListResponse

Het auditlogboek van het document downloaden

Bewerkings-id:
GetDocumentAuditLog

PDF van alleen het auditlogboek van het document.

Parameters

Name Sleutel Vereist Type Description
Document-id
 docId True uuid

Document-id

Retouren

response
file

Koppeling geadresseerde ophalen

Bewerkings-id:
GetSignerLink

Een gebruikskoppeling voor geadresseerde om naar ondertekeningspagina's te gaan.

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True uuid

Geadresseerde-id

Koppeling voor insluitbare PDF-bestanden ophalen

Bewerkings-id:
GetPdfTemplateEditLink

Retourneer een eenmalige koppeling om pdf-editor in te sluiten.

Parameters

Name Sleutel Vereist Type Description
Pdf-id
 pdfId True string

Geüploade PDF-id instellen.
Lijst met velden verbergen voor weergegeven pagina
 hide_sender_fields boolean

Lijst met velden verbergen voor weergegeven pagina.
Hex-code met uitzondering van hash-symbool voor achtergrondkleur
 css_body_backgroundcolor string

Gebruik hexcode met uitzondering van hashsymbool om de achtergrondkleur te wijzigen.

Leden van groepen

Bewerkings-id:
GetMembers

Vermeldingen van alle leden van uw groepen.

Parameters

Name Sleutel Vereist Type Description
Groeps-id
 group string

Filteren op een specifieke groep
Querylimiet
 limit integer

Gebruik met offset om de resultaten te herhalen.
Verschuiving van query
 offset integer

Gebruik deze met limiet om de resultaten te herhalen.

Retouren

Body
MemberListResponse

Lid van een groep

Bewerkings-id:
GetMember

Details van een specifieke gebruiker binnen een groep.

Parameters

Name Sleutel Vereist Type Description
Lid-id
 memberId True uuid

Lid-id

Retouren

Body
MemberResponse

PDF-bijlage uploaden

Bewerkings-id:
PostAttachment

Sla een pdf op als bijlage bij een e-mail van een geadresseerde.

Parameters

Name Sleutel Vereist Type Description
group
 group True string

Resource-URI groeperen
pdf_file
 pdf_file True byte

Met Base64 gecodeerde PDF-bestandsgegevens, de maximale grootte is standaard een groepsinstelling, 5 MB.
filename
 filename True string

Eenvoudige alfanumerieke naam die eindigt .pdf
user
 user string

Wijs deze toe aan een andere gebruiker.
beschrijving
 description string

PDF dowloaden

Bewerkings-id:
GetDocumentPdf

Haal het concept- of definitieve PDF-bestand op voor een ondertekeningsdocument, afhankelijk van de status. Let op: een reactie van 200 of 302 is mogelijk.

Parameters

Name Sleutel Vereist Type Description
Document-id
 docId True uuid

Document-id

Retouren

response
file

PDF-sjablonen ophalen

Bewerkings-id:
GetPdfTemplates

PDF-sjablonen weergeven

Parameters

Name Sleutel Vereist Type Description
Groeps-id
 group string

Kan volledige resource_uri of alleen id zijn.
Querylimiet
 limit integer

De lengte van de gegevensset die moet worden geretourneerd. Gebruiken met offsetquery om resultaten te doorlopen.
Verschuiving van query
 offset integer

Verschuiving van het begin van de gegevensset. Gebruik deze query met de limietquery om de gegevensset te herhalen.

Retouren

Sjabloonvermeldingen

Body
TemplatePdfListResponse

PDF-sjabloon ophalen

Bewerkings-id:
GetPdfTemplate

Details van een specifieke PDF-sjabloon

Parameters

Name Sleutel Vereist Type Description
Geüploade PDF-id
 pdfId True uuid

Geüploade PDF-id

Retouren

Sjabloondetails

Body
TemplatePdfResponse

PDF-sjabloon uploaden

Bewerkings-id:
PostPdfTemplate

Upload een PDF-document dat u wilt verzenden om te worden ondertekend.

Parameters

Name Sleutel Vereist Type Description
Archiveren bij verzenden
 archive_upon_send boolean

Stel true in als deze upload alleen voor eenmalig gebruik is.
Groep
 group True string

Geef een groep op waar dit wordt gebruikt.
PDF-bestand
 pdf_file True byte

Met Base64 gecodeerde PDF-bestandsgegevens.
Procestags
 process_tags boolean

Als het bestand tekstlabels bevat, converteert u deze naar velden.
Title
 title string

Geef deze record een naam, gebruikt bestandsnaam als deze niet wordt gebruikt.
User
 user string

Toewijzen aan groepslid als dat niet de API-gebruiker is.

Reden voor afwijzing van geadresseerde ophalen

Bewerkings-id:
GetSignerRejection

Retourneert de reden die de ondertekenaar heeft gegeven voor het weigeren van een document.

Parameters

Name Sleutel Vereist Type Description
Geadresseerde-id
 recipientId True uuid

Geadresseerde-id

Retouren

Name Pad Type Description
status
 status integer

Beelden van geadresseerden.
reden
 reason string

Reden negeren.

Triggers

Document gebeurtenis

Trigger voor een document gebeurtenis vindt plaats
Gebeurtenis geadresseerde

Activeren voor wanneer een gebeurtenis van een geadresseerde plaatsvindt

Document gebeurtenis

Bewerkings-id:
DocumentTrigger

Trigger voor een document gebeurtenis vindt plaats

Parameters

Name Sleutel Vereist Type Description
eventFilter
 eventFilter True string

Gebeurtenisfilter
group
 group string

Groepsfilter

Retouren

Name Pad Type Description
version
 version string

Versie
Voorwerp
 object string

Object
tag1
 data.tag1 string

Tag
recipients
 data.recipients array of object

Ontvangers
UUID (Universally Unique Identifier)
 data.recipients.uuid string

Geadresseerde-id
e-mailadres
 data.recipients.email string

E-mailadres van geadresseerde
order
 data.recipients.order integer

Ordernummer van geadresseerde
status
 data.recipients.status integer

Status van geadresseerde
achternaam
 data.recipients.lastname string

Achternaam van geadresseerde
roleText
 data.recipients.roleText string

Tekst van geadresseerderol
voornaam
 data.recipients.firstname string

Voornaam van geadresseerde
statusTekst
 data.recipients.statusText string

Statustekst van geadresseerde
resourceUri
 data.recipients.resourceUri string

Resource-URI van geadresseerde
rejectReason
 data.recipients.rejectReason string

rejectReason
groupResourceUri
 data.groupResourceUri string

Resource-URI groeperen
statusTekst
 data.statusText string

Documentstatustekst
naam
 data.name string

Documentnaam
tag
 data.tag string

Tag
resourceUri
 data.resourceUri string

Resource-URI
UUID (Universally Unique Identifier)
 data.uuid string

Document-id
tag2
 data.tag2 string

Tag2
group
 data.group string

Groep
status
 data.status integer

Documentstatus
created
 created integer

Gecreëerd
identiteitskaart
 id string

Deed
gebeurtenis
 event string

Event

Gebeurtenis geadresseerde

Bewerkings-id:
RecipientTrigger

Activeren voor wanneer een gebeurtenis van een geadresseerde plaatsvindt

Parameters

Name Sleutel Vereist Type Description
eventFilter
 eventFilter True string

Gebeurtenisfilter
group
 group string

Groepsfilter

Retouren

Name Pad Type Description
version
 version string

Versie
Voorwerp
 object string

Object
tag
 data.tag string

Tag
tag1
 data.tag1 string

Tag1
tag2
 data.tag2 string

Tag2
UUID (Universally Unique Identifier)
 data.uuid string

Geadresseerde-id
e-mailadres
 data.email string

E-mailen
group
 data.group string

Groep
order
 data.order integer

Bestelling
status
 data.status integer

Toestand
document
 data.document string

Document
achternaam
 data.lastname string

Achternaam
roleText
 data.roleText string

Roltekst
voornaam
 data.firstname string

Voornaam
statusTekst
 data.statusText string

Statustekst
emailBounce
 data.emailBounce integer

E-mail is niet bezorgd
resourceUri
 data.resourceUri string

Resource-URI van geadresseerde
documentNaam
 data.documentName string

Documentnaam
rejectReason
 data.rejectReason string

Reden negeren
groupResourceUri
 data.groupResourceUri string

Resource-URI groeperen
emailBounceMessage
 data.emailBounceMessage string

Niet-bezorgdbericht per e-mail
documentResourceUri
 data.documentResourceUri string

Documentresource-URI
created
 created integer

Gecreëerd
identiteitskaart
 id string

ID-kaart
gebeurtenis
 event string

Event

Definities

PermissionsEnum

Machtigingsopties

Machtigingsopties

integer

ListMeta

Meta-informatie over vermelding.

Name Pad Type Description
limit
 limit integer

Maximum aantal objecten.
volgende
 next string

URL voor de volgende set objecten.
offset
 offset integer

Aantal items vanaf het begin van de resultatenset.
vorig
 previous string

URL voor vorige set objecten.
total_count
 total_count integer

Totaal aantal objecten.

GroupListResponse

Lijst met groepen

Name Pad Type Description
Meta
 meta ListMeta

Meta-informatie over vermelding.
objecten
 objects array of object
created
 objects.created date-time

Gecreëerd
is_active
 objects.is_active boolean

Active
gemodificeerd
 objects.modified date-time

Gemodificeerd
naam
 objects.name string

Naam
public_name
 objects.public_name string

Openbare naam
resource_uri
 objects.resource_uri string

Resource-URI
naaktslak
 objects.slug string

Unieke naam
user
 objects.user string

Resource-URI voor maker
xframe_allow
 objects.xframe_allow boolean

Ondertekening van insluiten toestaan
xframe_allow_pdf_edit
 objects.xframe_allow_pdf_edit boolean

Bewerken insluiten toestaan

TemplatePdfListResponse

Sjabloonvermeldingen

Name Pad Type Description
Meta
 meta ListMeta

Meta-informatie over vermelding.
objecten
 objects array of TemplatePdfResponse

TemplatePdfResponse

Sjabloondetails

Name Pad Type Description
created
 created date-time

Gecreëerd
group
 group string

Groeps-URI
gemodificeerd
 modified date-time

Gemodificeerd
Partijen
 parties string

JSON stringified array of document party's.
page_count
 page_count integer

Aantal pagina's
resource_uri
 resource_uri string

Resource-URI
signer_count
 signer_count integer

Aantal ondertekenaar
title
 title string

Title
user
 user string

Resource-URI van maker
UUID (Universally Unique Identifier)
 uuid uuid

Pdf-id
geldig
 valid boolean

Kan worden verzonden (als velden niet valideren).

DocumentListResponse

Documentvermeldingen

Name Pad Type Description
Meta
 meta ListMeta

Meta-informatie over vermelding.
objecten
 objects array of object

Documents
Gearchiveerde
 objects.archived boolean

Gearchiveerde
auto_archive
 objects.auto_archive boolean

Archiveren na verzending.
cc_emails
 objects.cc_emails string

Door komma's gescheiden lijst-e-mailberichten naar CC na voltooiing.
created
 objects.created date-time

Gecreëerd
do_email
 objects.do_email boolean

Gebruik Legalesign-e-mailberichten.
download_final
 objects.download_final boolean

Is klaar om te downloaden na voltooiing.
group
 objects.group string

Resource-URI groeperen.
gemodificeerd
 objects.modified date-time

Gemodificeerd
naam
 objects.name string

Documentnaam
pdftext
 objects.pdftext string

Waarden van het veld Afzender
doorsturen
 objects.redirect string

URL om geadresseerde om te leiden na ondertekening
resource_uri
 objects.resource_uri string

Resource-URI
return_signer_links
 objects.return_signer_links boolean

Geadresseerdekoppelingen toevoegen aan een antwoord
Ondertekenaars
 objects.signers array of array

Geneste matrices met ondertekengegevens
items
 objects.signers array of

Bevat altijd [ondertekenaar-URI, voornaam, achternaam, e-mail, sms-nummer, has_fields, status, ondertekenaarvolgorde (0 geïndexeerd)]
signers_in_order
 objects.signers_in_order integer

E-mailontvangers simulerend of opeenvolgend
status
 objects.status DocumentStatusEnum

Opties voor documentstatus:

  • 10 - Initiële status, status van ondertekenaar controleren op verzonden/ongedaan maken
  • 20 - Ingevulde velden
  • 30 - Ondertekend
  • 40 - Verwijderd (vóór ondertekening)
  • 50 - Afgewezen
tag
 objects.tag string

Document taggen
tag1
 objects.tag1 string

Document taggen
tag2
 objects.tag2 string

Document taggen
sjabloon
 objects.template string

Sjabloonresource-URI indien gebruikt
templatepdf
 objects.templatepdf string

RESOURCE-URI van PDF-sjabloon
Tekst
 objects.text string

Tekst voor ondertekening
user
 objects.user string

Creator-URI
UUID (Universally Unique Identifier)
 objects.uuid uuid

Document-id

DocumentStatusEnum

Opties voor documentstatus:

  • 10 - Initiële status, status van ondertekenaar controleren op verzonden/ongedaan maken
  • 20 - Ingevulde velden
  • 30 - Ondertekend
  • 40 - Verwijderd (vóór ondertekening)
  • 50 - Afgewezen

Opties voor documentstatus:

  • 10 - Initiële status, status van ondertekenaar controleren op verzonden/ongedaan maken
  • 20 - Ingevulde velden
  • 30 - Ondertekend
  • 40 - Verwijderd (vóór ondertekening)
  • 50 - Afgewezen
integer

SignerResponse

Details van geadresseerde

Name Pad Type Description
document
 document string

Document
e-mailadres
 email string

E-mailadres van geadresseerde
voornaam
 first_name string

Voornaam van geadresseerde
achternaam
 last_name string

Achternaam van geadresseerde
has_fields
 has_fields boolean

Geadresseerde heeft velden
order
 order integer

Bestelling geadresseerde
resource_uri
 resource_uri string

Resource-URI van geadresseerde
status
 status SignerStatusEnum

Opties voor ondertekenstatus:

  • 4 - niet-verzonden
  • 5 - gepland om te worden verzonden
  • 10 - verzonden
  • 15 - e-mail geopend
  • 20 - bezocht
  • 30 - velden voltooid
  • 35 - velden voltooien ex handtekening
  • 39 - wachten tot de getuige is voltooid
  • 40 - ondertekend
  • 50 - gedownload
  • 60 - afgewezen

SignerStatusEnum

Opties voor ondertekenstatus:

  • 4 - niet-verzonden
  • 5 - gepland om te worden verzonden
  • 10 - verzonden
  • 15 - e-mail geopend
  • 20 - bezocht
  • 30 - velden voltooid
  • 35 - velden voltooien ex handtekening
  • 39 - wachten tot de getuige is voltooid
  • 40 - ondertekend
  • 50 - gedownload
  • 60 - afgewezen

Opties voor ondertekenstatus:

  • 4 - niet-verzonden
  • 5 - gepland om te worden verzonden
  • 10 - verzonden
  • 15 - e-mail geopend
  • 20 - bezocht
  • 30 - velden voltooid
  • 35 - velden voltooien ex handtekening
  • 39 - wachten tot de getuige is voltooid
  • 40 - ondertekend
  • 50 - gedownload
  • 60 - afgewezen
integer

DocumentResponseDetail

Documentdetails

Name Pad Type Description
Gearchiveerde
 archived boolean

Is gearchiveerd
auto_archive
 auto_archive boolean

Documentarchief verzenden na ondertekening.
cc_emails
 cc_emails string

Wie wordt cc'd met afzender bij e-mailmelding wanneer deze is ondertekend
created
 created date-time

Gecreëerd
do_email
 do_email boolean

Legalesign-e-mailberichten gebruiken
download_final
 download_final boolean

Uiteindelijke PDF is beschikbaar om te downloaden
voettekst
 footer string

HTML-documenten - tekst voor voettekst als deze wordt gebruikt
footer_height
 footer_height integer

HTMl-documenten - px hoogte van voettekst indien gebruikt
group
 group string

Resource-URI van groep
has_fields
 has_fields boolean

Document bevat velden
hash_value
 hash_value string

SHA256-controlesom van het definitieve document, gebruik dit om uw uiteindelijke PDF-download te valideren
koptekst
 header string

HTML-documenten - tekst voor koptekst als deze wordt gebruikt
header_height
 header_height integer

HTMl-documenten - px-hoogte van header indien gebruikt
gemodificeerd
 modified date-time

Gemodificeerd
naam
 name string

Documentnaam
pdf_password
 pdf_password string

PDF-wachtwoord
pdf_password_type
 pdf_password_type string

Als het PDF-wachtwoord wordt bewaard
pdftext
 pdftext string

Dit negeren
doorsturen
 redirect string

URL voor omleiding van geadresseerden na ondertekening
resource_uri
 resource_uri string

Resource-URI
return_signer_links
 return_signer_links boolean

Negeren
sign_mouse
 sign_mouse boolean

negeren
sign_time
 sign_time date-time

Aanmeldingstijd
sign_type
 sign_type boolean

nalatenschap
sign_upload
 sign_upload boolean

nalatenschap
signature_placement
 signature_placement integer

nalatenschap
signature_type
 signature_type integer

verouderd - altijd 4
Ondertekenaars
 signers array of array

Geneste matrices met ondertekengegevens
items
 signers array of

Bevat altijd [ondertekenaar-URI, voornaam, achternaam, e-mail, sms-nummer, has_fields, status, ondertekenaarvolgorde (0 geïndexeerd)]
signer_objects
 signer_objects array of object

Lijst met geadresseerden
e-mailadres
 signer_objects.email string

E-mailen
voornaam
 signer_objects.firstname string

Voornaam
achternaam
 signer_objects.lastname string

Achternaam
Tel
 signer_objects.tel string

Telnummer
order
 signer_objects.order integer

Ondertekeningsorder
resource_uri
 signer_objects.resource_uri string

Resource-URI
rol
 signer_objects.role string

Rol
status
 signer_objects.status integer

Statuscode van geadresseerde
UUID (Universally Unique Identifier)
 signer_objects.uuid string

Geadresseerde-id
signers_in_order
 signers_in_order boolean

E-mailontvangers simulerend of opeenvolgend
status
 status DocumentStatusEnum

Opties voor documentstatus:

  • 10 - Initiële status, status van ondertekenaar controleren op verzonden/ongedaan maken
  • 20 - Ingevulde velden
  • 30 - Ondertekend
  • 40 - Verwijderd (vóór ondertekening)
  • 50 - Afgewezen
tag
 tag string

Uw verwijzing
tag1
 tag1 string

Uw verwijzing
tag2
 tag2 string

Uw verwijzing
sjabloon
 template string

Resource-URI voor tekstsjabloon indien gebruikt
templatepdf
 templatepdf string

Resource-URI voor PDF-sjabloon indien gebruikt
Tekst
 text string

Tekst voor document indien gebruikt
user
 user string

Gebruikersresource-URI.
UUID (Universally Unique Identifier)
 uuid uuid

Document-id

MemberListResponse

Name Pad Type Description
Meta
 meta ListMeta

Meta-informatie over vermelding.
objecten
 objects array of MemberResponse

MemberResponse

Name Pad Type Description
created
 created date-time

Gecreëerd
group
 group string

Resource-URI groeperen
gemodificeerd
 modified date-time

Gemodificeerd
toestemming
 permission PermissionsEnum

Machtigingsopties
resource_uri
 resource_uri string

Resource-URI
user
 user string

Gebruikersresource-URI.

AttachmentResponse

Item bijvoegen.

Name Pad Type Description
created
 created date-time

Gecreëerd
beschrijving
 description string

Description
filename
 filename string

Bestandsnaam
group
 group string

Groep
resource_uri
 resource_uri string

Resource-URI koppelen
user
 user string

Gebruikersresource-URI
UUID (Universally Unique Identifier)
 uuid uuid

Id bijvoegen

AttachmentListResponse

Bijlagevermelding

Name Pad Type Description
Meta
 meta ListMeta

Meta-informatie over vermelding.
objecten
 objects array of object

Aanbieding
created
 objects.created date-time

Gecreëerd
beschrijving
 objects.description string

Description
filename
 objects.filename string

Bestandsnaam
group
 objects.group string

Groep
resource_uri
 objects.resource_uri string

Resource-URI
user
 objects.user string

Gebruikersresource-URI
UUID (Universally Unique Identifier)
 objects.uuid uuid

Id bijvoegen

UserDetailResponse

Details van de gebruiker.

Name Pad Type Description
date_joined
 date_joined date-time

Datum toegevoegd
e-mailadres
 email email

E-mailen
voornaam
 first_name string

Voornaam
groups
 groups array of string

Lijst met groepen die deze gebruiker heeft toegevoegd.
last_login
 last_login date-time

Laatste aanmelding
achternaam
 last_name string

Achternaam
resource_uri
 resource_uri string

Resource-URI
timezone
 timezone string

Tijdzone
username
 username string

Gebruikersnaam

bestand

Dit is het basisgegevenstype 'bestand'.