Overview
The Return Path URL is a feature in VerifiMe that lets clients automatically redirect customers back to a URL after the identity check is complete.
Important: The Return Path URL is configured once at the client container level and automatically applies to all orchestrations run against your business's specific static link.
What Problem Does This Solve?
Previously, when customers completed the VerifiMe identity check process, they remained on the VerifiMe completion screen with no automated way to return to the client application. This created friction in the user experience and required customers to manually navigate back or close tabs.
How It Works
Container-Level Configuration
The Return Path URL is a one-time configuration setting at your client container level this can be set up via support or your account manager. Once configured:
It automatically applies to all identity verification orchestrations
All customers using your business's static orchestration link will be redirected to this URL upon completion
Standard Orchestrated Flow
When a customer completes the identity verification process using your static orchestration link, they will be automatically redirected to your configured Return Path URL.
Widget Implementation Flow
The Return Path URL configuration also applies to widget implementations with two scenarios:
Static Return URL (Recommended):
Your container-level Return Path URL is used
Customer is automatically redirected upon completion
Dynamic Return URL Requirements:
When your implementation requires a dynamic return URL (determined at runtime and different from the container-level setting)
Upon completion, the page displays a confirmation message instructing the customer to:
Close the VerifiMe tab(s)
Return to the originating URL/tab
The VerifiMe widget on the originating page automatically updates to confirm the identity check process has been completed
Implementation Guide
Prerequisites
Active VerifiMe client account with container access
Valid HTTPS endpoint for receiving returning customers
One-Time Configuration
Step 1: Configure Your Return Path URL via [email protected] or Contact Your Account Manager
Your Return Path URL
Provide your fully qualified HTTPS URL
Example:
https://yourdomain.com/verification-completeThis URL will be used for all orchestrations under this container
Step 2: Prepare Your Return Endpoint
Ensure your Return Path URL endpoint is ready to:
Receive incoming customers redirected from VerifiMe
Handle session restoration or customer identification
Continue your application's post-verification workflow
Technical Specifications
Return Path URL Requirements
Protocol: Must use HTTPS
Format: Fully qualified URL (e.g.,
https://domain.com/path)Scope: Applies to entire client container
Query Parameters: Can be included in the base URL
Length: Maximum 2048 characters recommended
Configuration: Set once at container level
Updating Your Return Path URL
If you need to change your Return Path URL contact [email protected]
Troubleshooting
Customer Not Being Redirected
Possible Causes:
Return Path URL not configured in the container
URL is incorrectly formatted
Endpoint is unreachable (returns error status)
Customer Redirected but Session Lost
Possible Causes:
Cookie configuration issues
Session timeout
Cross-domain cookie restrictions
Widget Implementation Scenarios
When to Use Container-Level Return Path URL
✅ Your application workflow returns to a consistent page
✅ You can identify customers via session or verification ID
✅ The return destination doesn't depend on runtime factors
✅ You want the simplest implementation
When to Use Dynamic Return Path (Manual Return)
✅ Return destination varies by customer journey
✅ Each verification needs a unique return context
✅ You're handling multi-tenant scenarios with different return paths
✅ The initiating URL contains dynamic state that must be preserved
Note: If you frequently need dynamic return URLs, consider discussing custom implementation options via the API’s with your VerifiMe account team.
FAQs
Q: Can I have different Return Path URLs for different types of verifications?
A: The Return Path URL is configured at the container level and applies to all orchestrations. If you require different return destinations, contact your VerifiMe account manager to discuss multiple container options or custom solutions.
Q: What happens if I don't configure a Return Path URL?
A: Customers will see the standard VerifiMe completion screen without automatic redirection. They will be requested to now close the windows associated with the verification request.
Q: Can I change the Return Path URL frequently?
A: Yes, you can update it as needed through your container settings. However, consider the impact on in-flight verifications and plan transitions carefully.
Q: Can VerifiMe pass verification results in the redirect?
A: Contact your VerifiMe account manager to discuss what parameters can be appended to your Return Path URL during the redirect.