eIDs

Authenticates users using a national electronic identity document

Used when businesses need to authenticate users through government-issued eID schemes. Supports multiple eID providers (e.g. France Identité, German eID) through a unified step, with routing to the appropriate provider managed by IDnow.

---

Key features

• Multi-provider support: Routes to the appropriate eID provider backend based on the user's selected method and your organisation's routing configuration.
• OIDC-based authentication: Authenticates users via OpenID Connect with the eID provider.
• Flexible method selection: Works with an upstream Verification method selector (v2) step, or can be pre-configured to a fixed method.
• Provider-agnostic flow: The flow definition carries no provider reference — routing is resolved at runtime by IDnow.

---

Configuration

Attribute	Type	Required	Description
preconfigure	object	No	Pre-selects a fixed eID method, bypassing the need for an upstream Verification method selector step. When present, the step uses this method directly instead of reading the user's selection from the flow context.
preconfigure.method	string	Yes (if preconfigure set)	The eID method to use. Accepted values: france_identite, personalausweis.
preconfigure.assuranceLevel	string	No	Required assurance level for the authentication. Accepted values: low, substantial, high.
preconfigure.trustFramework	string	No	Trust framework governing the assurance level. Accepted values: eidas.
enableRetry	boolean	No	When true, adds a retry output route that can be used to handle user cancellations. Defaults to false.

Without preconfigure, the step reads the user's eID method selection produced by an upstream VERIFICATION_METHOD_SELECTOR:v2 step. If neither preconfigure nor an upstream selector is present, the flow is misconfigured and will fail at runtime.

---

Example

With an upstream Verification method selector (recommended for multi-method flows):

{}

With preconfigure (single-method flows, no selector needed):

{
  "preconfigure": {
    "method": "france_identite",
    "assuranceLevel": "substantial",
    "trustFramework": "eidas"
  }
}

---

Input datablocks

Data block	Required	Description
eIDMethodSelection	No	Produced by an upstream VERIFICATION_METHOD_SELECTOR:v2 step when the user selects an eID method. Used to determine which provider to call. When absent, preconfigure must be set.

---

Verdicts

Verdict	Description
verified	The user's identity has been successfully authenticated by the eID provider. The OIDC flow completed and the provider returned a valid ID token with verified identity attributes.
not_verified	The authentication attempt failed. The identity could not be verified — for example, the user entered an incorrect PIN or the eID provider rejected the authentication request.

---

Output datablocks

Verdict	Data blocks produced
verified	BasicIdentity, ExtendedIdentity, AuthenticationResult
not_verified	AuthenticationResult

AuthenticationResult — verified

Field	Type	Description
result	string	Always "success".
provider	string	The eID provider used (e.g. "france_identite").
credentialType	string	Always "eID".
subjectId	string	Provider-assigned subject identifier for the authenticated user.
requestId	string	IDnow-assigned transaction reference.
authenticatedAt	string	ISO 8601 timestamp of the authentication.
trustFramework	string	Trust framework of the assurance level achieved (e.g. "eidas"). Present when returned by the provider.
assuranceLevel	string	Assurance level achieved (e.g. "substantial"). Present when returned by the provider.

AuthenticationResult — not_verified

Field	Type	Description
result	string	Always "failure".
provider	string	The eID provider used (e.g. "france_identite").
credentialType	string	Always "eID".
requestId	string	IDnow-assigned transaction reference.
attemptedAt	string	ISO 8601 timestamp of the failed attempt.
reason.code	string	Always "NOT_VERIFIED".
reason.details	string	Human-readable description of the failure.