VRPlatformVRPlatform
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

GET
/plaid/health

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

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",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "CONNECTION_RECONNECT_REQUIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "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",
    "classification": {
      "kind": "providerOutage",
      "ownership": "institution",
      "action": "retry",
      "retryable": true,
      "cooldownSeconds": 0
    },
    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
    "connectionName": "string",
    "operation": "string",
    "restartMode": "create",
    "institutionHealth": {
      "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"
          }
        }
      ]
    },
    "institutionHealthError": {
      "endpoint": "string",
      "method": "string",
      "operation": "string",
      "plaidDisplayMessage": "string",
      "plaidDocumentationUrl": "string",
      "plaidErrorCode": "string",
      "plaidErrorCodeReason": "string",
      "plaidErrorMessage": "string",
      "plaidErrorType": "string",
      "plaidRequestId": "string",
      "plaidSuggestedAction": "string",
      "retryAfterSeconds": 0,
      "status": 0,
      "statusText": "string"
    }
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "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",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "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",
    "classification": {
      "kind": "providerOutage",
      "ownership": "institution",
      "action": "retry",
      "retryable": true,
      "cooldownSeconds": 0
    },
    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
    "connectionName": "string",
    "operation": "string",
    "restartMode": "replace",
    "institutionHealth": {
      "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"
          }
        }
      ]
    },
    "institutionHealthError": {
      "endpoint": "string",
      "method": "string",
      "operation": "string",
      "plaidDisplayMessage": "string",
      "plaidDocumentationUrl": "string",
      "plaidErrorCode": "string",
      "plaidErrorCodeReason": "string",
      "plaidErrorMessage": "string",
      "plaidErrorType": "string",
      "plaidRequestId": "string",
      "plaidSuggestedAction": "string",
      "retryAfterSeconds": 0,
      "status": 0,
      "statusText": "string"
    }
  }
}
{
  "code": "LOCKED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "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",
    "classification": {
      "kind": "providerOutage",
      "ownership": "institution",
      "action": "retry",
      "retryable": true,
      "cooldownSeconds": 0
    },
    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
    "connectionName": "string",
    "operation": "string",
    "restartMode": "create",
    "institutionHealth": {
      "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"
          }
        }
      ]
    },
    "institutionHealthError": {
      "endpoint": "string",
      "method": "string",
      "operation": "string",
      "plaidDisplayMessage": "string",
      "plaidDocumentationUrl": "string",
      "plaidErrorCode": "string",
      "plaidErrorCodeReason": "string",
      "plaidErrorMessage": "string",
      "plaidErrorType": "string",
      "plaidRequestId": "string",
      "plaidSuggestedAction": "string",
      "retryAfterSeconds": 0,
      "status": 0,
      "statusText": "string"
    }
  }
}
{
  "code": "PLAID_PROVIDER_UNAVAILABLE",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "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",
    "classification": {
      "kind": "providerOutage",
      "ownership": "institution",
      "action": "retry",
      "retryable": true,
      "cooldownSeconds": 0
    },
    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
    "connectionName": "string",
    "operation": "string",
    "restartMode": "create",
    "institutionHealth": {
      "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"
          }
        }
      ]
    },
    "institutionHealthError": {
      "endpoint": "string",
      "method": "string",
      "operation": "string",
      "plaidDisplayMessage": "string",
      "plaidDocumentationUrl": "string",
      "plaidErrorCode": "string",
      "plaidErrorCodeReason": "string",
      "plaidErrorMessage": "string",
      "plaidErrorType": "string",
      "plaidRequestId": "string",
      "plaidSuggestedAction": "string",
      "retryAfterSeconds": 0,
      "status": 0,
      "statusText": "string"
    }
  }
}

/bank-rules/{id} PUT

Previous Page

/plaid/connect/complete POST

Next Page