Skip to content

Enhance KYC sharing documentation#123

Open
tierriMonteiro wants to merge 1 commit into
masterfrom
enhancement/enhance-kyc-sharing-documentation
Open

Enhance KYC sharing documentation#123
tierriMonteiro wants to merge 1 commit into
masterfrom
enhancement/enhance-kyc-sharing-documentation

Conversation

@tierriMonteiro
Copy link
Copy Markdown
Contributor

@tierriMonteiro tierriMonteiro commented May 28, 2026

Description

Reframes the KYC sharing documentation to clearly position shareable tokens as the recommended approach and KYC sharing API as the alternative for partners that don't use Sumsub.

Changes in docs/kyc-sharing.md:

  • Added an intro line steering partners to shareable tokens and a :::tip "Recommended approach" admonition on that section.
  • Rewrote the identity note to match the actual backend behaviour: the Sumsub flow only initiates when the user has a valid Sumsub identity and identity (or related personal-data scopes) is needed for the current session.
  • Added a ### User experience subsection with two screenshots showing what the end user sees: the partner-provided identity already accepted, and the Sumsub liveness check rendered inside Topper.
  • Added an :::info "Alternative approach" admonition on the API section and strengthened the compliance note — partners using the API must be approved by Compliance to be authoritative for the shared scopes.

Related issues

@tierriMonteiro tierriMonteiro self-assigned this May 28, 2026
@tierriMonteiro tierriMonteiro requested a review from a team as a code owner May 28, 2026 09:20
@github-actions
Copy link
Copy Markdown

🚀 Preview has been deployed.

Name Link
🔨 Commit SHA d4c8d8a
🔍 Deploy log https://github.com/uphold/topper-docs/actions/runs/26566129184
🚀 Preview URL https://b72090e3.topper-docs.pages.dev

Comment thread docs/kyc-sharing.md

:::note
Only applicants with a valid identity will be able to be ingested through the shareable token.
The Sumsub shareable token flow is only initiated when the user has a valid Sumsub identity **and** Topper requires identity (or related personal-data scopes) for the current session. If identity is not needed, the token is ignored.
Copy link
Copy Markdown
Contributor

@andregoncalvesdev andregoncalvesdev Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Sumsub shareable token flow is only initiated when the applicant has a valid Sumsub identity and Topper requires identity for the current session. If identity is not needed, the token is ignored.

Comment thread docs/kyc-sharing.md

### User experience

When the share token is accepted, the user sees their partner-provided identity document already marked as accepted in Topper and only needs to complete a fresh liveness check rendered by the Sumsub SDK.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user will be presented with a KYC onboarding screen, where they will be required to capture a selfie as part of a liveness check to securely share their personal data. The Sumsub SDK will be initiated, allowing the user to clearly see the information they are about to share while guiding them through the liveness verification process. Once the selfie is successfully submitted, the user will either proceed to transact or, if necessary based on their country, be prompted to provide additional KYC details.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And update images with the KYC onboarding screen, the initial screen after the SDK has been initiated, the steps screen, and the pre-initiate liveness check step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants