Skip to main content

Simple text signing

About this feature​

Simple text signing lets you capture a lightweight, binding confirmation from an end-user after they authenticate with an eID method. The signature is produced without a full document-based signing ceremony. Instead, the system records the authenticated end-user's identity together with the text they agreed to.

How it works​

  1. You create a signing session specifying that the session uses simple text signing.
  2. The end-user is redirected to authenticate with one of the supported eID methods.
  3. Optional: Some values can be prefilled and shown to the end-user.
  4. The end-user reviews the text you supplied in the session request.
  5. The end-user confirms their consent.
  6. The API returns a signed result object that includes the agreed text, signing metadata and identity information.

Core API elements​

Create signing session request​

When you create a signing session, add the relevant parameters to the request body in your HTTP POST request to the Signing sessions endpoint. These parameters determine what the end-user sees and how the flow behaves.

Example fields you can include:

  • Parameters that enable simple text signing
  • Optional prefill configuration
  • Optional UI configuration

Prefilling (optional)​

Simple text signing supports prefilling of login-related fields when the end-user authenticates. Currently this applies to the national identification number (NIN) only.

When enabled, additional login hints are collected from the authentication step. Prefilled values are shown to the end-user as part of the simple text signing screen. Prefill content varies by eID method, depending on what each method exposes.

You can enable this behaviour through an optional parameter in your signing session request:

"signer": {
      "nationalIdentificationNumber": "12345678910",
      "prefill": [
        "NATIONAL_IDENTIFICATION_NUMBER"
      ]
    }

User interface behaviour​

You can specify two optional UI parameters that let you adjust how the flow appears.

Hide welcome screen (optional)​

When hideWelcomeScreen is set to true, the welcome screen is not shown. The end-user is taken directly to the content that needs to be signed.

To hide the welcome screen, include the following in your signing session request:

"ui": {
  "hideWelcomeScreen": true
}

Minimal text mode (optional)​

When minimalTextMode is set to true, a stripped down version of sign UI is shown. Note that this only works if only a single plain/text document is included in the signing session.

To use minimal text mode, include the following in your signing session request:

"ui": {
  "minimalTextMode": true
}

Signed result format​

After the user confirms the simple text, the API returns a signed result object that includes:

  • The text that was signed
  • Metadata about the signing
  • Details retrieved from the authentication method
  • Identity attributes available from the eID provider

Response example​

"signatures": [
      {
        "resultDocumentId": "019a3001-8f98-7e84-bb28-162a2c9059c5",
        "resultArchiveId": "id here" // if sendSigningResultsToArchive
        "originalDocumentId": "019a2ff4-cab0-7a61-b74e-dff3e9b2c18a",
        "signatureType": "XADES"
      }
    ],
On this page