Skip to content
API References
/
Authentication API
/
/
Check users existence

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

Retrieve user by email

Request

Fetches user details using their email address.

Security
ApiKeyAuth
Bodyapplication/json

Email address of the user to fetch

emailstringrequired

Email of post /get-user-by-email request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/get-user-by-email \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "bikramjeet1@ivalt.com"
  }'

Responses

User details retrieved 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": "Retrieve user by email"
}

Check users existence

Request

Checks the existence of users by mobile numbers.

Security
ApiKeyAuth
Bodyapplication/json

List of mobile numbers to check

mobile_numbersArray of stringsrequired

Mobile numbers of post /check-users-existense request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/check-users-existense \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile_numbers": [
      "6283974746",
      "1111111111"
    ]
  }'

Responses

Users existence checked 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": "Check users existence"
}

Redirect to merchant with auth token and mobile

Request

Redirects to a merchant page using auth token and user mobile number.

Security
ApiKeyAuth
Path
auth_tokenstringrequired

Authentication token

mobilestringrequired

User mobile number

curl -i -X GET \
  'https://api-docs.ivalt.com/_mock/products/authentication/auth_apis/api/v1/redirect/to/merchant/{auth_token}/{mobile}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Redirect successful

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": "Redirect to merchant with auth token and mobile"
}