diff --git a/docs/kyc-sharing.md b/docs/kyc-sharing.md index fbfaced..2eb7ee8 100644 --- a/docs/kyc-sharing.md +++ b/docs/kyc-sharing.md @@ -8,22 +8,40 @@ To improve the onboarding experience, we provide multiple ways to empower our bu By receiving KYC details, Topper can reduce the amount of information requested from users, resulting in a faster and smoother KYC process. +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. + ## KYC shareable tokens +:::tip +**Recommended approach** — use this whenever your KYC provider is Sumsub. +::: + 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. Currently, we only support tokens from **Sumsub** provider. :::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. ::: :::info To use KYC shareable tokens please see [crypto on-ramp](./flows/crypto-onramp.mdx) or [crypto off-ramp](./flows/crypto-offramp.mdx) flows documentation. ::: +### 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. + +| Identity already accepted | Sumsub liveness check | +|---------------------------|-----------------------| +| Topper showing the identity document already accepted via the share token | Sumsub SDK liveness check rendered inside Topper | + ## KYC sharing API +:::info +**Alternative approach** — use this only if you cannot integrate via Sumsub or prefer a manual REST integration. +::: + There is a REST API where partners can check user KYC details and share information regarding current missing or expired/outdated scopes. Currently, we support the following scopes: **email**, **profile**, **address**, **phone**, and **identity**. @@ -31,5 +49,5 @@ Currently, we support the following scopes: **email**, **profile**, **address**, For more details, see the [KYC sharing documentation](https://developer.uphold.com/rest-apis/core-api/kyc/introduction). :::info -To use the KYC sharing API, business customers need to complete a compliance check and be approved before gaining access. +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. ::: diff --git a/static/images/kyc-sharing-identity-accepted.png b/static/images/kyc-sharing-identity-accepted.png new file mode 100644 index 0000000..e458921 Binary files /dev/null and b/static/images/kyc-sharing-identity-accepted.png differ diff --git a/static/images/kyc-sharing-liveness-check.png b/static/images/kyc-sharing-liveness-check.png new file mode 100644 index 0000000..2825676 Binary files /dev/null and b/static/images/kyc-sharing-liveness-check.png differ