VeridionQGet Started

Zoho People Extension

Admin Guide

Everything a Zoho People admin needs to install, configure, and maintain the VeridionQ BGV integration — including API keys, OAuth, credits, and sync health.

Prerequisites

Zoho People plan

Professional or above (API access required)

VeridionQ account

Create a free account at veridionq.com/signup

VeridionQ API key

Generate from your VeridionQ dashboard

VeridionQ credits

Purchase from veridionq.com/dashboard/billing

1

Create a VeridionQ Account

If you don't already have a VeridionQ account, create one at veridionq.com/signup. Select the Employer account type. Once registered, your account dashboard is immediately available.

Screenshot: VeridionQ signup page — company name, email, password fields, Employer account type selected
Screenshot: VeridionQ employer dashboard after sign-up — showing credit balance, active cases, quick actions
2

Generate an API Key

API keys authenticate the Zoho People extension to your VeridionQ account.

  1. 1.Log in to your VeridionQ dashboard.
  2. 2.Go to Settings → API Keys.
  3. 3.Click Generate New Key.
  4. 4.Give it a label — e.g. 'Zoho People Integration'.
  5. 5.Copy the key immediately. It is shown only once.
Screenshot: VeridionQ dashboard — Settings > API Keys page with 'Generate New Key' button
Screenshot: API key creation modal — label field, environment selector (Production/Sandbox), 'Generate' button
Screenshot: New API key revealed — key value highlighted with copy button, one-time display warning
Important: Store the API key securely. If lost, you must generate a new key and re-enter it in the Zoho People extension settings.
3

Install the Extension in Zoho People

  1. 1.Open Zoho People as an Administrator.
  2. 2.Go to Settings → Integrations → Extensions.
  3. 3.Search for 'VeridionQ BGV' in the Zoho Marketplace.
  4. 4.Click Install and follow the on-screen prompts.
  5. 5.Accept the required permissions.
Screenshot: Zoho People Settings → Integrations → Extensions page with VeridionQ BGV listed
Screenshot: Zoho Marketplace install page for VeridionQ BGV — extension description, Install button
Screenshot: Permission grant screen listing Zoho People scopes required by VeridionQ BGV
4

Configure the Extension

After installation, open the VeridionQ Settings widget inside Zoho People.

  1. 1.Go to Settings → Extensions → VeridionQ BGV → Open.
  2. 2.Paste your VeridionQ API key into the API Key field.
  3. 3.Select the environment — Production for live use, Sandbox for testing.
  4. 4.Select your Zoho data center (e.g. India, US, Europe).
  5. 5.Click Save & Connect. A connection test runs automatically.
  6. 6.Your account name, plan, and credit balance appear on success.
Screenshot: VeridionQ Settings widget — API Key input field, environment dropdown, data center selector, Save & Connect button
Screenshot: Settings widget after successful connection — account name, plan, credit balance, green 'Connected' badge
5

Authorise Zoho People Access

VeridionQ needs permission to write BGV status updates back to Zoho People employee records. This is done via a one-time OAuth authorisation.

  1. 1.In the VeridionQ Settings widget, click Connect Zoho People.
  2. 2.A Zoho authorisation popup opens.
  3. 3.Log in with your Zoho admin credentials if prompted.
  4. 4.Review the permissions and click Accept.
  5. 5.The popup closes and the Settings widget shows 'Zoho People: Connected'.
Screenshot: Settings widget — 'Connect Zoho People' button in the OAuth section
Screenshot: Zoho OAuth authorisation popup — VeridionQ app requesting Zoho People read/write permissions
Screenshot: Settings widget after OAuth — 'Zoho People: Connected' status with green tick, Disconnect option
Why is this needed? When a BGV case status changes in VeridionQ, our system automatically writes the updated status to the employee's Zoho People record. This OAuth permission enables that write-back.

Managing Credits

Each BGV initiation deducts credits from your VeridionQ account. Credits can be purchased in advance.

Credit StatusMeaningAction
Credits AvailableBalance is above your low thresholdNo action needed
Low CreditsBalance is at or below the thresholdTop up soon
No CreditsZero balance — initiations are blockedTop up before initiating
Payment PendingA transaction is being processedWait for payment confirmation

Top up at veridionq.com/dashboard/billing.

Screenshot: VeridionQ dashboard billing page — credit balance, purchase credits button, transaction history

Monitoring Sync Logs

Sync logs show every attempt by VeridionQ to push a status update to Zoho People. Use these to diagnose and retry any failed syncs.

  1. 1.In the VeridionQ Settings widget, scroll to the Sync Logs section.
  2. 2.Filter by status (All / Failed) or by a specific case.
  3. 3.For any Failed entry, click Retry to re-attempt the sync.
Screenshot: Settings widget sync logs section — table of sync events with status badges (Success / Failed), Retry button on failed rows

API Access Control

API keys can be rotated, revoked, or scoped per environment from your VeridionQ dashboard.

Screenshot: VeridionQ API Keys management page — list of keys, last used date, revoke button, enable/disable toggle

Security Best Practices

  • Create a dedicated API key for the Zoho People integration — don't share it with other systems.
  • Use the Production environment key only for live Zoho People org; use Sandbox for testing.
  • Rotate the key every 90 days or immediately if the Zoho org admin changes.
  • Revoke unused keys from the VeridionQ dashboard promptly.

Extension configured. Now train your team.

Share the User Guide with your HR team so they can start initiating BGV from day one.

User Guide