Skip to content
Last updated

Getting Started with iVALT Authentication APIs

Quick start guide for integrating iVALT's biometric authentication and identity verification into your application.


Prerequisites

What You Need
  • API Key: Your x-api-key from your iVALT account administrator
  • Base URL: https://api.ivalt.com/admin/public/api

Authentication

All API requests require the x-api-key header:

x-api-key: YOUR_API_KEY
Content-Type: application/json

Quick Start

1. Verify User

Verify a user's identity using their country code and mobile number.

POST /verify-user

Request:

{
  "country_code": "+91",
  "mobile": "6283974746"
}

Response:

{
  "status": "success",
  "message": "Verify user details with encryption"
}

2. Validate Global Authentication

Validate global authentication using the user's mobile number.

POST /validate/global/auth

Request:

{
  "mobile": "+915558675309"
}

Response:

{
  "status": "success",
  "message": "Validate global authentication"
}

Complete Example

const API_KEY = 'YOUR_API_KEY';
const BASE_URL = 'https://api.ivalt.com/admin/public/api';

const headers = {
  'x-api-key': API_KEY,
  'Content-Type': 'application/json'
};

// Step 1: Verify user
const verify = await fetch(`${BASE_URL}/verify-user`, {
  method: 'POST',
  headers,
  body: JSON.stringify({
    country_code: '+91',
    mobile: '5558675309'
  })
});

const verifyResult = await verify.json();

// Step 2: Validate global authentication
const validate = await fetch(`${BASE_URL}/validate/global/auth`, {
  method: 'POST',
  headers,
  body: JSON.stringify({
    mobile: '+915558675309'
  })
});

const validateResult = await validate.json();

Next Steps


Need Help?
  • Visit support.ivalt.com
  • Email support@ivalt.com
  • Use the "Try It" console on any endpoint page