DigitalSignatureOptions

Options for creating a digital signature on a PDF document.

A digital signature requires a certificate (PFX/P12 file) to cryptographically sign the document. Additional metadata such as signer name, reason, and location can optionally be included. For PAdES-T compliance, configure a to include a trusted timestamp.

from nutrient import DigitalSignatureOptions

Methods

set_certificate_password 

def set_certificate_password(self, value: str) -> None

Sets the password to decrypt the PFX/P12 certificate file.

Parameters:

NameTypeDescription
valuestrThe value to set for the CertificatePassword property.

set_certificate_path 

def set_certificate_path(self, value: str) -> None

Sets the file path to the PFX/P12 certificate file.

Parameters:

NameTypeDescription
valuestrThe value to set for the CertificatePath property.

set_contact_info 

def set_contact_info(self, value: str) -> None

Sets contact information for the signer.

Parameters:

NameTypeDescription
valuestrThe value to set for the ContactInfo property.

set_hash_algorithm 

def set_hash_algorithm(self, value: SignatureHashAlgorithm) -> None

Sets the hash algorithm to use for the signature.

Parameters:

NameTypeDescription
valueSignatureHashAlgorithmThe value to set for the HashAlgorithm property.

set_location 

def set_location(self, value: str) -> None

Sets the location where the document was signed.

Parameters:

NameTypeDescription
valuestrThe value to set for the Location property.

set_reason 

def set_reason(self, value: str) -> None

Sets the reason for signing the document.

Parameters:

NameTypeDescription
valuestrThe value to set for the Reason property.

set_signer_name 

def set_signer_name(self, value: str) -> None

Sets the name of the person or entity signing the document.

Parameters:

NameTypeDescription
valuestrThe value to set for the SignerName property.

set_timestamp 

def set_timestamp(self, value: TimestampConfiguration) -> None

Sets optional timestamp configuration for PAdES-T compliance.

Parameters:

NameTypeDescription
valueTimestampConfigurationThe value to set for the Timestamp property.

Properties

certificate_password 

@property
def certificate_password(self) -> str

Gets the password to decrypt the PFX/P12 certificate file.

Type: str

Read-only property.

certificate_path 

@property
def certificate_path(self) -> str

Gets the file path to the PFX/P12 certificate file.

Type: str

Read-only property.

contact_info 

@property
def contact_info(self) -> str

Gets contact information for the signer.

Type: str

Read-only property.

hash_algorithm 

@property
def hash_algorithm(self) -> SignatureHashAlgorithm

Gets the hash algorithm to use for the signature.

Type: SignatureHashAlgorithm

Read-only property.

location 

@property
def location(self) -> str

Gets the location where the document was signed.

Type: str

Read-only property.

reason 

@property
def reason(self) -> str

Gets the reason for signing the document.

Type: str

Read-only property.

signer_name 

@property
def signer_name(self) -> str

Gets the name of the person or entity signing the document.

Type: str

Read-only property.

timestamp 

@property
def timestamp(self) -> TimestampConfiguration

Gets optional timestamp configuration for PAdES-T compliance.

Type: TimestampConfiguration

Read-only property.