PIN/OTP (ワンタイムパスワード)の検証

概要

このリクエストでは、ユーザーから受け取ったPIN/OTP がRakuten CPaaS で送信されたものと一致するかどうか確認することができます。

エンドポイント URL: https://api.cpaas.symphony.rakuten.net/twofa/v1/pin/$request_id

メソッド: POST

HTTP ヘッダー

パラメーター	要否	値
Authentication	必須	Type: Bearer Token: JWT Token
Accept	必須	application/json
Content-Type	必須	application/json; charset=UTF-8

リクエストボディスキーマ： application/json

パラメーター	要否	詳細/値
pin	必須	検証のため、顧客が入力した PIN を送信します

サンプルレスポンス

{
  "pin": "12345678", 
}

レスポンス:

成功した場合は、APIの呼び出しに対するレスポンスがJson形式で 200 OKとなります。失敗時のレスポンスの詳細は"エラーコード"を参照してください

パラメーター	詳細
success	true
result_code	結果コードを参照する
result_message	結果コードの詳細
client_reference	クライアント証明書はリクエストで指定されたときのみ返されます。"client reference" は "Additional/Advanced Options" の下で確認することができます。
request_id	リクエストで提供された "request_id"が参照用として返されます。

正しい場合の PIN/OTP レスポンス

{
  "success" : true,	
  "result_code" : 0,
  "result_message" : "Request successfully submitted",
  "client_reference": "...if provided during original request...",
  "request_id" : "...the request_id provided in the request is returned for reference...",
}

誤った場合の PIN/OTP レスポンス

{
  "result_code" : 211,
  "result_message" : "The submitted PIN was not the expected PIN for this request",
}

PIN/OTP (ワンタイムパスワード)の検証

概要​

概要