---
title: "Get a single user by their authorization token"
method: GET
path: "/users/me"
tags: ["users-users", "users-onboardapi"]
---

# Get a single user by their authorization token

`GET /users/me`

## Response `200`

Success

- UserDataDto
  - `userId` string, required — the user ID
  - `email` string, required — User's email
  - `name` string — Name of customer
  - `phoneNumber` string — User phone number
  - `phoneNumberVerified` boolean — flag indicating if user has verified their phone number
  - `fullName` string — user's kyc fullname
  - `referralLink` string — referral link
  - `referralCode` string — referral code generated for this user. Also known as onboard pass
  - `userType` 'CUSTOMER' | 'PARTNER' — the type of the user
  - `roles` UserRoles[]
  - `isCustomer` boolean
  - `isMerchant` boolean
  - `isOnboardWalletUser` boolean — flag indicating if user is an Onboard wallet user or not. i.e user has made use of/sign in using Onboard wallet before.
  - `isOpnMerchant` boolean — Indicates if the merchant has been provisioned for OPN
  - `isMerchantNetwork` boolean
  - `kycStatus` 'VERIFIED' | 'UNVERIFIED' | 'IN_PROGRESS' | 'AWAITING_INPUT' | 'FAILED_VERIFICATION' | 'REVIEW_REQUIRED' | 'VERIFICATION_TIMEOUT'
  - `kycRetryCount` number — The number of kyc retries
  - `kycRetryLimit` number — kyc retry limit
  - `kycNameHistory` KycNameChangeHistoryDto[] — History of name change
    - `reason` string, required — Name change reason
    - `actor` string, required — Name of admin that initiated the change
    - `previousName` string, required — Previous full name
    - `currentName` string, required — Current full name
    - `evidenceUrl` string, url — Url link of change request evidence
    - `timestamp` string, date-time, required
  - `comments` object[]
    - `comment` string
    - `addedBy` string
  - `includes` object
  - `supportedCurrencies` string[]
  - `language` string — Language preference (preferred or detected). Can be just language (en) or locale (en-GB). See samples
  - `availability` boolean
  - `active` boolean
  - `country` string
  - `verifiedAddress` string — Wallet Address connected to user's account.
  - `profile` ProfileDataDto
    - `status` 'VERIFIED' | 'UNVERIFIED' | 'FAILED_VERIFICATION' | 'REVIEW_REQUIRED' | 'IN_PROGRESS' | 'REJECTED' — user's verification status
    - `fullname` string — User's full name
    - `country` string — User's country
    - `dob` string, date — User's date of birth
    - `displayName` string — User's display name
    - `proofOfAddress` string — Proof of partner's address
    - `hasBusinessBankAccount` boolean — partner has a business account
    - `businessName` string
    - `certificateOfIncorporation` string
    - `hasShareHolderList` boolean
    - `userInShareHolderList` boolean
    - `noShareHolderListEvidence` string
    - `useOfBusinessAccountApprovedByShareholders` boolean
    - `noOfLegalDirectors` number
    - `regulatoryIdsOfDirectors` string[]
    - `depositTimeout` number
    - `approvalTimeout` number
    - `tradeHistoryDetails` ProfileTradeDto
      - `hasPreviousTradeHistory` boolean — Partner have previous trading experience
      - `proofOfTrade` string[] — Partner's proof of previous trade history
      - `referee` string — Partner's referee
  - `transactionLimit` UserTransactionLimit
    - `dailyTransactionLimit` number
    - `maxSingleTransactionLimit` number
    - `minSingleTransactionLimit` number
    - `maxLifetimeLimit` number
  - `authSource` string — specifies the user's wallet source
  - `createdAt` string, date-time — Timestamp field.
  - `lastActiveAt` string, date-time — Timestamp field.
  - `isTotpSetup` boolean
  - `totpSetupAt` string, date-time — Timestamp field.
  - `verifiedPhoneNumberLastUpdatedAt` string, date-time — Timestamp field.

## Other responses

- `400` — Bad request
- `401` — Unauthorized request
- `404` — Not found
- `500` — Server error

---

[API](https://skmtc.net/nestechops/apis/onboard-external-api-gateway.md) · [All operations](https://skmtc.net/nestechops/apis/onboard-external-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nestechops/onboard-external-api-gateway/revisions/35fe01ca087b/schema)