# iVALT Authentication APIs

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.

Version: 1.0.0
License: Proprietary and Confidential

## Servers

Production server
```
https://api.ivalt.com/admin/public/api
```

## Security

### ApiKeyAuth

API key required in the header. 

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[iVALT Authentication APIs](https://ivalt-apis.redocly.app/_bundle/products/authentication/Auth_Apis.yaml)

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

### Verify user details with encryption

 - [POST /verify-user](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/verifyuser.md): Endpoint to verify user identity based on country code and mobile number with encryption.

### Generate authentication token

 - [POST /generate-auth-token](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/generateauthtoken.md): Generates an authentication token using client credentials.

### Submit biometric and geo-fence authentication results

 - [POST /biometric-geo-fence-auth-results](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/postbiometricgeofenceauthresults.md): Endpoint to submit user biometric and geo-fencing authentication data.

### Validate geo-fence authentication

 - [POST /validate-geo-fence-auth](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/validategeofenceauth.md): Validates the geo-fence authentication data for a user.

### Validate admin authentication

 - [POST /validate-admin-auth](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/validateadminauth.md): Validates the admin's mobile number for authentication purposes.

### Validate global authentication

 - [POST /validate/global/auth](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/validateglobalauth.md): Validates global authentication using mobile number.

### Validate person

 - [POST /validate/person](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/validateperson.md): Validates a person's mobile number for authentication.

### Validate user time slots and geofencing

 - [POST /validate/user/timeslots/geofencing](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/validateusertimeslotsgeofencing.md): Validates the time slots and geofence location data of a user.

### Global REST authentication validation

 - [POST /validate/global/rest/auth](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/validateglobalrestauth.md): Validates global REST authentication tokens associated with users.

### API v1 user validation

 - [POST /api/v1/validate/user](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/validateapiv1user.md): Validates user identity using face authentication and auth tokens for API version 1.

### API v1 authentication

 - [POST /api/v1/auth](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/authapiv1.md): Authenticates client using client ID and secret for API version 1.

### Get login URL

 - [POST /api/v1/login/url](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/loginapiv1url.md): Retrieves login URL using authentication token and user details.

### Authenticate user by auth token and UID

 - [GET /api/v1/user/auth/{auth_token}/{uid}](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/authapiv1userauthtokenuid.md): Retrieves user authentication status for given auth token and user ID.

### Retrieve user by email

 - [POST /get-user-by-email](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/getuserbyemail.md): Fetches user details using their email address.

### Check users existence

 - [POST /check-users-existense](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/checkusersexistense.md): Checks the existence of users by mobile numbers.

### Redirect to merchant with auth token and mobile

 - [GET /api/v1/redirect/to/merchant/{auth_token}/{mobile}](https://ivalt-apis.redocly.app/products/authentication/auth_apis/auth-apis/authapiv1userauthtokenmobile.md): Redirects to a merchant page using auth token and user mobile number.