---
title: "List consents"
method: GET
path: "/api/consents/"
tags: ["Consents"]
---

# List consents

`GET /api/consents/`

## ▶️ Usage

With the Consents method, you can:

1. List all consents related to your Belvo account (without using any query parameters).

## 📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the `page_size` query parameter to increase the number of items returned to a maximum of 1000 items. You can use the `page` query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.

## 🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

## Query parameters

- `page_size` integer
- `page` integer
- `omit` string
- `fields` string
- `user_document` string, required

## Response `200`

Ok

- object
  - `count` integer — The total number of results in your Belvo account.
  - `next` string, uri, nullable — The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is `null`. In our documentation example, we use `{endpoint}` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, `accounts` or `owners`).
  - `previous` string, uri, nullable — The URL to the previous page of results. If there is no previous page, the value is `null`.
  - `results` Consents[] — Array of consent objects.
    - `id` string, uuid — Belvo's unique identifier for the current item.
    - `display_name` string, nullable — The full name of the individual that initiated the consent, as provided by the institution.
    - `document_number` string — The document number (CPF) of the individual.
    - `belvo_institution_name` string — Belvo's name for the open finance institution that the consent is related to.
    - `institution_display_name` string — The display name of the banking institution that the consent is related to.
    - `institution_icon_logo` string — The URL to the banking institution's logo.
    - `belvo_organization_name` string — The name registered in Belvo of the organization that created the link.
    - `link_id` string, uuid — The Belvo link ID that the consent belongs to.
    - `user_name` string, nullable — The name provided in `consent.identification_info.name` during the initial Widget Access Token Request.
    - `expired_at` string, date-time — The ISO-8601 timestamp when the consent will expire. In the case that `undefined_consent_expiration` is `true`, this field will be `null`.
    - `undefined_consent_expiration` boolean — Indicated whether the consent is for an undefined period, that is, that there is no expiration for the consent.
    - `consent_duration` integer, nullable — The duration of the consent in days. In the case that `undefined_consent_expiration` is `true`, this field will be `null`. Possible values: - `92` (3 months) - `183` (6 months) - `275` (9 months) - `366` (12 months)
    - `created_at` string, date-time — The ISO-8601 timestamp of when the data point was created in Belvo's database.
    - `status` 'AUTHORISED' | 'AWAITING_AUTHORISATION_CONFIRMATION' | 'AWAITING_AUTHORISATION' | 'REJECTED' | 'EXPIRED' | 'null', nullable — The status of the consent in the open finance network. Can be either: - `AUTHORISED`: The consent is still valid for use until the `expired_at` date. - `AWAITING_AUTHORISATION_CONFIRMATION`: The user must confirm within their institution. - `AWAITING_AUTHORISATION`: The user has been redirected to their institution to grant consent. - `REJECTED`: The user has not granted consent within their institution. - `EXPIRED`: The consent has expired as of the `expired_at` date. - `null`
    - `permissions` object — Details regarding the permissions attached to the consent.
      - `ACCOUNTS` string[] — A list of of open banking permissions relating to accessing account information.
      - `CREDIT_CARDS` string[] — A list of of open banking permissions relating to accessing credit card information.
      - `CREDIT_OPERATIONS` string[] — A list of of open banking permissions relating to accessing credit product information.
      - `REGISTER` string[] — A list of of open banking permissions relating to accessing personal information.
      - `RESOURCES` string[] — A list of functional permissions required to interact with the permissions.
      - `INVESTMENTS` string[] — A list of open banking permissions relating to accessing investment information.

## Other responses

- `401` — Unauthorized
- `403` — Access to Belvo API denied
- `404` — Not Found Error
- `408` — Request Timeout
- `500` — Unexpected Error

---

[API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/revisions/3423c786ece5/schema)