Get Started
API
- Authentication
- Link Session
- Links
- Institutions
- Accounts
- Account Numbers
- Investments
- Transactions
- Identity
- Users
- Products
- Webhooks
Links
Force Reset
Force a “relink required” state on a link (Test only)
POST
/
links
/
{id}
/
reset
Copy
curl --request POST \
--url http://localhost:8080/links/{id}/reset \
--header 'Authorization: Bearer <token>'
Copy
{
"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"
}
Copy
curl -i -X POST \
'http://localhost:8080/links/{id}/reset' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'moneykit-version: 2023-02-18'
Copy
{
"link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
"institution_id": "chase",
"provider": "mx",
"state": "connected"
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Path Parameters
The unique ID for this link.
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url http://localhost:8080/links/{id}/reset \
--header 'Authorization: Bearer <token>'
Copy
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.