Add kyc sharing doc #99
Conversation
|
🚀 Preview has been deployed.
|
andregoncalvesdev
force-pushed
the
feature/kyc-sharing
branch
2 times, most recently
from
01dba9e to
b5d3223
Compare
andregoncalvesdev
force-pushed
the
feature/kyc-sharing
branch
from
b5d3223 to
868f0f5
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for KYC sharing functionality, explaining how business customers can share user KYC information directly with Topper through a REST API to improve the onboarding experience. It also enhances the customization documentation by adding information about pre-filling the email input on the authentication screen.
- Added comprehensive KYC sharing documentation with supported scopes and API reference
- Enhanced customization documentation with email pre-filling feature
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/kyc-sharing.md | New documentation file explaining KYC sharing API functionality and supported scopes |
| docs/customization.md | Added documentation for pre-filling email input on authentication screen |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -16,6 +16,8 @@ To skip this screen on initialization and go straight to authentication, simply | |||
| |-------------------------|-------------------------| | |||
| | <img src="/images/amount-selection-screen.jpg" alt="Amount selection screen" width="300"/> | <img src="/images/get-started-screen.jpg" alt="Authentication screen" width="300"/> | | |||
|
|
|||
| To pre-fill the email input on the authentication screen, add the `user_email` query parameter with the escaped email value. | |||
|
|
|||
There was a problem hiding this comment.
The documentation mentions 'escaped email value' but doesn't provide clarity on what type of escaping is required. Consider adding an example showing how to properly escape email addresses for URL parameters (e.g., user_email=user%40example.com for [email protected]).
| For example, to pre-fill the email with `[email protected]`, use `user_email=user%40example.com` in the URL. |
Copilot uses AI. Check for mistakes.
Description
Add kyc sharing documentation.
Related issues
https://uphold.atlassian.net/browse/SWY-3303