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

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 admin authentication

Request

Validates the admin's mobile number for authentication purposes.

Security
ApiKeyAuth
Bodyapplication/json

Mobile number of the admin for validation

mobilestringrequired

Mobile of post /validate-admin-auth request.

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

Responses

Admin authenticated 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 admin authentication" }