Confirm API

This document describes how the Confirm API allows applications to request one-time pins (OTPs) to be sent to users via SMS or voice channels for two-factor authentication flows.

A single API provides the full 2FA solution, from authentication management to message automation, spanning SMS and Voice.

The API follows standard REST API conventions, messages are submitted as POST requests with a JSON payload describing the details of the message to send. The account credentials are passed in the form of a JWT Token in the Authorization HTTP Header (see section below regarding authentication).

An HTTP 200 OK response indicates that the message was successfully delivered to the API. Alternatively, an HTTP 40x response indicates that there was a problem with the request that was submitted, and an HTTP 50x that there was a temporary fault in the service.

All requests should be encoded using the UTF-8 Charset.

Note: All timestamps in this document are in UTC