API Changelog

All notable changes to the OTP API will be documented in this file.

[v1.11.0] - 2020-10-27

Add email OTP and email templates

Added

• Added email OTP option

• Added templates for email OTP with dynamic variables that can be populated from the otp POST /otp/requests request

[v1.10.0] - 2020-09-02

Backend encryption improvements

Updated

• Updated encryption on backend data stores

[v1.9.1] - 2020-08-03

Added Pagination fix for fetching OTP requests

Bugfix

• Added pagination fix on GET /otp/requests endpoint when lastOtpId parameter is used

[v1.9.0] - 2020-07-01

Added new statistics endpoints

Added

• Added new statistics endpoint to show a daily oveview of OTP events GET /otp/stats/events

• Added new statistics endpoint to show a daily oveview of OTP verification failures GET /otp/stats/failures

Updated

• Improved caching on GET /otp/request API call.

[v1.8.0] - 2020-05-27

More GET /otp/request speed improvements

Updated

• Backend DB and query optimisations for speed improvements in the GET /otp/request API call.

Bugfix

• Fixed bug with random code generation when using named charset eg. ‘base10’

[v1.7.0] - 2020-04-23

More dispatchers added and bug fixes.

Updated

• Changed metadata value minimum length from 4 to 1.

Bugfix

• Fixed OTP request limits not failing on excess attempts.

[v1.6.0] - 2020-03-31

Improvements to GET Request endpoint, added event driven webhooks

Added

• Added webhooks option to send an HTTP POST on OTP events to a url defined in the application config. For more details check the API doc.

[v1.5.0] - 2020-01-13

Encryption improvements on backend. No API changes.

[v1.4.0] - 2019-12-11

Source IP addresses updated on the SMS dispatcher.

Updated

• SMS dispatcher source IP addresses updated. SMS will now be sent from either 3.105.170.93, 13.54.198.144 or 3.105.100.6

[v1.3.0] - 2019-11-18

Performance improvements and bug fixed. No API changes.

[v1.2.0] - 2019-10-21

Improvements to GET Request endpoint, and changes to GET Request API response.

[v1.1.0] - 2019-10-16

Encryption enhancements on backend databases. No API changes.

[v1.0.3] - 2019-10-09

New field added to OTP request endpoint

Added

• Added metadata field to the POST /otp/requests API call. This is intended to replace customerRef in a future release

BugFix

• Added fix for POST /authenticate failing with valid credentials

[v1.0.2] - 2019-09-26

General backend improvements. No API changes.

[v1.0.1] - 2019-09-04

Backend POST /authenticate improvements. No API changes.

[v1.0.0] - 2019-09-04

Initial Production release

Added

• Authentication endpoint POST /authenticate for authenticating users
• Get OTP Applications endpoint GET /otp for listing OTP applications and their config
• Create OTP request endpoint POST /otp/requests to send a new OTP request
• Lookup OTP requests endoint GET /otp/requests to list and filter OTP requests
• Verify OTP request endpoint POST /otp/requests/{otpId}/verify to verify the OTP request