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

API Endpoint: Send OTP

This endpoint is used to send a One-Time Password (OTP) to the shipper for shipment verification. The OTP will be delivered to the shipper’s registered phone number and must be validated in subsequent steps.

Request

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

Request Body Parameters

Key Type Description
AccountCode string Unique account code of the shipper.
ShipperName string Name of the shipper.
ConsigneeName string Name of the consignee.
ConsigneeCountry string Destination country code (ISO Alpha-2).
KYCType string Type of KYC document (e.g., PAN Number, Aadhaar Number).
KYCNo string KYC document number.
ShipperPhoneNumber string Phone number where the OTP will be sent.
GoodsType string Type of goods (e.g., DOX, NDOX).
ImageBase64String string Optional shipment image in Base64 format.
KYCImageBase64String string KYC document image in Base64 format (required for certain goods).

Response

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

Success Response

{
  "Status": true,
  "Error": null,
  "Data": {
    "Message": "OTP Sent Successfully"
  },
  "Timestamp": "2025-09-07T07:18:37.8629933Z",
  "RequestId": "dc470036-fc1b-4489-bf29-3c34bf767a43"
}

Failed Response

{
  "Status": false,
  "Error": {
    "Code": "401",
    "Message": "Validation failed",
    "Details": [
      "KYC Image Base64string is required."
    ]
  },
  "Data": null,
  "Timestamp": "2025-09-07T07:19:28.175341Z",
  "RequestId": "b87be9d1-3553-4875-b025-e87c11005359"
}