Fractal ID uses OAuth 2.0 as its underlying protocol. This protocol relies on scopes to limit application's access to user information.
We have the following scopes available.
| Scope | Description |
|---|---|
contact:read |
Email address or phone number of the user (whichever they chose during registration, where they provide one or the other) |
uid:read |
(default scope) Anonymized unique user identifier. |
There are two types of user KYC scopes, the verification scope and information details scope. One type allows you to request the verification status (like verification.basic:read), while the second type allows you to access the information provided during the onboarding (verification.basic.details:read).
{% hint style="info" %} If you wish to see the information details scope and request that the user goes through a given KYC level verification, you must specify both scopes. {% endhint %}
| KYC level / add-on | Verification scope | Information details scope |
|---|---|---|
uniqueness |
verification.uniqueness:read |
verification.uniqueness.details:read |
basic |
verification.basic:read |
verification.basic.details:read |
plus |
verification.plus:read |
verification.plus.details:read |
{% hint style="warning" %} Asking a user for the following scopes without the presence of a level scope (like the ones above) is unsupported, and will result in an unexpected user experience. {% endhint %}
| KYC level / add-on | Verification scope | Information details scope |
|---|---|---|
liveness |
verification.liveness:read |
verification.liveness.details:read |
selfie |
verification.selfie:read |
verification.selfie.details:read |
sow |
verification.sow:read |
verification.sow.details:read |
ssn |
verification.ssn:read |
verification.ssn.details:read |
telegram |
verification.telegram:read |
verification.telegram.details:read |
twitter |
verification.twitter:read |
verification.twitter.details:read |
uniq |
verification.uniq:read |
verification.uniq.details:read |
idos |
verification.idos:read |
verification.idos.details:read |
[DEPRECATED] wallet |
verification.wallet:read |
verification.wallet.details:read |
wallet-ada |
verification.wallet-ada:read |
verification.wallet-ada.details:read |
wallet-algo |
verification.wallet-algo:read |
verification.wallet-algo.details:read |
wallet-btc |
verification.wallet-btc:read |
verification.wallet-btc.details:read |
wallet-eth |
verification.wallet-eth:read |
verification.wallet-eth.details:read |
wallet-kar |
verification.wallet-kar:read |
verification.wallet-kar.details:read |
wallet-sol |
verification.wallet-sol:read |
verification.wallet-sol.details:read |
wallet-substrate |
verification.wallet-substrate:read |
verification.wallet-substrate.details:read |
These scopes can be used during the client credentials flow.
| Scope | Description |
|---|---|
client.stats:read |
Grants access to our statistics API |