Dela via

Verifierat

Anslutningsprogram för verifierat API för att aktivera skapande av anpassade dokumentsigneringsprocesser.

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 Verifierat
URL https://verified.eu/en/#about-us
E-postmeddelande support@verified.eu
Metadata för anslutningsprogram
Utgivare Crm - Konsulterna i Sverige AB
Webbplats https://verified.eu/
Sekretesspolicy https://verified.eu/trust-center
Kategorier Innehåll och filer; Produktivitet

Verifierad är en programvara som tjänstleverantör för elektronisk identifiering och digital signering. Den här anslutningsappen gör det möjligt att integrera i API:et för Verifierad och skapa enkla och intuitiva signeringsprocesser i ditt program.

Förutsättningar

Du behöver följande för att fortsätta:

Hämta autentiseringsuppgifter

Den här anslutningsappen använder grundläggande autentisering. Användaren måste presentera användarnamn, lösenord och företags-ID när en anslutning skapas. Användarnamn och lösenord är samma som du använder för att logga in på verifierad portal. För att få företags-ID:t måste du logga in på verifierad portal genom att välja rätt företag om du har flera och kopiera företags-ID:t från URL:en.

Get started

Ett vanligt användningsfall är att starta och hantera en signeringsprocess, dvs. konfigurera automatisering för att skicka dokument som ska signeras till Verifierade och få signerade dokument tillbaka regelbundet. Vanliga åtgärder som används för att starta en verifierad signeringsprocess är Skapa kuvert – beskrivning eller Skapa kuvert – standard, Lägg till dokument i kuvert, Lägg till fil i dokument, Lägg till mottagare i kuvert och Uppdatera publiceringsstatus för kuvert. Vanliga åtgärder som används för att kontrollera verifierad status för dokument är Hämta kuvert efter ID, Hämta alla dokument med kuvert-ID, Hämta filer efter dokument-ID, Hämta fil-URL efter ID. Observera att åtgärden Generera säkerhetstoken alltid används som ett första steg för att hämta en säkerhetstoken som ska användas i följande steg.

Kända problem och begränsningar

Följande begränsningar är kända för närvarande.

  • I början av varje flöde måste man skapa en autentiseringstoken som ska återanvändas i varje steg nedan.
  • För att lägga till ett dokument måste man skicka en HTTP-begäran till en viss URL.
  • Om du vill använda den nya sökslutpunkten måste den aktiveras för kontot via den verifierade suppoerten.

Vanliga frågor

Hur laddar jag upp ett dokument till Verifierat?

Om du vill ladda upp ett faktiskt dokument måste du skapa en fil i verifierat API och ladda upp dokumenthashen till blob-URL:en som svarade från verifierat API.

Hur får jag tag på kuvertet när jag har använt åtgärden Hämta kuvert-ID?

Stegen som skapar ett kuvert svarar med ett uid, vilket är en fullständig sökväg till kuvertet (exempel: "/envelopes/ABCDE"). För andra steg behöver man bara den sista delen av uid (som är det faktiska kuvert-ID:t, i vårt exempel "ABCDE").

Här är ett exempel på hur du gör det

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

Hur får jag tag på dokument-ID:t när jag har använt åtgärden Lägg till dokument i kuvert?

Stegen som skapar ett dokument svarar med platsen för det nya dokumentet i rubriken. Platsen är den fullständiga sökvägen till dokumentet (exempel: "/api/envelopes/ABCDE/documents/FGHIJ"). Endast dokument-ID (i vårt fall: FGHIJ) behövs för följande steg.

Här är ett exempel på hur du gör det

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

Hur får jag tag på flödes-ID:t från ett kuvert?

När man läser in information om ett kuvert är det relaterade flödet en del av svaret (exempel: "/flow/default"). I svaret kallas det ID för ett flöde, men man behöver bara den sista delen när ett annat steg (till exempel Hämta flödesstatus) ber om flödes-ID.

Här är ett exempel på hur du gör det

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

Hur kan jag använda den nya sökåtgärden?

För att kunna använda den nya sökåtgärden måste sökslutpunkten aktiveras för din verifierade organisation. För att göra detta måste du skriva ett e-postmeddelande till Verifierad support, inklusive ditt organisations-ID så att de kan aktivera slutpunkten åt dig.

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
username securestring Användarnamnet för det här API:et Sann
lösenord securestring Lösenordet för det här API:et Sann
Företags-ID snöre Företags-ID tillhandahålls av Verified. Du hittar den i URL:en genom att logga in på app.verified.eu Sann

Begränsningsgränser

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

Åtgärder

Ange dokumentets avbrutna status

Anger status för ett visst dokument som avbrutet.
Ange kuvertets avbrutna status

Anger statusen för ett visst kuvert till avbrutet.
Ange papperskorgsstatus för kuvert

Anger status för ett visst kuvert till papperskorgen.
Fråga efter alla kuvert (inaktuella)

Kör frågor mot alla kuvert som matchar ett visst filter. (Föråldrad)
Generera dokument från mall

Genererar ett dokument från en förkonfigurerad mall.
Generera säkerhetstoken

Hämtar autentiseringstoken från verifierat API.
Hämta alla beskrivningar

Hämtar en lista över alla deskriptorer som finns i det aktuella företaget. Listan kan filtreras.
Hämta alla dokument med kuvert-ID

Hämtar alla dokument som är relaterade till ett visst kuvert.
Hämta alla kuvertmottagare

Hämtar alla mottagare av ett visst kuvert.
Hämta användarinformation

Hämtar information om den inloggade användaren.
Hämta användarinställningar

Hämtar inställningarna för en viss användare.
Hämta deskriptor efter ID

Hämtar information om en viss beskrivning.
Hämta dokument efter ID

Hämtar information om ett visst dokument.
Hämta en specifik mottagare för ett kuvert

Hämtar en specifik mottagare för ett visst kuvert.
Hämta fil efter ID

Hämtar information om en viss fil.
Hämta fil-URL efter ID

Hämtar URL:en till en viss fil.
Hämta filer efter dokument-ID

Hämtar alla filer som är anslutna till ett visst dokument.
Hämta flödestillstånd efter kuvert-ID

Hämtar aktuellt flödestillstånd för ett visst kuvert.
Hämta företag efter ID

Hämtar information om ett visst företag.
Hämta kuvert med ID

Hämtar information om ett visst kuvert.
Hämta standardbeskrivning

Hämtar standardbeskrivningen för kuvert.
Lägg till fil i dokumentet

Lägger till en fil i ett befintligt dokument.
Lägg till mottagare i kuvertet

Lägger till en mottagare i ett visst kuvert.
Lägga till dokument i kuvert

Lägger till ett nytt dokument i ett befintligt kuvert.
Skapa kuvert – beskrivning

Skapar ett kuvert baserat på en specifik beskrivning.
Skapa kuvert – standard

Skapar ett nytt kuvert med standardbeskrivningen.
Skapa signaturlänk

Skapar en signaturlänk. Implementeringen är flödesspecifik och kan saknas för ditt specifika flöde.
Skicka meddelande

Skickar ett meddelande till mottagare av ett visst kuvert.
Sök i alla kuvert

Sök igenom alla kuvert som matchar ett visst filter.
Ta bort dokument efter ID

Tar bort ett visst dokument.
Ta bort kuvert med ID

Tar bort ett visst kuvert.
Uppdatera kuvertinställningar

Uppdaterar Inställningar för ett visst kuvert.
Uppdatera mottagaren efter ID

Uppdaterar en mottagare.
Uppdatera publiceringsstatus för kuvert

Uppdaterar publiceringsstatusen för ett visst kuvert.

Ange dokumentets avbrutna status

Åtgärds-ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Anger status för ett visst dokument som avbrutet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga

Ange kuvertets avbrutna status

Åtgärds-ID:
PutEnvelopesEnvelopeIdAbortStatus

Anger statusen för ett visst kuvert till avbrutet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
kommentar
 comment string

Ange papperskorgsstatus för kuvert

Åtgärds-ID:
PutEnvelopesEnvelopeIdTrashStatus

Anger status för ett visst kuvert till papperskorgen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Comment
 comment string

Fråga efter alla kuvert (inaktuella)

Åtgärds-ID:
GetQueryEnvelopes

Kör frågor mot alla kuvert som matchar ett visst filter. (Föråldrad)

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Filterar
 filters string

Filtrera fråga för att välja undermontering
Från
 from integer

Från datum
Limit
 limit integer

Begränsa belopp
Sortera
 sort string

Sortera efter

Returer

response
array of EnvelopeDescriptorString

Generera dokument från mall

Åtgärds-ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Genererar ett dokument från en förkonfigurerad mall.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga
Mall-ID
 template-id True string

ID för mallen som ska användas
object

Generera säkerhetstoken

Åtgärds-ID:
PostAuthenticate

Hämtar autentiseringstoken från verifierat API.

Parametrar

Name Nyckel Obligatorisk Typ Description
Utan IP-lås
 withoutIpLock True integer

Om Verifierad aktiverar IP-lås (0, standard) eller inte (1)

Returer

Name Sökväg Typ Description
Bevis
 token string

Åtkomsttoken

Hämta alla beskrivningar

Åtgärds-ID:
GetEnvelopeDescriptors

Hämtar en lista över alla deskriptorer som finns i det aktuella företaget. Listan kan filtreras.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Filterar
 filters string

Filtrera fråga för att välja undermontering

Returer

response
array of Descriptor

Hämta alla dokument med kuvert-ID

Åtgärds-ID:
GetEnvelopesEnvelopeIdDocuments

Hämtar alla dokument som är relaterade till ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga

Returer

response
array of Document

Hämta alla kuvertmottagare

Åtgärds-ID:
GetEnvelopesEnvelopeIdRecipients

Hämtar alla mottagare av ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga

Returer

response
array of Recipient

Hämta användarinformation

Åtgärds-ID:
GetAuthUserinfo

Hämtar information om den inloggade användaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken

Returer

Body
UserInfo

Hämta användarinställningar

Åtgärds-ID:
GetCompaniesCompanyIdUsersUserIdSettings

Hämtar inställningarna för en viss användare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 company-id True string

ID:t för det aktuella företaget
Användar-ID
 user-id True string

ID för användaren i fråga

Returer

Body
Setting

Hämta deskriptor efter ID

Åtgärds-ID:
GetEnvelopeDescriptorsEnvelopeDescriptorId

Hämtar information om en viss beskrivning.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvertbeskrivnings-ID
 envelope-descriptor-id True string

ID för kuvertbeskrivningen

Returer

Deskriptor
Descriptor

Hämta dokument efter ID

Åtgärds-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentId

Hämtar information om ett visst dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga

Returer

Dokument
Document

Hämta en specifik mottagare för ett kuvert

Åtgärds-ID:
GetEnvelopesEnvelopeIdRecipientsRecipientId

Hämtar en specifik mottagare för ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Mottagar-ID
 recipient-id True string

ID:t för mottagarna i fråga

Returer

Recipient
Recipient

Hämta fil efter ID

Åtgärds-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Hämtar information om en viss fil.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga
Fil-ID
 file-id True string

ID:t för filen i fråga

Returer

File
File

Hämta fil-URL efter ID

Åtgärds-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Hämtar URL:en till en viss fil.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga
Fil-ID
 file-id True string

ID:t för filen i fråga
Som objekt
 asObject boolean

Definierar om svaret är ett objekt

Returer

Name Sökväg Typ Description
URL
 url string

Fil-URL

Hämta filer efter dokument-ID

Åtgärds-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Hämtar alla filer som är anslutna till ett visst dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga

Returer

response
array of File

Hämta flödestillstånd efter kuvert-ID

Åtgärds-ID:
GetFlowsFlowIdJobsEnvelopeId

Hämtar aktuellt flödestillstånd för ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Flödes-ID
 flow-id True string

ID för flödet i fråga

Returer

Name Sökväg Typ Description
Bevis
 token string

Hämta företag efter ID

Åtgärds-ID:
GetCompaniesCompanyId

Hämtar information om ett visst företag.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 company-id True string

ID:t för det aktuella företaget

Returer

Företag
Company

Hämta kuvert med ID

Åtgärds-ID:
GetEnvelopesEnvelopeId

Hämtar information om ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga

Returer

Kuvert
Envelope

Hämta standardbeskrivning

Åtgärds-ID:
GetEnvelopeDescriptorsDefault

Hämtar standardbeskrivningen för kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Filterar
 filters string

Filtrera fråga för att välja undermontering

Returer

Deskriptor
Descriptor

Lägg till fil i dokumentet

Åtgärds-ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Lägger till en fil i ett befintligt dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga
Namn
 name True string
FileType
 fileType True string
Hash
 hash string

Returer

File
File

Lägg till mottagare i kuvertet

Åtgärds-ID:
PostEnvelopesEnvelopeIdRecipients

Lägger till en mottagare i ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Förnamn
 givenName True string
Efternamn
 familyName True string
Language
 language True string
Signeringsmetod
 signingMethod True string
Meddelandemetod
 notificationMethod string
E-post
 email True string
Telefon
 telephone string

Formatet ska vara +<countryCode-telefonnummer><>
Beställning
 order integer
Åtgärd
 action True string

Verifierat namn på åtgärden som en mottagare ska utföra.
Etikett
 label True string

Etikett för en mottagares roll/åtgärd
Namn
 name True string

Verifierat namn på en mottagares roll
Säkerställa
 secure boolean
SMS
 sms boolean
personnummer
 ssn string
Bank
 bank string

Lägga till dokument i kuvert

Åtgärds-ID:
PostEnvelopesEnvelopeIdDocuments

Lägger till ett nytt dokument i ett befintligt kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Hash
 hash integer
Namn
 name True string
Källa
 source string

Skapa kuvert – beskrivning

Åtgärds-ID:
PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Skapar ett kuvert baserat på en specifik beskrivning.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvertbeskrivnings-ID
 envelope-descriptor-id True string

ID för kuvertbeskrivningen
E-postmeddelande
 email string
Förnamn
 givenName string
Efternamn
 familyName string
Automatiska påminnelser
 automaticReminders number
Expiration
 expiration string
Hash
 hash string

Returer

Name Sökväg Typ Description
uid
 uid string

Skapa kuvert – standard

Åtgärds-ID:
PostEnvelopeDescriptorsDefaultEnvelopes

Skapar ett nytt kuvert med standardbeskrivningen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
E-postmeddelande
 email string
Förnamn
 givenName string
Efternamn
 familyName string
Automatiska påminnelser
 automaticReminders number
Expiration
 expiration string
Hash
 hash string

Returer

Name Sökväg Typ Description
uid
 uid string

Skapa signaturlänk

Åtgärds-ID:
PostEnvelopesEnvelopeIdJobsGetSignLink

Skapar en signaturlänk. Implementeringen är flödesspecifik och kan saknas för ditt specifika flöde.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Id
 id string
Omdirigera till
 redirectTo uri

Fullständig URL för att omdirigera användaren till efter inloggningen.

Returer

Name Sökväg Typ Description
URL
 getSignLink.recipient.{recipient-id}.url string

Skicka meddelande

Åtgärds-ID:
PostEnvelopesEnvelopIdJobsSendNotification

Skickar ett meddelande till mottagare av ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Hälsning
 greeting string
Mottagar-ID
 id True string

ID:t för mottagaren som meddelandet ska skickas till.

Sök i alla kuvert

Åtgärds-ID:
GetSearchEnvelopes

Sök igenom alla kuvert som matchar ett visst filter.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Filterar
 filters string

Filtrera fråga för att välja undermontering
Från
 from integer

Från datum
Limit
 limit integer

Begränsa belopp
Sortera
 sort string

Sortera efter

Returer

response
array of EnvelopeDescriptorString

Ta bort dokument efter ID

Åtgärds-ID:
DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Tar bort ett visst dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Dokument-ID
 document-id True string

ID för dokumentet i fråga

Ta bort kuvert med ID

Åtgärds-ID:
DeleteEnvelopesEnvelopeId

Tar bort ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga

Uppdatera kuvertinställningar

Åtgärds-ID:
PutEnvelopesEnvelopeId

Uppdaterar Inställningar för ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Sekventiell signering
 sequentialSigning boolean
Hälsning
 greeting string
Expiration
 expiration date

Datum i följande format 2017-02-26T21:59:59.999Z
Automatiska påminnelser
 automaticReminders number

X dagar före förfallodatum

Uppdatera mottagaren efter ID

Åtgärds-ID:
PutEnvelopesEnvelopeIdRecipientsRecipientId

Uppdaterar en mottagare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Mottagar-ID
 recipient-id True string

ID:t för mottagarna i fråga
Förnamn
 givenName True string
Efternamn
 familyName True string
Language
 language True string
Signeringsmetod
 signingMethod True string
Meddelandemetod
 notificationMethod string
E-post
 email True string
Telefon
 telephone string

Formatet ska vara +<countryCode-telefonnummer><>
Beställning
 order integer
Åtgärd
 action True string

Verifierat namn på åtgärden som en mottagare ska utföra.
Etikett
 label True string

Etikett för en mottagares roll/åtgärd
Namn
 name True string

Verifierat namn på en mottagares roll
Säkerställa
 secure boolean
SMS
 sms boolean
personnummer
 ssn string
Bank
 bank string

Uppdatera publiceringsstatus för kuvert

Åtgärds-ID:
PutEnvelopesEnvelopeIdPublishStatus

Uppdaterar publiceringsstatusen för ett visst kuvert.

Parametrar

Name Nyckel Obligatorisk Typ Description
Bevis
 token True string

Token som tagits emot från åtgärden Generera säkerhetstoken
Företags-ID
 x-namespace string

Företags-ID:t som ska användas för åtgärden. Formatera /företag/<företags-ID>. Standardinställningar för företags-ID för anslutningar om det inte har angetts.
Kuvert-ID
 envelope-id True string

Id för kuvertet i fråga
Publicerad
 published True boolean

Definitioner

Inställning

Name Sökväg Typ Description
Global
 global string
Signatoriskt språk
 preferences.signatoryLanguage string
Hälsning
 preferences.greeting string
Signeringsmetod
 preferences.signingMethod string
Påminnelseförskjutning
 preferences.reminderOffset string

Användarinfo

Name Sökväg Typ Description
Förnamn
 givenName string
Efternamn
 familyName string
E-postmeddelande
 email string
Language
 metadata.language string
Lösenord saknas
 missingPassword boolean
Är aktiverad
 isEnabled boolean
Namespace
 namespace string
Enabled
 enabled boolean
UID
 uid string
Id
 id string
Roller
 roles array of Role
Validated
 validated boolean

Företag

Name Sökväg Typ Description
Namn
 name string
Reg. Nummer
 regNumber string
Skapades
 created string
Modifierad
 modified string
Address
 address string
City
 city string
Postnummer
 zipCode string
Logotyp
 logo string
Country
 country string
Uid
 uid string
Id
 id string

Recipient

Name Sökväg Typ Description
UID
 uid string

UID för mottagare
Namespace
 namespace string

Namnområde för mottagare
Skapades
 created string

Mottagaren har skapats
Role
 role RoleActionString
Efternamn
 familyName string

Mottagarens efternamn
Förnamn
 givenName string

Mottagarens fristnamn
Language
 language string

Mottagarspråk
E-postmeddelande
 email string

E-postmottagare
Signeringsmetod
 signingMethod string

Methid för mottagarsignering
Meddelandemetod
 notificationMethod string
Beställning
 order integer

Mottagarordning
Id
 id string

Mottagar-ID
Modifierad
 modified string

Mottagaren har ändrats
Anmälda
 notified boolean
Slutfört
 completed boolean
demandAttachment
 demandAttachment boolean
personnummer
 ssn string
Bank
 bank string
Säkerställa
 secure boolean
SMS
 sms boolean
Telefon
 telephone string
Signaturer
 signatures object
Notifications
 notifications array of Notification

Role

Name Sökväg Typ Description
Typ
 action.type string
metoder
 action.methods array of string
Etikett
 label string

Etikett
Num. Max
 numMax integer

Num. Max
Num. Min
 numMin integer

Num. Min
Rollnamn
 roleName string

RoleActionString

Name Sökväg Typ Description
Åtgärd
 action ActionString

Åtgärd
Etikett
 label string

Etikett
Num. Max
 numMax integer

Num. Max
Num. Min
 numMin integer

Num. Min
Rollnamn
 roleName string

ActionString

Åtgärd

Åtgärd

Åtgärd
string

Kuvert

Name Sökväg Typ Description
Id
 id string

Kuvert-ID
UID
 uid string

UID för kuvert
Namespace
 namespace string

Namnområde för kuvert
Utgåva
 version integer

Kuvertversion
Publicerad
 published boolean

Kuvert publicerat
Complete
 completed boolean

Kuvertet har slutförts
Avbröts
 aborted boolean

Kuvert avorterat
Papperskorgen
 trashed boolean

Kuvert i papperskorgen
Sekventiell signering
 sequentialSigning boolean
Autmatiska påminnelser
 automaticReminders integer
Skapades
 created string

Kuvert skapat
Modifierad
 modified string

Kuvertet har ändrats
Upphörd
 expired boolean

Kuvertet har upphört att gälla
Flow
 flow Flow
Deskriptor
 descriptor Descriptor
Person
 sender Person
Documents
 documents array of Document
Mottagare
 recipients array of Recipient
Etiketter
 tags array of object
Ägare
 owners array of Person

EnvelopeDescriptorString

Name Sökväg Typ Description
Id
 id string

Kuvert-ID
UID
 uid string

UID för kuvert
Namespace
 namespace string

Namnområde för kuvert
Utgåva
 version integer

Kuvertversion
Publicerad
 published boolean

Kuvert publicerat
Complete
 completed boolean

Kuvertet har slutförts
Avbröts
 aborted boolean

Kuvert avorterat
Papperskorgen
 trashed boolean

Kuvert i papperskorgen
Sekventiell signering
 sequentialSigning boolean
Autmatiska påminnelser
 automaticReminders integer
Skapades
 created string

Kuvert skapat
Modifierad
 modified string

Kuvertet har ändrats
Upphörd
 expired boolean

Kuvertet har upphört att gälla
Flow
 flow Flow
Deskriptor
 descriptor string

Kuvertbeskrivning
Person
 sender Person
Documents
 documents array of Document
Mottagare
 recipients array of Recipient
Etiketter
 tags array of object
Ägare
 owners array of Person

File

Name Sökväg Typ Description
Id
 id string

Fil-ID
URL
 url string

Fil-URL
Namn
 name string

Filnamn
Mime-typ
 mimeType string
Filtyp
 fileType string
Lagringssökväg
 storagePath string
Uppladdad vid
 uploadedAt string
Skapades
 created string

Fil skapad
Ägare
 owners array of object
UID
 owners.uid string

UID för filägare
Id
 owners._id string

Filägar-ID
Namespace
 namespace string
UID
 uid string

Fil-UID

Flow

Name Sökväg Typ Description
Id
 id string

Flödes-ID
Namn
 name string

Flödesnamn

Deskriptor

Name Sökväg Typ Description
Namn
 name string

Beskrivningsnamn
Utgåva
 version integer

Beskrivningsversion
UID
 uid string

Beskrivande UID
Borttagen
 deleted boolean

Descriptor-borttagning
Public
 public boolean

Beskrivande offentlig
Upphörd
 expired boolean

Beskrivningen har upphört att gälla
Id
 id string

Beskrivnings-ID
Mandatory
 mandatory boolean

Obligatorisk deskriptor
Etikett
 label string

Beskrivningsetikett
Typ
 type string

Beskrivningstyp
Roller
 roles array of Role
Ägare
 owners array of Person
Flow
 flow Flow
defaultValues
 defaultValues DefaultValues

defaultValues
Tillfällen
 instances array of object

Person

Name Sökväg Typ Description
UID
 uid string

Person-UID
Förnamn
 givenName string

Personens förnamn
Efternamn
 familyName string

Personens efternamn
E-postmeddelande
 email string

E-post för person
Language
 language string

Personspråk
Beställning
 order integer

Personbeställning

Dokument

Name Sökväg Typ Description
Etikett
 label string

Dokumentetikett
Typ
 type string

Dokumenttyp
Hash
 hash integer

Dokumenthash
Num. Max
 numMax integer

Dokumentnummer. Max
Num. Min
 numMin integer

Dokumentnummer. Min
UID
 uid string

Dokument-UID
Namespace
 namespace string

Dokumentnamnområde
Källa
 source string

Dokumentkälla
Skapades
 created string

Dokumentet har skapats
Namn
 name string

Dokumentnamn
Id
 id string

Dokument-ID
Modifierad
 modified string

Dokumentet har ändrats
Avvisad
 rejected boolean

Dokumentet avvisades
Undertecknad
 signed boolean

Signerat dokument
Papperskorgen
 trashed boolean

Dokument i papperskorgen
Avbröts
 aborted boolean

Dokumentet avbröts
Utgåva
 version integer

Dokumentversion
attachments
 attachments array of Attachment
Flow
 flow Flow
roles
 roles array of Role
Template
 template Template
Deskriptor
 descriptor Descriptor
Signaturer
 signatures array of Signature

Attachment

Name Sökväg Typ Description
Etikett
 label string

Etikett för bifogad fil
Num. Max
 numMax integer

Num för bifogad fil. Max
Num. Min
 numMin integer

Bifogad fil Num.Min
Hash
 hash integer

Hash för bifogade filer

Template

Name Sökväg Typ Description
Typ
 type string

Malltyp
HTML
 html string
PDFHTML
 pdfHtml string
Id
 id string
UID
 uid string
Namespace
 namespace string
Utgåva
 version integer
Skapades
 created string
Modifierad
 modified string
Modifierad
 published boolean
Slutfört
 completed boolean
Avbröts
 aborted boolean

Signature

Name Sökväg Typ Description
ID-nummer
 id string
Ursprung
 origin string
Förnamn
 givenName string

Förnamn
Efternamn
 familyName string

Efternamn
E-postmeddelande
 email string

E-postmeddelande
IP
 ip string
Date
 date string
Läge
 status string
Comment
 comment string

DefaultValues

defaultValues

Name Sökväg Typ Description
Person
 signer Person
Person
 reviewer Person

Notification

Name Sökväg Typ Description
ID-nummer
 id string
UID
 uid string
Namespace
 namespace string
Läge
 status string
Beställning
 order integer
Detaljer
 details object
Date
 date string