Dela via

Legalesign (förhandsversion)

Legalesigns anslutningsapp är utformad för efterlevnadsfokuserade juridiska team och åtgärdsteam och länkar Microsoft power platform med Legalesign eSignature för att utlösa dokument- och mottagararbetsflöden, skicka påminnelser, hämta PDF-filer och ytformulärdata. Kräver en aktiv Legalesign-prenumeration som godkänts för API-användning.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster Class Regioner
Copilot Studio Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Norm Alla Logic Apps-regioner utom följande:
     – Azure Government-regioner
     – Regioner i Azure Kina
     - US Department of Defense (DoD)
Power Apps Premie Alla Power Apps-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Kontakt
Namn API-stöd
URL https://legalesign.com/contact/
E-postmeddelande sales@legalesign.com
Metadata för anslutningsprogram
Utgivare Legalesign
Läs mer om Legalesign https://docs.microsoft.com/connectors/legalesign
Webbplats https://legalesign.com
Integritetspolicy https://legalesign.com/opn/privacy/
Kategorier Innehåll och filer; Produktivitet

Legalesign eSignature REST Connector

Rest-API:et Legalesign driver eSignature-arbetsflöden. Den här anslutningsappen ger fullständig API-åtkomst och realtidsutlösare, vilket möjliggör sömlös integrering med Microsoft Power Automate, Logic Apps och relaterade plattformar.

Förutsättningar

För att komma igång behöver du ett Legalesign-konto och EN API-nyckel: 1. Registrera dig för en kostnadsfri utvärderingsversion. 2. Skapa en grupp (en enskild miljö – till exempel en för utveckling och en annan för produktion). 3. Begär en API-nyckel genom att skapa en supportbegäran. Inkludera ditt användningsfall, företag och din roll så att supporten kan verifiera din identitet. 4. När du har verifierat det loggar du in på API-instrumentpanelen för att hämta din nyckel.

Driftsättning

Nya konton börjar i sandbox-läge med följande begränsningar: • Dokument kan bara skickas för att testa e-postadresser som du konfigurerar i API-instrumentpanelen. • Begäranden begränsas till 100/minut.

När du är redo att gå live skapar du en supportbegäran för att byta konto från sandbox-miljö till produktion. Då kommer restriktionerna att hävas. Mer information finns i distributionsguiden .

Triggers

Anslutningsappen stöder två realtidsutlösare:

  • Dokumenthändelser (t.ex. skapade, avvisade, signerade, slutgiltiga PDF-filer skapade)
  • Mottagarhändelser (t.ex. slutförda, avvisade, öppnade e-postmeddelanden, studsade, påminnelser skickade)

Du kan ta emot alla dokument eller mottagare, av filter efter grupp eller händelsetyp. Alla associerade Legalesign-webhooks kan hanteras och övervakas på API-instrumentpanelen.

Operations

Legalesign REST API-åtgärder stöds. Det vanligaste är att ladda ned en signerad PDF, hantera mallar, dokument, mottagare och fältplacering. Se den fullständiga API-dokumentationen för den fullständiga specifikationen.

I Legalesign kallas ett uppladdat dokument för en "mall". När en mall skickas till en eller flera mottagare blir den ett "dokument". Du laddar vanligtvis upp en mall, återställer dess identifierare och skickar den sedan till en eller flera mottagare.

Vanliga åtgärder är:

Templates

  • Create PDF template – ladda upp en mall (valfri filtyp, till exempel PDF, Word eller bild).
  • Get PDF embeddable link – en enanvändarlänk för att visa mallredigeraren för en användare

Documents

  • Location to download PDF – returnerar PDF-binärfilen för ett signerat dokument
  • Create signing document – skicka ett dokument (välj en mall och mottagare)
  • Void/archive signing document – stoppa ett dokument från att signeras
  • Permanently delete signing document - ta bort ett dokument för alltid

Mottagare (undertecknare)

  • Send signer reminder email – påminn mottagaren om att fylla i dokumentet
  • Get signer rejection reason – om dokumentet avvisas kan du se varför

Fältplacering

Legalesign har ett avancerat formulärsystem med fält. Om du har undertecknare måste varje undertecknare ha minst ett signaturfält.

Det finns fyra sätt att definiera fält i mallen:

  1. Ladda upp en PDF med inbäddade fält (automatiskt konverterad av Legalesign).
  2. Använd Texttaggar för Legalesign.
  3. Definiera x/y-koordinater.
  4. Använd formulärredigeraren Legalesign (via inbäddningslänken eller webbappen).

Klicka här för guiden

Frågor och support

Om du vill ha ytterligare support eller frågor loggar du in på ditt Legalesign-konto och skapar en supportbegäran.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:
Standardinställning Parametrar för att skapa anslutning. Alla regioner Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn Typ Description Krävs
API-nyckel securestring Api_key för det här API:et Sann

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Hämta användare

Hämta användarinformation.
Hämta bifogad fil

Hämta en bifogad fil.
Hämta bifogade filer

Visa en lista över bifogade filer.
Hämta dokument

Returnera ett visst dokument.
Hämta dokument

Visa en lista över dokument med oarchiverade signeringar.
Hämta dokumentfält

Fälten från dokumentet.
Hämta grupper

Lista grupper som API-användaren tillhör.
Hämta mottagare

Hämta status och information om en enskild mottagare.
Hämta mottagarformulärfält

Returnera formulärfälten från en specifik mottagare.
Hämta mottagarlänk

En-användningslänk för mottagare för att gå till signeringssidor.
Hämta orsaken till mottagarens avvisande

Returnerar orsaken som undertecknaren gav för att avvisa ett dokument.
Hämta pdf-inbäddningsbar länk

Returnera en enstaka länk för att bädda in PDF-redigeraren.
Hämta PDF-mall

Information om en specifik PDF-mall
Hämta PDF-mallar

Lista PDF-mallar
Ladda ned dokumentgranskningsloggen

PDF av endast dokumentgranskningsloggen.
Ladda ned PDF

Hämta utkastet eller den slutliga PDF-filen för ett signeringsdokument, beroende på dess status. Observera att ett svar på 200 eller 302 är möjligt.
Ladda upp PDF-bifogad fil

Spara en pdf som ska bifogas i ett e-postmeddelande med mottagaren.
Ladda upp PDF-mall

Ladda upp ett PDF-dokument som du vill skicka för att signeras.
Medlem i en grupp

Information om en specifik användare i en grupp.
Medlemmar i grupper

Listor över alla medlemmar i dina grupper.
Ogiltigt dokument och arkivdokument

Anger ett dokument med status 40 borttaget och arkiverar det.
Skicka dokument

Skicka ett dokument för signatur eller godkännande.
Skicka e-post till mottagarens påminnelse

Skicka ett e-postmeddelande till en mottagare.
Ta bort dokument permanent

Tar bort data och filer permanent.
Ta bort en bifogad fil

Ta bort en bifogad fil.

Hämta användare

Åtgärds-ID:
GetUser

Hämta användarinformation.

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-ID
 userId True uuid

Användar-ID

Returer

Information om användaren.

Body
UserDetailResponse

Hämta bifogad fil

Åtgärds-ID:
GetAttachment

Hämta en bifogad fil.

Parametrar

Name Nyckel Obligatorisk Typ Description
ID för bifogade filer
 attachId True uuid

ID för bifogade filer

Returer

Bifoga objekt.

Body
AttachmentResponse

Hämta bifogade filer

Åtgärds-ID:
GetAttachments

Visa en lista över bifogade filer.

Parametrar

Name Nyckel Obligatorisk Typ Description
Grupp-ID
 group string

Filtrera efter en specifik grupp.
Frågegräns
 limit integer

Använd med förskjutning för att iterera genom resultat.
Frågeförskjutning
 offset integer

Använd med gräns för att iterera genom resultat.

Returer

Lista över bifogade filer

Body
AttachmentListResponse

Hämta dokument

Åtgärds-ID:
GetDocument

Returnera ett visst dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument-ID
 docId True uuid

Dokument-ID

Returer

Dokumentinformation

Body
DocumentResponseDetail

Hämta dokument

Åtgärds-ID:
GetDocuments

Visa en lista över dokument med oarchiverade signeringar.

Parametrar

Name Nyckel Obligatorisk Typ Description
Grupp-ID
 group True string

Filtrera efter en specifik grupp som krävs.
Inkludera arkiverade dokument
 archived string

Filtrera efter arkiverad status, standardvärdet är oarchiverat, använd värdet i den här parametern för att köra frågor mot alla dokument.
Filtrera efter e-postmottagare
 email string

Filtrera efter mottagarens e-post.
Frågegräns
 limit integer

Längden på datamängden som ska returneras. Använd med förskjutningsfråga för att iterera genom resultat.
Frågeförskjutning
 offset integer

Förskjutning från början av datamängden. Använd med gränsfrågan för att iterera via datauppsättningen.
Filtrera efter dokumentstatus
 status integer

Filtrera efter dokumentstatus.
Ta bort mottagare från svar
 nosigners string

Lägg till värde 1 för att ta bort information om mottagare för en snabbare fråga.
Filtrera efter det här datumet
 created_gt date-time

Filtrera efter de dokument som skapats efter en viss tid.
Filtrera efter ändrat efter det här datumet
 modified_gt date-time

Filtrera efter de dokument som ändrats efter en viss tid.

Returer

Dokumentlistor

Body
DocumentListResponse

Hämta dokumentfält

Åtgärds-ID:
GetDocumentFields

Fälten från dokumentet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument-ID
 docId True uuid

Dokument-ID

Returer

Name Sökväg Typ Description
array of object

Lista över dokumentfält
element_type
 element_type string

Elementtyp
fältordning
 fieldorder integer

Fältordning
label
 label string

Etikett
label_extra
 label_extra string

Extra etikett
undertecknare
 signer integer

Recipient
state
 state boolean
validering
 validation integer

Verifieringsidentifierare
värde
 value string

Värde

Hämta grupper

Åtgärds-ID:
GetGroups

Lista grupper som API-användaren tillhör.

Parametrar

Name Nyckel Obligatorisk Typ Description
Frågeförskjutning
 offset integer

Förskjutning från början av datamängden. Använd med gränsfrågan för att iterera via datauppsättningen.
Frågegräns
 limit integer

Längden på datamängden som ska returneras. Använd med förskjutningsfråga för att iterera genom resultat.

Returer

Lista över grupper

Body
GroupListResponse

Hämta mottagare

Åtgärds-ID:
GetRecipient

Hämta status och information om en enskild mottagare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mottagar-ID
 recipientId True uuid

Mottagar-ID

Returer

Information om mottagare

Body
SignerResponse

Hämta mottagarformulärfält

Åtgärds-ID:
GetSignerFields

Returnera formulärfälten från en specifik mottagare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mottagar-ID
 recipientId True uuid

Mottagar-ID

Returer

Name Sökväg Typ Description
array of object
label
 label string

Etikett
label_extra
 label_extra string

Extra etikett
state
 state boolean

Stat/län
fältordning
 fieldorder integer

Fältordning
värde
 value string

Om fältet är en undertecknarfil blir det här värdet en kortlivad nedladdnings-URL.

Hämta mottagarlänk

Åtgärds-ID:
GetSignerLink

En-användningslänk för mottagare för att gå till signeringssidor.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mottagar-ID
 recipientId True uuid

Mottagar-ID

Hämta orsaken till mottagarens avvisande

Åtgärds-ID:
GetSignerRejection

Returnerar orsaken som undertecknaren gav för att avvisa ett dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mottagar-ID
 recipientId True uuid

Mottagar-ID

Returer

Name Sökväg Typ Description
status
 status integer

Mottagarstatyer.
reason
 reason string

Avvisa orsak.

Hämta pdf-inbäddningsbar länk

Åtgärds-ID:
GetPdfTemplateEditLink

Returnera en enstaka länk för att bädda in PDF-redigeraren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Pdf-ID
 pdfId True string

Ange uppladdat PDF-ID.
Dölj fältlistan från renderad sida
 hide_sender_fields boolean

Dölj fältlistan från renderad sida.
Hexkod exklusive hashsymbol för bakgrundsfärg
 css_body_backgroundcolor string

Använd hexkod exklusive hashsymbol för att ändra bakgrundsfärg.

Hämta PDF-mall

Åtgärds-ID:
GetPdfTemplate

Information om en specifik PDF-mall

Parametrar

Name Nyckel Obligatorisk Typ Description
Uppladdat PDF-ID
 pdfId True uuid

Uppladdat PDF-ID

Returer

Mallinformation

Body
TemplatePdfResponse

Hämta PDF-mallar

Åtgärds-ID:
GetPdfTemplates

Lista PDF-mallar

Parametrar

Name Nyckel Obligatorisk Typ Description
Grupp-ID
 group string

Kan vara full resource_uri eller endast ID.
Frågegräns
 limit integer

Längden på datamängden som ska returneras. Använd med förskjutningsfråga för att iterera genom resultat.
Frågeförskjutning
 offset integer

Förskjutning från början av datamängden. Använd med gränsfrågan för att iterera via datauppsättningen.

Returer

Malllistor

Body
TemplatePdfListResponse

Ladda ned dokumentgranskningsloggen

Åtgärds-ID:
GetDocumentAuditLog

PDF av endast dokumentgranskningsloggen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument-ID
 docId True uuid

Dokument-ID

Returer

response
file

Ladda ned PDF

Åtgärds-ID:
GetDocumentPdf

Hämta utkastet eller den slutliga PDF-filen för ett signeringsdokument, beroende på dess status. Observera att ett svar på 200 eller 302 är möjligt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument-ID
 docId True uuid

Dokument-ID

Returer

response
file

Ladda upp PDF-bifogad fil

Åtgärds-ID:
PostAttachment

Spara en pdf som ska bifogas i ett e-postmeddelande med mottagaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
group
 group True string

Gruppera resurs-URI
pdf_file
 pdf_file True byte

Base64-kodade PDF-fildata, maxstorlek är en gruppinställning, 5 MB som standard.
filename
 filename True string

Enkelt alfanumeriskt namn som slutar .pdf
user
 user string

Tilldela till en annan användare.
beskrivning
 description string

Ladda upp PDF-mall

Åtgärds-ID:
PostPdfTemplate

Ladda upp ett PDF-dokument som du vill skicka för att signeras.

Parametrar

Name Nyckel Obligatorisk Typ Description
Arkivera vid sändning
 archive_upon_send boolean

Ange sant om den här uppladdningen endast ska användas för en enda användning.
Grupp
 group True string

Ange grupp där detta ska användas.
PDF-fil
 pdf_file True byte

Base64-kodade PDF-fildata.
Processtaggar
 process_tags boolean

Om filen innehåller texttaggar konverterar du dem till fält.
Titel
 title string

Namnge den här posten och använd filnamnet om det inte används.
User
 user string

Tilldela till gruppmedlem om inte api-användare.

Medlem i en grupp

Åtgärds-ID:
GetMember

Information om en specifik användare i en grupp.

Parametrar

Name Nyckel Obligatorisk Typ Description
Medlems-ID
 memberId True uuid

Medlems-ID

Returer

Body
MemberResponse

Medlemmar i grupper

Åtgärds-ID:
GetMembers

Listor över alla medlemmar i dina grupper.

Parametrar

Name Nyckel Obligatorisk Typ Description
Grupp-ID
 group string

Filtrera efter en specifik grupp
Frågegräns
 limit integer

Använd med förskjutning för att iterera genom resultat.
Frågeförskjutning
 offset integer

Använd med gräns för att iterera genom resultat.

Returer

Body
MemberListResponse

Ogiltigt dokument och arkivdokument

Åtgärds-ID:
UpdateArchiveDocument

Anger ett dokument med status 40 borttaget och arkiverar det.

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument-ID
 docId True uuid

Dokument-ID
Skicka ett e-postmeddelande till mottagaren
 email string

Om värdet är true eller 1 meddelas mottagarna att dokumentet har ogiltigförklarats.

Skicka dokument

Åtgärds-ID:
PostDocument

Skicka ett dokument för signatur eller godkännande.

Parametrar

Name Nyckel Obligatorisk Typ Description
Grupp
 group True string

Gruppera resurs-URI
Namn
 name True string

Ange namnet på dokumentet
PDF-mall
 templatepdf True string

Den uppladdade PDF-filen som ska skickas.
Mejladress
 email True email

E-postmeddelande
förnamn
 firstname True string

Förnamn
efternamn
 lastname True string

Efternamn
attachments
 attachments array of string

Lista över resurs-uris för bifogade filer.
Upphör
 expires date-time

ISO8601 formgiven datetime, inställd på TZ av avsändaren eller tidszonen om den används
meddelande
 message string

Ditt personliga meddelande till parten, som anges i mitten av grupp-e-postmallen. Använd namnet på en sparad e-postmall som föregrips av en hash-symbol för att använda mallen. Om det finns fler än en mall med samma namn kommer den att välja den som senast ändrades.
förnamn
 firstname string

Förnamn
efternamn
 lastname string

Efternamn
Mejladress
 email True email

E-postmeddelande
include_link
 include_link boolean

Inkludera en länk till signeringssidorna så att en granskare kan signera
sms
 sms string

Använd internationellt formatnummer för att lägga till SMS-verifiering. Krävs om ett vittne eller en vittne undertecknare.
ämne
 subject string

Ämnesrad för utgående e-post
timezone
 timezone string

TZ för undertecknaren måste vara giltig TZ per tidszon (se Användaren för timezoneenum information). Om tomt använder tz av avsändaren.
Signaturtyp
 signature_type integer

Använd 4 för att få din utförda PDF-certifierad. Rekommenderad. Standardvärdet är 1 (använder en sha256-hash för dokumentintegritet).
Lägg till PDF
 append_pdf boolean

Lägg till Valideringsinformation för Legalesign till slutlig PDF.
auto_archive
 auto_archive boolean

Skicka till arkivet strax efter signeringen. Håller webbappens e-post ledig
Använda Legalesign-e-postmeddelanden
 do_email boolean

Använd Legalesign-e-post för att skicka e-postmeddelanden. Om falskt undertrycker alla e-postmeddelanden.
Cc när det är klart
 cc_emails string

Kommaavgränsad sträng med e-postadresser som meddelas om signering eller avvisande.
Konvertera tomma avsändarfält till de första mottagarfälten
 convert_sender_to_signer boolean

Om några avsändarfält lämnas tomma konverterar du dem till fält för den första mottagaren.
PDF-lösenord
 pdf_password string

Ange ett lösenord. Måste vara ascii encode-able, du måste också ange signature_type till 4 och välja en pdf_password_type.
Inställningar för PDF-lösenord
 pdf_password_type integer

1 för att lagra lösenord, 2 för att ta bort från våra poster vid slutlig signering.
pdftext
 pdftext object

Tilldela värden till PDF-avsändarfält, använd mallens fältetikett eller dess uuid som objektnycklar. Se templatepdf/:id/fields/ och filtrera efter element_type="admin" för att hämta relevanta fält med deras etikett eller uuid. Se även strict_fields.
Omdirigerings-URL
 redirect string

URL som undertecknaren ska skickas till efter signeringen (i stället för nedladdningssidan). Url:en innehåller frågeparametrar med ID och tillståndsinformation på följande sätt: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Påminnelseschema
 reminders string

Ange "standard" om du vill använda standardschemat för påminnelser i gruppen (gå till webbappen för att ange standardschema)
Länkar för retursignerare
 return_signer_links boolean

Returnera dokumentlänkar för undertecknare i svarstexten.
skicka sekvensering
 signers_in_order boolean

Meddela undertecknarna i ordningsföljden. Om falskt meddelas alla simulataneously.
signertext
 signertext object

Lägg till anpassade platshållare i signerfält. Använd fältetiketter eller uuid som nycklar i objektet (som för pdftext). Se templatepdf/:id/fields/ och filtrera efter element_type = "text" för att hämta relevanta fält med sina etiketter eller uuid.
Framtvinga fältverifiering
 strict_fields boolean

Pdftext misslyckas med verifieringskontrollerna tyst och anger true för att verifiera.
Din referens
 tag string

Tag
Din referens
 tag1 string

Tag
Din referens
 tag2 string

Tag
user
 user string

Tilldela dokument till en annan användare i gruppen.

Skicka e-post till mottagarens påminnelse

Åtgärds-ID:
PostSignerReminder

Skicka ett e-postmeddelande till en mottagare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mottagar-ID
 recipientId True uuid

Mottagar-ID
texten
 text string

Anpassad meddelandetext

Ta bort dokument permanent

Åtgärds-ID:
DeleteDocument

Tar bort data och filer permanent.

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument-ID
 docId True uuid

Dokument-ID

Ta bort en bifogad fil

Åtgärds-ID:
DeleteAttachment

Ta bort en bifogad fil.

Parametrar

Name Nyckel Obligatorisk Typ Description
ID för bifogade filer
 attachId True uuid

Bifoga ID

Utlösare

Dokumenthändelse

Utlösare för en dokumenthändelse inträffar
Mottagarhändelse

Utlösare för när en mottagarhändelse inträffar

Dokumenthändelse

Åtgärds-ID:
DocumentTrigger

Utlösare för en dokumenthändelse inträffar

Parametrar

Name Nyckel Obligatorisk Typ Description
eventFilter
 eventFilter True string

Händelsefilter
group
 group string

Gruppfilter

Returer

Name Sökväg Typ Description
version
 version string

Utgåva
objekt
 object string

Object
tag1
 data.tag1 string

Tag
recipients
 data.recipients array of object

Mottagare
Universellt unik identifierare (UUID)
 data.recipients.uuid string

Mottagar-ID
Mejladress
 data.recipients.email string

E-postmottagare
order
 data.recipients.order integer

Mottagarens ordernummer
status
 data.recipients.status integer

Mottagarstatus
efternamn
 data.recipients.lastname string

Mottagarens efternamn
roleText
 data.recipients.roleText string

Text för mottagarroll
förnamn
 data.recipients.firstname string

Mottagarens förnamn
statusText
 data.recipients.statusText string

Statustext för mottagare
resourceUri
 data.recipients.resourceUri string

Mottagarresurs-URI
rejectReason
 data.recipients.rejectReason string

rejectReason
groupResourceUri
 data.groupResourceUri string

Gruppera resurs-URI
statusText
 data.statusText string

Dokumentstatustext
name
 data.name string

Dokumentnamn
tag
 data.tag string

Tag
resourceUri
 data.resourceUri string

Resurs-URI
Universellt unik identifierare (UUID)
 data.uuid string

Dokument-ID
tag2
 data.tag2 string

Tagg2
group
 data.group string

Grupp
status
 data.status integer

Dokumentstatus
created
 created integer

Skapades
Id-nummer
 id string

Gjorde
händelse
 event string

Event

Mottagarhändelse

Åtgärds-ID:
RecipientTrigger

Utlösare för när en mottagarhändelse inträffar

Parametrar

Name Nyckel Obligatorisk Typ Description
eventFilter
 eventFilter True string

Händelsefilter
group
 group string

Gruppfilter

Returer

Name Sökväg Typ Description
version
 version string

Utgåva
objekt
 object string

Object
tag
 data.tag string

Tag
tag1
 data.tag1 string

Tagg1
tag2
 data.tag2 string

Tagg2
Universellt unik identifierare (UUID)
 data.uuid string

Mottagar-ID
Mejladress
 data.email string

E-postmeddelande
group
 data.group string

Grupp
order
 data.order integer

Beställning
status
 data.status integer

Läge
dokument
 data.document string

Dokument
efternamn
 data.lastname string

Efternamn
roleText
 data.roleText string

Rolltext
förnamn
 data.firstname string

Förnamn
statusText
 data.statusText string

Statustext
emailBounce
 data.emailBounce integer

E-postmeddelandet studsade
resourceUri
 data.resourceUri string

Mottagarresurs-URI
documentName (dokumentnamn)
 data.documentName string

Dokumentnamn
rejectReason
 data.rejectReason string

Avvisa orsak
groupResourceUri
 data.groupResourceUri string

Gruppera resurs-URI
emailBounceMessage
 data.emailBounceMessage string

E-post studsa meddelande
documentResourceUri
 data.documentResourceUri string

Dokumentresurs-URI
created
 created integer

Skapades
Id-nummer
 id string

ID-nummer
händelse
 event string

Event

Definitioner

PermissionsEnum

Behörighetsalternativ

Behörighetsalternativ

integer

ListMeta

Metainformation om listning.

Name Sökväg Typ Description
limit
 limit integer

Maximalt antal objekt.
next
 next string

URL för nästa uppsättning objekt.
offset
 offset integer

Antal objekt från början av resultatuppsättningen.
föregående
 previous string

URL för tidigare uppsättning objekt.
total_count
 total_count integer

Totalt antal objekt.

GroupListResponse

Lista över grupper

Name Sökväg Typ Description
meta
 meta ListMeta

Metainformation om listning.
objekt
 objects array of object
created
 objects.created date-time

Skapades
is_active
 objects.is_active boolean

Active
modifierad
 objects.modified date-time

Modifierad
name
 objects.name string

Namn
public_name
 objects.public_name string

Offentligt namn
resource_uri
 objects.resource_uri string

Resurs-URI
snigel
 objects.slug string

Unikt namn
user
 objects.user string

Skaparresurs-URI
xframe_allow
 objects.xframe_allow boolean

Tillåt inbäddningssignering
xframe_allow_pdf_edit
 objects.xframe_allow_pdf_edit boolean

Tillåt inbäddningsredigering

TemplatePdfListResponse

Malllistor

Name Sökväg Typ Description
meta
 meta ListMeta

Metainformation om listning.
objekt
 objects array of TemplatePdfResponse

TemplatePdfResponse

Mallinformation

Name Sökväg Typ Description
created
 created date-time

Skapades
group
 group string

Grupp-URI
modifierad
 modified date-time

Modifierad
fester
 parties string

JSON-strängmatris med dokumentpartier.
page_count
 page_count integer

Antal sidor
resource_uri
 resource_uri string

Resurs-URI
signer_count
 signer_count integer

Antal undertecknare
title
 title string

Titel
user
 user string

Skaparens resurs-URI
Universellt unik identifierare (UUID)
 uuid uuid

Pdf-ID
giltigt
 valid boolean

Kan skickas (om fälten inte verifieras).

DocumentListResponse

Dokumentlistor

Name Sökväg Typ Description
meta
 meta ListMeta

Metainformation om listning.
objekt
 objects array of object

Documents
arkiverad
 objects.archived boolean

Arkiverad
auto_archive
 objects.auto_archive boolean

Arkivera efter sändning.
cc_emails
 objects.cc_emails string

Kommaavgränsade e-postmeddelanden i listan till cc när det är klart.
created
 objects.created date-time

Skapades
do_email
 objects.do_email boolean

Använd Legalesign-e-post.
download_final
 objects.download_final boolean

Är redo att laddas ned efter slutförande.
group
 objects.group string

Gruppera resurs-URI.
modifierad
 objects.modified date-time

Modifierad
name
 objects.name string

Dokumentnamn
pdftext
 objects.pdftext string

Fältvärden för avsändare
omdirigera
 objects.redirect string

URL för omdirigering av mottagare efter signering
resource_uri
 objects.resource_uri string

Resurs-URI
return_signer_links
 objects.return_signer_links boolean

Lägga till mottagarlänkar i svaret
Undertecknarna
 objects.signers array of array

Kapslade matriser med information om undertecknare
items
 objects.signers array of

Innehåller alltid [signer uri, förnamn, efternamn, e-post, sms-nummer, has_fields, status, undertecknarordning (0-indexerad)]
signers_in_order
 objects.signers_in_order integer

E-postmottagare simulataneously eller sekventiellt
status
 objects.status DocumentStatusEnum

Alternativ för dokumentstatus:

  • 10 – Initialt tillstånd, kontrollera undertecknarens status för skickat/oförsent
  • 20 – Fälten har slutförts
  • 30 – Signerad
  • 40 – Borttagen (före signering)
  • 50 – Avvisade
tag
 objects.tag string

Tagga dokument
tag1
 objects.tag1 string

Tagga dokument
tag2
 objects.tag2 string

Tagga dokument
mall
 objects.template string

Mallresurs-URI om den används
templatepdf
 objects.templatepdf string

RESURS-URI för PDF-mall
texten
 objects.text string

Text för signering
user
 objects.user string

Skapar-URI
Universellt unik identifierare (UUID)
 objects.uuid uuid

Dokument-ID

DocumentStatusEnum

Alternativ för dokumentstatus:

  • 10 – Initialt tillstånd, kontrollera undertecknarens status för skickat/oförsent
  • 20 – Fälten har slutförts
  • 30 – Signerad
  • 40 – Borttagen (före signering)
  • 50 – Avvisade

Alternativ för dokumentstatus:

  • 10 – Initialt tillstånd, kontrollera undertecknarens status för skickat/oförsent
  • 20 – Fälten har slutförts
  • 30 – Signerad
  • 40 – Borttagen (före signering)
  • 50 – Avvisade
integer

SignerResponse

Information om mottagare

Name Sökväg Typ Description
dokument
 document string

Dokument
Mejladress
 email string

E-postmottagare
förnamn
 first_name string

Mottagarens förnamn
efternamn
 last_name string

Mottagarens efternamn
has_fields
 has_fields boolean

Mottagaren har fält
order
 order integer

Mottagarordning
resource_uri
 resource_uri string

Mottagarresurs-URI
status
 status SignerStatusEnum

Statusalternativ för undertecknare:

  • 4 – ej sedda
  • 5 – schemalagt att skickas
  • 10 - skickad
  • 15 – e-post öppnas
  • 20 - besökt
  • 30 – fälten har slutförts
  • 35 – fält slutför ex-signatur
  • 39 - väntar på att vittnet ska slutföras
  • 40 – signerad
  • 50 – nedladdad
  • 60 – avvisade

SignerStatusEnum

Statusalternativ för undertecknare:

  • 4 – ej sedda
  • 5 – schemalagt att skickas
  • 10 - skickad
  • 15 – e-post öppnas
  • 20 - besökt
  • 30 – fälten har slutförts
  • 35 – fält slutför ex-signatur
  • 39 - väntar på att vittnet ska slutföras
  • 40 – signerad
  • 50 – nedladdad
  • 60 – avvisade

Statusalternativ för undertecknare:

  • 4 – ej sedda
  • 5 – schemalagt att skickas
  • 10 - skickad
  • 15 – e-post öppnas
  • 20 - besökt
  • 30 – fälten har slutförts
  • 35 – fält slutför ex-signatur
  • 39 - väntar på att vittnet ska slutföras
  • 40 – signerad
  • 50 – nedladdad
  • 60 – avvisade
integer

DocumentResponseDetail

Dokumentinformation

Name Sökväg Typ Description
arkiverad
 archived boolean

Arkiveras
auto_archive
 auto_archive boolean

Skicka dokumentarkiv efter signering.
cc_emails
 cc_emails string

Vem kommer att vara cc'd med avsändaren vid e-postavisering när den signeras
created
 created date-time

Skapades
do_email
 do_email boolean

Använda Legalesign-e-postmeddelanden
download_final
 download_final boolean

Slutlig PDF finns att ladda ned
Sidfot
 footer string

HTML-dokument – text för sidfot om den används
footer_height
 footer_height integer

HTMl-dokument – sidfotens höjd om den används
group
 group string

Resurs-URI för grupp
has_fields
 has_fields boolean

Dokumentet har fält
hash_value
 hash_value string

SHA256-kontrollsumma för det slutliga dokumentet, använd detta för att verifiera din slutliga PDF-nedladdning
rubrik
 header string

HTML-dokument – text för sidhuvud om det används
header_height
 header_height integer

HTMl-dokument – px-höjden på huvudet om det används
modifierad
 modified date-time

Modifierad
name
 name string

Dokumentnamn
pdf_password
 pdf_password string

PDF-lösenord
pdf_password_type
 pdf_password_type string

Om pdf-lösenord behålls
pdftext
 pdftext string

Ignorera detta
omdirigera
 redirect string

URL för omdirigering av mottagare efter signering
resource_uri
 resource_uri string

Resurs-URI
return_signer_links
 return_signer_links boolean

Ignorera
sign_mouse
 sign_mouse boolean

bortse från
sign_time
 sign_time date-time

Teckentid
sign_type
 sign_type boolean

legat
sign_upload
 sign_upload boolean

legat
signature_placement
 signature_placement integer

legat
signature_type
 signature_type integer

legacy – alltid 4
Undertecknarna
 signers array of array

Kapslade matriser med information om undertecknare
items
 signers array of

Innehåller alltid [signer uri, förnamn, efternamn, e-post, sms-nummer, has_fields, status, undertecknarordning (0-indexerad)]
signer_objects
 signer_objects array of object

Lista över mottagare
Mejladress
 signer_objects.email string

E-postmeddelande
förnamn
 signer_objects.firstname string

Förnamn
efternamn
 signer_objects.lastname string

Efternamn
Tel
 signer_objects.tel string

Tel-nummer
order
 signer_objects.order integer

Signeringsordning
resource_uri
 signer_objects.resource_uri string

Resurs-URI
None needed, as the translation is already accurate and fluent.
 signer_objects.role string

Role
status
 signer_objects.status integer

Statuskod för mottagare
Universellt unik identifierare (UUID)
 signer_objects.uuid string

Mottagar-ID
signers_in_order
 signers_in_order boolean

E-postmottagare simulataneously eller sekventiellt
status
 status DocumentStatusEnum

Alternativ för dokumentstatus:

  • 10 – Initialt tillstånd, kontrollera undertecknarens status för skickat/oförsent
  • 20 – Fälten har slutförts
  • 30 – Signerad
  • 40 – Borttagen (före signering)
  • 50 – Avvisade
tag
 tag string

Din referens
tag1
 tag1 string

Din referens
tag2
 tag2 string

Din referens
mall
 template string

Resurs-URI för textmall om den används
templatepdf
 templatepdf string

Resurs-URI för pdf-mall om den används
texten
 text string

Text för dokument om det används
user
 user string

Användarresurs-URI.
Universellt unik identifierare (UUID)
 uuid uuid

Dokument-ID

MemberListResponse

Name Sökväg Typ Description
meta
 meta ListMeta

Metainformation om listning.
objekt
 objects array of MemberResponse

MemberResponse

Name Sökväg Typ Description
created
 created date-time

Skapades
group
 group string

Gruppera resurs-URI
modifierad
 modified date-time

Modifierad
tillåtelse
 permission PermissionsEnum

Behörighetsalternativ
resource_uri
 resource_uri string

Resurs-URI
user
 user string

Användarresurs-URI.

AttachmentResponse

Bifoga objekt.

Name Sökväg Typ Description
created
 created date-time

Skapades
beskrivning
 description string

Description
filename
 filename string

Filnamn
group
 group string

Grupp
resource_uri
 resource_uri string

Koppla resurs-URI
user
 user string

Användarresurs-URI
Universellt unik identifierare (UUID)
 uuid uuid

Bifoga ID

AttachmentListResponse

Lista över bifogade filer

Name Sökväg Typ Description
meta
 meta ListMeta

Metainformation om listning.
objekt
 objects array of object

Lista
created
 objects.created date-time

Skapades
beskrivning
 objects.description string

Description
filename
 objects.filename string

Filnamn
group
 objects.group string

Grupp
resource_uri
 objects.resource_uri string

Resurs-URI
user
 objects.user string

Användarresurs-URI
Universellt unik identifierare (UUID)
 objects.uuid uuid

Bifoga ID

UserDetailResponse

Information om användaren.

Name Sökväg Typ Description
date_joined
 date_joined date-time

Datum ansluten
Mejladress
 email email

E-postmeddelande
förnamn
 first_name string

Förnamn
groups
 groups array of string

Lista över grupper som användaren har anslutit till.
last_login
 last_login date-time

Senaste inloggning
efternamn
 last_name string

Efternamn
resource_uri
 resource_uri string

Resurs-URI
timezone
 timezone string

Tidszon
username
 username string

Användarnamn

fil

Det här är den grundläggande datatypen "fil".