> ## Documentation Index
> Fetch the complete documentation index at: https://help.checkrmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User

> Get the current user's profile.

Returns the authenticated user's profile including name, email, phone,
and lifecycle status flags (onboarding, bank connection, subscription, trial).
Creates the user record if it does not yet exist.

PAT (public API) callers receive a trimmed response with only contact fields.



## OpenAPI

````yaml GET /v1/user
openapi: 3.1.0
info:
  title: Checkr Money API
  description: >
    Read-only API for personal access token (PAT) users.


    ## Authentication


    Authenticate with `Authorization: Bearer <token>`. Tokens have a `pat_`
    prefix

    and are generated in the Truv web app under Settings → API keys.


    ## Available Endpoints


    This API exposes a subset of read-only endpoints for retrieving financial
    data,

    account links, and user profile information.
  version: 1.0.0
servers:
  - url: https://api.mytruv.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: users
    description: User profile — read-only access to the authenticated user's profile.
  - name: financial-data
    description: >-
      Financial data — balances, transactions, income, spending, liabilities,
      and balance history.
  - name: links
    description: >-
      Account links — list connected financial institutions and payroll
      providers.
paths:
  /v1/user:
    get:
      tags:
        - users
      summary: Get User Route
      description: >-
        Get the current user's profile.


        Returns the authenticated user's profile including name, email, phone,

        and lifecycle status flags (onboarding, bank connection, subscription,
        trial).

        Creates the user record if it does not yet exist.


        PAT (public API) callers receive a trimmed response with only contact
        fields.
      operationId: getUserProfile
      responses:
        '200':
          description: User profile including name, email, and contact information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicUserSchema'
components:
  schemas:
    PublicUserSchema:
      description: >-
        User profile information (public API view, excludes internal lifecycle
        fields).
      properties:
        first_name:
          default: null
          description: User's first name.
          examples:
            - Jane
          title: First Name
          type:
            - string
            - 'null'
        last_name:
          default: null
          description: User's last name.
          examples:
            - Doe
          title: Last Name
          type:
            - string
            - 'null'
        email:
          default: null
          description: User's email address.
          examples:
            - jane@example.com
          title: Email
          type:
            - string
            - 'null'
        phone:
          default: null
          description: User's phone number.
          examples:
            - +1-555-123-4567
          title: Phone
          type:
            - string
            - 'null'
      title: PublicUserSchema
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: PAT
      description: >-
        Bearer authentication with a personal access token (prefix `pat_`).
        Generate tokens in the Truv web app under Settings → API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.