Verifying eID (Personalausweis) (v1)

Deprecated

GERMAN_EID:v1 is deprecated. Use the Verifying eID (v2) step instead — it supports Personalausweis alongside other eID providers through a unified configuration. Migrate your existing flows to EIDS:v2.

Verifies a user's identity using Personalausweis via AusweisApp

Provides a secure verification option where users prove their identity through Personalausweis via the AusweisApp. Ideal for fast, trusted onboarding or identity verification processes with strong eIDAS assurance.

---

Key features

• eID-based authentication: Secure authentication using Personalausweis via the AusweisApp middleware.
• Seamless redirection: Redirects users to AusweisApp for login and returns them post-authentication.
• Configurable shortname: Links to a pre-configured DocIDV journey on the platform.

---

Configuration

Option	Type	Required	Default	Description
config	object	Yes	—	Environment-specific configuration.
config.live.shortname	string	Yes	—	German eID shortname for the environment (live or staging). Provided by IDnow during onboarding. (live)
config.staging.shortname	string	Yes	—	German eID shortname for the environment (live or staging). Provided by IDnow during onboarding. (staging)
inputSources	object	No	—	Maps upstream step IDs to input data blocks. See Input mapping.
inputSources.basicIdentity	string	No	—	ID of an upstream step whose BasicIdentity output should be forwarded for cross-checking.
enableRetry	boolean	No	false	When true, adds a retry output route that can be used to handle user cancellations.

Example configuration

{
  "config": {
    "live": { "shortname": "your-live-shortname" },
    "staging": { "shortname": "your-staging-shortname" }
  }
}

---

Input data blocks

Data block	Required	Description
BasicIdentity	Conditional	Identity data forwarded for cross-checking against the eID data. Present only when inputSources.basicIdentity is set.

---

Routes

Route	Description
verified	The user's identity has been successfully authenticated by Personalausweis. Identity data was extracted from the eID chip.
fraud_detected	Fraud was detected during the eID verification. No identity data is extracted — only the DocumentVerification data block is produced for audit purposes.
retry	Available only when enableRetry is true. User cancelled and can retry.

---

Output data blocks

Route	Data blocks produced
verified	BasicIdentity, ExtendedIdentity, DocumentData, DocumentVerification
fraud_detected	DocumentVerification
retry	DocumentVerification Available only when enableRetry is true.

Example payloads

BasicIdentity — verified

{
  "givenName": "Hans",
  "familyName": "Müller",
  "name": "Hans Müller",
  "birthDate": "1982-07-14",
  "birthPlace": "Berlin"
}

ExtendedIdentity — verified

{
  "portrait": {
    "$ref": "vault",
    "$id": "01960000-43d8-7000-8000-6814c0bdc35a"
  },
  "nationality": "DEU",
  "personalAdministrativeNumber": "T220001293",
  "familyNameBirth": "Müller",
  "givenNameBirth": "Hans",
  "sex": 1,
  "emailAddress": null,
  "mobilePhoneNumber": null,
  "residentAddress": "Unter den Linden 12 10117 Berlin Deutschland",
  "residentStreet": "Unter den Linden",
  "residentHouseNumber": "12",
  "residentHouseName": null,
  "residentCountry": "DE",
  "residentState": "Berlin",
  "residentCity": "Berlin",
  "residentPostalCode": "10117"
}

DocumentData — verified

{
  "documentType": "ID",
  "documentNumber": "T220001293",
  "expiryDate": "2031-03-14",
  "issuanceDate": "2021-03-15",
  "issuingCountry": "DE",
  "issuingAuthority": "Bürgeramt Berlin Mitte"
}

DocumentVerification — verified

{
  "verdict": {
    "status": "VERIFIED",
    "reason": null
  },
  "issues": [],
  "report": null,
  "evidences": []
}

---