GetOTPドキュメント

OTP認証ステータス

このエンドポイントから各OTPステータスを認証できます。

OTP認証リクエスト

OTPの認証には、GETリクエストを弊社のOTPエンドポイントに送信ください。OTPエンドポイントは、末尾にスラッシュがあることに注意してください:

https://otp.dev/api/verify/{otp_id}/

以下の基本的なHTTP認証方法の場合:

説明 必須 データ型
APIキー はい 文字列 mtbi2w4hlendfpxa1igthcu5p6mzxf7k
APIトークン はい 文字列 mpktanoshzf4c81e3bydjl76ixr9wugv

メモ

  • このページよりAPIキーとAPIトークンを取得できます
  • 最大3つのAPIキーを作成できます

以下は、cURLを利用したリクエスの例です:

curl -L -X GET 'https://otp.dev/api/verify/ttnnkgggvjef7euc72j8/' \
-u 'mtbi2w4hlendfpxa1igthcu5p6mzxf7k:mpktanoshzf4c81e3bydjl76ixr9wugv'

レスポンスはJSONフォーマットで、HTTP 200 コード ステータスで返却されます:

{
  "callback_url": "http://mysite.test/payments/callback",
  "success_redirect_url": "http://mysite.test/payments/65/success",
  "fail_redirect_url": "http://mysite.test/payments/65/failed",
  "otp_id": "ttnnkgggvjef7euc72j8",
  "status": [
    {
      "channel": "email",
      "auth_status": "not_verified"
    }
  ],
  "channels": [
    "email"
  ],
  "creation_time": "2021-07-07T08:26:41.952690Z",
  "metadata": "{\"order_id\":\"xfdu48sfdjsdf\", \"agent_id\":2258}",
  "captcha": true,
  "risk_score": 0.0023
}