Udostępnij przez

PKIsigning (wersja zapoznawcza)

Zautomatyzuj potrzeby podpisywania dokumentów za pomocą łącznika platformy PKIsigning. Wysyłanie dokumentów do platformy PKIsigning; wysyła zaproszenia i pobiera podpisane dokumenty.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Obsługa PKIsigning
adres URL https://pkisigning.nl/support
Email support@pkisigning.nl
Metadane łącznika
Publisher SBRS B.V.
Witryna internetowa https://pkisigning.nl
Zasady ochrony prywatności https://pkisigning.nl/privacy
Kategorie Kolaboracja; Produktywność

PKIsigning umożliwia organizacjom automatyzowanie, upraszczanie i zabezpieczanie procesu zatwierdzania, podpisywania i wysyłania dokumentów do klientów i osób trzecich. Platforma obsługuje wszystkie osobiste certyfikaty podpisywania eIDAS od holenderskich kwalifikowanych zaufanych dostawców usług i jest ISO27001 certyfikowany. Dzięki temu PKIsigning jest idealnym partnerem dla organizacji prawnych, finansowych i opieki zdrowotnej oraz instytucji rządowych. Połącz się z usługą PKisigning, aby zautomatyzować, uprościć i zabezpieczyć proces podpisywania dokumentów.

Wymagania wstępne

Aby korzystać z łącznika PKIsigning, konto platformy PKIsigning jest wymagane w ramach subskrypcji "professional". Skontaktuj się z dostawcą PKIsigning , aby zarejestrować się w celu uzyskania płatnej subskrypcji.

Jak uzyskać poświadczenia

Po zarejestrowaniu się w celu uzyskania subskrypcji użytkownicy otrzymają wiadomość e-mail z zaproszeniem do skonfigurowania konta. Po zarejestrowaniu tego konta można używać bezpośrednio z tym łącznikiem.

Wprowadzenie do łącznika

Domyślny przepływ uruchamiania dokumentów podpisywania jest następujący:

  1. Tworzenie dokumentacji
  2. Dodawanie dokumentów
  3. Dodawanie aktorów
  4. Uruchamianie przepływu pracy
  5. Użyj wyzwalacza, aby otrzymywać powiadomienia o zmianach stanu
  6. Pobierz dokumentację

Dokumentacji

PKIsigning oczekuje, że zawsze należy najpierw utworzyć dokumentację. Dokumentacja działa jako kontener dokumentów i podmiotów. Dokumentację można utworzyć za pomocą akcji Dossiers_Create. Po utworzeniu dokumentacji użyj zwróconego identyfikatora PkisId jako odwołania do przyszłych akcji.

Documents

Po utworzeniu dokumentacji można dodać dokumenty z akcją Documents_Add przy użyciu poprawnego identyfikatora dossierId. Akcja nie wymaga żadnych innych parametrów, ponieważ są one rozpraszane od samych plików dokumentów. Nie ma limitu liczby dokumentów w dokumentacji. Wszystkie dokumenty będą widoczne i można je pobrać dla wszystkich dodanych aktorów.

Ważne: dokument wymaga co najmniej jednego unikatowego symbolu zastępczego tekstowego, w zależności od liczby podpisów, aby wskazać, gdzie należy umieścić podpis i przez jakiego aktora. Może to być dowolny tekst w dowolnym miejscu w dokumencie. Podczas dodawania aktorów można zdefiniować symbol zastępczy za pomocą parametru symbolu zastępczego. Np. signature1, signature2 itp.

Actors

Trzeci krok polega na dodawaniu aktorów do dokumentów. Odbywa się to za pomocą akcji Actor_Create przy użyciu poprawnego identyfikatora dokumentacji i identyfikatora documentId.

Uruchamianie przepływu pracy

Aby rozpocząć przepływ pracy i skutecznie wysłać zaproszenia do wszystkich podmiotów w celu podpisania lub pobrania dokumentów w podanej kolejności, użyj akcji Dossiers_StartWorkflow z prawidłowym identyfikatorem dossierId.

Użyj wyzwalacza, aby otrzymywać powiadomienia o zmianach stanu

Aby uzyskać dokument po jego podpisaniu, zasubskrybuj powiadomienia przy użyciu wyzwalacza. Aby otrzymywać powiadomienie o stanie, określ wartość "status" w polu Zdarzenia.

Pobierz dokumentację

Gdy wyzwalacz zostanie powiadomiony o aktualizacji stanu, sprawdź, czy stan dokumentu to "Ukończono". W tej chwili można pobrać wszystkie dokumenty w dokumentacji w jednym pliku zipfile. Jeśli zostanie określona w ustawieniach platformy PKIsigning, która powinna zostać wygenerowana inspekcja, zostanie również uwzględniona.

Znane problemy i ograniczenia

W tej chwili publikacji nie są znane żadne problemy.

Typowe błędy i środki zaradcze

Brak aktualizacji stanu za pośrednictwem wyzwalacza

Jeśli wyzwalacz nie odpowiada na aktualizacje stanu, sprawdź, czy wartość "status" została podana w polu Zdarzenia.

Błąd HTTP 402 — wymagana płatność

Platforma PKIsigning wymaga środków do wykonywania akcji. Po dodaniu podmiotów środki są zarezerwowane w celu zapewnienia, że akcja może się odbyć, a zaproszenia nie są skonfrontowane z problemami dotyczącymi niewystarczającej liczby dostępnych środków. Jeśli wiele zaproszeń jest wysyłanych do aktorów, może się zdarzyć, że pakiet kredytowy nie ma więcej środków do zastrzegowania. W tej chwili zostanie zwrócony błąd HTTP 402.

Aby rozwiązać ten problem, PKIsigning support to top-up saldo środków lub oczyścić wszelkie niewykonane dokumentacje z aktorami w koszu na platformie. Niewykorzystane środki staną się następnie ponownie dostępne.

Często zadawane pytania

Zobacz naszą bazę wiedzy lub skontaktuj się z nami pod adresem support@pkisigning.nl

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie aktora

Zmienia dane określonego aktora.
Aktualizowanie dokumentu

Zmienia dane dla określonego dokumentu.
Aktualizuj żądanie

Zmienia dane dla określonego żądania.
Pobieranie danych aktora

Zwraca wszystkie dane dla określonego aktora.
Pobieranie danych aktora według dokumentu

Zwraca wszystkie dane wszystkich aktorów dla określonego dokumentu.
Pobieranie danych aktora według żądania

Zwraca wszystkie dane wszystkich aktorów dla określonego żądania.
Pobieranie danych dokumentu

Zwraca wszystkie (meta)dane dla określonego dokumentu.
Pobieranie danych żądania

Zwraca wszystkie (meta)dane dla określonego żądania.
Pobieranie grup roboczych dla organizacji

Zwraca listę wszystkich grup roboczych dla określonej organizacji.
Pobieranie grup roboczych dla użytkownika

Zwraca listę wszystkich grup roboczych dla określonego użytkownika określonej organizacji.
Tworzenie aktora

Tworzy nowego aktora i dodaje go do dokumentu.
Tworzenie dokumentu

Tworzy nowy dokument i dodaje go do określonego żądania.
Usuwanie aktora

Trwale usuwa określonego aktora.
Usuwanie dokumentu

Trwale usuwa określony dokument.
Usuwanie żądania

Trwale usuwa określone żądanie.
Utwórz żądanie

Utwórz nowe żądanie.
Wycofuj zaproszenie

Wycofuje zaproszenie dla bieżącego aktora w kolejce do określonego żądania.
Wyślij ponownie zaproszenie

Ponownie wysyła zaproszenie dla bieżącego aktora w kolejce do określonego żądania.
Wyślij żądanie

Uruchamia przepływ pracy i wysyła zaproszenie do pierwszego aktora w wierszu dla określonego żądania.
Żądanie pobrania

Pobiera żądania i jego zawartość jako plik .zip.

Aktualizowanie aktora

Identyfikator operacji:
Actors_Update

Zmienia dane określonego aktora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.
Identyfikator aktora
 actorId True guid

Unikatowy identyfikator aktora.
Akcja
 action True string

Akcja, którą musi wykonać aktor.
Imię
 firstname True string

Imię aktora.
Prefiks
 prefix string

Prefiks aktora.
Nazwisko
 lastname True string

Nazwisko aktora.
Adres e-mail
 email True string

Adres e-mail aktora.
Numer telefonu komórkowego
 mobile True string

Numer telefonu komórkowego aktora.
Deadline
 deadline True date-time

Data i godzina wykonania akcji przez aktora.
Język
 language True string

Język zaproszenia.
Używanie silnej weryfikacji
 validateRealIdentity True boolean

Użyj silniejszej metody identyfikacji dla tego aktora.
dossierPersonId
 dossierPersonId integer
komunikat
 message string

Zwraca

Body
ExtendedSignerModel

Aktualizowanie dokumentu

Identyfikator operacji:
Documents_Update

Zmienia dane dla określonego dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.
Nazwa dokumentu
 name string

Nazwa określonego dokumentu
Nazwa pliku dokumentu
 filename string

Nazwa pliku dla określonego dokumentu
Rodzaj dokumentu
 documentType True string

Typ określonego dokumentu. (Np. zwykły plik PDF, oświadczenie fiskalne, raport audytorów itp.).

Zwraca

Ogólne metadane dokumentu

Body
DocumentMetaDataModel

Aktualizuj żądanie

Identyfikator operacji:
Requests_Update

Zmienia dane dla określonego żądania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Nazwa żądania
 name True string

Nazwa określonego żądania.
Identyfikator grupy roboczej
 workgroupId guid

Unikatowy identyfikator grupy roboczej.
Poziom odprawy zabezpieczeń
 clearancelevel True integer

Poziom odprawy zabezpieczeń dla określonego żądania.
Zażądaj właściciela
 owner email

Użytkownik będący właścicielem określonego żądania.

Zwraca

Body
RequestModel

Pobieranie danych aktora

Identyfikator operacji:
Actors_Get

Zwraca wszystkie dane dla określonego aktora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.
Identyfikator aktora
 actorId True guid

Unikatowy identyfikator aktora.

Zwraca

Body
ExtendedSignerModel

Pobieranie danych aktora według dokumentu

Identyfikator operacji:
Actors_List

Zwraca wszystkie dane wszystkich aktorów dla określonego dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.
Ukończono akcję
 hasActed boolean

Zwraca tylko aktorów, którzy mają lub nie ukończyli swojej akcji, pozostaw pole puste, aby zwrócić wszystkich aktorów.

Zwraca

response
array of ExtendedSignerModel

Pobieranie danych aktora według żądania

Identyfikator operacji:
Actors_RequestActors

Zwraca wszystkie dane wszystkich aktorów dla określonego żądania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Czy aktor działał na żądanie
 hasActed boolean

Wartość tylko do odczytu, aby sprawdzić, czy aktor działał już w dokumencie.

Zwraca

response
array of ExtendedSignerModel

Pobieranie danych dokumentu

Identyfikator operacji:
Documents_Get

Zwraca wszystkie (meta)dane dla określonego dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.

Zwraca

Ogólne metadane dokumentu

Body
DocumentMetaDataModel

Pobieranie danych żądania

Identyfikator operacji:
Requests_Get

Zwraca wszystkie (meta)dane dla określonego żądania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Klucz uwierzytelniania
 callbackAuthenticationKey string

Klucz uwierzytelniania dostarczony przez wyzwalacz.

Zwraca

Body
RequestModel

Pobieranie grup roboczych dla organizacji

Identyfikator operacji:
Organisations_GetWorkgroups

Zwraca listę wszystkich grup roboczych dla określonej organizacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator organizacji
 organisationId True guid

Unikatowy identyfikator organizacji.

Zwraca

response
array of OrganisationWorkgroup

Pobieranie grup roboczych dla użytkownika

Identyfikator operacji:
Organisations_GetWorkgroupsByUser

Zwraca listę wszystkich grup roboczych dla określonego użytkownika określonej organizacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator organizacji
 organisationId True guid

Unikatowy identyfikator organizacji.
Nazwa użytkownika
 username True email

Adres e-mail użytkownika

Zwraca

response
array of OrganisationWorkgroup

Tworzenie aktora

Identyfikator operacji:
Actors_Create

Tworzy nowego aktora i dodaje go do dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.
Akcja
 action True string

Akcja, którą musi wykonać aktor.
Imię
 firstname True string

Imię aktora.
Prefiks
 prefix string

Prefiks aktora.
Nazwisko
 lastname True string

Nazwisko aktora.
Adres e-mail
 email True string

Adres e-mail aktora.
Numer telefonu komórkowego
 mobile True string

Numer telefonu komórkowego aktora.
Deadline
 deadline True date-time

Data i godzina wykonania akcji przez aktora.
Język
 language True string

Język zaproszenia.
Używanie silnej weryfikacji
 validateRealIdentity True boolean

Użyj silniejszej metody identyfikacji dla tego aktora.
dossierPersonId
 dossierPersonId integer
komunikat
 message string
Pole podpisywania
 fieldName string

Nazwa istniejącego pola podpisywania w dokumencie dla tego aktora do podpisania.
Placeholder
 placeholder string

Tekst określonego symbolu zastępczego w dokumencie, w którym aktor musi umieścić podpis.

Zwraca

Body
ExtendedSignerModel

Tworzenie dokumentu

Identyfikator operacji:
Documents_Create

Tworzy nowy dokument i dodaje go do określonego żądania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania, do którego będzie należeć ten dokument.
File
 file True file

Plik do przetworzenia (tylko określone typy plików).

Zwraca

Ogólne metadane dokumentu

Body
DocumentMetaDataModel

Usuwanie aktora

Identyfikator operacji:
Actors_Delete

Trwale usuwa określonego aktora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.
Identyfikator aktora
 actorId True guid

Unikatowy identyfikator aktora.

Usuwanie dokumentu

Identyfikator operacji:
Documents_Delete

Trwale usuwa określony dokument.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.
Identyfikator dokumentu
 documentId True guid

Unikatowy identyfikator dokumentu.

Usuwanie żądania

Identyfikator operacji:
Requests_Delete

Trwale usuwa określone żądanie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.

Utwórz żądanie

Identyfikator operacji:
Requests_Create

Utwórz nowe żądanie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa żądania
 name True string

Nazwa określonego żądania.
Identyfikator grupy roboczej
 workgroupId guid

Unikatowy identyfikator grupy roboczej.
Poziom odprawy zabezpieczeń
 clearancelevel True integer

Poziom odprawy zabezpieczeń dla określonego żądania.
Zażądaj właściciela
 owner email

Użytkownik będący właścicielem określonego żądania.

Zwraca

Body
RequestModel

Wycofuj zaproszenie

Identyfikator operacji:
Actors_WithdrawCurrentInvite

Wycofuje zaproszenie dla bieżącego aktora w kolejce do określonego żądania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.

Wyślij ponownie zaproszenie

Identyfikator operacji:
Actors_ResendCurrentInvite

Ponownie wysyła zaproszenie dla bieżącego aktora w kolejce do określonego żądania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.

Wyślij żądanie

Identyfikator operacji:
Requests_Send

Uruchamia przepływ pracy i wysyła zaproszenie do pierwszego aktora w wierszu dla określonego żądania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.

Żądanie pobrania

Identyfikator operacji:
Requests_Download

Pobiera żądania i jego zawartość jako plik .zip.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
 requestId True guid

Unikatowy identyfikator żądania.

Zwraca

response
file

Wyzwalacze

Gdy zdarzenie występuje w żądaniu

Zarejestruj adres URL wywołania zwrotnego podczas zmiany stanu. Platforma PKIsigning zgłosi wszelkie informacje o stanie aktualizacji dokumentacji w tej organizacji do tego adresu URL.

Gdy zdarzenie występuje w żądaniu

Identyfikator operacji:
Webhooks_CreateWebhook

Zarejestruj adres URL wywołania zwrotnego podczas zmiany stanu. Platforma PKIsigning zgłosi wszelkie informacje o stanie aktualizacji dokumentacji w tej organizacji do tego adresu URL.

Parametry

Nazwa Klucz Wymagane Typ Opis
Typy zdarzeń
 Events True array of string

Lista typów zdarzeń występujących na żądanie, których ten wyzwalacz zostanie powiadomiony
Identyfikator organizacji
 organisationId True guid

Unikatowy identyfikator organizacji.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator żądania
 PkisId guid

Unikatowy identyfikator żądania.
Stan żądania
 DossierStatus string

Status dokumentacji.
Przyczyna
 Reason string

Przyczyna zmiany.
Klucz uwierzytelniania
 AuthenticationKey string

Nagłówek umożliwiający uzyskanie metadanych w żądaniu.

Definicje

ExtendedSignerModel

Nazwa Ścieżka Typ Opis
Pole podpisywania
 fieldName string

Nazwa istniejącego pola podpisywania w dokumencie dla tego aktora do podpisania.
Placeholder
 placeholder string

Tekst określonego symbolu zastępczego w dokumencie, w którym aktor musi umieścić podpis.
Akcja
 action string

Akcja, którą musi wykonać aktor.
Imię
 firstname string

Imię aktora.
Prefiks
 prefix string

Prefiks aktora.
Nazwisko
 lastname string

Nazwisko aktora.
Adres e-mail
 email string

Adres e-mail aktora.
Numer telefonu komórkowego
 mobile string

Numer telefonu komórkowego aktora.
Deadline
 deadline date-time

Data i godzina wykonania akcji przez aktora.
Język
 language string

Język zaproszenia.
Używanie silnej weryfikacji
 validateRealIdentity boolean

Użyj silniejszej metody identyfikacji dla tego aktora.
dossierPersonId
 dossierPersonId integer
komunikat
 message string
Identyfikator aktora
 id guid

Unikatowy identyfikator określonego aktora.
Data ukończenia
 signingDate date-time

Data i godzina wykonania akcji przez aktora.
Ukończono akcję
 hasSigned boolean
Imię i nazwisko
 fullName string

Połączone imię, prefiks i nazwisko aktora.
Informacje o stanie
 emailActivity array of EmailActivity

Informacje o stanie dotyczące procesu wykonywania akcji przez aktora.
documentId
 documentId guid

EmailActivity

Metadane wiadomości e-mail wysyłane do aktora

Nazwa Ścieżka Typ Opis
Aktywność poczty e-mail
 event string

Działanie poczty e-mail dla określonego żądania i aktora.
Informacje SMTP
 reason string

Informacje SMTP dotyczące wiadomości e-mail wysłanej do określonego aktora w ramach żądania.
Data wiadomości e-mail
 timestamp date-time

Data wysłania wiadomości e-mail do określonego aktora w ramach żądania.
Typ wiadomości e-mail
 pkisMessageType string

Wpisz wiadomość e-mail wysłaną do określonego aktora w ramach żądania (np. Zaproś, Przypomnienie itp.).
Identyfikator żądania e-mail
 pkisInviteId string

Unikatowy identyfikator wiadomości e-mail wysłanej do określonego aktora w ramach żądania.
Adres e-mail
 email string

Adres e-mail wiadomości e-mail wysłany do określonego aktora w ramach żądania.

SignerModel

Specjalny typ aktora

Nazwa Ścieżka Typ Opis
Akcja
 action string

Akcja, którą musi wykonać aktor.
Imię
 firstname string

Imię aktora.
Prefiks
 prefix string

Prefiks aktora.
Nazwisko
 lastname string

Nazwisko aktora.
Adres e-mail
 email string

Adres e-mail aktora.
Numer telefonu komórkowego
 mobile string

Numer telefonu komórkowego aktora.
Deadline
 deadline date-time

Data i godzina wykonania akcji przez aktora.
Język
 language string

Język zaproszenia.
Używanie silnej weryfikacji
 validateRealIdentity boolean

Użyj silniejszej metody identyfikacji dla tego aktora.
dossierPersonId
 dossierPersonId integer
komunikat
 message string
Pole podpisywania
 fieldName string

Nazwa istniejącego pola podpisywania w dokumencie dla tego aktora do podpisania.
Placeholder
 placeholder string

Tekst określonego symbolu zastępczego w dokumencie, w którym aktor musi umieścić podpis.

DocumentMetaDataModel

Ogólne metadane dokumentu

Nazwa Ścieżka Typ Opis
Nazwa dokumentu
 name string

Nazwa określonego dokumentu.
Ostatnia aktualizacja dokumentu
 lastUpdate date-time

Data ostatniej aktualizacji określonego dokumentu.
Liczba stron dokumentów
 pages integer

Liczba stron dla określonego dokumentu.
Data utworzenia dokumentu
 created date-time

Data utworzenia określonego dokumentu.
Identyfikator dokumentu
 id guid

Unikatowy identyfikator dokumentu.
Stan dokumentu
 status string

Stan określonego dokumentu. (np. nowe, ukończone itp.).
Dokument zawiera podpis
 signed boolean

Wskazuje, czy określony dokument zawiera już jeden lub więcej podpisów.
Podpisy dokumentów
 signatures array of SignatureData

Lista wszystkich podpisów dla określonego dokumentu.
Pola pustego podpisu dokumentu
 emptySignatureFields array of SignatureField

Lista wszystkich pustych pól podpisu dla określonego dokumentu.
Puste pola podpisu
 containsBlankSignatureFields boolean

Wskazuje, czy określony dokument zawiera puste pola podpisu.
Aktorzy dokumentów
 actors array of ExtendedSignerModel

Lista wszystkich aktorów dla określonego dokumentu.
Identyfikator żądania
 requestId guid

Unikatowy identyfikator żądania.
Indeks żądania
 dossierIndex integer

Indeks wszystkich dokumentów należących do określonego żądania.
documentSize
 documentSize integer

Rozmiar dokumentu należącego do określonego żądania.
documentType
 documentType string

Typ dokumentu należącego do określonego żądania.

SignatureData

Nazwa Ścieżka Typ Opis
Pola podmiotu certyfikatu
 subject array of KeyValuePairOfStringAndString

Pola z wiersza tematu certyfikatu używanego do określonego podpisu.
Pola wystawcy certyfikatu
 issuer array of KeyValuePairOfStringAndString

Pola z wiersza wystawcy certyfikatu używanego do określonego podpisu.
Data podpisu
 date date-time

Data i godzina umieszczenia określonego podpisu.
Lokalizacja podpisywania
 location string

Lokalizacja geograficzna określonego aktora w momencie podpisania.
Przyczyna podpisania
 reason string

Przyczyna podpisania jako podana przez określonego aktora w momencie podpisania.
Kwalifikowany podpis elektroniczny
 euQualified boolean

Wskazuje, czy określony podpis jest kwalifikowany (QeS) zgodny z przepisami eIDAS.
Zaawansowany podpis elektroniczny
 advanced boolean

Wskazuje, czy określony podpis jest zaawansowany (AeS) zgodny z przepisami eIDAS.
Kwalifikowana eSeal
 eSeal boolean

Wskazuje, czy określony certyfikat używany do podpisywania lub uszczelniania to kwalifikowane przepisy eIDAS zgodne ze standardem eIDAS.
Adres IP aktora
 ipAddress string

Adres IP określonego aktora
Pole podpisu
 signatureField string

Pole, które zostało podpisane
Obraz podpisu
 signatureImage string

Plik obrazu, który został użyty do określonego podpisu wybranego przez aktora.

KeyValuePairOfStringAndString

Nazwa Ścieżka Typ Opis
klucz
 key string
value
 value string

SignatureField

Nazwa Ścieżka Typ Opis
Nazwa pola podpisu
 name string

Nazwa określonego pola podpisu
Strona pola podpisu
 page integer

Strona, na której znajduje się określone pole podpisu dla określonego dokumentu.
Współrzędna szerokości pola podpisu
 x double

Szerokość pozycji dla określonego pola podpisu względem strony, która jest umieszczana w określonym dokumencie.
Współrzędna wysokiej wartości pola podpisu
 y double

Wysoka wartość pozycji dla określonego pola podpisu względem strony, która jest umieszczana w określonym dokumencie.
Wysoki poziom pola podpisu
 height double

Wysoka wartość dla określonego pola podpisu.
Szerokość pola podpisu
 width double

Wartość szerokości dla określonego pola podpisu.

OrganizacjaWorkgroup

Grupa robocza używana w dokumentacji

Nazwa Ścieżka Typ Opis
Identyfikator grupy roboczej
 id guid

Unikatowy identyfikator grupy roboczej
Nazwa grupy roboczej
 name string

Nazwa określonej grupy roboczej

RequestModel

Nazwa Ścieżka Typ Opis
Identyfikator żądania
 id guid

Unikatowy identyfikator żądania
Nazwa żądania
 dossierName string

Nazwa określonego żądania.
Żądanie dokumentów
 documents array of DocumentModel

Lista dokumentów zawartych w tym żądaniu.
Stan żądania
 status string

Stan określonego żądania. (np. nowe, ukończone itp.).
Żądaj aktorów
 actors array of ExtendedSignerModel

Lista wszystkich aktorów dla określonego żądania.
Podpisy dokumentów
 signatures array of SignatureData

Lista wszystkich podpisów dla określonego żądania.
Typ żądania
 dossierType string

Typ określonego żądania. (E.g. PDF, SBR Assurance itp.).
Przyczyna anulowania
 reasons string

Przyczyna anulowania określonego żądania przez użytkownika lub aktora.
Notatka osoby podpisającego
 signerNote string

Zwróć uwagę na co najmniej jeden aktor, który nie ma innej akcji niż znak.
Notatka adresata
 recipientNote string

Zwróć uwagę na co najmniej jeden aktor, który nie ma innej akcji niż pobieranie.
Notatka osoby zatwierdzającej
 accorderNote string

Zwróć uwagę na co najmniej jeden aktor, który nie ma innej akcji niż zatwierdzanie żądania.
Data wygaśnięcia żądania
 expires date-time

Data i godzina wygaśnięcia określonego żądania.
Informacje o stanie
 emailActivity array of EmailActivity

Informacje o stanie dotyczące procesu wykonywania akcji przez aktora.
Moje żądanie
 myDossier boolean

Wskazuje, czy jesteś właścicielem określonego żądania.
Identyfikator grupy roboczej
 workgroup guid

Unikatowy identyfikator grupy roboczej.
Poziom odprawy zabezpieczeń
 clearancelevel integer

Poziom odprawy zabezpieczeń dla określonego żądania.

DocumentModel

Nazwa Ścieżka Typ Opis
Identyfikator dokumentu
 id guid

Unikatowy identyfikator dokumentu
Nazwa dokumentu
 name string

Nazwa określonego dokumentu
Rodzaj dokumentu
 documentType string

Wpisz określony dokument.
Indeks żądania
 dossierIndex integer

Indeks wszystkich dokumentów należących do określonego żądania.
Stan dokumentu
 documentstatus string

Stan określonego dokumentu. (np. nowe, ukończone itp.).
Aktorzy dokumentów
 actors array of SignerModel

Lista wszystkich aktorów dla określonego dokumentu.

plik

Jest to podstawowy typ danych "file".