PkIsigning (anteprima)
Automatizzare le esigenze di firma dei documenti con il connettore della piattaforma PKIsigning. Inviare documenti alla piattaforma PKIsigning; inviare inviti e recuperare i documenti firmati.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Supporto di pkIsigning |
| URL | https://pkisigning.nl/support |
| support@pkisigning.nl |
| Metadati del connettore | |
|---|---|
| Editore | SBRS B.V. |
| Sito web | https://pkisigning.nl |
| Informativa sulla privacy | https://pkisigning.nl/privacy |
| Categorie | Collaborazione; Produttività |
PkIsigning consente alle organizzazioni di automatizzare, semplificare e proteggere il processo di approvazione, firma e invio di documenti a clienti e terze parti. La piattaforma supporta tutti i certificati di firma personale eIDAS dei provider di servizi attendibili qualificati olandesi ed è ISO27001 certificato. Questo rende pkisigning un partner ideale per organizzazioni legali, finanziarie e sanitarie e governi. Connettersi con PKisigning per automatizzare, semplificare e proteggere il processo di firma dei documenti.
Prerequisiti
Per usare il connettore PKIsigning, è necessario un account per la piattaforma PKIsigning all'interno di una sottoscrizione "professionale". Contattare PKIsigning per registrarsi per una sottoscrizione a pagamento.
Come ottenere le credenziali
Dopo la registrazione per una sottoscrizione, gli utenti riceveranno un messaggio di posta elettronica con un invito a configurare il proprio account. Dopo la registrazione, tale account può essere usato direttamente con questo connettore.
Introduzione al connettore
Il flusso predefinito per avviare la firma dei documenti è il seguente:
- Creare un dossier
- Aggiungere documenti
- Aggiungere attori
- Avviare il flusso di lavoro
- Usare un trigger per ricevere una notifica delle modifiche di stato
- Scaricare il dossier
Fascicoli
PKIsigning prevede di creare sempre un dossier. Un dossier funge da contenitore per documenti e attori. È possibile creare un dossier con l'azione Dossiers_Create. Dopo aver creato un dossier, usare il pkisId restituito come riferimento per le azioni future.
Documents
Dopo aver creato un dossier, è possibile aggiungere documenti con l'azione Documents_Add utilizzando il dossierId corretto. L'azione non richiede altri parametri perché sono distratti dai file di documento stessi. Non esiste alcun limite per il numero di documenti in un dossier. Tutti i documenti saranno visualizzabili e scaricabili per tutti gli attori aggiunti.
Importante: il documento necessita di uno o più segnaposto testuali univoci, a seconda del numero di firme, per indicare dove deve essere inserita una firma e da quale attore. Può trattarsi di qualsiasi testo in qualsiasi posizione del documento. Quando si aggiungono attori, è possibile definire il segnaposto con il parametro segnaposto. Ad esempio: firma1, firma2 e così via...
Actors
Il terzo passaggio consiste nell'aggiungere attori ai documenti. Questa operazione viene eseguita con l'azione Actor_Create usando il dossierId e documentId corretti.
Avviare il flusso di lavoro
Per avviare un flusso di lavoro e inviare in modo efficace inviti a tutti gli attori a firmare o scaricare documenti nell'ordine specificato, usare l'azione Dossiers_StartWorkflow con il dossierId corretto.
Usare un trigger per ricevere una notifica delle modifiche di stato
Per ottenere il documento dopo la firma, sottoscrivere le notifiche usando un trigger. Per ricevere la notifica sullo stato, specificare "status" nel campo Eventi.
Scaricare il dossier
Quando il trigger riceve una notifica di un aggiornamento dello stato, verificare se lo stato del documento è "Completato". A partire da quel momento, è possibile scaricare tutti i documenti nel dossier in un unico file ZIP. Se è specificato nelle impostazioni all'interno della piattaforma PKIsigning che deve essere generato un audittrail, verrà incluso anche questo.
Problemi noti e limitazioni
Nessun problema è noto al momento della pubblicazione.
Errori e rimedi comuni
Nessun aggiornamento dello stato tramite trigger
Se il trigger non risponde agli aggiornamenti dello stato, verificare se il valore 'status' è stato specificato nel campo Eventi.
Errore HTTP 402 Pagamento richiesto
La piattaforma PKIsigning richiede crediti per eseguire azioni. Quando gli attori vengono aggiunti, i crediti sono riservati per garantire che l'azione possa essere eseguita e che gli invitati non siano confrontati con problemi relativi a un numero insufficiente di crediti disponibili. Se un sacco di inviti vengono inviati agli attori, può verificarsi che il bundle di credito non abbia più crediti lasciati per essere riservati. In quel momento, verrà restituito un errore HTTP 402.
Per risolvere il problema, l'assegnazione del supporto pkIsigning per il saldo del credito o la pulizia di eventuali dossier non inviati con attori nel cestino sulla piattaforma. I crediti inutilizzati saranno quindi nuovamente disponibili.
Domande frequenti
Consultare la knowledge base o contattarci all'indirizzo support@pkisigning.nl
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiornare il documento |
Modifica i dati per un documento specifico. |
| Aggiornare l'attore |
Modifica i dati per un attore specifico. |
| Creare un attore |
Crea un nuovo attore e lo aggiunge a un documento. |
| Creare un documento |
Crea un nuovo documento e lo aggiunge a una richiesta specifica. |
| Creare una richiesta |
Creare una nuova richiesta. |
| Elimina documento |
Elimina definitivamente un documento specifico. |
| Eliminare l'attore |
Elimina definitivamente un attore specifico. |
| Eliminare una richiesta |
Elimina definitivamente una richiesta specifica. |
| Invia richiesta |
Avvia il flusso di lavoro e invia un invito al primo attore in linea per una richiesta specifica. |
| Inviare di nuovo l'invito |
Invia nuovamente l'invito per l'attore corrente in linea per una richiesta specifica. |
| Ottenere gruppi di lavoro per l'organizzazione |
Restituisce un elenco di tutti i gruppi di lavoro per un'organizzazione specifica. |
| Ottenere gruppi di lavoro per l'utente |
Restituisce un elenco di tutti i gruppi di lavoro per un utente specifico di un'organizzazione specifica. |
| Ottenere i dati del documento |
Restituisce tutti i dati (meta)per un documento specifico. |
| Ottenere i dati dell'attore |
Restituisce tutti i dati per un attore specifico. |
| Ottenere i dati dell'attore in base al documento |
Restituisce tutti i dati di tutti gli attori per un documento specifico. |
| Ottenere i dati dell'attore per richiesta |
Restituisce tutti i dati di tutti gli attori per una richiesta specifica. |
| Ottenere i dati della richiesta |
Restituisce tutti i dati (meta)per una richiesta specifica. |
| Richiesta di aggiornamento |
Modifica i dati per una richiesta specifica. |
| Richiesta di download |
Scarica una richiesta e il relativo contenuto come file .zip. |
| Ritirare l'invito |
Ritira l'invito per l'attore corrente in linea per una richiesta specifica. |
Aggiornare il documento
Modifica i dati per un documento specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
|
Nome documento
|
name | string |
Nome di un documento specifico |
|
|
Nome file di documento
|
filename | string |
Nome file per un documento specifico |
|
|
Tipo di documento
|
documentType | True | string |
Tipo per un documento specifico. (ad esempio, PDF regolare, dichiarazione fiscale, report revisori e così via). |
Restituisce
Metadati generali del documento
- Corpo
- DocumentMetaDataModel
Aggiornare l'attore
Modifica i dati per un attore specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
|
ID attore
|
actorId | True | guid |
ID univoco di un attore. |
|
Action
|
action | True | string |
Azione che l'attore deve eseguire. |
|
Nome di battesimo
|
firstname | True | string |
Nome dell'attore. |
|
Prefisso
|
prefix | string |
Prefisso dell'attore. |
|
|
Cognome
|
lastname | True | string |
Cognome dell'attore. |
|
Indirizzo di posta elettronica
|
True | string |
Indirizzo di posta elettronica dell'attore. |
|
|
Numero di cellulare
|
mobile | True | string |
Numero di telefono cellulare dell'attore. |
|
Deadline
|
deadline | True | date-time |
Data e ora di esecuzione dell'azione da parte dell'attore. |
|
Language
|
language | True | string |
Lingua per l'invito. |
|
Usare la verifica avanzata
|
validateRealIdentity | True | boolean |
Usare un metodo di identificazione più efficace per questo attore. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string |
Restituisce
- Corpo
- ExtendedSignerModel
Creare un attore
Crea un nuovo attore e lo aggiunge a un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
|
Action
|
action | True | string |
Azione che l'attore deve eseguire. |
|
Nome di battesimo
|
firstname | True | string |
Nome dell'attore. |
|
Prefisso
|
prefix | string |
Prefisso dell'attore. |
|
|
Cognome
|
lastname | True | string |
Cognome dell'attore. |
|
Indirizzo di posta elettronica
|
True | string |
Indirizzo di posta elettronica dell'attore. |
|
|
Numero di cellulare
|
mobile | True | string |
Numero di telefono cellulare dell'attore. |
|
Deadline
|
deadline | True | date-time |
Data e ora di esecuzione dell'azione da parte dell'attore. |
|
Language
|
language | True | string |
Lingua per l'invito. |
|
Usare la verifica avanzata
|
validateRealIdentity | True | boolean |
Usare un metodo di identificazione più efficace per questo attore. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string | ||
|
Campo di firma
|
fieldName | string |
Nome di un campo di firma esistente nel documento per il quale l'attore deve firmare. |
|
|
Placeholder
|
placeholder | string |
Testo di un segnaposto specifico nel documento in cui l'attore deve inserire una firma. |
Restituisce
- Corpo
- ExtendedSignerModel
Creare un documento
Crea un nuovo documento e lo aggiunge a una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta a cui appartiene il documento. |
|
File
|
file | True | file |
File da elaborare (solo tipi di file specifici). |
Restituisce
Metadati generali del documento
- Corpo
- DocumentMetaDataModel
Creare una richiesta
Creare una nuova richiesta.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome della richiesta
|
name | True | string |
Nome per una richiesta specifica. |
|
ID gruppo di lavoro
|
workgroupId | guid |
ID univoco di un gruppo di lavoro. |
|
|
Livello di autorizzazione di sicurezza
|
clearancelevel | True | integer |
Livello di autorizzazione di sicurezza per una richiesta specifica. |
|
Richiedi proprietario
|
owner |
Utente proprietario di una richiesta specifica. |
Restituisce
- Corpo
- RequestModel
Elimina documento
Elimina definitivamente un documento specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
Eliminare l'attore
Elimina definitivamente un attore specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
|
ID attore
|
actorId | True | guid |
ID univoco di un attore. |
Eliminare una richiesta
Elimina definitivamente una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
Invia richiesta
Avvia il flusso di lavoro e invia un invito al primo attore in linea per una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
Inviare di nuovo l'invito
Invia nuovamente l'invito per l'attore corrente in linea per una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
Ottenere gruppi di lavoro per l'organizzazione
Restituisce un elenco di tutti i gruppi di lavoro per un'organizzazione specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID organizzazione
|
organisationId | True | guid |
ID univoco di un'organizzazione. |
Restituisce
- response
- array of OrganisationWorkgroup
Ottenere gruppi di lavoro per l'utente
Restituisce un elenco di tutti i gruppi di lavoro per un utente specifico di un'organizzazione specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID organizzazione
|
organisationId | True | guid |
ID univoco di un'organizzazione. |
|
Nome utente
|
username | True |
Indirizzo di posta elettronica dell'utente |
Restituisce
- response
- array of OrganisationWorkgroup
Ottenere i dati del documento
Restituisce tutti i dati (meta)per un documento specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
Restituisce
Metadati generali del documento
- Corpo
- DocumentMetaDataModel
Ottenere i dati dell'attore
Restituisce tutti i dati per un attore specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
|
ID attore
|
actorId | True | guid |
ID univoco di un attore. |
Restituisce
- Corpo
- ExtendedSignerModel
Ottenere i dati dell'attore in base al documento
Restituisce tutti i dati di tutti gli attori per un documento specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
ID documento
|
documentId | True | guid |
ID univoco di un documento. |
|
Azione completata
|
hasActed | boolean |
Restituisce solo gli attori che hanno o non hanno completato l'azione, lasciare vuoto per restituire tutti gli attori. |
Restituisce
- response
- array of ExtendedSignerModel
Ottenere i dati dell'attore per richiesta
Restituisce tutti i dati di tutti gli attori per una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
L'attore ha agito sulla richiesta
|
hasActed | boolean |
Valore di sola lettura per verificare se un attore ha già agito sul documento. |
Restituisce
- response
- array of ExtendedSignerModel
Ottenere i dati della richiesta
Restituisce tutti i dati (meta)per una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
Chiave di autenticazione
|
callbackAuthenticationKey | string |
Chiave di autenticazione fornita dal trigger. |
Restituisce
- Corpo
- RequestModel
Richiesta di aggiornamento
Modifica i dati per una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
|
Nome della richiesta
|
name | True | string |
Nome per una richiesta specifica. |
|
ID gruppo di lavoro
|
workgroupId | guid |
ID univoco di un gruppo di lavoro. |
|
|
Livello di autorizzazione di sicurezza
|
clearancelevel | True | integer |
Livello di autorizzazione di sicurezza per una richiesta specifica. |
|
Richiedi proprietario
|
owner |
Utente proprietario di una richiesta specifica. |
Restituisce
- Corpo
- RequestModel
Richiesta di download
Scarica una richiesta e il relativo contenuto come file .zip.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
Restituisce
- response
- file
Ritirare l'invito
Ritira l'invito per l'attore corrente in linea per una richiesta specifica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID richiesta
|
requestId | True | guid |
ID univoco di una richiesta. |
Trigger
| Quando si verifica un evento in una richiesta |
Registrare un URL per il callback in caso di modifica dello stato. La piattaforma PKIsigning segnala tutti gli aggiornamenti dello stato dei dossier all'interno di questa organizzazione all'URL. |
Quando si verifica un evento in una richiesta
Registrare un URL per il callback in caso di modifica dello stato. La piattaforma PKIsigning segnala tutti gli aggiornamenti dello stato dei dossier all'interno di questa organizzazione all'URL.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Tipi di evento
|
Events | True | array of string |
Elenco di tipi di evento che si verificano in una richiesta di cui il trigger riceverà una notifica |
|
ID organizzazione
|
organisationId | True | guid |
ID univoco di un'organizzazione. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID richiesta
|
PkisId | guid |
ID univoco di una richiesta. |
|
Stato della richiesta
|
DossierStatus | string |
Stato del dossier. |
|
Motivo
|
Reason | string |
Motivo della modifica. |
|
Chiave di autenticazione
|
AuthenticationKey | string |
Intestazione per ottenere i metadati nella richiesta. |
Definizioni
ExtendedSignerModel
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Campo di firma
|
fieldName | string |
Nome di un campo di firma esistente nel documento per il quale l'attore deve firmare. |
|
Placeholder
|
placeholder | string |
Testo di un segnaposto specifico nel documento in cui l'attore deve inserire una firma. |
|
Action
|
action | string |
Azione che l'attore deve eseguire. |
|
Nome di battesimo
|
firstname | string |
Nome dell'attore. |
|
Prefisso
|
prefix | string |
Prefisso dell'attore. |
|
Cognome
|
lastname | string |
Cognome dell'attore. |
|
Indirizzo di posta elettronica
|
string |
Indirizzo di posta elettronica dell'attore. |
|
|
Numero di cellulare
|
mobile | string |
Numero di telefono cellulare dell'attore. |
|
Deadline
|
deadline | date-time |
Data e ora di esecuzione dell'azione da parte dell'attore. |
|
Language
|
language | string |
Lingua per l'invito. |
|
Usare la verifica avanzata
|
validateRealIdentity | boolean |
Usare un metodo di identificazione più efficace per questo attore. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
ID attore
|
id | guid |
ID univoco di un attore specifico. |
|
Data di completamento
|
signingDate | date-time |
Data e ora in cui l'attore ha eseguito l'azione. |
|
Azione completata
|
hasSigned | boolean | |
|
Nome completo
|
fullName | string |
Nome combinato, prefisso e cognome dell'attore. |
|
Informazioni sullo stato
|
emailActivity | array of EmailActivity |
Informazioni sullo stato sul processo di esecuzione dell'azione da parte dell'attore. |
|
documentId
|
documentId | guid |
EmailActivity
Metadati del messaggio di posta elettronica inviati a un attore
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Attività di posta elettronica
|
event | string |
Attività di posta elettronica per una richiesta e un attore specifici. |
|
Informazioni SMTP
|
reason | string |
Informazioni SMTP per un messaggio di posta elettronica inviato a un attore specifico come parte di una richiesta. |
|
Data e-mail
|
timestamp | date-time |
Data di invio di un messaggio di posta elettronica a un attore specifico come parte di una richiesta. |
|
Tipo di posta elettronica
|
pkisMessageType | string |
Digitare un messaggio di posta elettronica inviato a un attore specifico come parte di una richiesta (ad esempio Invito, Promemoria e così via). |
|
ID richiesta di posta elettronica
|
pkisInviteId | string |
ID univoco per un messaggio di posta elettronica inviato a un attore specifico come parte di una richiesta. |
|
Indirizzo di posta elettronica
|
string |
Indirizzo di posta elettronica per un messaggio di posta elettronica inviato a un attore specifico come parte di una richiesta. |
SignerModel
Tipo speciale di attore
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Action
|
action | string |
Azione che l'attore deve eseguire. |
|
Nome di battesimo
|
firstname | string |
Nome dell'attore. |
|
Prefisso
|
prefix | string |
Prefisso dell'attore. |
|
Cognome
|
lastname | string |
Cognome dell'attore. |
|
Indirizzo di posta elettronica
|
string |
Indirizzo di posta elettronica dell'attore. |
|
|
Numero di cellulare
|
mobile | string |
Numero di telefono cellulare dell'attore. |
|
Deadline
|
deadline | date-time |
Data e ora di esecuzione dell'azione da parte dell'attore. |
|
Language
|
language | string |
Lingua per l'invito. |
|
Usare la verifica avanzata
|
validateRealIdentity | boolean |
Usare un metodo di identificazione più efficace per questo attore. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
Campo di firma
|
fieldName | string |
Nome di un campo di firma esistente nel documento per il quale l'attore deve firmare. |
|
Placeholder
|
placeholder | string |
Testo di un segnaposto specifico nel documento in cui l'attore deve inserire una firma. |
DocumentMetaDataModel
Metadati generali del documento
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome documento
|
name | string |
Nome di un documento specifico. |
|
Ultimo aggiornamento del documento
|
lastUpdate | date-time |
Data dell'ultimo aggiornamento per un documento specifico. |
|
Numero di pagine documento
|
pages | integer |
Numero di pagine per un documento specifico. |
|
Data di creazione del documento
|
created | date-time |
Data di creazione per un documento specifico. |
|
ID documento
|
id | guid |
ID univoco di un documento. |
|
Stato documento
|
status | string |
Stato di un documento specifico. (ad esempio, nuovo, completato e così via). |
|
Il documento contiene la firma
|
signed | boolean |
Indica se un documento specifico contiene già una o più firme. |
|
Firme dei documenti
|
signatures | array of SignatureData |
Elenco di tutte le firme per un documento specifico. |
|
Documentare i campi di firma vuoti
|
emptySignatureFields | array of SignatureField |
Elenco di tutti i campi di firma vuoti per un documento specifico. |
|
Campi di firma vuoti
|
containsBlankSignatureFields | boolean |
Indica se un documento specifico contiene campi di firma vuoti. |
|
Attori del documento
|
actors | array of ExtendedSignerModel |
Elenco di tutti gli attori per un documento specifico. |
|
ID richiesta
|
requestId | guid |
ID univoco di una richiesta. |
|
Indice della richiesta
|
dossierIndex | integer |
Indice di tutti i documenti appartenenti a una richiesta specifica. |
|
documentSize
|
documentSize | integer |
Dimensioni di un documento appartenente a una richiesta specifica. |
|
documentType
|
documentType | string |
Tipo di documento appartenente a una richiesta specifica. |
SignatureData
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Campi oggetto certificato
|
subject | array of KeyValuePairOfStringAndString |
Campi dalla riga dell'oggetto del certificato utilizzato per una firma specifica. |
|
Campi autorità di certificazione
|
issuer | array of KeyValuePairOfStringAndString |
Campi dalla riga dell'autorità di certificazione del certificato utilizzato per una firma specifica. |
|
Data firma
|
date | date-time |
Data e ora in cui è stata inserita una firma specifica. |
|
Percorso di firma
|
location | string |
Posizione geografica di un attore specifico al momento della firma. |
|
Motivo della firma
|
reason | string |
Motivo della firma come fornito da un attore specifico al momento della firma. |
|
Firma elettronica qualificata
|
euQualified | boolean |
Indica se una firma specifica è qualificata (QeS) conforme alle normative eIDAS. |
|
Firma elettronica avanzata
|
advanced | boolean |
Indica se una firma specifica è conforme alle normative eIDAS (AeS). |
|
ESeal qualificato
|
eSeal | boolean |
Indica se un certificato specifico utilizzato per la firma o la chiusura è un regolamento eIDAS conforme qualificato. |
|
Indirizzo IP dell'attore
|
ipAddress | string |
Indirizzo IP per un attore specifico |
|
Campo Firma
|
signatureField | string |
Campo firmato |
|
Immagine della firma
|
signatureImage | string |
File di immagine usato per una firma specifica scelta da un attore. |
KeyValuePairOfStringAndString
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | string |
SignatureField
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome campo firma
|
name | string |
Nome per un campo di firma specifico |
|
Pagina del campo Firma
|
page | integer |
Pagina in cui viene inserito un campo di firma specifico per un documento specifico. |
|
Coordinata di larghezza campo firma
|
x | double |
Valore di larghezza della posizione per un campo di firma specifico relativo alla pagina in cui viene inserito in un documento specifico. |
|
Coordinata hight del campo della firma
|
y | double |
Valore elevato della posizione per un campo di firma specifico relativo alla pagina in cui viene inserito in un documento specifico. |
|
Altezza del campo della firma
|
height | double |
Valore massimo per un campo di firma specifico. |
|
Larghezza campo firma
|
width | double |
Valore di larghezza per un campo di firma specifico. |
OrganizationWorkgroup
Un gruppo di lavoro utilizzato all'interno di un dossier
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID gruppo di lavoro
|
id | guid |
ID univoco di un gruppo di lavoro |
|
Nome gruppo di lavoro
|
name | string |
Nome per un gruppo di lavoro specifico |
RequestModel
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID richiesta
|
id | guid |
ID univoco di una richiesta |
|
Nome della richiesta
|
dossierName | string |
Nome per una richiesta specifica. |
|
Richiedere documenti
|
documents | array of DocumentModel |
Elenco dei documenti inclusi in questa richiesta. |
|
Stato della richiesta
|
status | string |
Stato per una richiesta specifica. (ad esempio, nuovo, completato e così via). |
|
Richiedere attori
|
actors | array of ExtendedSignerModel |
Elenco di tutti gli attori per una richiesta specifica. |
|
Firme dei documenti
|
signatures | array of SignatureData |
Elenco di tutte le firme per una richiesta specifica. |
|
Tipo di richiesta
|
dossierType | string |
Tipo per una richiesta specifica. (E.g. PDF, SBR Assurance e così via). |
|
Motivo di annullamento
|
reasons | string |
Motivo dell'annullamento per una richiesta specifica da parte di un utente o di un attore. |
|
Nota del firmatario
|
signerNote | string |
Nota per uno o più attori che non dispongono di un'azione diversa dal segno. |
|
Nota destinatario
|
recipientNote | string |
Nota per uno o più attori che non hanno altre azioni rispetto al download. |
|
Nota del responsabile approvazione
|
accorderNote | string |
Nota per uno o più attori che non hanno altre azioni rispetto alla richiesta di approvazione. |
|
Data di scadenza della richiesta
|
expires | date-time |
Data e ora di scadenza per una richiesta specifica. |
|
Informazioni sullo stato
|
emailActivity | array of EmailActivity |
Informazioni sullo stato sul processo di esecuzione dell'azione da parte dell'attore. |
|
Richiesta personale
|
myDossier | boolean |
Indica se si è il proprietario di una richiesta specifica. |
|
ID gruppo di lavoro
|
workgroup | guid |
ID univoco di un gruppo di lavoro. |
|
Livello di autorizzazione di sicurezza
|
clearancelevel | integer |
Livello di autorizzazione di sicurezza per una richiesta specifica. |
DocumentModel
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID documento
|
id | guid |
ID univoco di un documento |
|
Nome documento
|
name | string |
Nome di un documento specifico |
|
Tipo di documento
|
documentType | string |
Digitare per un documento specifico. |
|
Indice della richiesta
|
dossierIndex | integer |
Indice di tutti i documenti appartenenti a una richiesta specifica. |
|
Stato documento
|
documentstatus | string |
Stato di un documento specifico. (ad esempio, nuovo, completato e così via). |
|
Attori del documento
|
actors | array of SignerModel |
Elenco di tutti gli attori per un documento specifico. |
documento
Si tratta del tipo di dati di base 'file'.