pdftools_sdk.sign.signature_configuration

Classes

SignatureConfiguration(handle)

Configuration for signature creation

class pdftools_sdk.sign.signature_configuration.SignatureConfiguration(handle)

Bases: _NativeObject

Configuration for signature creation

This configuration controls the signature creation in pdftools_sdk.sign.signer.Signer.sign() and pdftools_sdk.sign.signer.Signer.certify() .

Use a pdftools_sdk.crypto.providers.provider.Provider to create a signature configuration.

Note that this object can be re-used to sign multiple documents for mass-signing applications.

property field_name: str | None

The name of the existing signature field

The pdftools_sdk.pdf.signature_field.SignatureField.field_name of an existing, unsigned signature field to sign. Note that when an existing signature field is signed, the appearance’s position is defined by the existing field. Therefore, make sure the pdftools_sdk.sign.signature_configuration.SignatureConfiguration.appearance fits into the pdftools_sdk.pdf.signature_field.SignatureField.bounding_box .

If None a new signature field is created using a unique field name.

Default is None

Returns:

Optional[str]

Raises:

StateError – If the creating provider has already been closed

property appearance: Appearance | None

The visual appearance of the signature

The visual appearance or None to create a signature without a visual appearance.

Default is None

Returns:

Optional[pdftools_sdk.sign.appearance.Appearance]

Raises:

StateError – If the creating provider has already been closed

property name: str | None

The name of the signing certificate

Returns:

Optional[str]

Raises:

StateError – If the creating provider has already been closed

property location: str | None

The location of signing

The CPU host name or physical location of the signing.

Returns:

Optional[str]

Raises:

StateError – If the creating provider has already been closed

property reason: str | None

The reason for signing

Returns:

Optional[str]

Raises:

StateError – If the creating provider has already been closed

property contact_info: str | None

The contact information of the signer

Information provided by the signer to enable a recipient to contact the signer to verify the signature. For example, a phone number.

Returns:

Optional[str]

Raises:

StateError – If the creating provider has already been closed