---
title: "Get user"
method: GET
path: "/api/v1/user"
tags: ["General.User"]
---

# Get user

`GET /api/v1/user`

Returns the authenticated user

## Response `200`

successful operation

- GeneralUser — The user model represents a unique Tink end-user and includes properties that defines the user, user profile information and user-modifiable settings. The user information can primarily be used whenever a Tink user signs up for a 3rd party service using her Tink account, or when user-modifiable settings, such as locale or currency, are needed in order to display or calculate the correct data in the 3rd party service.
  - `appId` string, required — The internal identifier of the app that the user belongs to.
  - `created` string, date-time, required — The date when the user was created.
  - `externalUserId` string — The external identifier of the user, where you can use your own ID to associate with this user. This value will be unique within your app, and is an alternative way to identify users when performing API requests, instead of the user's `id`. This can be modified by the user. Avoid using personal information (PI); we recommend using a generated alphanumeric ID.
  - `flags` string[] — The user-specific feature flags assigned to the user.
  - `id` string, required — The internal identifier of the user, which is a globally unique value that's generated by Tink upon user creation. This can identify users when performing API requests. See also `externalUserId`.
  - `nationalId` string — Detected national identification number of the end-user.
  - `profile` GeneralUserUserProfile, required — The configurable profile of the user.
    - `currency` string, required — The configured ISO 4217 currency code of the user. Defaults to default currency for the user's market.
    - `locale` string, required — The configured locale of the user. Defaults to default locale for the user's market. This can be modified by the user.
    - `market` string, required — The primary market/country of the user.
    - `notificationSettings` GeneralUserNotificationSettings, required — Notification preferences for the user.
      - `balance` boolean, required — Indicates if the user wants to receive notifications with low or high balances alerts.
      - `budget` boolean, required — Indicates if the user wants to receive notifications regarding her budgets.
      - `doubleCharge` boolean, required — Indicates if the user wants to receive notifications with double-charge alerts.
      - `einvoices` boolean, required — Indicates if the user wants to receive notifications for e-invoices.
      - `fraud` boolean, required — Indicates if the user wants to receive notifications for ID Control warnings.
      - `income` boolean, required — Indicates if the user wants to receive notifications when an income is received.
      - `largeExpense` boolean, required — Indicates if the user wants to receive notifications when a large expense is detected.
      - `leftToSpend` boolean, required — Indicates if the user wants to receive left to spend notifications.
      - `loanUpdate` boolean, required — Indicates if the user wants to receive notifications for loan updates.
      - `summaryMonthly` boolean, required — Indicates if the user wants to receive notifications with monthly summaries.
      - `summaryWeekly` boolean, required — Indicates if the user wants to receive notifications with weekly summaries.
      - `transaction` boolean, required — Indicates if the user wants to receive notifications for every transaction.
      - `unusualAccount` boolean, required — Indicates if the user wants to receive notifications when there is unusual activity on any of her accounts.
      - `unusualCategory` boolean, required — Indicates if the user wants to receive notifications when she has spent more than usual on something.
    - `periodAdjustedDay` integer, required — The configured day of the month to break the adjusted period on. Defaults to default period adjusted day for the user's market. This can be modified by the user. A valid value should be in the range between 1 and 31. If the adjusted day is after the last day of a given month, then it is treated as the last day of the month.
    - `periodMode` 'MONTHLY' | 'MONTHLY_ADJUSTED', required — The configured monthly period mode of the user. Defaults to default period mode for the user's market. This can be modified by the user.
    - `timeZone` string, required — The configured time zone of the user. Defaults to default time zone for the user's market. This can be modified by the user.
  - `username` string — The username of the user. This can be modified by the user. Only usable by older integrations. Otherwise, see `externalUserId` for an equivalent field.

## Other responses

- `400` — The request body was invalid
- `409` — User with the same external id already exists.

---

[API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)