Verify

This end point allows you to verify an OTP code using its request Id.

post

Authorizations

x-auth-token

x-auth-tokenstringRequired

Body

application/json

codestringRequired

OTP Code

requestIdstringRequired

Request Id

operationstring · enumRequired

OTP type

Possible values:

Responses

201Success

application/json

post

/public/otp/verify

HTTPcURLJavaScriptPython

POST /public/otp/verify HTTP/1.1
Host: api.marsol.ly
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "code": "text",
  "requestId": "text",
  "operation": "CODE"
}

201Success

{
  "status": "SUCCESS",
  "message": "text",
  "recipient": "text"
}

Endpoint: /public/otp/verify

Method: POST

Verify an OTP request.

Request Body:

• code (string): The OTP code to verify.

• requestId (string): The unique identifier of the OTP request.

• operation (enum): The type of the operation (CODE, VOICE, FLASH_CALL)

POST /public/otp/verify HTTP/1.1
Host: api.marsol.ly
x-auth-token: your_api_token_here
Content-Type: application/json
{
  "code": "string",
  "requestId": "string",
  "operation": "CODE"
}

Response:

• status (enum): The status of the message for this recipient (SUCCESS, FAILED).

• message (string): The content of the message that was sent.

• recipient (string): The phone number of the recipient.

{
  "status": "SUCCESS",
  "message": "string",
  "recipient": "string"
}