Confirm API

本仕様書では、Confirm APIを使用して、SMSを介してユーザーにワンタイムパスワードを送信するようアプリケーションに要求する方法について説明したものになります。

一つのAPIによって、SMSを用いた認証管理からメッセージ配信の自動化に至る完全な二要素認証のソリューションを提供します。

API は REST API の規則に従います。送信するメッセージの詳細は JSON 形式を利用し、メッセージは POST メ ソッドで送信されます。アカウントの認証情報は、Authorization HTTP ヘッダで JWT トークンの形式でお伝えいたします。(詳細は認証のセクションをご覧ください。)

レスポンスが 200 OK であった場合は、メッセージが API へと正しく送信されています。一方で、レスポンス が 40x であった場合は、送信されたリクエストに何かしらの問題があったことを示しています。50x となっている場合は、サービスに一時的な障害があったことを意味しています。

全てのリクエストにおいて、エンコード UTF-8 を使用してください。

注: 本ドキュメントに記載されている時刻はすべて UTC となります。