Release notes

Page Summary

outlined_flag

• The /cancelProofing endpoint was added to the API on January 28, 2025.

• As of October 18, 2024, ProvisionMobileSecurityObjects can return any number of MSOs, regardless of the number of Auth Keys passed.

• Updates made on March 10, 2023, include replacing deviceEncryptionCertificate with a DeviceEncryptionKey object for certain endpoints and adding metadata to the EncryptedData object.

• On January 10th, 2023, the HTTP methods for the getIdentityKey and getHybridEncryptionKey endpoints were changed from GET to POST.

• The initial version of this documentation was launched on October 24, 2022.

Feb 27 2026

• Include flows to distinguish wallet-initiated and issuer-initiated flows.

Sept 19 2025

• Updating documentation to reflect the supported CredentialStatus.

Aug 8 2025

• Updated GetProofingStatus response:
  • Added riskCheckFailure and livenessCheckFailure as new rejection reasons.

Feb 11 2025

• Update CredentialStatus to include reverification related statuses with UserActionRequired field.

Jan 28 2025

• Include /cancelProofing endpoint.

18 Oct 2024

• Update ProvisionMobileSecurityObjects to allow for any number of MSOs to be returned, not just the same as the number of Auth Keys passed.

16 Feb 2024

• Corrected documentation for encrypted data
• Corrected typo for barcode format

06 Dec 2023

• Updated documentation to include details on context values for E2EE.

28 Nov 2023

• Updated documentation to include details on Static Auth Data and MSO construction.

22 Nov 2023

• Added additionalTimeRequired to challenge of getProofingStatusResponse.

25 Sept 2023

• Updated documentation for device registration nonce to include details on nonce length.

25 July 2023

• Updated documentation for "Suspended" credential status

23 June 2023

• Add credentialVersionId to ProvisionMobileSecurityObjects
• Add deviceIdentityCertificateChain to RegisterDevice, deprecate deviceIdentityCertificate

9th May 2023

• Add ErrorResponse type.

10th Mar 2023

• Replace the deviceEncryptionCertificate field with a DeviceEncryptionKey object for provisionCredential and provisionMobileSecurityObjects.
• Add additional metadata to the EncryptedData object

21st Feb 2023

• Change the format of identity key and encryption key from 'PEM' to 'DER'

10th Jan 2023

• Change the HTTP method from 'GET' to 'POST' for getIdentityKey and getHybridEncryptionKey.

3rd Nov 2022

• Included endpoints for getIdentityKey and getHybridEncryptionKey.

24th Oct 2022

• Initial version