User information retrieval
As soon as you obtain an user's access token, you are able to access the status of their verification case and the personal information they submitted.
You can also access the user's provided information, as well as their KYC process status, in the user explorer within the client dashboard.
Retrieve user information
GET
https://RESOURCE_DOMAIN/v2/users/me
This endpoint returns JSON. The scopes associated with the access token will define which fields will be returned.
Headers
Name | Type | Description |
---|---|---|
Content-Type | string |
|
Authorization | string |
|
Response fields
Top level
Field | Type / Format | Description |
---|---|---|
|
| This user's unique identifier. |
|
| A list of email addresses belonging to the user. |
|
| A list of phone numbers belonging to the user. |
|
| The verification cases that you requested for this user. |
|
| The wallets this user has provided during onboarding. |
emails
emails
An array of email addresses belonging to the user. Available when users sign up using an email address. We do not support more than one email address. If the user registered using a phone number, this may be an empty array. Each email entry contains the following fields:
Field | Type / Format | Description |
---|---|---|
|
| A email address, confirmed to belong to the user |
|
|
|
phones
phones
An array of phone numbers belonging to the user. Available when users sign up using a phone number. We do not support more than one phone number. If the user registered using an email address, this may be an empty array. Each phone entry contains the following fields:
Field | Type / Format | Description |
---|---|---|
|
| A phone number, confirmed to belong to the user, in E.164 format (e.g. |
verification_cases
verification_cases
A verification case represents information that has been validated internally by Fractal. Verifications are emitted separately per each level and add-ons. A verification request for basic+liveness
will generate two verifications, one per item.
Field | Type / Format | Description |
---|---|---|
|
| The level (or add-on) that this verification refers to. |
|
|
|
|
|
|
|
| The outcome of our analysis.
|
|
| A unique identifier for this verification case. |
|
| The set of user data fields (see below for details) that have been validated with respect to this level or add-on. For more details on these fields, please check the |
|
| [Deprecated] Coinfirm integration has been deprecated. If you wish to use Coinfirm, please integrate with it directly. Valid only for the wallet add-on verification. The AML report generated by Coinfirm for the cryptocurrency address present under For further information on the report fields, please refer to the the Coinfirm documentation. |
wallets
wallets
An array of wallet addresses and currencies the user has provided during onboarding. This array can be empty if you did not request the user to share a wallet address during onboarding. The array can grow even after the user is approved, as users are allowed to update their wallet addresses and decide with which applications they want to share them.
At this time, this array cannot shrink.
Please note that the wallet currency is merely representative of the addon that was used to request the wallet. For example, if you have used the wallet-eth
addon to request any EVM-compatible wallet, the currency will be eth
.
Field | Type / Format | Description |
---|---|---|
|
| A unique identifier for the wallet. |
|
| The wallet address. |
|
| The wallet currency derived from the used wallet addon. |
|
| Indicates wether the ownership of the wallet has been confirmed with Fractal. |
details
details
The set of fields enumerated below contains the information submitted by the user. The version of the information validated in the context of verification will be present under the details
key in each member of the verification_cases
array. As our process evolves, we may add or remove fields from this list.
Some fields are available for natural person
s only, while others are institution
only. These will be marked in the "Restrictions" column below.
Identification related fields
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
|
|
| |
|
|
| |
| URL |
| |
|
| ||
| URL |
| |
|
|
| |
|
|
| |
|
|
| |
| URL |
| |
|
|
| |
|
|
|
Liveness related fields
liveness_audit_best_file
will generally be the best image of the user. liveness_audit_least_similar_file
is the least similar image to the first image. liveness_audit_open_eyes_file
is the image where the users' eyes are the most open. liveness_audit_quality{1,2,3}_file
are the next 3 highest images.
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
| boolean |
| |
| URL |
| |
| URL |
| |
| URL |
| |
| URL |
| |
| URL |
| |
| URL |
|
Institution related fields
These fields will only be available if the user is an institution and not a natural person.
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
| URL |
| |
|
|
| |
| URL |
| Canada institution |
| URL |
| USA institution |
| URL |
| USA & Canada institution |
| URL |
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
| URL |
| |
| URL |
| |
| URL |
| USA & Canada institution |
| URL |
| |
| URL |
| |
|
|
| USA, Singapore & Hong-Kong institution |
Residency related fields
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
|
| ||
| URL |
| |
|
|
| |
|
|
| This field is required only for applications with split address configuration enabled. For, the rest is optional. |
|
|
| This field is required only for applications with split address configuration enabled. For, the rest is optional. |
|
|
| This field is required only for applications with split address configuration enabled. For, the rest is optional. |
|
|
| This field is required only for applications with split address configuration enabled. For , the rest is optional. |
|
|
|
Source of wealth related fields
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
|
|
| |
|
|
|
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
| URL |
|
|
| URL |
|
|
| URL |
|
|
|
|
|
|
|
|
|
|
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
|
|
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
| URL |
|
|
Social security related fields
Field | Type / Format | KYC level availability | Restrictions |
---|---|---|---|
|
|
| USA residents only |
URLs are set expire a few hours after they were requested.
Last updated