DSSDK logo Document Scanner SDK

Licensing & trial Pixelnetica™ Document Scanning SDK for Apple iOS

DSSDK is a commercial SDK. A license key unlocks full output (no watermark) and the licensed features. This page covers getting a key, applying it, and checking it at runtime.

Getting a trial key

A free trial key is available from Pixelnetica — visit the Document Scanning SDK product page to request one. A license key is bound to a specific app bundle identifier, so request the trial for the bundle ID you build with.

Applying the license

Call PxLicense.initialize(withKey:) once, as early as possible in the app lifecycle (for example at launch). It returns a PxLicenseStatus. Passing nil deactivates any current license and runs in evaluation mode.

import DocScanningSDK

let status = PxLicense.initialize(withKey: myLicenseKey)
switch status {
case PxLicenseStatus_Active:
    break // Full functionality, no watermark.
default:
    // Evaluation mode — see below.
    break
}

Evaluation mode

If no active license is applied — no key, an invalid key, or an expired one — the SDK still works, but processed results are watermarked. This lets you evaluate the full pipeline before purchasing. Apply a valid key to remove the watermark.

Checking the status at runtime

PxLicense.initialize(withKey:) returns the current status, and PxLicense.info() exposes details about the active license. Useful members:

MemberMeaning
statusThe current PxLicenseStatus.
appIdThe bundle identifier the license is bound to.
clientNameThe license owner.
validTsUNIX timestamp the license is valid until (0xfffffff = unlimited).
validSubscriptionTsUNIX timestamp the update subscription is valid until.
featuresBitmask of licensed features (see below).

The PxLicenseStatus values cover the common failure cases — no key, a malformed key, a key bound to a different app (AppID_Mismatch) or platform, an expired license, and an expired update subscription — so you can show the user a precise message.

Feature gating

Some outputs are gated by license features (PxLicenseFeature): PNG export, TIFF export, PDF export, and OCR. The features bitmask on the active license tells you which are permitted; a full-featured license enables all of them.

Tips

  • Apply the license before you use any SDK functionality.
  • The license is tied to your bundle identifier — an AppID_Mismatch status usually means the key was issued for a different bundle ID.
  • Check the status at runtime rather than assuming success, and surface a clear message when it is not active.

Next steps

Top