Skip to content

Commit e5d60a1

Browse files
zangetsouuandregoncalvesdev
authored andcommitted
Add KYC shareable tokens documentation
1 parent 17f03b1 commit e5d60a1

3 files changed

Lines changed: 26 additions & 2 deletions

File tree

docs/flows/crypto-offramp.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ The crypto off-ramp flow allows a user to sell cryptocurrency and convert it int
2929
- `type`: Tag type (e.g.: `memo` or `destination-tag`).
3030
- `value`: Tag value.
3131
- `priority` (_optional_): Priority of the crypto transaction (e.g.: `fast` will enable instant send for `Dash` transactions). Defaults to `normal`.
32+
- `reusableKYC` (_optional_): An object to provide a KYC shareable token.
33+
- `provider` (_required_): Provider that issued the shareable token.
34+
- `token` (_required_): Token issued that can be used to fetch user information.
3235
- `simulation` (_optional_): Simulation object.
3336
- `country` (_optional_): Country to use during simulations, in alpha-2 code format; It will be ignored after the user is authenticated and the user's country will be used.
3437
- `source` (_optional_): An object configuring the asset and amount to be sold.

docs/flows/crypto-onramp.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ The crypto on-ramp flow allows a user to add funds from a credit or debit card t
2424
- `same-tab`: Open in the same tab or iframe (default).
2525
- `parent-tab`: Useful only in an iframe: open in the tab that contains the iframe.
2626
- `partnerFee` (_deprecated_): Use `partner.fee` instead.
27+
- `reusableKYC` (_optional_): An object to provide a KYC shareable token.
28+
- `provider` (_required_): Provider that issued the shareable token.
29+
- `token` (_required_): Token issued that can be used to fetch user information.
2730
- `simulation` (_optional_): Simulation object.
2831
- `country` (_optional_): Country to use during simulations, in alpha-2 code format; It will be ignored after the user is authenticated and the user's country will be used.
2932
- `source` (_optional_): An object configuring the asset and amount to be paid.

docs/kyc-sharing.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,32 @@ sidebar_position: 15
44

55
# KYC sharing
66

7-
To improve the onboarding experience, we provide a REST API that allows our business customers to share user KYC information directly with Topper.
7+
To improve the onboarding experience, we provide multiple ways to empower our business customers to share user KYC information directly with Topper.
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+
## KYC shareable tokens
12+
13+
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.
14+
15+
Currently, we only support tokens from **Sumsub** provider.
16+
17+
:::note
18+
Only applicants with a valid identity will be able to be ingested through the shareable token.
19+
:::
20+
21+
:::info
22+
To use KYC shareable tokens please see [crypto on-ramp](./flows/crypto-onramp.mdx) or [crypto off-ramp](./flows/crypto-offramp.mdx) flows documentation.
23+
:::
24+
25+
## KYC sharing API
26+
27+
There is a REST API where partners can check user KYC details and share information regarding current missing or expired/outdated scopes.
28+
1129
Currently, we support the following scopes: **email**, **profile**, **address**, **phone**, and **identity**.
1230

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

1533
:::info
16-
To use the KYC sharing feature, business customers need to complete a compliance check and be approved before gaining access.
34+
To use the KYC sharing API, business customers need to complete a compliance check and be approved before gaining access.
1735
:::

0 commit comments

Comments
 (0)