Skip to content
API References
/
IoT Device API
/
/
Dynamic auth login

IoT APIs (1.0.0)

IoT APIs for dynamic authentication, device management, and stock monitoring. This specification includes detailed summaries and descriptions for every operation, parameter, request/response body, and schema so clients can integrate without reading code. Examples and field-level constraints (formats, patterns, and valid values) are provided wherever applicable.

Download OpenAPI description
Iot_Apis.json
Iot_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/iot-device/iot_apis/
Development server.
https://dev.api.ivalt.com/admin/public/api/
Production server.
https://api.ivalt.com/admin/public/api/

IotApis

Operations related to IoT APIs, including dynamic authentication workflows, device lifecycle tasks, and stock price retrieval.

Operations

Register dynamic authentication

Request

Create a new dynamic authentication registration for a device. Typically called during device onboarding or when associating a device with a stock for monitoring. Persists machine metadata, stock details, and contact number used for downstream verification and notifications.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Machine metadata and stock details for registration. All fields are required and validated for format/patterns (see schema for constraints).

machineIdstringrequired

Unique identifier for the machine. Allowed characters: letters, numbers, dot, hyphen, underscore.

Example: "MACHINE-001"
stockNamestringrequired

Name or code of the stock associated with the device (case-insensitive).

Example: "ANDROID"
totalPricestringrequired

Total price string for the stock (supports comma-separated thousands and up to 2 decimals). Example formats: 200.00, 2,000.00.

Example: "200.00"
currentStockPricestringrequired

Current market price as a string (same formatting rules as totalPrice).

Example: "150.00"
machineNamestringrequired

Human-readable display name for the machine.

Example: "Testing-2"
mobilestringrequired

E.164 formatted mobile number for notifications and verification.

Example: "+917837582588"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/iot-device/iot_apis/dynamic_auth/register \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "machineId": "MACHINE-001",
    "stockName": "ANDROID",
    "totalPrice": "200.00",
    "currentStockPrice": "150.00",
    "machineName": "Testing-2",
    "mobile": "+917837582588"
  }'

Responses

Registration successful. The device and its stock context are now recorded and usable in subsequent auth calls.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Device registered successfully"
}

Dynamic auth login

Request

Authenticate a device within the dynamic auth workflow by associating its machine and stock details. Often used after registration to initialize an operational session.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Machine identifier and stock context for login. All properties must match the registration state for the device.

machineIdstringrequired

Unique identifier for the machine.

Example: "MACHINE-001"
stockNamestringrequired

Name/code of the stock used during login.

Example: "ANDROID"
totalPricestringrequired

Total price string (supports commas and up to 2 decimals).

Example: "200.00"
currentStockPricestringrequired

Current price string (supports commas and up to 2 decimals).

Example: "150.00"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/iot-device/iot_apis/dynamic_auth/login \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "machineId": "MACHINE-001",
    "stockName": "ANDROID",
    "totalPrice": "200.00",
    "currentStockPrice": "150.00"
  }'

Responses

Login successful. A session for the device is now active in the system.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Login successful"
}

Verify dynamic auth

Request

Verify whether a device is authentic/known to the dynamic auth system using its machine identifier. Use this to gate access to protected actions.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Payload containing the machine identifier to be verified. Note: this endpoint expects machine_id (snake_case).

machine_idstringrequired

Machine ID to verify against the registry.

Example: "MACHINE-001"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/iot-device/iot_apis/dynamic_auth/verify \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "machine_id": "MACHINE-001"
  }'

Responses

Verification successful. The provided device is recognized and allowed.

Bodyapplication/json
statusstringrequired

Indicates request success. Always success in this schema.

Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{
  "status": "success",
  "message": "Verification successful"
}

Get stock price

Request

Fetch the latest price and associated exchange details for a given stock symbol. Intended for quick lookups used in dashboards or device displays.

Security
ApiKeyAuth
Path
Symbolstringrequired

Stock symbol to fetch price for. Symbols are case-insensitive alphanumeric strings used by the upstream provider.

Example: IBM
Headers
Acceptstring

Content type accepted by the client. Must be application/json. Some clients set this automatically; include explicitly for strict gateways.Defaults to application/json if not provided.

Value"application/json"
Example: application/json
curl -i -X GET \
  https://api-docs.ivalt.com/_mock/products/iot-device/iot_apis/get/stock-price/IBM \
  -H 'Accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Stock price retrieved successfully from the data provider.

Bodyapplication/json
statusstringrequired

Result indicator. success for successful retrieval.

Example: "success"
messagestringrequired

Human-readable message describing the result.

Example: "Stock price fetched successfully"
dataobjectrequired

Stock information container.

data.​stockNamestringrequired

Display name of the stock.

Example: "BSE Ltd"
data.​stockPricestringrequired

Price string formatted with optional commas and up to 2 decimals.

Example: "2,162.50"
data.​stockExchangeNamestringrequired

Exchange name or code returned by the provider.

Example: "BSE:National Stock Exchange of India"
Response
application/json
{
  "status": "success",
  "message": "Stock price fetched successfully",
  "data": {
    "stockName": "BSE Ltd",
    "stockPrice": "2,162.50",
    "stockExchangeName": "BSE:National Stock Exchange of India"
  }
}