Electronic Signature Module

The Electronic Signature module handles eIDAS-aligned electronic signing flows: render documents to be signed, collect compliance consents, capture the signature, and finalize. Three variants exist: base AES, Advanced Electronic Signature (AE), and Qualified Electronic Signature (QE). All three share a single state machine and manager API.

This module follows the document-signing pattern.

Variants

ae-signature and qe-signature are thin wrappers around electronic-signature:

The wrappers hardcode variant: 'ae' or 'qe' and re-export the same state machine, state types, and helpers from the base module (AeSignatureState is ElectronicSignatureState, etc.).

Web components: <incode-electronic-signature>, <incode-ae-signature>, <incode-qe-signature>. All three import paths register their own tag and ship their own CSS.

// Base AES
import '@incodetech/web/electronic-signature';
import '@incodetech/web/electronic-signature/styles.css';

// Advanced Electronic Signature
import '@incodetech/web/ae-signature';
import '@incodetech/web/ae-signature/styles.css';

// Qualified Electronic Signature
import '@incodetech/web/qe-signature';
import '@incodetech/web/qe-signature/styles.css';

Properties

Configuration

type ElectronicSignatureConfig = {
  variant?: 'ae' | 'qe'; // Hardcoded by the AE/QE wrapper modules
  uploadDocument?: boolean;
  downloadDocument?: boolean;
  providerCode?: string;
  language?: string;
};

When the QE Signature module runs inside an SDK Flow, providerCode comes from the flow configuration and language comes from the active SDK locale. Set them directly only when creating a standalone manager.

Consent keys

The user must check all required consent boxes before signing. Each variant defines its own keys (re-exported from the variant's module):

const AE_CONSENT_KEYS = [
  'terms',
  'signElectronically',
  'signDisplayed',
] as const;

const QE_CONSENT_KEYS = [
  'issuance',
  'qesAcknowledgement',
  'qscdConfirmation',
  'termsAgreement',
  'documentsReviewed',
] as const;

const NAMIRIAL_QES_CONSENT_KEYS = ['providerTerm0', 'providerTerm1'] as const;

Helpers from @incodetech/core/electronic-signature (also re-exported from the AE/QE wrappers): getDefaultConsentChecks(variant) returns a fresh ConsentChecks map for the given variant ('ae' | 'qe'); areAllConsented(consents) returns whether every key in that map is checked.

For providerCode: 'QES_3', the SDK requests the certificate application and checkbox labels from the provider before loading documents. It renders exactly the two provider labels without adding SDK policy links. The user can open the provider's certificate application form in a plain-text viewer and must accept both statements before signing.

State machine

ElectronicSignatureState is a discriminated union over status:

The state.documents array (when populated) carries the ElectronicSignatureDocument[] to render: { documentRef, documentUrl }.

A few states carry additional fields beyond documents: uploading and reviewing add fileName (reviewing also adds fileUrl); signing adds variant, consentChecks, allConsented, providerTerms, viewingDocumentUrl, and viewingApplicationForm; success adds signedDocuments: { signed: boolean; signedDocumentUrl?: string }[] and downloadDocument. The base AES endpoint returns a signed URL immediately. Legacy QES returns only { success: true }; Namirial QES fetches the signed document collection after all documents are signed.

providerTerms.contractText can contain personal holder information. Treat it as ephemeral UI state: do not log, persist, or emit it as telemetry.

Error feedback

After narrowing state.status to error and signError, read state.errorMessage (string) for failure feedback. It can be empty, so provide a translated fallback. This field is only present in those error states; use the recovery actions below.

API methods

Plus the base lifecycle: subscribe, getState, stop. Unlike the face-capture and ID-capture managers, this manager has no reset() — create a new manager instance to start over.

See also

• Module: Signature: handwritten signature on canvas (no document review)
• Module Patterns → document-signing
• Individual Modules