Skip to content

Latest commit

 

History

History
128 lines (108 loc) · 2.46 KB

_users.md

File metadata and controls

128 lines (108 loc) · 2.46 KB

Users

Get User

curl "https://api.uphold.com/v0/me" \
  -H "Authorization: Bearer <token>"

The above command returns the following JSON:

{
  "address": {
    "city": "New Valentinstad",
    "line1": "80236 Ivy Loaf",
    "line2": "Apt. 366",
    "zipCode": "53059"
  },
  "balances": {
    "currencies": {
      "BTC": {
        "amount": "90.00",
        "balance": "0.1",
        "currency": "USD",
        "rate": "900.00000"
      }
    },
    "total": "90.00"
  },
  "birthdate": "2014-08-27",
  "country": "US",
  "currencies": [
    "BTC"
  ],
  "email": "[email protected]",
  "firstName": "Luke",
  "lastName": "Skywalker",
  "memberAt": "2015-07-10T15:36:20.288Z",
  "name": "Luke Skywalker",
  "settings": {
    "currency": "USD",
    "intl": {
      "dateTimeFormat": {
        "locale": "en-US"
      },
      "language": {
        "locale": "en-US"
      },
      "numberFormat": {
        "locale": "en-US"
      }
    },
    "otp": {
      "login": {
        "enabled": true
      },
      "transactions": {
        "send": {
          "enabled": true
        },
        "transfer": {
          "enabled": false
        },
        "withdraw": {
          "crypto": {
            "enabled": true
          }
        }
      }
    },
    "theme": "vintage"
  },
  "state": "WA",
  "status": "ok",
  "verifications": {}
}

Request

GET https://api.uphold.com/v0/me

Requires the user:read scope for Uphold Connect applications.

Response

Returns the data associated with the current user. See the user object documentation for details about the format of the response.

Be advised that this method can potentially return a large amount of data.

Cards

The cards property will be removed from the response. To access the cards of a given user please refer to the appropriate specific endpoint.

Get User Phone Numbers

curl "https://api.uphold.com/v0/me/phones" \
  -H "Authorization: Bearer <token>"

The above command returns the following JSON:

[{
  "e164Masked": "+XXXXXXXXX04",
  "id": "1d78aeb5-43ac-4ee8-8d28-1291b5d8355c",
  "internationalMasked": "+X XXX-XXX-XX04",
  "nationalMasked": "(XXX) XXX-XX04",
  "primary": "true",
  "verified": "true"
}]

Request

GET https://api.uphold.com/v0/me/phones

Response

Returns an array of all the phone numbers associated with the current user.