POST api/identityVerification/verifyOTP

Request Information

URI Parameters

None.

Body Parameters

BO.Identity.Response.OTPVerificationRequest
NameDescriptionTypeAdditional information
OTPCode

string

None.
RequestId

string

None.
RequestType

BO.Identity.Enums.VerificationRequestType

None.

Request Formats

application/json, text/json

Sample: 
{
  "otpCode": "sample string 1",
  "requestId": "sample string 2",
  "requestType": 1
}

application/xml, text/xml

Sample: 
<OTPVerificationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RequestType>FirstLogin</RequestType>
  <RequestId>sample string 2</RequestId>
  <OTPCode>sample string 1</OTPCode>
</OTPVerificationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BO.BETResponseObjects.BaseResponseOfBO.Identity.Response.CheckVerificationStatusRequest
NameDescriptionTypeAdditional information
ResponseObject

BO.Identity.Response.CheckVerificationStatusRequest

None.
ResponseMessage

string

None.
ResponseType

BO.Enums.ResponseType

None.

Response Formats

application/json, text/json

Sample: 
{
  "responseObject": {
    "isSuccess": true,
    "exceededAttempts": true,
    "clientId": "sample string 3",
    "message": "sample string 4"
  },
  "responseMessage": "sample string 1",
  "responseType": 1
}

application/xml, text/xml

Sample: 
<BaseResponseOfCheckVerificationStatusRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ResponseObject>
    <IsSuccess>true</IsSuccess>
    <ExceededAttempts>true</ExceededAttempts>
    <ClientId>sample string 3</ClientId>
    <Message>sample string 4</Message>
  </ResponseObject>
  <ResponseMessage>sample string 1</ResponseMessage>
  <ResponseType>Success</ResponseType>
</BaseResponseOfCheckVerificationStatusRequest>