REST API
API Versioning
The Scrive eID Hub API uses Semantic Versioning. The current version is 1.78.0. All changes are backwards-compatible within a major version.
Backwards-compatible changes (
MINOR / PATCH)- New API endpoints
- Additional properties in responses for existing endpoints
- Additional optional parameters for existing endpoints
- Additional options for enumerated values
- Changes to the format or length of URIs and IDs generated by the service
Occasionally changes not meeting these requirements may be released as MINOR when impact on existing integrations is deemed minimal. Affected customers will be notified in advance.
161 releases
| Version | Date | Details |
|---|---|---|
| 1.78.0 | — | Support setting SmartID userSemanticsIdentifier on transaction start for sign transactions |
| 1.77.0 | 2026-07-09 | Introduce signing via Scrive ISC |
| 1.76.0 | 2026-06-23 | Expose Freja detailsJws in completion data |
| 1.75.0 | 2026-05-20 | Add uuid parameter to MitID auth params for the reauth/skip-first-page flow |
| 1.74.0 | 2026-05-20 | Drop support for SE BankID maxRiskLevel parameter |
| 1.73.0 | 2026-05-06 | Support fragments in redirectUrl |
| 1.72.0 | 2026-04-14 | Introduce dedicated age verification endpoint |
| 1.71.0 | 2026-04-14 | Support persistent identity in Swisscom MAB |
| 1.70.0 | 2026-04-01 | Introduce MobileID provider |
| 1.69.0 | 2026-03-25 | Deprecate NO BankID classic signDoc flow |
| 1.68.0 | 2026-02-25 | Make user info optional for Freja sign |
| 1.67.0 | 2026-01-21 | Introduce uiLanguage parameter |
| 1.66.0 | 2025-11-19 | Introduce requestNNIN parameter for Norwegian BankID Classic Sign |
| 1.65.0 | 2025-11-19 | Add requestNNIN to NO BankID CSC parameters |
| 1.64.0 | 2025-11-19 | Add support for Swisscom MAB |
| 1.63.0 | 2025-11-19 | NO BankID certificateData is deprecated and all its properties are optional |
| 1.62.0 | 2025-11-19 | Add isSingleDeviceFlowparameter to start endpoint |
| 1.61.0 | 2025-11-19 | Add skipSingleOption parameter |
| 1.60.0 | 2025-11-04 | Add Multi-auth Selection (MAS) |
| 1.59.0 | 2025-10-01 | Support for NO BankID CSC pre-prod |
| 1.58.0 | 2025-09-09 | Support for core Onfido Studio functionality |
| 1.57.0 | 2025-08-27 | Deprecate SE BankID maxRiskLevel in providerParameters |
| 1.56.0 | 2025-08-13 | Support LoaLevel attribute in Freja parameters |
| 1.55.0 | 2025-05-27 | Add eventTime property to client callback payloads |
| 1.54.0 | 2025-05-20 | Disable support for NOBankID as identity provider for Scrive QES |
| 1.53.0 | 2025-05-06 | Support CIBA flow for Norwegian BankID |
| 1.52.0 | 2025-04-08 | Support requestAgeCheck in iDIN auth parameters |
| 1.51.0 | 2025-03-25 | Add OneID as an auth provider |
| 1.50.0 | 2025-03-19 | Add returnEndUserInfo parameter to the /new endpoint |
| 1.49.0 | 2025-02-18 | Remove parameter dkProvider from the /start endpoint |
| 1.48.0 | 2025-02-10 | Add support for SE BankID PIN code option |
| 1.47.0 | 2025-01-29 | Drop support for SE BankID non-secure start |
| 1.46.0 | 2024-12-10 | Add endUserIP parameter to the /start endpoint |
| 1.45.0 | 2024-11-12 | Add support for Freja OrganisationID |
| 1.44.0 | 2024-09-17 | Add callbackUrl parameter and deprecate NO BankID useMobileBankID |
| 1.43.0 | 2024-08-27 | SE BankID risk indication |
| 1.42.0 | 2024-07-23 | Prohibit URLs in SMS OTP message text |
| 1.41.0 | 2024-06-26 | Add Scrive QES as a sign provider |
| 1.40.0 | 2024-06-19 | Add countryOfResidence parameter to Onfido |
| 1.39.0 | 2024-06-04 | Add an endpoint to fetch an Onfido check |
| 1.38.0 | 2024-06-04 | Make givenName in FTN completion data a nullable field |
| 1.37.0 | 2024-05-30 | Add motion frames to the images endpoint for Onfido |
| 1.36.12 | 2024-04-08 | Add new processStatusInfo values for Swedish BankID |
| 1.36.11 | 2024-04-03 | Properly URL-encode parameters in authUrl and signUrl for OIDC-based providers |
| 1.36.10 | 2024-03-19 | Add Polish language to Swisscom |
| 1.36.9 | 2024-02-22 | Enable test mode for SMS OTP |
| 1.36.8 | 2024-01-11 | Remove NemID |
| 1.36.7 | 2024-01-11 | Add Motion as an option for facial-similarity check for Onfido |
| 1.36.6 | 2023-12-12 | Disable support for NemID |
| 1.36.5 | 2023-12-07 | Improve length-validation for SMS OTP message text |
| 1.36.4 | 2023-10-17 | Deprecate BankIdent method for Swisscom SRS |
| 1.36.3 | 2023-08-23 | Add action to MitID authentication parameters |
| 1.36.2 | 2023-06-29 | Add a specific MitID Business error, NoBusinessIdentity |
| 1.36.1 | 2023-06-28 | Add callInitiator to Swedish BankID auth parameters to enable the phone-authentication feature |
| 1.36.0 | 2023-06-12 | Add bankIdIssueDate and stepUp to Swedish BankID completion data |
| 1.35.3 | 2023-04-12 | Mark requireAutoStartToken in Swedish BankID as Deprecated |
| 1.35.2 | 2023-03-29 | Add Proof-of-Adress report to Onfido |
| 1.35.1 | 2023-03-14 | Return a single signature in the Itsme Sign response |
| 1.35.0 | 2023-02-08 | Add MitID Erhverv (MitID Business) login by employeeLogin option |
| 1.34.1 | 2023-01-31 | Remove the deprecated by Onfido useLiveDocumentCapture option |
| 1.34.0 | 2023-01-23 | Modify Smart-ID signature flow to make the signature *AdES-compliant |
| 1.33.5 | 2022-12-19 | Add new Onfido error codes due to upgrade to Onfido API v3.3 |
| 1.33.4 | 2022-12-19 | Remove optional unused fields in FTN completion data |
| 1.33.3 | 2022-12-13 | Support the Dutch locale in the Onfido UI |
| 1.33.2 | 2022-11-29 | Add forceCrossDevice and useLiveDocumentCapture for Onfido as two separate options |
| 1.33.1 | 2022-11-04 | Add user(Non)VisibleData for Swedish BankID auth and make possible to use Markdown formatting |
| 1.33.0 | 2022-10-27 | Add /digidentity/metadata endpoint to fetch metadata reports from Digidentity |
| 1.32.7 | 2022-10-24 | Finnish MobileID is merged into banks selection page thus making mobileid a new possible value in completionData.bank for FTN authentication |
| 1.32.6 | 2022-09-22 | Add more data about a document image for /onfido/images endpoint |
| 1.32.5 | 2022-08-24 | Extract date of birth from Smart-ID certificate to a dedicated field in the completion data |
| 1.32.4 | 2022-08-18 | Add an option to allow Substantial security level for Norwegian BankID |
| 1.32.3 | 2022-08-09 | Add a possibility to request CPR from the end user with MitID |
| 1.32.2 | 2022-06-21 | Add Robo-Ident to available registration methods for Swisscom SRS |
| 1.32.1 | 2022-06-07 | Make possible to use Onfido without eID-Hub's frontend (see new referrerUrlPatternForSdk parameter) |
| 1.32.0 | 2022-05-24 | Add qrData for the SE BankID animated QR codes and deprecate autoStartToken use in QR codes |
| 1.31.1 | 2022-05-02 | Extract additional user information from Smart-ID response to the completion data |
| 1.31.0 | 2022-03-30 | Add Digidentity as an auth provider |
| 1.30.0 | 2022-01-04 | Add SmartID as a sign provider |
| 1.29.4 | 2021-12-29 | Add idToken to Norwegian BankID completion data; remove nullable deprecated fields |
| 1.29.3 | 2021-12-28 | Limit Swisscom signing message length |
| 1.29.2 | 2021-11-29 | Remove deprecated prefilledPhoneNumber from Itsme parameters and add userId to the completion data |
| 1.29.1 | 2021-11-29 | Add status to Verimi-sign provider info |
| 1.29.0 | 2021-11-25 | Rename beItsme to itsme |
| 1.28.0 | 2021-11-04 | Add SmartID as an auth provider |
| 1.27.0 | 2021-10-11 | Add the BankIdent registration method for Swisscom |
| 1.26.0 | 2021-10-06 | Add the VideoIdent registration method for Swisscom |
| 1.25.0 | 2021-09-06 | Add MitID as a sign provider |
| 1.24.4 | 2021-09-06 | Add a new endpoint for Swisscom SRS video identification |
| 1.24.3 | 2021-09-06 | Allow to do CPR-match calls for MitID transactions |
| 1.24.2 | 2021-08-12 | Add Italian and Portuguese languages to Onfido |
| 1.24.1 | 2021-08-12 | Sign user data for MitID transactions |
| 1.24.0 | 2021-08-05 | Add new auth provider NemID-or-MitID |
| 1.23.3 | 2021-07-14 | Add validUntil for MitID completion data |
| 1.23.2 | 2021-06-17 | Add dateOfBirth as a parameter for Onfido |
| 1.23.1 | 2021-06-17 | Add support for new Onfido report types: documentWithAddressInformation and documentWithDrivingLicenceInformation |
| 1.23.0 | 2021-06-17 | Add a Swisscom specific endpoint to check registration status |
| 1.22.1 | 2021-06-08 | Allow to validate NemID auth against a provided CPR |
| 1.22.0 | 2021-06-08 | Add MitID as an auth provider |
| 1.21.1 | 2021-05-31 | Add sdkError to Onfido's errorData |
| 1.21.0 | 2021-05-06 | Add a new endpoint to match Danish CPR for completed NemID transactions |
| 1.20.3 | 2021-04-26 | Add personalNumber to Onfido completion data |
| 1.20.2 | 2021-04-20 | Validate Onfido's applicant names against forbidden characters |
| 1.20.1 | 2021-04-13 | Allow Onfido's issuingCountry be to country codes that aren't yet in ISO-3166, e.g. RKS for Kosovo |
| 1.20.0 | 2021-03-11 | Add Swisscom as a sign provider |
| 1.19.6 | 2021-02-23 | Add missing address parts in iDIN completion data |
| 1.19.5 | 2021-02-08 | Add a parameter to set if Onfido's UI forces mobile document capture or not |
| 1.19.4 | 2021-02-08 | Add address information to Onfido completion data |
| 1.19.3 | 2021-01-11 | Allow cancelling started Freja transactions |
| 1.19.2 | 2020-11-26 | Add facialSimilarityErrors to Onfido errorData |
| 1.19.1 | 2020-11-26 | Add categorisation to Onfido document report data |
| 1.19.0 | 2020-11-23 | Add rate limiting to the API, see the relevant section for details |
| 1.18.5 | 2020-11-19 | Add description for facialSimilarityScore for Onfido |
| 1.18.4 | 2020-10-28 | Add errorData for NemID sign and FTN sign |
| 1.18.3 | 2020-10-23 | Add PID to NemID sign completion data |
| 1.18.2 | 2020-10-19 | Add errorData for Onfido |
| 1.18.1 | 2020-10-12 | Add more document information into Onfido completion data |
| 1.18.0 | 2020-10-12 | Add an endpoint to fetch Onfido images (documents and live photos) |
| 1.17.0 | 2020-10-07 | Add cancel endpoint |
| 1.16.2 | 2020-09-19 | Add allowedDocumentTypes and allowedDocumentCounties to Onfido |
| 1.16.1 | 2020-09-28 | Fix a typo in the SMS OTP parameters |
| 1.16.0 | 2020-09-14 | Add Freja eID as sign provider |
| 1.15.2 | 2020-09-10 | Add Onfido uiLocale to ParamAuthOnfido |
| 1.15.1 | 2020-09-07 | Allow presetting CVR for NemID sign |
| 1.15.0 | 2020-08-27 | Align the structure of providerParameters for the new transaction endpoint with the structure returned by other endpoints. The previous structure will continue to be accepted in requests throughout the lifetime of API v1 |
| 1.14.2 | 2020-08-11 | Add Onfido applicantId to InfoAuthOnfido |
| 1.14.1 | 2020-08-05 | Add errorData for various providers |
| 1.14.0 | 2020-07-31 | Add Verimi as sign provider |
| 1.13.1 | 2020-07-27 | Additional status in iDIN completion data |
| 1.13.0 | 2020-06-23 | Deprecate Onfido checksClear in providerInfo |
| 1.12.1 | 2020-06-10 | Add presetBank parameter for iDIN |
| 1.12.0 | 2020-06-08 | Add Freja eID as auth provider |
| 1.11.4 | 2020-05-27 | Fix behaviour for Onfido when no first and/or last name is provided |
| 1.11.3 | 2020-05-12 | Change to Onfido continue endpoint response: checksCleared may now be null |
| 1.11.2 | 2020-04-07 | Better validation for SMS OTP parameters |
| 1.11.1 | 2020-04-02 | Make originator parameter customizable in SMS OTP |
| 1.11.0 | 2020-03-30 | Add Onfido as auth provider |
| 1.10.0 | 2020-03-26 | Change internal provider for NO BankID for sign |
| 1.9.1 | 2020-03-13 | Stop requesting email for iDIN by default |
| 1.9.0 | 2020-03-11 | Change internal provider for NO BankID for auth |
| 1.8.0 | 2020-03-10 | Add SMS OTP as auth provider |
| 1.7.9 | 2020-02-10 | Set up data retention periods and data purging |
| 1.7.8 | 2020-01-23 | Change frontend to avoid use of cookies |
| 1.7.7 | 2020-01-22 | Add explicit method parameter |
| 1.7.6 | 2020-01-20 | Improve structure of error responses |
| 1.7.5 | 2020-01-07 | Add lastNamePrefix to iDIN completion data |
| 1.7.4 | 2019-12-12 | Improve redirection behaviour for some providers |
| 1.7.3 | 2019-12-11 | Fix a typo in a FTN bank name |
| 1.7.2 | 2019-12-02 | Make DK NemID method optional for signing requests |
| 1.7.1 | 2019-12-02 | Fix iDIN language parameter to be lower-case |
| 1.7.0 | 2019-12-02 | Change SE BankID to only allow 12-digit personal numbers |
| 1.6.0 | 2019-11-22 | Add Tupas as a signing provider |
| 1.5.1 | 2019-10-21 | Add FI Mobile ID |
| 1.5.0 | 2019-10-03 | Add itsme as a provider |
| 1.4.1 | 2019-09-27 | Make requesting CPR for NemID optional |
| 1.4.0 | 2019-09-26 | Add iDIN as a provider |
| 1.3.0 | 2019-08-13 | Improve redirecting at the end of authentication process |
| 1.2.2 | 2019-08-02 | Change Verimi from embedded to redirect due to provider restrictions |
| 1.2.1 | 2019-07-19 | Allow HTTP (non-TLS) redirectUrl on non-production environments |
| 1.2.0 | 2019-07-05 | Error responses are now in JSON |
| 1.1.0 | 2019-06-27 | Start using Semantic Versioning |
| 1.0.0 | 2019-06-05 | First release |