All users who have initiated the account linking process with at least one data provider account is related to a specific tenant, identified by the API key and secret used while creating their Smile record.

A token for the user is issued at the same time, and may be renewed through the GET /tokens endpoint.

Users may have one or multiple Accounts connected to their user record.

Once users revoke their accounts (via the SDK, or tenants may initiate this process through the Revoke Account API), their data will be removed and will no longer be accessible.

The User object

Attribute	Type	Description
id	string	Unique ID of this user
externalMetadata
createdAt	string	When this user was created
providers	array of strings	List of providers that the user has an account with, and have shared their data through Smile

Sample User object

{
    "id": "tenantid-f482de95b2154985b65551c85095f886",
    "externalMetadata": null,
    "createdAt": "2022-09-20T01:27:26Z",
    "providers": [
        "abccorp",
        "abcplatform",
        "xyzemployer"
    ]
}

Endpoints

Endpoint
Retrieve user records	`GET /users`
Create new user record	`POST /users`
Retrieve one user record	`GET /users/{id}`

Webhooks

`USER_CREATED`

Fired when a new user has been created in the Smile Network and their link token is available.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "USER_CREATED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78"
  }
}