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

200 Please refer to response1.json and response2.json tabs for details

response1.json

/**
* 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": "[e-mail]",
      "source_type": "registration", // "obsolete", "journey"
    }
  ],
  "phones:": [
    {
      "number": "[phone]"
    }
  ],
  "uid": "b76ab44d-b71e-4d19-b6f9-f6e88cd73946",
  "verification_cases": [
    {
      "details": null,
      "level": "plus+selfie",
      "status": "pending"
    },
    {
      "details": null,
      "level": "basic+liveness",
      "status": "approved"
    },
    {
      "details": {
         "files": "...",
      },
      "level": "basic+liveness+wallet-eth",
      "status": "approved",
      "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
      }
    }
  ]
}

response2.json

/**
* supposes `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
*/

{
  "uid": "b76ab44d-b71e-4d19-b6f9-f6e88cd73946",
  "wallets": [
     { "currency": "eth", "address": "0x2003" }
  ],
  "verification_cases": [
    {
      "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",
      "status": "approved",
      "report": null
    },
    {
      "details": {
        "identification_document_selfie_file": "<URL>",
        "identification_document_front_file": "<URL>"
      },
      "level": "selfie",
      "status": "approved",
      "report": null
    },
    {
      "level": "basic+liveness+wallet-eth",
      "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

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:

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:

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.

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.

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.

Identification related fields

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.

Institution related fields

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

Residency related fields

Source of wealth related fields

Social security related fields

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