Pluggy · Schema

ConnectTokenRequest

Create a connect token request payload

CompanyOpen FinanceBankingFinancial DataPaymentsBrazilFintech

Properties

Name Type Description
itemId string Item identifier to allow Connect Widget to performan an update on it.
options object
View JSON Schema on GitHub

JSON Schema

pluggy-connect-token-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-connect-token-request-schema.json",
  "title": "ConnectTokenRequest",
  "description": "Create a connect token request payload",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pluggy-auth-api-openapi.yml#/components/schemas/ConnectTokenRequest",
  "properties": {
    "itemId": {
      "type": "string",
      "description": "Item identifier to allow Connect Widget to performan an update on it.",
      "format": "uuid"
    },
    "options": {
      "$ref": "#/$defs/ItemOptions"
    }
  },
  "type": "object",
  "$defs": {
    "ItemOptions": {
      "description": "Item options available to send through connect tokens",
      "properties": {
        "clientUserId": {
          "type": "string",
          "description": "Client's external identifier for the user, it can be a ID, UUID or even an email. This is free for clients to use."
        },
        "webhookUrl": {
          "type": "string",
          "description": "Url to be notified of this specific item changes"
        },
        "oauthRedirectUri": {
          "type": "string",
          "description": "Url to redirect the user after the connect flow"
        },
        "avoidDuplicates": {
          "type": "boolean",
          "description": "Avoids creating a new item if there is already one with the same credentials"
        }
      },
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pluggy-connect-token-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.