Accounts

Accounts in the Smile Network form the basis of the data shared by the user to our clients. Each user may connect multiple accounts among the data Providers that Smile supports, which provides a clearer picture of their history and information.

Upon providing consent and access directly from the end user, Smile retrieves available data from the account and provides normalized data under each user data endpoint at that particular point in time. If your account has Continuous Data Sync enabled, Smile will also periodically check with the provider for updated data, and keep your user's information updated for as long as the account is connected (i.e., not revoked by the user).

Available data points for each provider may vary, which you can review real-time using the Data Sources section of the Developer Portal. You can track availability of the data using Webhook event notifications.

By default, the List Accounts API will return all accounts under your tenantId that match your query parameters. Make sure to filter the results by userId or startDate and endDate to narrow down your query.

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.

Continuous Data Sync

Smile API's Continuous Data Sync (CDS) feature provides you access to the most up-to-date and recent data from your users, once these users have consented and connected their account through the Wink Widget.

Instead of requiring the user to reconnect their account if you need updated information, CDS provides you with permissioned access to updated data. By consenting to CDS, users can authorize Smile to sync data for you across multiple months, until they revoke access to their account.

We fire a webhook event ACCOUNT_SYNC_TASK_FINISHED (see below) when an Account has been newly refreshed, so you can receive information about the update.

CDS must be enabled for your business to enjoy these features, but once enabled, there is no change needed to your integration with Smile API.

Supported Providers and Data Points

The Account object

Account Statuses

Connection Status

Monitoring Status

Sample Account data

{
    "id": "a-123abc456def789abc123def456abc78",
    "createdAt": "2022-10-01T00:00:00Z",
    "providerId": "abccorp",
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "connectionStatus": "CONNECTED",
    "connection": {
        "status": "CONNECTED",
        "errorCode": null,
        "errorMessage": null,
        "updatedAt": "2022-10-01T00:00:00Z"
    },
    "monitorStatus": "UNSUPPORTED",
    "monitor": {
        "status" : "UNSUPPORTED",
        "updatedAt" : null
    }
}

Endpoints

Webhooks

ACCOUNT_CREATED

Fired when the account linking process has been initiated by the user. This webhook will be fired even for providers who do not require logins.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "ACCOUNT_CREATED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "accountId": "a-123abc456def789abc123def456abc78",
    "providers": [
      "abccorp"
    ]
  }
}

ACCOUNT_CONNECTED

Fired when a user has successfully connected an account to the Smile Network. This will only be fired if the data provider requires a login.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "ACCOUNT_CONNECTED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "accountId": "a-123abc456def789abc123def456abc78",
    "loginName": "userLoginName"
    "providers": [
      "abccorp"
    ]
  }
}

ACCOUNT_DISCONNECTED

Fired when a user has successfully disconnected or revoked the link to their account from the Smile Network.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "ACCOUNT_DISCONNECTED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "accountId": "a-123abc456def789abc123def456abc78"
    "providers": [
      "abccorp"
    ]
  }
}

ACCOUNT_FAILED

Fired when the account linking process initiated by the user is unsuccessful.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "ACCOUNT_FAILED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "accountId": "a-123abc456def789abc123def456abc78",
    "loginName": "userLoginName",
    "errorCode": "INVALID_CREDENTIALS",
    "errorMessage": "Invalid username or password!",
    "providers": [
      "abccorp"
    ]
  }
}

ACCOUNT_SYNC_TASK_FINISHED

Fired when the account syncing task has been completed in the backend.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "ACCOUNT_SYNC_TASK_FINISHED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "sourceId": "a-123abc456def789abc123def456abc78",
    "sourceType": "ACCOUNT",
    "providers": [
      "abccorp"
    ],
    "status": "SUCCEEDED",
    "monitorStatus": "ACTIVE",
    "dataPoints": [
      "IDENTITIES",
      "EMPLOYMENTS",
      "INCOMES"
    ]
  }
}

Event Listeners

The SDK also emits events that can be caught by your native application to allow the application to react and perform functions as needed.

Error Codes

As users connect their accounts, your users may come across various errors listed below.