Consents

A 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.

{
  "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
}

Property	Description	Required
id	Consent primary identifier	✅
itemId	Primary identifier of the item associated to the consent	✅
products	Products to be collected in the connection	✅
openFinancePermissionsGranted	Products consented by the user to be collected. Only available for Open Finance connectors.
createdAt	Date when the consent was given	✅
expiresAt	Date when the consent expires. Null if the consent doesn't expire
revokedAt	Date when the consent was revoked.

See Consent Management Docs for more information.