Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

General.User

Update user

Updates certain user modifiable properties of a user. Please refer to the body schema to see which properties are modifiable by the user.

patch/api/v1/user

Request body

externalUserIdstring

The external identifier of the user. This can be modified by the user.

usernamestring

The username of the user. Today only used by selected customers. This can be modified by the user.

Example request

{
  "externalUserId": "2d3bd65493b549e1927d97a2d0683ab8",
  "profile": {
    "locale": "sv_SE",
    "periodAdjustedDay": 25,
    "periodMode": "MONTHLY_ADJUSTED"
  }
}

Response

successful operation

appIdstring required

The internal identifier of the app that the user belongs to.

createdstring date-time required

The date when the user was created.

externalUserIdstring

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.

flagsstring[]

The user-specific feature flags assigned to the user.

idstring 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.

nationalIdstring

Detected national identification number of the end-user.

usernamestring

The username of the user. This can be modified by the user. Only usable by older integrations. Otherwise, see externalUserId for an equivalent field.

Example response

{
  "appId": "56a33be25eb9443fbb696f7c61eabd94",
  "created": "1730116104",
  "externalUserId": "2d3bd65493b549e1927d97a2d0683ab8",
  "flags": [
    "TRANSFERS",
    "TEST_PINK_ONBOARDING"
  ],
  "id": "6e68cc6287704273984567b3300c5822",
  "nationalId": "198410045701",
  "profile": {
    "currency": "SEK",
    "locale": "sv_SE",
    "market": "SE",
    "periodAdjustedDay": 25,
    "periodMode": "MONTHLY_ADJUSTED",
    "timeZone": "Europe/Stockholm"
  },
  "username": "tinker@example.com"
}