Endpoints
Validate OTP
Validate a one-time password (OTP) code sent to a recipient
POST
Validate OTP
This endpoint allows you to validate a one-time password (OTP) code that was sent to a recipient. Endpoint:POST /v1/external/validate/otp
Request Body
- code (string, required): The OTP code to validate.
- recipient (string, required): The recipient phone number that received the OTP (without + prefix).
Responses
- 200 OK: OTP validation successful.
- 400 Bad Request: Invalid OTP code or recipient.
- 401 Unauthorized: Invalid or missing API key.
Response Example
Response Fields
- statusCode (string): HTTP status code.
- statusMessage (string): Status message (e.g., “Verification successful”).
- transactionId (string): Unique transaction identifier.
- sequenceNo (string|null): Sequence number (typically null for OTP validation).
- data (object): Validation result data.
- uuid (string): Unique identifier for the validation.
- code (string): Masked OTP code for security.
- timestamp (string): ISO 8601 timestamp of the response.
Authorizations
API Key for authentication
API Secret for authentication
Headers
API version header (required for full JSON response)
Available options:
2025-08-01 Body
application/json
Response
OTP validation successful
HTTP status code
Example:
"200"
Status message
Example:
"Verification successful"
Unique transaction identifier
Example:
"60642211-155a-48cc-8d90-82fa62897b37"
Sequence number
Example:
null
ISO 8601 timestamp
Example:
"2025-10-03T15:14:34.919Z"