Skip to main content
A setup guide for clients to configure secure access and begin integration with the platform. This document outlines the required access permissions, tools, and security prerequisites needed before starting integration or development activities.

​
1. Access Requirements

Before starting integration, the client requires:
  • Client Dashboard access
  • Valid development credentials
  • Approved role-based permissions
  • Secure network configuration
Access must be provisioned and approved by the system administrator.

​
2. Development Tools

Clients may use:
  • Visual Studio Code (VS Code)
  • Any preferred IDE (IntelliJ, WebStorm, etc.)
Ensure the environment supports:
  • HTTPS communication
  • Secure API calls
  • SDK integration testing

​
3. Network & Environment Whitelisting

For secure API communication and integration, proper whitelisting must be configured.

​
Domain Whitelisting

Ensure the following domains are allowed in your firewall or security configuration: This ensures uninterrupted API communication.

​
IP Whitelisting

If API access is restricted:
  • Provide your public IP address to the system administrator
  • Request IP whitelisting for access
Without IP whitelisting, API calls may fail due to security restrictions.

​
4. VPN & Secure Access

If accessing from:
  • Cloud environments
  • External networks
  • Restricted enterprise networks
A VPN may be required.

​
VPN Setup

  • Install approved VPN client software
  • Connect before accessing dashboards or APIs
This ensures secure communication with the platform infrastructure.

​
5. Security Configuration

Before starting integration:
  • Verify your account has correct permissions
  • Confirm IP/domain whitelisting is active
  • Ensure HTTPS certificates are trusted
  • Avoid sharing credentials across team members
All access should comply with internal security policies.

​
6. Testing & Validation Checklist

Before beginning active integration:
  • Confirm successful login to Client Dashboard
  • Validate API connectivity
  • Test basic authentication calls
  • Verify sandbox environment accessibility
  • Ensure face capture and verification services respond correctly
This ensures the client environment is fully configured.

​
7. Summary

The Environment Setup guide ensures that clients have secure, authorized, and properly configured access to the platform. By completing credential setup, tool configuration, domain/IP whitelisting, and VPN setup (if required), clients can safely integrate, test, and deploy features within the platform ecosystem.