POST api/CUSTOMERS/VERIFY_OTP?token={token}&customerId={customerId}&otpCode={otpCode}&foreigns={foreigns}

Verify OTP Code with the one sent as SMS to mobile number. Token expire period is 10 minutes.

Request Information

URI Parameters

Name	Description	Type	Additional information
token	The SMS TOKEN value (its type is Guid) received from API while adding CUSTOMER/resending OTP SMS	globally unique identifier	Required
customerId	The CUSTOMER_ID value	integer	Required
otpCode	OTP Code entered by user that need to be verified	integer	Required
foreigns	Optional. Default value is false. True=> Include nested foreign objects within reply. False=> Do NOT Include nested foreign objects within reply	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

CUSTOMERS_CMD_RESPONSE

Name	Description	Type	Additional information
Status		Status	None.
DATA		Collection of CUSTOMERS	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": {
    "Success": true,
    "MessageEn": "sample string 2",
    "MessageAr": "sample string 3",
    "DetailedMessage": "sample string 4",
    "Code": 0,
    "CartErrors": [
      {
        "ResultStatusCode": 0,
        "CartId": 1,
        "CorrectValue": {},
        "MessageEn": "sample string 2",
        "MessageAr": "sample string 3",
        "CartCorrectAction": 0
      },
      {
        "ResultStatusCode": 0,
        "CartId": 1,
        "CorrectValue": {},
        "MessageEn": "sample string 2",
        "MessageAr": "sample string 3",
        "CartCorrectAction": 0
      }
    ]
  },
  "DATA": [
    {
      "CUSTOMER_ID": 1,
      "CUSTOMER_ID_IMAGE": "a90d126e-0b30-4e5c-9726-64dc5b76cbc9",
      "CUSTOMER_NAME_AR": "sample string 2",
      "CUSTOMER_NAME_EN": "sample string 3",
      "FK_EMIRATE": 1,
      "EMAIL": "sample string 4",
      "MOBILE_NO": "sample string 5",
      "LOGIN_PASSWORD": "sample string 6",
      "FK_MOBILE_COUNTRY": 7,
      "ACTIVE": true,
      "NOTES": "sample string 9",
      "LAST_NOTIFY_DELETE": "2025-12-08T00:39:37.532Z",
      "FK_USER": 1,
      "FK_GROUP": 1,
      "COUNTRIES": {
        "COUNTRY_ID": 1,
        "COUNTRY_NO": 2,
        "CALLING_CODE": "sample string 3",
        "COUNTRY_NAME_AR": "sample string 4",
        "COUNTRY_NAME_EN": "sample string 5",
        "COUNTRY_CODE2": "sample string 6",
        "COUNTRY_CODE3": "sample string 7"
      },
      "EMIRATES": {
        "EMIRATE_ID": 1,
        "EMIRATE_NAME_AR": "sample string 2",
        "EMIRATE_NAME_EN": "sample string 3"
      }
    },
    {
      "CUSTOMER_ID": 1,
      "CUSTOMER_ID_IMAGE": "a90d126e-0b30-4e5c-9726-64dc5b76cbc9",
      "CUSTOMER_NAME_AR": "sample string 2",
      "CUSTOMER_NAME_EN": "sample string 3",
      "FK_EMIRATE": 1,
      "EMAIL": "sample string 4",
      "MOBILE_NO": "sample string 5",
      "LOGIN_PASSWORD": "sample string 6",
      "FK_MOBILE_COUNTRY": 7,
      "ACTIVE": true,
      "NOTES": "sample string 9",
      "LAST_NOTIFY_DELETE": "2025-12-08T00:39:37.532Z",
      "FK_USER": 1,
      "FK_GROUP": 1,
      "COUNTRIES": {
        "COUNTRY_ID": 1,
        "COUNTRY_NO": 2,
        "CALLING_CODE": "sample string 3",
        "COUNTRY_NAME_AR": "sample string 4",
        "COUNTRY_NAME_EN": "sample string 5",
        "COUNTRY_CODE2": "sample string 6",
        "COUNTRY_CODE3": "sample string 7"
      },
      "EMIRATES": {
        "EMIRATE_ID": 1,
        "EMIRATE_NAME_AR": "sample string 2",
        "EMIRATE_NAME_EN": "sample string 3"
      }
    }
  ]
}