POST
/
otp
/
verify
curl --request POST \
  --url https://api.simpu.co/otp/verify \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "123456",
  "id": "674535b2b39158b9aae90188fcec23eb"
}'
{
  "id": "674535b2b39158b9aae90188fcec23eb",
  "recipient": "2348023456789",
  "status": 1,
  "status_desc": "SENT",
  "created_datetime": "2024-06-28T23:56:38.128604+00:00",
  "updated_datetime": "2024-06-28T23:56:38.128604+00:00"
}

Authorizations

​
Authorization
string
header
required

An API key to authenticate requests

Body

application/json
OTP verify request object
​
token
string
required

The OTP token to verify

Example:

"123456"

​
id
string
required

The ID of the OTP token to verify

Example:

"674535b2b39158b9aae90188fcec23eb"

Response

200
application/json
OTP response
​
id
string
required

ID of the OTP token

Example:

"674535b2b39158b9aae90188fcec23eb"

​
recipient
string
required

Recipient of the OTP token

Example:

"2348023456789"

​
status
number
required

Status of the OTP token

Example:

1

​
status_desc
string
required

Description of the status of the OTP token

Example:

"SENT"

​
created_datetime
string
required

Date and time the OTP token was created

Example:

"2024-06-28T23:56:38.128604+00:00"

​
updated_datetime
string

Date and time the OTP token was last updated, if any

Example:

"2024-06-28T23:56:38.128604+00:00"

Request OTPRevoke OTP