Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

General.User

Create user

Creates a user and its user profile and returns the ID of the created user

post/api/v1/user/create

Request body

external_user_idstring

Optional external user ID for the created user.

localestring

Locale for the user. Defaults to default locale for the user's market.

marketstring required

Market specific code for the user as a ISO 3166-1 country code.

retention_classstring

[BETA] Determines whether Tink will retain the user until explicitly deleted, or automatically delete the user after 24 hours. Set with either "permanent" or "temporary". Defaults to the <a href="https://docs.tink.com/glossary#permanent-users:~:text=our%20guide.-,Permanent%20users,-A%20Tink%20User">user retention setting for your app</a>.

Example request

{
  "external_user_id": "user_123_abc",
  "locale": "en_US",
  "market": "SE",
  "retention_class": "permanent"
}

Response

The user was successfully created and returned.

external_user_idstring required

The external user ID of the created user.

user_idstring required

The user ID of the created user.

Example response

{
  "external_user_id": "user_123_abc",
  "user_id": "6e68cc6287704273984567b3300c5823"
}