Skip to main content
A guide to generating, managing, and monitoring secure API keys for integrating with Venator services. The API Credentials section enables clients to create and manage access keys used for authenticating requests to Venator APIs. Each credential represents a secure integration configured within a specific environment. The API Credentials module can be accessed from the Client Portal sidebar under My Credentials.

​
1. API Credentials Interface

The API Credentials interface combines credential cards, environment indicators, and action controls in a structured layout.

​
2. Using the API Credentials Module

The API Credentials section allows clients to manage and review integration credentials at both overview and individual levels.

​
Credential List Overview

The main view displays all API credentials as individual cards. For each credential, clients can view:
  • Credential Name / Identifier — Unique name of the API key
  • Environment Label — Indicates environment (e.g., Development, Testing, Staging, Production)
  • Status Badge — Shows Active state
  • Issued On — Date the credential was created
  • Live Status — Indicates verification status (e.g., Verified)
This provides a quick overview of all active integrations and their readiness.

​
Credential Cards

Each credential is presented as a structured card with clear status visibility. Each card includes:
  • Environment tag (e.g., Production Environment)
  • Active status indicator (top-right badge)
  • Issued date and verification status
  • Service entitlement summary
    • Example: Access to multiple services (Document Verification, Biometrics, AML, KYC, etc.)
Active and verified credentials are clearly highlighted for easy identification.

​
Credential Actions

Each credential card includes an action button:
  • View Credentials — Opens detailed credential information
This allows users to get:
  • API Key
  • Secret Key

​
Generate API Key

The Generate API Key button (top-right) allows clients to create a new credential. When generating a key, users define:
  • Key name
  • Environment (Development, Testing, Staging, Production)
Each generated key is automatically added to the credential list with its status and metadata.

​
3. Operational Use Cases

The API Credentials module is commonly used for:
  • Managing API access for backend integrations
  • Monitoring credential status (Active / Verified)
  • Reviewing service entitlements
  • Creating new API keys for different environments
  • Maintaining secure authentication across services
It ensures controlled and secure access to Ventor APIs.

​
4. Navigation

The API Credentials section is accessible from: Client Portal → Services → My Credentials

​
5. Summary

The API Credentials module acts as the secure access management layer within the Venator platform. By combining credential cards, environment visibility, and status indicators, it enables clients to manage API keys, monitor integration readiness, and maintain secure access control across all connected systems.