Force Reset Link

Force Reset Link

URL

POST
/links/{id}/reset
Request
curl --request POST \
--url https://api.moneykit.com/links/mk_eqkWN34UEoa2NxyALG8pcV/reset \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
const options = {method: 'POST', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}};

fetch('https://api.moneykit.com/links/mk_eqkWN34UEoa2NxyALG8pcV/reset', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import requests

url = "https://api.moneykit.com/links/mk_eqkWN34UEoa2NxyALG8pcV/reset"

headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}

response = requests.request("POST", url, headers=headers)

print(response.text)
package main

import (
"fmt"
"net/http"
"io/ioutil"
)

func main() {

url := "https://api.moneykit.com/links/mk_eqkWN34UEoa2NxyALG8pcV/reset"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

fmt.Println(res)
fmt.Println(string(body))

}
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.moneykit.com/links/mk_eqkWN34UEoa2NxyALG8pcV/reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer REPLACE_BEARER_TOKEN'

response = http.request(request)
puts response.read_body
import Foundation

let headers = ["Authorization": "Bearer REPLACE_BEARER_TOKEN"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moneykit.com/links/mk_eqkWN34UEoa2NxyALG8pcV/reset")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})

dataTask.resume()
Response
{
"link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
"institution_id": "chase",
"institution_name": "Chase",
"institution_avatar": "https://example.com/avatar.png",
"provider": "mx",
"state": "connected",
"last_synced_at": "2023-02-16T09:14:11",
"tags": [
"user_type:admin"
],
"products": {
"accounts": {
"refreshed_at": "2023-02-16T09:14:11",
"last_attempted_at": "2023-02-16T09:14:11"
},
"identity": {
"refreshed_at": "2023-02-16T09:14:11",
"last_attempted_at": "2023-02-16T09:14:11",
"settings": {
"required": true,
"prefetch": false
}
}
}
}
{
"error_code": "api_error.auth.expired_access_token",
"error_message": "Access token expired",
"documentation_url": string
}
{
"error_code": "link_error.forbidden_action",
"error_message": "Accounts access not permitted",
"documentation_url": string
}
{
"error_code": "link_error.not_found",
"error_message": "Link not found.",
"documentation_url": string
}
{
"error_code": "link_error.deleted",
"error_message": "Link deleted.",
"documentation_url": string
}
{
"error_code": "link_error.bad_state",
"error_message": string,
"documentation_url": string,
"link_error_code": string
}
{
"error_code": "api_error.rate_limit_exceeded",
"error_message": "Rate limit exceeded",
"documentation_url": string
}

id

: string

required

The unique ID for this link.

example: mk_eqkWN34UEoa2NxyALG8pcV

Responses

200

Successful Response

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

institution_avatar

: string

required

An avatar image for the link's institution.

example: https://example.com/avatar.png

state

: string

required

An enumeration.

connecting awaiting_token_exchange connected deleted error

example: connected

Allowed values:

"connecting"

"awaiting_token_exchange"

"connected"

"deleted"

"error"

error_code

: string

required

An enumeration.

system_error provider_error institution_error user_error auth_expired incomplete

Allowed values:

"system_error"

"provider_error"

"institution_error"

"user_error"

"auth_expired"

"incomplete"

last_synced_at

: string

required

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

format:

date-time

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

tags

: array

required

Arbitrary strings used to describe this link.

example: smoke_test

example: user_type:admin

example: user_type:admin

products

: object

required

The granted products available for this link.

available_products

: array

required

A list of products that could be added to this link. Products can be added to (and removed from) an existing link by creating a new /link-session and supplying the existing_link_id with a new set of products.

example: account_numbers

Allowed values:

"accounts"

"account_numbers"

"identity"

"transactions"

"investments"

provider

: string

required

An enumeration.

moneykit finicity plaid yodlee mx akoya sophtron

example: mx

Allowed values:

"moneykit"

"finicity"

"plaid"

"yodlee"

"mx"

"akoya"

"sophtron"

webhook

: string

required

The webhook url assigned to this link.

example: https://example.com/webhook

401

Invalid access_token or insufficent API client scope or unauthorized link access.

403

Forbidden by link owner. The user did not give permission to access this data when linking or reset only supported for test links.

error_code

: string

required

link_error.forbidden_action

default: "link_error.forbidden_action"

Allowed values:

"link_error.forbidden_action"

error_message

: string

required

Error message

example: Accounts access not permitted

documentation_url

: string

required

404

Link not found.

error_code

: string

required

link_error.not_found

default: "link_error.not_found"

Allowed values:

"link_error.not_found"

error_message

: string

required

default: "Link not found."

documentation_url

: string

required

410

Link deleted.

error_code

: string

required

link_error.deleted

default: "link_error.deleted"

Allowed values:

"link_error.deleted"

error_message

: string

required

default: "Link deleted."

documentation_url

: string

required

422

Link error.

error_code

: string

required

link_error.bad_state

default: "link_error.bad_state"

Allowed values:

"link_error.bad_state"

error_message

: string

required

documentation_url

: string

required

429

Rate limit exceeded.

error_code

: string

required

api_error.rate_limit_exceeded

default: "api_error.rate_limit_exceeded"

Allowed values:

"api_error.rate_limit_exceeded"

error_message

: string

required

Error message

default: "Rate limit exceeded"

documentation_url

: string

required