Skip to content

iVALT Authentication APIs (1.0.0)

The iVALT Authentication APIs provide secure, real-time user verification and session management through a single 1-Click experience. These APIs allow developers to authenticate users using mobile biometrics, device identity, and contextual factors such as location, IP, time window, and organization-defined rules.

Core Capabilities:

  • Verify user identity and device trust
  • Generate and validate authentication tokens
  • Submit biometric and geo-fence data for evaluation
  • Retrieve pass/fail results with factor-level detail
  • Enforce custom authentication policies defined in the iVALT Admin Portal

Use these endpoints to embed iVALT’s secure authentication workflow directly into your web or mobile applications.

Download OpenAPI description
Languages
Servers
Mock server
https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/
Production server
https://api.ivalt.com/admin/public/api/

Auth Apis

Auth includes operations for verifying user credentials, managing session tokens, handling biometric validations, and enforcing geo-fencing rules. These APIs ensure secure and compliant access control for both users and administrators within the system.

Operations

Validate person

Request

Validates a person's mobile number for authentication.

Security
ApiKeyAuth
Bodyapplication/json

Person's mobile number for validation

mobilestringrequired

Mobile of post /validate/person request.

Example: "6283974746"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/validate/person \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "+916283974746"
  }'

Responses

Person validated successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

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

Validate user time slots and geofencing

Request

Validates the time slots and geofence location data of a user.

Security
ApiKeyAuth
Bodyapplication/json

User mobile and longitude data for validation

mobilestringrequired

Mobile of post /validate/user/timeslots/geofencing request.

Example: "6283974746"
longitudestringrequired

Longitude of post /validate/user/timeslots/geofencing request.

Example: "74.872264"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/validate/user/timeslots/geofencing \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "+916283974746",
    "longitude": "74.937933"
  }'

Responses

User time slots and geofence validated successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Validate user time slots and geofencing" }

Global REST authentication validation

Request

Validates global REST authentication tokens associated with users.

Security
ApiKeyAuth
Bodyapplication/json

User mobile and authentication token for validation

mobilestringrequired

Mobile of post /validate/global/rest/auth request.

Example: "6283974746"
auth_tokenstringrequired

Auth token of post /validate/global/rest/auth request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/validate/global/rest/auth \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile": "+916283974746",
    "auth_token": "Sample_Token_Example"
  }'

Responses

Global REST authentication validated successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Global REST authentication validation" }