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

NameTypeDescription

Content-Type

string

application/json

Authorization

string

Bearer

access_token

/**
* supposes `access_token` has the following scopes, with plus, 
* selfie and wallet verifications emitted.
*  
* - uid:read  
* - contact:read  
* - verification.plus:read  
* - verification.selfie:read  
* - verification.wallet:read  
* - verification.wallet.details:read  
*/

{
  "emails": [
    {
      "address": "example@frctls.com",
      "source_type": "registration", // "obsolete", "journey"
    }
  ],
  "phones:": [
    {
      "number": "+44000000000"
    }
  ],
  "uid": "b76ab44d-b71e-4d19-b6f9-f6e88cd73946",
  "verification_cases": [
    {
      "details": null,
      "level": "plus+selfie",
      "status": "pending",
      "credential": "pending",
    },
    {
      "details": null,
      "level": "basic+liveness",
      "status": "done",
      "credential": "approved",
    },
    {
      "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

FieldType / FormatDescription

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.

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:

FieldType / FormatDescription

address

string

A email address, confirmed to belong to the user

source_type

enum(string)

  • registration - verified authentication email address

  • journey - unverified email address, not used for authentication

  • obsolete - verified authentication email address that is no longer in use

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:

FieldType / FormatDescription

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.

FieldType / FormatDescription

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.

FieldType / FormatDescription

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.

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 persons only, while others are institution only. These will be marked in the "Restrictions" column below.

FieldType / FormatKYC level availabilityRestrictions

date_of_birth

YYYY-MM-DD

plus

basic

full_name

string

plus

basic

identification_document_back_file

URL

selfie

basic

identification_document_country

plus

basic

identification_document_front_file

URL

selfie

basic

identification_document_number

string

plus

basic

identification_document_type

national_id

passport

drivers_license

plus

place_of_birth

string

plus

identification_document_selfie_file

URL

selfie

identification_document_date_of_issue

YYYY-MM-DD

plus

basic

identification_document_date_of_expiry

YYYY-MM-DD

plus

basic

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.

FieldType / FormatKYC level availabilityRestrictions

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

These fields will only be available if the user is an institution and not a natural person.

FieldType / FormatKYC level availabilityRestrictions

articles_of_association_file

URL

plus

beneficial_owner

string

plus

certificate_of_corporate_status_file

URL

plus

Canada institution

certificate_of_good_standing_file

URL

plus

USA institution

certificate_of_incorporation_file

URL

plus

USA & Canada institution

commercial_register_entry_file

URL

plus

commercial_register

string

plus

company_name

string

plus

company_seat

string

plus

jurisdiction

string

plus

legal_form

string

plus

managing_directors

string

plus

owner_identity_proof_file

URL

plus

power_of_attorney_file

URL

plus

secretary_certificate_file

URL

plus

USA & Canada institution

shareholders_list_file

URL

plus

transparency_register_entry_file

URL

plus

unique_identification_number

string

plus

USA, Singapore & Hong-Kong institution

FieldType / FormatKYC level availabilityRestrictions

residential_address_country

plus

residential_address_proof_file

URL

plus

residential_address

string

plus

residential_address_line1

string

plus

This field is required only for applications with split address configuration enabled. For, the rest is optional.

residential_address_line2

string

plus

This field is required only for applications with split address configuration enabled. For, the rest is optional.

residential_address_city

string

plus

This field is required only for applications with split address configuration enabled. For, the rest is optional.

residential_address_zip

string

plus

This field is required only for applications with split address configuration enabled. For , the rest is optional.

residential_address_proof_date_of_expiry

YYYY-MM-DD

plus

FieldType / FormatKYC level availabilityRestrictions

sow_estimated_net_worth_currency

EUR or USD

sow

sow_estimated_net_worth_value

string

sow

FieldType / FormatKYC level availabilityRestrictions

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

FieldType / FormatKYC level availabilityRestrictions

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

FieldType / FormatKYC level availabilityRestrictions

social_security_number

string

ssn

USA residents only

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

Last updated