VRPlatformVRPlatform
Plaid

/plaid/health

Check Plaid health using an existing connection

GET
/plaid/health
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

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": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}