Developer console

Get user details by uid

🚧

Important:

Request headers are required. See API basics introduction for more information.

Get user details by uid

Endpoint

GET /user/{uid}

Returns the user details for a given uid associated with the given App (set by the X-API-KEY).

Parameters

Path parameters

Path parameterDescription
uidThe unique identifier of the user for this app (ex. 816379099131).

Response

You will receive the user details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe user UID.Mandatory
created_atString
(Timestamp)
The timestamp of the user creation.Mandatory
emailString
(Email)
The user email.Can be null
user_external_idStringThe unique ID by which you identify this user in your system.Can be null
walletsList[wallet]see below
client_idStringThis field has been deprecated. You should now use user_external_idDeprecated
Response wallet fieldsTypeDescriptionCondition
addressStringThe wallet address.Mandatory
explorer_urlStringThe explorer URL (PolygonScan) of the wallet.Mandatory
networkString
(Email)
The wallet network (Polygon | Solana).Mandatory
chain_idNumberThe wallet chain id when EVM (Polygon | Amoy).Optional

Response example

{
  "success": true,
  "data": {
    "uid": "816379099131",
    "created_at": "2023-08-10T14:07:14.494142Z",
    "email": "[email protected]",
    "user_external_id": "user_external_id_1",
    "wallets": [{
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "explorer_url": "https://amoy.polygonscan.com/address/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "network": "Polygon",
      "chain_id": 80002}
      ],
    "client_id": "user_external_id_1" // Deprecated - use user_external_id
  }
}

📘

Note:

Considering that user wallet creation is asynchronous and delayed at the first on-chain usage (mint or deposit), wallets or address might be empty until wallets are created. See Create User for more information.

Example

The following example gets the user details for uid 222222222222.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X GET \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/user/222222222222"