v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Consents

Get a consent's details

Get the details of a specific consent.

get/api/consents/{id}/

Path parameters

idstring uuid required

The consent.id you want to get detailed information about.

Response

idstring uuid

Belvo's unique identifier for the current item.

display_namestring nullable

The full name of the individual that initiated the consent, as provided by the institution.

document_numberstring

The document number (CPF) of the individual.

belvo_institution_namestring

Belvo's name for the open finance institution that the consent is related to.

institution_display_namestring

The display name of the banking institution that the consent is related to.

institution_icon_logostring

The URL to the banking institution's logo.

belvo_organization_namestring

The name registered in Belvo of the organization that created the link.

link_idstring uuid

The Belvo link ID that the consent belongs to.

user_namestring nullable

The name provided in consent.identification_info.name during the initial Widget Access Token Request.

expired_atstring 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_expirationboolean

Indicated whether the consent is for an undefined period, that is, that there is no expiration for the consent.

consent_durationinteger 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_atstring date-time

The ISO-8601 timestamp of when the data point was created in Belvo's database.

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

Example response

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