This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/python/signing/digital-signature-options.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. DigitalSignatureOptions

DigitalSignatureOptions

Markdown version of this page, suitable for AI agents and automation

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 Timestamp to include a trusted timestamp.

from nutrient_sdk import DigitalSignatureOptions

Construction 

DigitalSignatureOptions()

Creates a new DigitalSignatureOptions instance with default settings.

Properties

certificate_password 

@property
def certificate_password(self) -> str


@certificate_password.setter
def certificate_password(self, value: str) -> None

The password to decrypt the PFX/P12 certificate file.

Type: str

certificate_path 

@property
def certificate_path(self) -> str


@certificate_path.setter
def certificate_path(self, value: str) -> None

The file path to the PFX/P12 certificate file.

Type: str

certificate_serial_number 

@property
def certificate_serial_number(self) -> str


@certificate_serial_number.setter
def certificate_serial_number(self, value: str) -> None

The serial number of the certificate to use from the operating-system certificate store or a smartcard. Required when KeySource is WindowsCertificateStore or SmartCard.

Type: str

certification 

@property
def certification(self) -> SignatureCertificationLevel


@certification.setter
def certification(self, value: SignatureCertificationLevel) -> None

The certification (DocMDP) level of the signature.

Type: SignatureCertificationLevel

contact_info 

@property
def contact_info(self) -> str


@contact_info.setter
def contact_info(self, value: str) -> None

Contact information for the signer.

Type: str

format 

@property
def format(self) -> SignatureFormat


@format.setter
def format(self, value: SignatureFormat) -> None

The container format of the signature.

Type: SignatureFormat

hash_algorithm 

@property
def hash_algorithm(self) -> SignatureHashAlgorithm


@hash_algorithm.setter
def hash_algorithm(self, value: SignatureHashAlgorithm) -> None

The hash algorithm to use for the signature.

Type: SignatureHashAlgorithm

key_source 

@property
def key_source(self) -> SignatureKeySource


@key_source.setter
def key_source(self, value: SignatureKeySource) -> None

Where the signing key and certificate come from.

Type: SignatureKeySource

level 

@property
def level(self) -> SignatureLevel


@level.setter
def level(self, value: SignatureLevel) -> None

The PAdES baseline level to produce.

Type: SignatureLevel

location 

@property
def location(self) -> str


@location.setter
def location(self, value: str) -> None

The location where the document was signed.

Type: str

pkcs11 

@property
def pkcs11(self) -> Pkcs11Options


@pkcs11.setter
def pkcs11(self, value: Pkcs11Options) -> None

The PKCS#11 module and key location. Required when KeySource is Pkcs11.

Type: Pkcs11Options

reason 

@property
def reason(self) -> str


@reason.setter
def reason(self, value: str) -> None

The reason for signing the document.

Type: str

signer_name 

@property
def signer_name(self) -> str


@signer_name.setter
def signer_name(self, value: str) -> None

The name of the person or entity signing the document.

Type: str

smart_card_pin 

@property
def smart_card_pin(self) -> str


@smart_card_pin.setter
def smart_card_pin(self, value: str) -> None

The PIN used to unlock a smartcard key. Used when KeySource is SmartCard.

Type: str

timestamp 

@property
def timestamp(self) -> TimestampConfiguration


@timestamp.setter
def timestamp(self, value: TimestampConfiguration) -> None

Optional timestamp configuration for PAdES-T compliance.

Type: TimestampConfiguration