FAQs
The following document answers common questions about integrating with HyperVerge One, authentication, workflows, and going live, with quick answers and links to the right docs.
Integration & Core Concepts
What is a Transaction ID?
A Transaction ID uniquely identifies a single end-user application on HyperVerge One.
It is used to:
- Track a user’s onboarding journey uniquely
- Retrieve application details on the dashboard or via APIs
- Map webhook responses back to the correct user in your system
You can define the Transaction ID as any combination of alphanumeric characters and -, as long as it uniquely identifies a user in your system.
Can I integrate your APIs directly instead of SDKs or onboarding links?
Several core HyperVerge One platform capabilities are available only when using SDKs or onboarding links.
The following features are not available with API-only integration:
- No-code workflow orchestration and realtime workflow updates
- Dashboard-based application tracking and status visibility
- Advanced analytics on the dashboard
- Case management actions such as approve / decline
- Attempt-wise and timeline-based organization of results
- Outputs/Logs APIs and Results webhook
- Several other capabilities
For most use cases, we strongly recommend using SDKs or onboarding links to fully leverage the HyperVerge One platform.
If you’re unsure which integration approach is right for your use case, please reach out to integrations@hyperverge.co.
Is SDK authentication using App ID and App Key secure?
Using App ID and App Key directly in client-side applications is not recommended.
Why:
- These credentials can be extracted by decompiling your application
- If compromised, they can be misused to hit HyperVerge services, impacting billing and rate limits
Recommended approach:
Generate short-lived authentication tokens from your backend and pass them to the frontend for SDK authentication. This significantly reduces security risk.
Refer to the token-based authentication documentation for implementation details.
Web SDK & Environment Issues
My Web SDK calls are getting blocked by CORS policy. What should I do?
This error usually occurs when your domain has not been whitelisted.
Error you may observe:
Access to fetch has been blocked by CORS policy…
Resolution:
- Whitelist your domain using the CORS Whitelisting page on the dashboard
- Once whitelisted, Web SDK calls should work as expected.
We are getting CORS issues / Web SDK is not working on UAT
This typically means the UAT domain has not been whitelisted.
Resolution:
- Please ensure your UAT domain is added here.
My Web SDK is returning a 401 Error
A 401 error usually indicates an invalid or expired authentication token.
Please ensure:
- The token is valid
- The token has not expired at the time of SDK initialization
Workflow & UI Customisation
Can I add our brand logo to the workflow?
Yes. We support showing your brand logo on the UI screens of the workflow.
Please reach out to integrations@hyperverge.co to configure this for your workflow.
Can we remove “Powered by HyperVerge” from the screens?
No. HyperVerge does not currently offer a fully white-labelled experience without branding.
If you have concerns regarding branding, please reach out to your HyperVerge sales point of contact.
Dashboard, Data & Billing
Can multiple users access the dashboard?
Yes. You can manage dashboard users directly from the Users tab.
Access and permissions can be managed from the dashboard’s User Management page
Can we change the data retention period?
Yes.
- By default, application data is retained for 14 days
- Custom data retention periods can be configured on request
Please contact integrations@hyperverge.co to modify the data retention period.
How long are image links valid in the Logs API?
Pre-signed S3 image URLs returned by the Logs API are valid for 15 minutes.
Statuses, Analytics & Webhooks
What is a “Completed” status?
A transaction is considered completed when it reaches one of the following states:
- Auto Approved
- Auto Rejected
- Manual Review
Can a Transaction ID reach a completed status multiple times?
Yes. A Transaction ID can attempt the same workflow multiple times based on your workflow logic.
For example:
- Attempt 1 → Auto Rejected
- Attempt 2 → Auto Approved
Why does the completed transaction count differ from Analytics → Business Metrics?
This discrepancy can occur due to two reasons:
- Status Tracking Differences
- Billing counts a transaction if it has reached a completed status at least once
- Business Metrics shows only the latest status of each transaction
- Timing Differences
- Billing considers transactions that completed within a billing month
- Business Metrics displays transactions that started within a selected date range
What is the webhook response time?
- Average webhook response time: five to ten seconds
- During peak traffic, responses may take up to one minute
What is the webhook retry mechanism?
- Webhooks are retried five times at five minute intervals
- Failed messages move to a secondary queue
- Messages are redriven daily at 3:00 AM IST
- Each message is redriven up to 3 times maximum
Cross-Platform Resume (CPR)
What is Cross-Platform Resume (CPR)?
Cross-Platform Resume allows users to continue an application across devices and browsers without losing progress.
Instead of storing state locally, application progress is securely stored on HyperVerge’s backend.
Key benefits of CPR
- Reduced drop-offs when users switch devices or browsers
- Better user experience if the app is uninstalled or browser changes
- A feature commonly expected by enterprise customers
How does CPR work?
- Each transaction is assigned a unique identifier
- Application state is stored securely on HyperVerge servers
- Users can resume the workflow from any device
- State is retrieved securely when the user returns