POST https://api.cmswebservice.in/api/shipment/verify-otp

API Endpoint: Verify OTP

This endpoint verifies the One-Time Password (OTP) that was sent earlier during the shipment process. A successful verification will return a transaction ID that confirms the OTP validation.

Request

  • Method: POST
  • URL: https://api.cmswebservice.in/api/shipment/verify-otp
  • Content-Type: application/json

Request Body Parameters

Key Type Description
AccountCodestringUnique account code of the shipper.
ShipperNamestringName of the shipper.
ConsigneeNamestringName of the consignee.
ConsigneeCountrystringISO code of consignee country.
KYCTypestringType of KYC document (e.g., Aadhaar Number, PAN Number).
KYCNostringKYC document number.
ShipperPhoneNumberstringPhone number of the shipper where OTP was sent.
GoodsTypestringType of goods being shipped.
ImageBase64StringstringBase64 encoded image of the shipper (optional).
KYCImageBase64StringstringBase64 encoded KYC document image (optional).
OTPstringThe OTP received on the registered phone number.

Response

  • Status Code: 200 (on success or validation failure)
  • Content-Type: application/json

Success Response

{
    "Status": true,
    "Error": null,
    "Data": {
        "Message": "\"Transaction ID:66614568.\""
    },
    "Timestamp": "2025-09-07T08:57:31.1730172Z",
    "RequestId": "50ad465c-57d2-4d28-a592-d0ab4e1d2a38"
}

Failed Response

{
    "Status": false,
    "Error": {
        "Code": "400",
        "Message": "OTP send failed",
        "Details": [
            "\"Please enter Valid OTP to proceed further\""
        ]
    },
    "Data": null,
    "Timestamp": "2025-09-07T09:01:45.7054837Z",
    "RequestId": "da31758d-72bf-43e5-93a2-4e21be6eea01"
}