Skip to content
API References
/
/NotificationApis

Notification APIs (1.0.1)

Notification APIs manage and deliver real-time alerts, push notifications, and user messages. They support multiple channels for timely communication between the system and users.

Download OpenAPI description
Notification_Apis.json
Notification_Apis.yaml
Overview
URL
https://ivalt.com/support
IVALT Support
support@ivalt.com
License
Apache 2.0
Languages
Servers
Mock server
https://api-docs.ivalt.com/_mock/products/notification/notification_apis/
Development server
https://dev.api.ivalt.com/admin/public/api/

NotificationApis

Operations for sending alerts, push notifications, and messages to users.

Operations

Send global notification

Request

Sends a notification to a recipient identified by their mobile number. Used for OTPs, alerts, and global system notifications. The mobile number must follow E.164 format (e.g., +91XXXXXXXXXX).

Security
ApiKeyAuth
Headers
Acceptstring

Optional. Indicates the response format. Defaults to application/json if not provided.

Example: application/json
Bodyapplication/jsonrequired
mobilestring

The recipient's mobile number in E.164 format (e.g., +91XXXXXXXXXX).

Example: "+9162839xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/notification/notification_apis/send/global/notification \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "+9162839xxxxx"
  }'

Responses

Notification sent successfully.

Bodyapplication/json
statusstringrequired

Indicates a successful request.

Value"success"
messagestringrequired

Summary of successful operation.

timestampstring(date-time)

Server timestamp in UTC.

Response
application/json
{
  "status": "success",
  "message": "Send global notification",
  "timestamp": "2025-09-22T09:35:00Z"
}

Send authentication request by email

Request

Sends an authentication notification to a recipient via email for login verification or identity confirmation.

Security
ApiKeyAuth
Headers
Acceptstring

Optional. Indicates the response format. Defaults to application/json if not provided.

Example: application/json
Bodyapplication/jsonrequired
emailstring(email)required

Recipient's email address.

Example: "user@ivalt.com"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/notification/notification_apis/send-auth-request-by-email \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@ivalt.com"
  }'

Responses

Notification sent successfully.

Bodyapplication/json
statusstringrequired

Indicates a successful request.

Value"success"
messagestringrequired

Summary of successful operation.

timestampstring(date-time)

Server timestamp in UTC.

Response
application/json
{
  "status": "success",
  "message": "Send authentication request by email",
  "timestamp": "2025-09-22T09:35:00Z"
}

Send app authentication notification

Request

Sends an authentication request from one mobile user to another — typically used in peer-to-peer or user-to-admin workflows.

Security
ApiKeyAuth
Headers
Acceptstring

Optional. Indicates the response format. Defaults to application/json if not provided.

Example: application/json
Bodyapplication/jsonrequired
request_to_mobilestringrequired

Recipient’s mobile number (E.164 format).

Example: "+9162839xxxxx"
request_from_mobilestringrequired

Sender’s mobile number (E.164 format).

Example: "+9178375xxxxx"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/notification/notification_apis/send/app-auth/notification \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "request_to_mobile": "+9162839xxxxx",
    "request_from_mobile": "+9178375xxxxx"
  }'

Responses

Notification sent successfully.

Bodyapplication/json
statusstringrequired

Indicates a successful request.

Value"success"
messagestringrequired

Summary of successful operation.

timestampstring(date-time)

Server timestamp in UTC.

Response
application/json
{
  "status": "success",
  "message": "Send app authentication notification",
  "timestamp": "2025-09-22T09:35:00Z"
}