Skip to main content
POST
/
links
/
{id}
/
reset
Force a "relink required" state on a link (Test only).
curl --request POST \
  --url http://localhost:8080/links/{id}/reset \
  --header 'Authorization: Bearer <token>'
{
  "link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
  "institution_id": "chase",
  "institution_name": "Chase",
  "state": "connected",
  "error_code": "system_error",
  "last_synced_at": "2023-02-16T09:14:11",
  "tags": [
    "smoke_test",
    "user_type:admin"
  ],
  "products": {
    "accounts": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11"
    },
    "account_numbers": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "settings": {
        "required": false,
        "prefetch": false,
        "product": "accounts"
      }
    },
    "identity": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "settings": {
        "required": false,
        "prefetch": false,
        "product": "accounts"
      }
    },
    "transactions": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "settings": {
        "required": false,
        "prefetch": false,
        "product": "accounts",
        "extend_history": false
      }
    },
    "investments": {
      "refreshed_at": "2023-02-16T09:14:11",
      "last_attempted_at": "2023-02-16T09:14:11",
      "settings": {
        "required": false,
        "prefetch": false,
        "product": "accounts"
      }
    }
  },
  "provider": "mx",
  "webhook": "https://example.com/webhook"
}
curl -i -X POST \
  'http://localhost:8080/links/{id}/reset' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'moneykit-version: 2023-02-18'

{
  "link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
  "institution_id": "chase",
  "provider": "mx",
  "state": "connected"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
moneykit-version
string
default:2023-02-18

Path Parameters

​
id
string
required

The unique ID for this link.

Response

Successful Response

​
link_id
string
required

The unique ID for this link.

Example:

"mk_eqkWN34UEoa2NxyALG8pcV"

​
institution_id
string
required

The unique ID for the institution this link is connected to.

Example:

"chase"

​
institution_name
string
required

The institution name this link is connected to.

Example:

"Chase"

​
state
enum<string>
required

The current state of this link. Links that are not yet connected, or which require reconnection, will be in one of the non-connected states. An enumeration.

Available options:
connecting,
awaiting_token_exchange,
connected,
deleted,
error
Example:

"connected"

​
products
object
required

The granted products available for this link.

​
provider
enum<string>
required

The provider that most recently facilitated the creation of this link. Note that MoneyKit may switch providers if necessary to provide continuous access to the institution. An enumeration.

Available options:
moneykit,
finicity,
plaid,
yodlee,
mx,
akoya,
sophtron
Example:

"mx"

​
error_code
enum<string>

The type of error, if the link is in the error state. See Link Errors for an explanation of error codes. An enumeration.

Available options:
system_error,
provider_error,
institution_error,
user_error,
auth_expired,
incomplete
​
last_synced_at
string<date-time>

An ISO-8601 timestamp indicating the last time that the account was updated.

Example:

"2023-02-16T09:14:11"

​
tags
string[]

Arbitrary strings used to describe this link.

Example:
["smoke_test", "user_type:admin"]
​
webhook
string

The webhook url assigned to this link.

Example:

"https://example.com/webhook"