User information retrieval

get
Retrieve user information

https://RESOURCE_DOMAIN/users/me
This endpoint returns JSON. The scopes associated with the access token will define which fields will be returned.
Request
Response
Headers
Content-Type
optional
string
application/json
Authorization
required
string
Bearer access_token
200: OK
response1.json supposes access_token has the following scopes, with plus, selfie and wallet verifications emitted. * uid:read * email:read * verification.plus:read * verification.selfie:read * verification.wallet:read * verification.wallet.details:read response2.json suppose access_token has the following scopes: * uid:read * verification.plus:read * verification.plus.details:read * verification.selfie:read * verification.selfie.details:read * verification.wallet:read * verification.wallet.details:read
response1.json
response2.json
{
"emails": [
{
"address": "example@frctls.com"
}
],
"institution": null,
"person": {},
"uid": "b76ab44d-b71e-4d19-b6f9-f6e88cd73946",
"verifications": [
{
"details": null,
"level": "plus",
"report": null
},
{
"details": null,
"level": "selfie",
"report": null
},
{
"details": {
"wallet_address": "0xa1eD7e13271bFeB758CB5CB6F3EdcC97A0E5943D",
"wallet_currency": "ETH"
},
"level": "wallet",
"report": {
"mock_response": true,
"report_id": "28df4599a4256830a4285af140b00868a0e3566ad79ca058f609e6b7ea151fcb",
"is_smart_contract": false,
"version": "3.3",
"report_type": "standard",
"report_time": "2019-07-29T15:24:29.422Z",
"report_block_height": 1,
"address": "a1eD7e13271bFeB758CB5CB6F3EdcC97A0E5943D",
"address_type": "ETH",
"address_subtype": "ETH",
"address_used": false,
"address_estimation": null,
"cscore": 0,
"multisig": null,
"whitelist": false,
"cc_balance": 0,
"usd_balance": 0,
"usd_exchange_rate": 0,
"profiles": [],
"cscore_info": [],
"assets_total_usd_value": 0,
"assets_count": 4,
"indicators": null
}
}
]
}
{
"institution": null,
"person": {
"date_of_birth": "1967-08-16",
"full_name": "David Muller",
"identification_document_country": "DE",
"identification_document_front_file": "<URL>",
"identification_document_number": "123456789",
"identification_document_selfie_file": "<URL>",
"identification_document_type": "passport",
"place_of_birth": "Berlin",
"residential_address": "Wiener Straße 10, Berlin, 10999",
"residential_address_country": "DE",
"residential_address_proof_file": "<URL>",
"wallet_address": "0xa1eD7e13271bFeB758CB5CB6F3EdcC97A0E5943D",
"wallet_currency": "ETH"
},
"uid": "b76ab44d-b71e-4d19-b6f9-f6e88cd73946",
"verifications": [
{
"details": {
"residential_address_country": "DE",
"residential_address_proof_file": "<URL>",
"residential_address": "Wiener Straße 10, Berlin, 10999",
"identification_document_type": "passport",
"place_of_birth": "Berlin",
"date_of_birth": "1967-08-16",
"full_name": "David Muller",
"identification_document_country": "DE",
"identification_document_number": "123456789"
},
"level": "plus",
"report": null
},
{
"details": {
"identification_document_selfie_file": "<URL>",
"identification_document_front_file": "<URL>"
},
"level": "selfie",
"report": null
},
{
"details": {
"wallet_address": "0xa1eD7e13271bFeB758CB5CB6F3EdcC97A0E5943D",
"wallet_currency": "ETH"
},
"level": "wallet",
"report": {
"mock_response": true,
"report_id": "28df4599a4256830a4285af140b00868a0e3566ad79ca058f609e6b7ea151fcb",
"is_smart_contract": false,
"version": "3.3",
"report_type": "standard",
"report_time": "2019-07-29T15:24:29.422Z",
"report_block_height": 1,
"address": "a1eD7e13271bFeB758CB5CB6F3EdcC97A0E5943D",
"address_type": "ETH",
"address_subtype": "ETH",
"address_used": false,
"address_estimation": null,
"cscore": 0,
"multisig": null,
"whitelist": false,
"cc_balance": 0,
"usd_balance": 0,
"usd_exchange_rate": 0,
"profiles": [],
"cscore_info": [],
"assets_total_usd_value": 0,
"assets_count": 4,
"indicators": null
}
}
]
}

Response fields

Top level

Field

Type / Format

Description

emails

array

A list of email addresses belonging to the user.

institution

object

The user data fields for an institutional user.

person

object

The user data fields for an individual user.

verifications

array

The list of verifications given to this user.

Institution / Person

These fields contain the last version of the user data submitted to the platform. Only one of these fields will contain data, depending upon the user representing either an institution or themselves as a person. Since the user may edit their information at any time, verified data should be looked up under the verifications field only. For more details on these fields, please check the User data section below.

Verifications

A verification represents information that has been validated internally by Fractal. Verifications are emitted separately per each level and add-ons. A verification request for light+video will generate two verifications, one per item.

Field

Type / Format

Description

level

string

The level (or add-on) that this verification refers to.

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 User data section below.

report

object

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.

User data

The set of fields enumerated below contains the information submitted by the user. Since we allow the user to update his information at any moment, the most recent version of the information provided by the user in these fields will be enumerated either under the institution or person top-level field. The version of the information validated in the context of a verification will be present under the details key in each member of the verifications array.

Field

Type / Format

KYC level availability

Restrictions

date_of_birth

YYYY-MM-DD

v1, light, plus, basic

full_name

string

v1, light, plus, basic

identification_document_back_file

URL

v1, selfie, basic

identification_document_country

ISO 3166-1 alpha-2

v1, light, plus, basic

identification_document_front_file

URL

v1, selfie, basic

identification_document_number

string

v1, light, plus, basic

identification_document_selfie_file

URL

v1, selfie

identification_document_type

national_id, passport or drivers_license

v1, light, plus

place_of_birth

string

v1, light, plus

residential_address_country

ISO 3166-1 alpha-2

v1, light, plus

residential_address_proof_file

URL

v1, light, plus

residential_address

string

v1, light, plus

wallet_address

string

wallet

wallet_currency

BTC or ETH

wallet

social_security_number

string

v1, ssn

USA residents only

articles_of_association_file

URL

v1, light, plus

Institutions only

beneficial_owner

string

v1, light, plus

Institutions only

certificate_of_corporate_status_file

URL

v1, light, plus

Canada institutions only

certificate_of_good_standing_file

URL

v1, light, plus

USA institutions only

certificate_of_incorporation_file

URL

v1, light, plus

USA & Canada institutions only

commercial_register_entry_file

URL

v1, light, plus

Institutions only

commercial_register

string

v1, light, plus

Institutions only

company_name

string

v1, light, plus

Institutions only

company_seat

string

v1, light, plus

Institutions only

jurisdiction

string

v1, light, plus

Institutions only

legal_form

string

v1, light, plus

Institutions only

liveness

boolean

liveness

managing_directors

string

v1, light, plus

Institutions only

owner_identity_proof_file

URL

v1, light, plus

Institutions only

power_of_attorney_file

URL

v1, light, plus

Institutions only

secretary_certificate_file

URL

v1, light, plus

USA & Canada institutions only

shareholders_list_file

URL

v1, light, plus

Institutions only

transparency_register_entry_file

URL

v1, light, plus

Institutions only

unique_identification_number

string

v1, light, plus

USA, Singapore & Hong-Kong institutions only

sow_estimated_net_worth_currency

EUR or USD

sow

sow_estimated_net_worth_value

string

sow

sow_crypto_bank_statement_file

URL

sow

People only

sow_crypto_source_of_initial_investment_file

URL

sow

People only

sow_crypto_transactions_last_3_months_file

URL

sow

People only

sow_dividends_bank_statement_file

URL

sow

People only

sow_dividends_entitlement_file

URL

sow

People only

sow_divorce_settlement_bank_statement_file

URL

sow

People only

sow_divorce_settlement_proof_file

URL

sow

People only

sow_freelance_bank_statement_file

URL

sow

People only

sow_freelance_last_year_tax_returns_file

URL

sow

People only

sow_freelance_service_contracts_file

URL

sow

People only

sow_gifts_bank_statement_file

URL

sow

People only

sow_gifts_name_of_donator

string

sow

People only

sow_gifts_reason_for_donation

string

sow

People only

sow_gifts_relationship_with_donator

string

sow

People only

sow_inheritance_bank_statement_file

URL

sow

People only

sow_inheritance_proof_file

URL

sow

People only

sow_lease_revenue_agreement_file

URL

sow

People only

sow_lease_revenue_bank_statement_file

URL

sow

People only

sow_life_policy_bank_statement_file

URL

sow

People only

sow_life_policy_closing_statement_file

URL

sow

People only

sow_pension_bank_statement_file

URL

sow

People only

sow_pension_statement_file

URL

sow

People only

sow_salary_bank_statement_file

URL

sow

People only

sow_salary_last_year_tax_returns_file

URL

sow

People only

sow_salary_pay_slips_last_3_months_file

URL

sow

People only

sow_sale_of_company_bank_statement_file

URL

sow

People only

sow_sale_of_company_contract_file

URL

sow

People only

sow_sale_of_property_bank_statement_file

URL

sow

People only

sow_sale_of_property_contract_file

URL

sow

People only

sow_sale_of_shares_bank_statement_file

URL

sow

People only

sow_sale_of_shares_proof_file

URL

sow

People only

sow_type

crypto, dividends, divorce_settlement, freelance, gifts, inheritance, lease_revenue, life_policy, pension, salary, sale_of_company, sale_of_property, or sale_of_shares

sow

People only

sow_balance_sheet_file

URL

sow

Institutions only

sow_cash_flow_statement_file

URL

sow

Institutions only

sow_income_statement_file

URL

sow

Institutions only

sow_unaudited_accountant_name

string

sow

Institutions only

sow_unaudited_accountant_professional_body

string

sow

Institutions only

URLs are set expire a few hours after they were requested.