Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Items

Create

Creates a item and syncs all the products with the financial institution, using as credentials the sent parameters.

post/items

Request body

connectorIdnumber required

Primary identifier of the connector

webhookUrlstring uri

Url to be notified of item changes

clientUserIdstring

Client's external identifier for the user, it can be a ID, UUID or even an email. This is free for clients to use.

oauthRedirectUristring uri

Redirect URI required for the Oauth flow

productsstring[]

Products to be collected in the connection

avoidDuplicatesboolean

Avoids creating a new item if there is already one with the same credentials

Example request

{
  "connectorId": 2,
  "parameters": {
    "user": "user-ok",
    "password": "password-ok"
  },
  "webhookUrl": "https://example.com/webhook"
}

Response

Created item

idstring required

Primary identifier

statusstring required

Status of the Item

executionStatusstring required

Status of the sync execution

webhookUrlstring

Url to be notified of item changes

createdAtstring date-time

Date of creation

updatedAtstring date-time

Date of last modification

lastUpdatedAtstring date-time

Date of last syncronization

nextAutoSyncAtstring date-time

Date of next auto-sync, or null if auto-sync is disabled for this Item

consecutiveFailedLoginAttemptsnumber

Consecutives execution that ends up with a LOGIN_ERROR status

consentExpiresAtstring date-time

Consent expiration date

productsstring[]

Products collected by the item

Example response

{
  "id": "e062ab2b-9006-45e8-b689-defabba53647",
  "connector": {
    "id": 200,
    "name": "MeuPluggy",
    "primaryColor": "ef294b",
    "institutionUrl": "https://meu.pluggy.ai/",
    "country": "BR",
    "type": "PERSONAL_BANK",
    "credentials": [],
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/sandbox.svg",
    "hasMFA": false,
    "oauth": true,
    "health": {
      "status": "ONLINE",
      "stage": null
    },
    "products": [
      "ACCOUNTS",
      "TRANSACTIONS",
      "CREDIT_CARDS",
      "INVESTMENTS",
      "INVESTMENTS_TRANSACTIONS",
      "PAYMENT_DATA",
      "IDENTITY",
      "BROKERAGE_NOTE"
    ],
    "createdAt": "2023-09-12T16:44:13.900Z",
    "isSandbox": false,
    "isOpenFinance": false,
    "updatedAt": "2024-11-26T13:33:44.296Z",
    "supportsPaymentInitiation": false,
    "supportsScheduledPayments": false,
    "supportsSmartTransfers": false,
    "supportsBoletoManagement": false
  },
  "createdAt": "2024-09-19T13:10:31.212Z",
  "updatedAt": "2024-09-19T13:11:23.613Z",
  "status": "UPDATED",
  "executionStatus": "SUCCESS",
  "lastUpdatedAt": "2024-09-19T13:11:23.595Z",
  "webhookUrl": null,
  "error": null,
  "clientUserId": "gabriel@pluggy.ai",
  "consecutiveFailedLoginAttempts": 0,
  "statusDetail": null,
  "parameter": null,
  "userAction": null,
  "nextAutoSyncAt": null,
  "consentExpiresAt": null,
  "products": [
    "ACCOUNTS",
    "CREDIT_CARDS",
    "TRANSACTIONS",
    "INVESTMENTS",
    "IDENTITY",
    "INVESTMENTS_TRANSACTIONS",
    "PAYMENT_DATA"
  ],
  "oauthRedirectUri": null
}
All 84 operations