Comment on page

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.
get
https://RESOURCE_DOMAIN
/users/me
Retrieve user information
Response fields
Top level
Field
Type / Format
Description
uid
string
This user's unique identifier.
emails
array
A list of email addresses belonging to the user.
phones
array
A list of phone numbers belonging to the user.
verification_cases
array
The verification cases that you requested for this user.
wallets
array
The wallets this user has provided during onboarding.
institution
object
[Deprecated] Use verification_cases instead.
The user data fields for an institutional user.
person
object
[Deprecated] Use verification_cases instead.
The user data fields for an individual user.
verifications
array
[Deprecated] Use verification_cases instead.
The list of verifications given to this user.
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
address
string
A email address, confirmed to belong to the user
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
number
string
A phone number, confirmed to belong to the user, in E.164 format (e.g. +4400000000000)
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
level
string
The level (or add-on) that this verification refers to.
journey_completed
boolean
true once a user completes all the journey steps required by your scopes, and gets redirected to redirect_uri. false until then.
status
pending
contacted
done
pending: if Fractal needs to take action,
contacted: if the user needs to take action
done: if Fractal has reached a conclusion
credential
pending
approved
rejected
The outcome of our analysis.
approved: The user fulfills all the requirements
rejected: The user is unable to fulfill all the requirements
pending: Fractal is still evaluating the case
id
string
A unique identifier for this verification case.
details
object
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 details section below.
report
object
[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 details.
For further information on the report fields, please refer to the the Coinfirm documentation.
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
id
uuid
A unique identifier for the wallet.
address
string
The wallet address.
currency
ada
algo
btc
eth
kar
sol
substrate
sui
xrp
The wallet currency derived from the used wallet addon.
verified
boolean
Indicates wether the ownership of the wallet has been confirmed with Fractal.
[Deprecated] institution
This field will be removed eventually. Use verification_cases instead.
[Deprecated] person
This field will be removed eventually. Use verification_cases instead.
[Deprecated] verifications
This field will be removed eventually. Use verification_cases instead.
details
The set of fields enumerated below contains the information submitted by the user. The version of the information validated in the context of a 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 persons 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
date_of_birth
YYYY-MM-DD
light
plus
basic
​
full_name
string
light
plus
basic
​
identification_document_back_file
URL
selfie
basic
​
identification_document_country
​ISO 3166-1 alpha-2​
light
plus
basic
​
identification_document_front_file
URL
selfie
basic
​
identification_document_number
string
light
plus
basic
​
identification_document_type
national_id
passport
drivers_license
light
plus
​
place_of_birth
string
light
plus
​
identification_document_selfie_file
URL
selfie
​
identification_document_date_of_issue
YYYY-MM-DD
light
plus
basic
​
identification_document_date_of_expiry
YYYY-MM-DD
light
plus
basic
​
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
liveness
boolean
liveness
​
liveness_audit_best_file
URL
liveness
​
liveness_audit_least_similar_file
URL
liveness
​
liveness_audit_open_eyes_file
URL
liveness
​
liveness_audit_quality1_file
URL
liveness
​
liveness_audit_quality2_file
URL
liveness
​
liveness_audit_quality3_file
URL
liveness
​
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
articles_of_association_file
URL
light
plus
​
beneficial_owner
string
light
plus
​
certificate_of_corporate_status_file
URL
light
plus
Canada institution
certificate_of_good_standing_file
URL
light
plus
USA institution
certificate_of_incorporation_file
URL
light
plus
USA & Canada institution
commercial_register_entry_file
URL
light
plus
​
commercial_register
string
light
plus
​
company_name
string
light
plus
​
company_seat
string
light
plus
​
jurisdiction
string
light
plus
​
legal_form
string
light
plus
​
managing_directors
string
light
plus
​
owner_identity_proof_file
URL
light
plus
​
power_of_attorney_file
URL
light
plus
​
secretary_certificate_file
URL
light
plus
USA & Canada institution
shareholders_list_file
URL
light
plus
​
transparency_register_entry_file
URL
light
plus
​
unique_identification_number
string
light
plus
USA, Singapore & Hong-Kong institution
Residency related fields
Field
Type / Format
KYC level availability
Restrictions
residential_address_country
​ISO 3166-1 alpha-2​
light
plus
​
residential_address_proof_file
URL
light
plus
​
residential_address
string
light
plus
​
residential_address_proof_date_of_expiry
YYYY-MM-DD
plus
​
Wallet related fields
[Deprecated] All fields are currently deprecated.
Use the top-level wallets array for `wallet_address` and `wallet_currency`.
Coinfirm integration has been deprecated. If you wish to use Coinfirm, please integrate with it directly. This is now only used to return previously stored results.
Field
Type / Format
KYC level availability
Restrictions
wallet_address
string
wallet
​
wallet_currency
BTC or ETH
wallet
​
wallet_check_reports
array
wallet
​
wallet_check_reports contains an array of every AML report we requested from Coinfirm for this user's wallet address during the verification case process. For more information on the report fields, please refer to the the Coinfirm documentation.
Source of wealth related fields
Field
Type / Format
KYC level availability
Restrictions
sow_estimated_net_worth_currency
EUR or USD
sow
​
sow_estimated_net_worth_value
string
sow
​
Field
Type / Format
KYC level availability
Restrictions
sow_balance_sheet_file
URL
sow
institution
sow_cash_flow_statement_file
URL
sow
institution
sow_income_statement_file
URL
sow
institution
sow_unaudited_accountant_name
string
sow
institution
sow_unaudited_accountant_professional_body
string
sow
institution
Field
Type / Format
KYC level availability
Restrictions
sow_type
crypto
dividends
divorce_settlement
freelance
gifts
inheritance
lease_revenue
life_policy
pension
salary
sale_of_company
sale_of_property
sale_of_shares
sow
person
sow_crypto_bank_statement_file
URL
sow
person
sow_crypto_source_of_initial_investment_file
URL
sow
person
sow_crypto_transactions_last_3_months_file
URL
sow
person
sow_dividends_bank_statement_file
URL
sow
person
sow_dividends_entitlement_file
URL
sow
person
sow_divorce_settlement_bank_statement_file
URL
sow
person
sow_divorce_settlement_proof_file
URL
sow
person
sow_freelance_bank_statement_file
URL
sow
person
sow_freelance_last_year_tax_returns_file
URL
sow
person
sow_freelance_service_contracts_file
URL
sow
person
sow_gifts_bank_statement_file
URL
sow
person
sow_gifts_name_of_donator
string
sow
person
sow_gifts_reason_for_donation
string
sow
person
sow_gifts_relationship_with_donator
string
sow
person
sow_inheritance_bank_statement_file
URL
sow
person
sow_inheritance_proof_file
URL
sow
person
sow_lease_revenue_agreement_file
URL
sow
person
sow_lease_revenue_bank_statement_file
URL
sow
person
sow_life_policy_bank_statement_file
URL
sow
person
sow_life_policy_closing_statement_file
URL
sow
person
sow_pension_bank_statement_file
URL
sow
person
sow_pension_statement_file
URL
sow
person
sow_salary_bank_statement_file
URL
sow
person
sow_salary_last_year_tax_returns_file
URL
sow
person
sow_salary_pay_slips_last_3_months_file
URL
sow
person
sow_sale_of_company_bank_statement_file
URL
sow
person
sow_sale_of_company_contract_file
URL
sow
person
sow_sale_of_property_bank_statement_file
URL
sow
person
sow_sale_of_property_contract_file
URL
sow
person
sow_sale_of_shares_bank_statement_file
URL
sow
person
sow_sale_of_shares_proof_file
URL
sow
person
Social security related fields
Field
Type / Format
KYC level availability
Restrictions
social_security_number
string
ssn
USA residents only
URLs are set expire a few hours after they were requested.

Field	Type / Format	Description
`uid`	`string`	This user's unique identifier.
`emails`	`array`	A list of email addresses belonging to the user.
`phones`	`array`	A list of phone numbers belonging to the user.
`verification_cases`	`array`	The verification cases that you requested for this user.
`wallets`	`array`	The wallets this user has provided during onboarding.
`institution`	`object`	[Deprecated] Use `verification_cases` instead. The user data fields for an institutional user.
`person`	`object`	[Deprecated] Use `verification_cases` instead. The user data fields for an individual user.
`verifications`	`array`	[Deprecated] Use `verification_cases` instead. The list of verifications given to this user.

Field	Type / Format	Description
`address`	`string`	A email address, confirmed to belong to the user

Field	Type / Format	Description
`number`	`string`	A phone number, confirmed to belong to the user, in E.164 format (e.g. `+4400000000000`)

Field	Type / Format	Description
`level`	`string`	The level (or add-on) that this verification refers to.
`journey_completed`	`boolean`	`true` once a user completes all the journey steps required by your scopes, and gets redirected to `redirect_uri`. `false` until then.
`status`	`pending` `contacted` `done`	`pending`: if Fractal needs to take action, `contacted`: if the user needs to take action `done`: if Fractal has reached a conclusion
`credential`	`pending` `approved` `rejected`	The outcome of our analysis. `approved`: The user fulfills all the requirements `rejected`: The user is unable to fulfill all the requirements `pending`: Fractal is still evaluating the case
`id`	`string`	A unique identifier for this verification case.
`details`	`object`	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 `details` section below.
`report`	`object`	[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 `details`. For further information on the report fields, please refer to the the Coinfirm documentation.

Field	Type / Format	Description
`id`	`uuid`	A unique identifier for the wallet.
`address`	`string`	The wallet address.
`currency`	`ada` `algo` `btc` `eth` `kar` `sol` `substrate` `sui` `xrp`	The wallet currency derived from the used wallet addon.
`verified`	`boolean`	Indicates wether the ownership of the wallet has been confirmed with Fractal.

Field	Type / Format	KYC level availability
`date_of_birth`	`YYYY-MM-DD`	`light` `plus` `basic`
`full_name`	`string`	`light` `plus` `basic`
`identification_document_back_file`	URL	`selfie` `basic`
`identification_document_country`	ISO 3166-1 alpha-2	`light` `plus` `basic`
`identification_document_front_file`	URL	`selfie` `basic`
`identification_document_number`	`string`	`light` `plus` `basic`
`identification_document_type`	`national_id` `passport` `drivers_license`	`light` `plus`
`place_of_birth`	`string`	`light` `plus`
`identification_document_selfie_file`	URL	`selfie`
`identification_document_date_of_issue`	`YYYY-MM-DD`	`light` `plus` `basic`
`identification_document_date_of_expiry`	`YYYY-MM-DD`	`light` `plus` `basic`

Field	Type / Format	KYC level availability
`liveness`	boolean	`liveness`
`liveness_audit_best_file`	URL	`liveness`
`liveness_audit_least_similar_file`	URL	`liveness`
`liveness_audit_open_eyes_file`	URL	`liveness`
`liveness_audit_quality1_file`	URL	`liveness`
`liveness_audit_quality2_file`	URL	`liveness`
`liveness_audit_quality3_file`	URL	`liveness`

Field	Type / Format	KYC level availability	Restrictions
`articles_of_association_file`	URL	`light` `plus`
`beneficial_owner`	`string`	`light` `plus`
`certificate_of_corporate_status_file`	URL	`light` `plus`	Canada institution
`certificate_of_good_standing_file`	URL	`light` `plus`	USA institution
`certificate_of_incorporation_file`	URL	`light` `plus`	USA & Canada institution
`commercial_register_entry_file`	URL	`light` `plus`
`commercial_register`	`string`	`light` `plus`
`company_name`	`string`	`light` `plus`
`company_seat`	`string`	`light` `plus`
`jurisdiction`	`string`	`light` `plus`
`legal_form`	`string`	`light` `plus`
`managing_directors`	`string`	`light` `plus`
`owner_identity_proof_file`	URL	`light` `plus`
`power_of_attorney_file`	URL	`light` `plus`
`secretary_certificate_file`	URL	`light` `plus`	USA & Canada institution
`shareholders_list_file`	URL	`light` `plus`
`transparency_register_entry_file`	URL	`light` `plus`
`unique_identification_number`	`string`	`light` `plus`	USA, Singapore & Hong-Kong institution

Field	Type / Format	KYC level availability
`residential_address_country`	ISO 3166-1 alpha-2	`light` `plus`
`residential_address_proof_file`	URL	`light` `plus`
`residential_address`	`string`	`light` `plus`
`residential_address_proof_date_of_expiry`	`YYYY-MM-DD`	`plus`

Field	Type / Format	KYC level availability
`wallet_address`	`string`	`wallet`
`wallet_currency`	`BTC` or `ETH`	`wallet`
`wallet_check_reports`	`array`	`wallet`

Field	Type / Format	KYC level availability	Restrictions
`sow_estimated_net_worth_currency`	`EUR` or `USD`	`sow`
`sow_estimated_net_worth_value`	`string`	`sow`

Field	Type / Format	KYC level availability	Restrictions
`sow_balance_sheet_file`	URL	`sow`	`institution`
`sow_cash_flow_statement_file`	URL	`sow`	`institution`
`sow_income_statement_file`	URL	`sow`	`institution`
`sow_unaudited_accountant_name`	`string`	`sow`	`institution`
`sow_unaudited_accountant_professional_body`	`string`	`sow`	`institution`

Field	Type / Format	KYC level availability	Restrictions
`sow_type`	`crypto` `dividends` `divorce_settlement` `freelance` `gifts` `inheritance` `lease_revenue` `life_policy` `pension` `salary` `sale_of_company` `sale_of_property` `sale_of_shares`	`sow`	`person`
`sow_crypto_bank_statement_file`	URL	`sow`	`person`
`sow_crypto_source_of_initial_investment_file`	URL	`sow`	`person`
`sow_crypto_transactions_last_3_months_file`	URL	`sow`	`person`
`sow_dividends_bank_statement_file`	URL	`sow`	`person`
`sow_dividends_entitlement_file`	URL	`sow`	`person`
`sow_divorce_settlement_bank_statement_file`	URL	`sow`	`person`
`sow_divorce_settlement_proof_file`	URL	`sow`	`person`
`sow_freelance_bank_statement_file`	URL	`sow`	`person`
`sow_freelance_last_year_tax_returns_file`	URL	`sow`	`person`
`sow_freelance_service_contracts_file`	URL	`sow`	`person`
`sow_gifts_bank_statement_file`	URL	`sow`	`person`
`sow_gifts_name_of_donator`	`string`	`sow`	`person`
`sow_gifts_reason_for_donation`	`string`	`sow`	`person`
`sow_gifts_relationship_with_donator`	`string`	`sow`	`person`
`sow_inheritance_bank_statement_file`	URL	`sow`	`person`
`sow_inheritance_proof_file`	URL	`sow`	`person`
`sow_lease_revenue_agreement_file`	URL	`sow`	`person`
`sow_lease_revenue_bank_statement_file`	URL	`sow`	`person`
`sow_life_policy_bank_statement_file`	URL	`sow`	`person`
`sow_life_policy_closing_statement_file`	URL	`sow`	`person`
`sow_pension_bank_statement_file`	URL	`sow`	`person`
`sow_pension_statement_file`	URL	`sow`	`person`
`sow_salary_bank_statement_file`	URL	`sow`	`person`
`sow_salary_last_year_tax_returns_file`	URL	`sow`	`person`
`sow_salary_pay_slips_last_3_months_file`	URL	`sow`	`person`
`sow_sale_of_company_bank_statement_file`	URL	`sow`	`person`
`sow_sale_of_company_contract_file`	URL	`sow`	`person`
`sow_sale_of_property_bank_statement_file`	URL	`sow`	`person`
`sow_sale_of_property_contract_file`	URL	`sow`	`person`
`sow_sale_of_shares_bank_statement_file`	URL	`sow`	`person`
`sow_sale_of_shares_proof_file`	URL	`sow`	`person`