> ## Documentation Index > Fetch the complete documentation index at: https://docs.onboard.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get User by Auth Token Fetches the profile of the currently authenticated user, including their account details and KYC status. ## OpenAPI ````yaml get /users/me openapi: 3.0.3 info: version: 2.1.0 title: Onboard External API Gateway description: >- **Introduction** API Gateway for Onboard This specification describes API endpoints that are available to the public internet via the API gateway. The different endpoints require different authentication schemes, see documentation for what applies to the operation you want to access. **Errors** Uses conventional HTTP response codes to indicate success or failure. In general: - `2xx` status codes indicate success. Codes in the - `4xx` range indicate a client error (e.g. required parameters, failed request etc.). - `5xx` status codes indicate a server error occurred. contact: name: Nestcoin TechOps email: techops@nestcoin.com license: name: UNLICENSED servers: - url: https://external.dev.onboardpay.co description: Gateway for external API on staging environment. security: [] tags: - name: users-onboardapi description: Endpoints available to for merchants liquidity automation - name: users-users description: User related endpoints - name: users-partners description: Partner related endpoints - name: users-admin description: Back office related endpoints - name: users-user2fa description: User 2fa related endpoints - name: users-usernotifications description: User notifications related endpoints - name: users-merchantnetwork description: Merchant network endpoints - name: users-userauth description: Authentication endpoints - name: users-userservice description: Service endpoints - name: users-webhook description: webhook endpoints paths: /users/me: get: tags: - users-users - users-onboardapi summary: Get a single user by their authorization token operationId: getMyProfile responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UserDataDto' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' '401': description: Unauthorized request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' security: - authToken: [] components: schemas: UserDataDto: required: - email - userId type: object properties: userId: type: string description: the user ID email: type: string description: User's email name: type: string description: Name of customer phoneNumber: type: string description: User phone number example: '2348100000000' phoneNumberVerified: type: boolean description: flag indicating if user has verified their phone number fullName: type: string description: user's kyc fullname referralLink: type: string description: referral link referralCode: type: string description: referral code generated for this user. Also known as onboard pass userType: $ref: '#/components/schemas/UsersSvcUserType' roles: type: array items: $ref: '#/components/schemas/UserRoles' isCustomer: type: boolean isMerchant: type: boolean isOnboardWalletUser: type: boolean description: >- 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: type: boolean description: Indicates if the merchant has been provisioned for OPN isMerchantNetwork: type: boolean kycStatus: $ref: '#/components/schemas/KycJobStatus' kycRetryCount: type: number description: The number of kyc retries kycRetryLimit: type: number description: kyc retry limit kycNameHistory: type: array description: History of name change items: $ref: '#/components/schemas/KycNameChangeHistoryDto' comments: type: array items: type: object properties: comment: type: string addedBy: type: string includes: type: object properties: {} supportedCurrencies: type: array items: type: string language: type: string description: | Language preference (preferred or detected). Can be just language (en) or locale (en-GB). See samples example: en, en-US, fr-FR, pt-BR availability: type: boolean active: type: boolean country: type: string verifiedAddress: type: string description: Wallet Address connected to user's account. example: '0x15b8b00fb8d2bd7d76e90e70294e87fc6ba79e3b' profile: $ref: '#/components/schemas/ProfileDataDto' transactionLimit: $ref: '#/components/schemas/UserTransactionLimit' authSource: type: string description: specifies the user's wallet source createdAt: type: string format: date-time description: Timestamp field. lastActiveAt: type: string format: date-time description: Timestamp field. isTotpSetup: type: boolean totpSetupAt: type: string format: date-time description: Timestamp field. verifiedPhoneNumberLastUpdatedAt: type: string format: date-time description: Timestamp field. ErrorMessageDto: description: >- Default error object for services. This gives consistent error object that all services may use. type: object required: - code - message properties: code: type: string description: Error code example: UNKNOWN_ERROR message: type: string description: Descriptive error message example: Request could not be completed due to an error data: type: object description: Additional data for this error message. additionalProperties: true properties: {} x-common-model: ErrorMessageDto UsersSvcUserType: type: string description: the type of the user enum: - CUSTOMER - PARTNER UserRoles: type: string description: the roles a user can possess on Onboard enum: - CUSTOMER - MERCHANT - MERCHANT_NETWORK KycJobStatus: type: string enum: - VERIFIED - UNVERIFIED - IN_PROGRESS - AWAITING_INPUT - FAILED_VERIFICATION - REVIEW_REQUIRED - VERIFICATION_TIMEOUT KycNameChangeHistoryDto: type: object properties: reason: type: string description: Name change reason actor: type: string description: Name of admin that initiated the change previousName: type: string description: Previous full name currentName: type: string description: Current full name evidenceUrl: type: string format: url description: Url link of change request evidence timestamp: type: string format: date-time required: - reason - actor - previousName - currentName - timestamp ProfileDataDto: type: object properties: status: $ref: '#/components/schemas/VerificationStatus' fullname: type: string description: User's full name country: type: string description: User's country example: NG dob: type: string description: User's date of birth format: date example: '2024-04-18T00:00:00.000Z' displayName: type: string description: User's display name proofOfAddress: type: string description: Proof of partner's address hasBusinessBankAccount: type: boolean description: partner has a business account businessName: type: string certificateOfIncorporation: type: string hasShareHolderList: type: boolean userInShareHolderList: type: boolean noShareHolderListEvidence: type: string useOfBusinessAccountApprovedByShareholders: type: boolean noOfLegalDirectors: type: number regulatoryIdsOfDirectors: type: array items: type: string depositTimeout: type: number example: 1200 approvalTimeout: type: number example: 1200 tradeHistoryDetails: $ref: '#/components/schemas/ProfileTradeDto' UserTransactionLimit: type: object properties: dailyTransactionLimit: type: number maxSingleTransactionLimit: type: number minSingleTransactionLimit: type: number maxLifetimeLimit: type: number VerificationStatus: type: string description: user's verification status enum: - VERIFIED - UNVERIFIED - FAILED_VERIFICATION - REVIEW_REQUIRED - IN_PROGRESS - REJECTED ProfileTradeDto: type: object properties: hasPreviousTradeHistory: type: boolean description: Partner have previous trading experience proofOfTrade: type: array description: Partner's proof of previous trade history items: type: string referee: type: string description: Partner's referee securitySchemes: authToken: type: apiKey name: x-auth-token in: header ````