Validate PIN/OTP (One-Time Password)

Description

Use this request to confirm that the PIN/OTP you received from your user matches the one sent by Rakuten CPaaS in your confirm request.

Production Endpoint URL: https://api.cpaas.symphony.rakuten.net/twofa/v1/pin/$request_id

Methods: POST

HTTP Headers

Parameter	Required	Value
Authentication	Y	Type: Bearer Token: JWT Token
Accept	Y	application/json
Content-Type	Y	application/json; charset=UTF-8

Request Body Schema: application/json

Parameter	Required	Description/Values
pin	Y	Submit the PIN entered by customer for validation

Sample Request

{
  "pin": "12345678", 
}

Response:

If successful, the API call will return an HTTP 200 OK with a Json document as a response. Please see section “Errors Codes" for a description of the failure responses.

Parameter	Description
success	true
result_code	Refer Result Code List
result_message	Description of the result code
client_reference	Client reference is returned only when specified in request.
request_id	The request_id provided in the request is returned for reference

Correct PIN/OTP Response

{
  "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...",
}

Incorrect PIN/OTP Response

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

Validate PIN/OTP (One-Time Password)

Description​

Description