Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Consents

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

get/api/consents/

Query parameters

page_sizeinteger
Example:100

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

pageinteger
Example:1

A page number within the paginated result set.

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

user_documentstring required
Example:12345678900

The CPF or CNPJ number of the user you want to get consent information for.

Response

Ok

countinteger

The total number of results in your Belvo account.

nextstring 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).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "display_name": "Jack Oswald White",
      "document_number": "76109277673",
      "belvo_institution_name": "ofmockbank_br_retail",
      "institution_display_name": "Mock Bank",
      "institution_icon_logo": "https://assets.belvo.io/institutions/mockbank/logo.svg",
      "belvo_organization_name": "ACME Corporation",
      "link_id": "2e5d2c5e-6b3a-4b5c-8d1e-9f0a1b2c3d4e",
      "user_name": "Jack White",
      "expired_at": "2021-02-27T13:01:41.941Z",
      "consent_duration": 366,
      "created_at": "2022-02-09T08:45:50.406032Z",
      "status": "AUTHORISED",
      "permissions": {
        "ACCOUNTS": [
          "ACCOUNTS_OVERDRAFT_LIMITS_READ",
          "ACCOUNTS_READ",
          "ACCOUNTS_TRANSACTIONS_READ",
          "ACCOUNTS_BALANCES_READ"
        ],
        "CREDIT_CARDS": [
          "CREDIT_CARDS_ACCOUNTS_LIMITS_READ",
          "CREDIT_CARDS_ACCOUNTS_BILLS_READ",
          "CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ",
          "CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ",
          "CREDIT_CARDS_ACCOUNTS_READ"
        ],
        "CREDIT_OPERATIONS": [
          "LOANS_READ",
          "LOANS_WARRANTIES_READ",
          "LOANS_SCHEDULED_INSTALMENTS_READ",
          "LOANS_PAYMENTS_READ",
          "FINANCINGS_READ",
          "FINANCINGS_WARRANTIES_READ",
          "FINANCINGS_SCHEDULED_INSTALMENTS_READ",
          "FINANCINGS_PAYMENTS_READ",
          "UNARRANGED_ACCOUNTS_OVERDRAFT_READ",
          "UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ",
          "UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ",
          "UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ",
          "INVOICE_FINANCINGS_READ",
          "INVOICE_FINANCINGS_WARRANTIES_READ",
          "INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ",
          "INVOICE_FINANCINGS_PAYMENTS_READ"
        ],
        "REGISTER": [
          "CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ",
          "CUSTOMERS_PERSONAL_ADITTIONALINFO_READ"
        ],
        "RESOURCES": [
          "RESOURCES_READ"
        ],
        "INVESTMENTS": [
          "BANK_FIXED_INCOMES_READ",
          "CREDIT_FIXED_INCOMES_READ",
          "FUNDS_READ",
          "VARIABLE_INCOMES_READ",
          "TREASURE_TITLES_READ"
        ]
      }
    }
  ]
}