get status of otp

GET /otp/status

get status of otp

Query parameters

id string

Identifier or the object

Responses

200

Succes get status
Hide response attributes Show response attributes object
- otpID string
- redirectLink string
- phone_snippet string
- method string
- createdAt string(date-time)
- validUntil string(date-time)
- custom_data string(base64)
  
  Consumer related custom data
- otpValidated object | null
  
  Hide otpValidated attributes Show otpValidated attributes object | null
  
  otpValidated boolean
  
  validatedDuration integer
  
  otpValidatedAt string(date-time)
- sendStatus object | null
  
  Hide sendStatus attribute Show sendStatus attribute object | null
  
  sendAt string(date-time)
- error object | null
  
  Hide error attributes Show error attributes object | null
  
  createdAt string(date-time)
  
  cause string
  
  explenation string
400

Request Malfunction missing argument, properties or invalid data
500

Server Error

GET /otp/status

curl \
 -X GET https://api.goove.id/v1/otp/status \
 -H "X-API-KEY: $API_KEY"

Response examples (200)

{
  "otpID": "string",
  "redirectLink": "string",
  "phone_snippet": "string",
  "method": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "validUntil": "2023-05-04T09:42:00+00:00",
  "custom_data": "string",
  "otpValidated": {
    "otpValidated": true,
    "validatedDuration": 42,
    "otpValidatedAt": "2023-05-04T09:42:00+00:00"
  },
  "sendStatus": {
    "sendAt": "2023-05-04T09:42:00+00:00"
  },
  "error": {
    "createdAt": "2023-05-04T09:42:00+00:00",
    "cause": "string",
    "explenation": "string"
  }
}

Response examples (200)

{
  "otpID": "string",
  "redirectLink": "string",
  "phone_snippet": "string",
  "method": "string",
  "createdAt": "2025-05-04T09:42:00+00:00",
  "validUntil": "2025-05-04T09:42:00+00:00",
  "custom_data": "string",
  "otpValidated": {
    "otpValidated": true,
    "validatedDuration": 42,
    "otpValidatedAt": "2025-05-04T09:42:00+00:00"
  },
  "sendStatus": {
    "sendAt": "2025-05-04T09:42:00+00:00"
  },
  "error": {
    "createdAt": "2025-05-04T09:42:00+00:00",
    "cause": "string",
    "explenation": "string"
  }
}

Response examples (400)

"string"

Response examples (400)

string

Response examples (500)

"string"

Response examples (500)

string