Plaid
/plaid/health
Check the current Plaid Item and institution health for an existing connection. Typed errors distinguish reconnect, replacement, retry, and support actions.
Required scope: bank-connections:manage
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
connectionId*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/plaid/health?connectionId=string"{
"connectionId": "string",
"institutionName": "string",
"issues": [
{
"code": "transactions_updates",
"severity": "warning",
"context": {
"badge": "transactions_updates",
"title": "Transaction Updates",
"status": "HEALTHY",
"statusDescription": "string",
"refreshInterval": "NORMAL",
"description": "string"
}
}
]
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "CONNECTION_RECONNECT_REQUIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"endpoint": "string",
"method": "string",
"plaidDisplayMessage": "string",
"plaidDocumentationUrl": "string",
"plaidErrorCode": "string",
"plaidErrorCodeReason": "string",
"plaidErrorMessage": "string",
"plaidErrorType": "string",
"plaidRequestId": "string",
"plaidSuggestedAction": "string",
"retryAfterSeconds": 0,
"status": 0,
"statusText": "string",
"action": "reconnect",
"connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
"connectionName": "string",
"operation": "string"
}
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "MISDIRECTED_REQUEST",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
"dataRegion": "ap",
"apiBaseUrl": "http://example.com"
}
}{
"code": "PLAID_CONNECT_REQUIRES_NEW_LINK",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"endpoint": "string",
"method": "string",
"plaidDisplayMessage": "string",
"plaidDocumentationUrl": "string",
"plaidErrorCode": "string",
"plaidErrorCodeReason": "string",
"plaidErrorMessage": "string",
"plaidErrorType": "string",
"plaidRequestId": "string",
"plaidSuggestedAction": "string",
"retryAfterSeconds": 0,
"status": 0,
"statusText": "string",
"action": "replace",
"connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
"connectionName": "string",
"operation": "string",
"restartMode": "replace"
}
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"endpoint": "string",
"method": "string",
"plaidDisplayMessage": "string",
"plaidDocumentationUrl": "string",
"plaidErrorCode": "string",
"plaidErrorCodeReason": "string",
"plaidErrorMessage": "string",
"plaidErrorType": "string",
"plaidRequestId": "string",
"plaidSuggestedAction": "string",
"retryAfterSeconds": 0,
"status": 0,
"statusText": "string",
"action": "contactSupport",
"connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
"connectionName": "string",
"operation": "string"
}
}{
"code": "PLAID_PROVIDER_UNAVAILABLE",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"endpoint": "string",
"method": "string",
"plaidDisplayMessage": "string",
"plaidDocumentationUrl": "string",
"plaidErrorCode": "string",
"plaidErrorCodeReason": "string",
"plaidErrorMessage": "string",
"plaidErrorType": "string",
"plaidRequestId": "string",
"plaidSuggestedAction": "string",
"retryAfterSeconds": 0,
"status": 0,
"statusText": "string",
"action": "retry",
"connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
"connectionName": "string",
"operation": "string"
}
}