Skip to content

Commit 58a3664

Browse files
tierriMonteiroandregoncalvesdev
authored andcommitted
Enhance KYC sharing documentation
1 parent 5309d79 commit 58a3664

2 files changed

Lines changed: 20 additions & 2 deletions

File tree

docs/kyc-sharing.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,46 @@ To improve the onboarding experience, we provide multiple ways to empower our bu
88

99
By receiving KYC details, Topper can reduce the amount of information requested from users, resulting in a faster and smoother KYC process.
1010

11+
Of the two approaches below, **KYC shareable tokens** is the recommended path. The **KYC sharing API** is an alternative for partners who do not use Sumsub or prefer a manual REST integration.
12+
1113
## KYC shareable tokens
1214

15+
:::tip
16+
**Recommended approach** — use this whenever your KYC provider is Sumsub.
17+
:::
18+
1319
When starting a Topper session, partners can provide a KYC shareable token, which will be used to ingest all available information for the required scopes.
1420

1521
Currently, we only support tokens from **Sumsub** provider.
1622

1723
:::note
18-
Only applicants with a valid identity will be able to be ingested through the shareable token.
24+
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.
1925
:::
2026

2127
:::info
2228
To use KYC shareable tokens please see [crypto on-ramp](./flows/crypto-onramp.mdx) or [crypto off-ramp](./flows/crypto-offramp.mdx) flows documentation.
2329
:::
2430

31+
### User experience
32+
33+
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.
34+
35+
<video controls width="400">
36+
<source src="/videos/kyc-sharing-flow.mp4" type="video/mp4" />
37+
</video>
38+
2539
## KYC sharing API
2640

41+
:::info
42+
**Alternative approach** — use this only if you cannot integrate via Sumsub or prefer a manual REST integration.
43+
:::
44+
2745
There is a REST API where partners can check user KYC details and share information regarding current missing or expired/outdated scopes.
2846

2947
Currently, we support the following scopes: **email**, **profile**, **address**, **phone**, and **identity**.
3048

3149
For more details, see the [KYC sharing documentation](https://developer.uphold.com/rest-apis/core-api/kyc/introduction).
3250

3351
:::info
34-
To use the KYC sharing API, business customers need to complete a compliance check and be approved before gaining access.
52+
To use the KYC sharing API, business customers must be reviewed and approved by Compliance to be authoritative for the shared scopes before gaining access.
3553
:::

static/videos/kyc-sharing-flow.mp4

1.45 MB
Binary file not shown.

0 commit comments

Comments
 (0)