Usage

Create a Norwegian BankID transaction with provider: noBankID and method: auth to authenticate, or method: sign to sign.

Authentication

Authentication is a redirect flow at the High security level. You can preset the user's personal number and phone number so they're filled in for them on the BankID page, and you can set the interface language to Norwegian Bokmål or English. If you don't set a language, BankID picks the best match from the browser and falls back to Bokmål.

On completion you get back a stable identifier, the user's name and date of birth, an ID token and the issuer, and a flag telling you whether the user authenticated with mobile BankID. For the full request and response fields, see the API reference.

BankID Biometric and the Substantial level

To use BankID Biometric instead of the default, enable the Substantial-level option on the request. The user then approves with biometrics and the transaction completes at the Substantial level rather than High. Note that no certificate data is returned in this case.

Backchannel authentication (CIBA)

When you're already in contact with the user, for example on a call-centre line or in a customer-service chat, you can authenticate them in the background rather than redirecting them. Set the backchannel scenario on the request to either the call-centre or the chat-customer-service case. The user gets a request on their phone and approves it there. This flow uses BankID Biometric, so it completes at the Substantial level, and because it's backchannel there's no authentication URL to send the user to. See the API reference for the backchannel parameters.

Norwegian national identity number (NNIN)

NNIN is returned only if your eID Hub setup includes the extended certificate for it, which is arranged with Scrive and may require additional rights to process the data, and only when you request it (the default for authentication). On testing environments NNIN is always available. For CSC signing, asking for NNIN adds a consent step: if the user declines, the transaction is aborted with an access-denied error.

Signing

eID Hub signs with Norwegian BankID over the CSC protocol. Enable CSC on the sign request. CSC uses a digest callback: after the user is identified, eID Hub calls your endpoint with the transaction ID and the full certificate chain, and your endpoint returns the document's id and its base64-encoded digest. You can also pass arbitrary client data through. On completion you get back the signature and the certificate chain. See the API reference for the full signing parameters.

warning

The classic signDoc signing flow is deprecated, and CSC will be the only supported signing flow going forward. Use CSC for new integrations.