Onboarding Settings
Use Onboarding Settings to control how the onboarding link handoff behave for a Hosted KYC configuration.
This page helps you make the onboarding journey safer, easier to manage, and better suited to invitation-based use cases.
Onboarding Link settings
The onboarding link is the URL you share with your end-users to start Hosted KYC.
In Onboarding Settings, you can control how that link behaves.
Single-use link
You can make the onboarding link single-use.
After the end consumer uses the link and successfully completes onboarding, a "consumed" flag will appear next to the toggle. To reactivate the link, simply turn off the toggle, and the link will become valid again.
Use this when you want the link to be used for one onboarding attempt only, for example when you are sending a personalised invitation to a specific user.
Link expiry date
You can set an expiry date for the onboarding link.
Use this when the link should stop working after a certain date, such as:
invitation-based onboarding
time-limited campaigns
controlled onboarding windows
When to use these settings
These settings are especially useful when:
links are shared in a controlled onboarding process
the link should only be valid for a limited time
you want better control over how the onboarding entry point is used
Transaction Nonce
After you finish configuring Hosted KYC, you can copy the generated onboarding link and share it with your end-users.
You can send the link through channels such as:
email
SMS
WhatsApp
your website
your back-office tools
Use a transaction nonce to identify the session
If your team wants to match the Hosted KYC result to a specific customer, application, or case, add a unique transaction nonce to the onboarding link.
The transaction nonce is passed using the tn query parameter.
Example:
Why the transaction nonce matters
A transaction nonce helps your team:
connect the onboarding result to the correct customer record
identify each onboarding request uniquely
reduce the risk of mixing up sessions
This value is included in the onboarding result, making it easier for your technical team to match the result back to the correct internal record.
Best practice
Generate a new and unique tn value for every onboarding request.
If you are sending onboarding links from your own system, it is often best to generate the tn value first and attach it before directing the user into Hosted KYC.
Note For security and reliability, the transaction nonce should be generated and verified by your backend system rather than on the client side.
It is essential to emphasize that the transaction nonce will be securely stored on our server to prevent its reuse.
Important notes
If you're using the onboarding URL in offline mode such as sending it via email, where the process isn't triggered in real-time, we highly recommend utilizing a URL that initially directs to your API. This URL can carry your unique identification, and subsequently, redirect the end user to the onboarding URL with a generated transaction nonce. This approach enables you to validate the session before directing the end user to the onboarding process and generating the corresponding transaction nonce.
The "Transaction Nonce" denoted as "tn" should be unique for each transaction, and it is the responsibility of the customer to ensure adherence to this requirement. Failure to do so may result in an error being returned from our side when the end-user accesses the onboarding URL.
Last updated
Was this helpful?