The first time an Item connects, a Consent is created with an expiration date. The Consent shows which financial products an item is authorized to recover for a given period. You can use the Consents API to get all consents given to an item.

📘

Default expiration

By default, Open Finance Consents have no expiration. However, the user can revoke them from their connected Bank's app whenever necessary.

{
  "id": "a182a0ae-16b3-4790-9396-3724aa0bc14b",
  "itemId": "ed893a30-5fab-45d8-917c-e71a313dbe5e",
  "products": [
    "ACCOUNTS",
    "CREDIT_CARDS",
    "TRANSACTIONS",
    "INVESTMENTS",
    "IDENTITY",
    "INVESTMENTS_TRANSACTIONS",
    "PAYMENT_DATA",
    "LOANS"
  ],
  "openFinancePermissionsGranted": [
    "REGISTRATION_ALL",
    "ACCOUNTS_ALL",
    "CREDIT_CARDS_ALL",
    "CREDIT_OPERATIONS_ALL",
    "INVESTMENTS_ALL"
  ],
  "createdAt": "2024-06-11T15:10:45.362Z",
  "expiresAt": null,
  "revokedAt": null
}

See Consent Management Docs for more information.

Consent expiration / revocation

When a consent expires (for example, old Open Finance items) or is revoked by the user from the app, all its data endpoints (accounts, transactions, etc) will return empty data.

To continue using the Item after expiration (indicated by the field consentExpiresAt) you will need to run a un update on the item (PATCH on the Item), asking the user to connect again. The user will go through the consent flow once again, renewing the consent.

Once this is completed successfully, the item will go back to execution status SUCCESS and data endpoints will now be available again, with a new consentExpiresAt date on the Item.

There is no need to create a new item to renew a consent, expired items work the same as login error ones, updates will require a successful login to start syncing daily.