Input

Nome

Descrizione

Tipo

Opzionale

serverAddress

Indirizzo server da un Dominio esterno (per il Dominio della sessione corrente, utilizzare nullo o vuoto).

String

Y

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

identityReference

Collegamento all'identità che deve firmare il documento.

Reference

verificationId

Identificativo di verifica dell'operazione di validazione della firma con OTP.

String

otpCode

Codice OTP che deve fornire l'utente per quel verificationID.

String

resourceReference

Collegamento alla risorsa contenente il file da firmare.

Può essere un riferimento ad un Attachment, un FileComponent, un allegato di processo, un Document o un'altra risorsa contenente attachments.

Se la risorsa è di tipo Document e contiene più componenti file viene utilizzato:

•il componente principale se è di tipo File;

•in assenza di componente principale, deve esserci un solo componente di tipo File.

Se la risorsa contiene una lista di attachments, deve esserci un solo file.

Reference

fieldMapping

Nome dei campi disponibili nella risorsa indirizzata da identityReference per valorizzare il cognome, il nome della identità e il codice fiscale della identità che firma. I nomi dei campi, di tipo testo, che è possibile specificare nel dato strutturato sono firstName, lastName, fiscalCode. Obbligatorio se si desidera apporre una firma visibile.

Dataset

Y

signatureReason

Testo che riporta il motivo della firma (ad es. "Per approvazione"), può essere valorizzato anche per firme non visibili.

String

Y

signatureLocation

Testo che riporta il luogo in cui viene apposta la firma, può essere valorizzato anche per firme non visibili.

String

Y

credentialsReference

Collegamento alle credenziali da utilizzare per individuare il certificato o con il pattern del nickName.

Reference

signatureSettings

Impostazioni per la firma visibile, può essere di tipo AdHocSignatureSettings o AutoplaceSignatureSettings. Obbligatorio se si desidera apporre una firma visibile.

SignatureSettings

testMode

True se è richiesta l'esecuzione del metodo in modalità test. Se non specificato, viene effettuata l'esecuzione del metodo in modalità live.

Boolean

Y

Output

Nome

Descrizione

Tipo

returnValue

Restituisce un dato strutturato che contiene i seguenti campi:

•SignedDocument: collegamento al documento firmato;

•EvidenceReport: collegamento al report di firma che riporta informazioni sul firmatario, il certificato ed il documento firmato;

•SignedDocumentName: stringa che riporta il nome completo del file firmato;

•EvidenceReportName:stringa che riporta il nome completo del report di firma.

In modalità test, la firma elettronica non viene applicata al documento e viene restituito in output il medesimo file di input. Viene comunque generato un report di firma con le informazioni valorizzabili.

Dataset

Restituisce

Condizione

Errore

PLUG_MissingIdentificationDocument

Se l'identità referenziata in identityReference non dispone di un documento di riconoscimento.

Errore

PLUG_InvalidIdentificationCode

Se l'identità referenziata in identityReference dispone di un documento di riconoscimento scaduto.

Errore

PLUG_MissingIdentificationCode

Se l'identità referenziata in identityReference non dispone del codice del documento di riconoscimento.

Errore

PLUG_MissingEmailAddress

Se l'identità referenziata in identityReference non dispone di un indirizzo email.

Errore

PLUG_InvalidEmailAddress

Se l'identità referenziata in identityReference dispone di un indirizzo email ma esso non è validato.

Errore

PLUG_MissingPhoneAddress

Se l'identità referenziata in identityReference non dispone di un recapito telefonico.

Errore

PLUG_InvalidPhoneAddress

Se l'identità referenziata in identityReference dispone di un recapito telefonico ma esso non è validato.

Errore

PLUG_Error

Se signatureType riporta un tipo di firma che non si applica al documento da firmare resourceReference.

Errore

PLUG_Error

Se signatureType è diverso da Pades, Xades o Cades.

Errore

PLUG_Error

Se è stato specificato il parametro verificationId e non otpCode.

Errore

PLUG_Error

Se è stato specificato il parametro otpCode e non verificationId.

Errore

PLUG_Error

Se il codice riportato in secretCode non è corretto.

Errore

PLUG_OtpCodeExpired

Se il codice OTP inserito è scaduto.

Errore

PLUG_Error

Se si vuole apporre una firma elettronica xades ad un file riportato in resourceReference su cui è già apposta una firma xades.

Errore

PLUG_Error

Se il file xml che si vuole firmare non è ben formato e la firma richiesta è di tipo xades.

Errore

Certificate beyond usability limit - PLUG_NotAllowedCertificate

Se il certificato di firma associato all'identità indicata nel parametro identityReference è scaduto o è valido, ma non usabile.

Errore

Se la firma è definita visibile e il parametro signatureType è valorizzato con una stringa diversa da Pades.