Skip to content
API References
/
Authentication API
/
/
API v1 user validation

iVALT Authentication APIs (1.0.0)

The iVALT Authentication APIs provide secure, real-time user verification and session management for external enterprise integration. These APIs allow developers to authenticate users using mobile biometrics, device identity, and contextual factors such as location and time-based 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

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

Download OpenAPI description
Auth_Apis.json
Auth_Apis.yaml
Overview
URL
https://ivalt.com/support
iVALT Developer Support
support@ivalt.com
License
Proprietary and Confidential
Terms of Service
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

Verify user details with encryption

Request

Endpoint to verify user identity based on country code and mobile number with encryption.

Security
ApiKeyAuth
Bodyapplication/json

User information required for verification

country_codestringrequired

Country code of post /verify-user request.

Example: "+91"
mobilestringrequired

Mobile of post /verify-user request.

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

Responses

User verified 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": "Verify user details with encryption"
}

Generate authentication token

Request

Generates an authentication token using client credentials.

Security
ApiKeyAuth
Bodyapplication/json

Client credentials to generate token

client_idstringrequired

Client id of post /generate-auth-token request.

client_secretstringrequired

Client secret of post /generate-auth-token request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/generate-auth-token \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "client_id": "964a543a-80cc-4c08-a3a5-f18ce6b3995f",
    "client_secret": "SDbsdKASDssdhw312WAHewweaedhbadasdba"
  }'

Responses

Token generated 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": "Generate authentication token"
}

Submit biometric and geo-fence authentication results

Request

Endpoint to submit user biometric and geo-fencing authentication data.

Security
ApiKeyAuth
Bodyapplication/json

Biometric and location data for authentication

country_codestringrequired

Country code of post /biometric-geo-fence-auth-results request.

Example: "+91"
mobilestringrequired

Mobile of post /biometric-geo-fence-auth-results request.

Example: "6283974746"
statusintegerrequired

Status of post /biometric-geo-fence-auth-results request.

Example: 1
latitudestringrequired

Latitude of post /biometric-geo-fence-auth-results request.

Example: "31.633979"
longitudestringrequired

Longitude of post /biometric-geo-fence-auth-results request.

Example: "74.872264"
addressstringrequired

Address of post /biometric-geo-fence-auth-results request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/biometric-geo-fence-auth-results \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "country_code": "+91",
    "mobile": "9530654704",
    "status": 1,
    "latitude": "134564879",
    "longitude": "1231232",
    "address": "Chetanpura"
  }'

Responses

Authentication results submitted 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": "Submit biometric and geo-fence authentication results"
}

Validate geo-fence authentication

Request

Validates the geo-fence authentication data for a user.

Security
ApiKeyAuth
Bodyapplication/json

User location and status information for validation

country_codestringrequired

Country code of post /validate-geo-fence-auth request.

Example: "+91"
mobilestringrequired

Mobile of post /validate-geo-fence-auth request.

Example: "6283974746"
statusintegerrequired

Status of post /validate-geo-fence-auth request.

Example: 1
latitudestringrequired

Latitude of post /validate-geo-fence-auth request.

Example: "31.633979"
longitudestringrequired

Longitude of post /validate-geo-fence-auth request.

Example: "74.872264"
addressstringrequired

Address of post /validate-geo-fence-auth request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/validate-geo-fence-auth \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "country_code": "+91",
    "mobile": "+916283974746",
    "status": 1,
    "latitude": "134564879",
    "longitude": "1231232",
    "address": "Chetanpura"
  }'

Responses

Geo-fence 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": "Validate geo-fence authentication"
}

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"
}

API v1 user validation

Request

Validates user identity using face authentication and auth tokens for API version 1.

Security
ApiKeyAuth
Bodyapplication/json

Face authentication token and auth token

face_auth_tokenstringrequired

Face auth token of post /api/v1/validate/user request.

auth_tokenstringrequired

Auth token of post /api/v1/validate/user request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/api/v1/validate/user \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "face_auth_token": "Sample_Token_Example",
    "auth_token": "Sample_Token_Example"
  }'

Responses

User successfully validated

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": "API v1 user validation"
}