GET
Consulta um consentimento pelo id

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

Id (UUID) do consentimento.

Response

Consentimento encontrado.

Consentimento normalizado de Open Finance/Open Banking. Registra status, produtos, permissões e validade.

id
string<uuid>
required

Id do consentimento.

Example:

"c1d2e3f4-0000-4abc-9def-111213141516"

itemId
string<uuid>
required

Item dono do consentimento.

Example:

"a8f4f3e1-7b2c-4d4e-8f9a-0b1c2d3e4f5a"

status
enum<string>
required

Estado normalizado do consentimento.

Available options:
AWAITING_AUTHORISATION,
AUTHORISED,
CONSUMED,
REJECTED,
REVOKED,
EXPIRED
Example:

"AUTHORISED"

products
enum<string>[]
required

Produtos cobertos pelo consentimento.

Produto de dados coletável. Valores exatos e case-sensitive.

Available options:
ACCOUNTS,
TRANSACTIONS,
CREDIT_CARDS,
INVESTMENTS,
INVESTMENTS_TRANSACTIONS,
LOANS,
IDENTITY,
OPPORTUNITIES,
PORTFOLIO,
INCOME_REPORTS
Example:
openFinancePermissionsGranted
string[]
required

Permissões normalizadas; nomes variam por modalidade (ex.: ACCOUNTS_READ/RESOURCES_READ no Brasil ou ACCOUNTS/BALANCES/TRANSACTIONS no fluxo internacional).

Example:
createdAt
string<date-time>
required

Timestamp ISO-8601 de criação do consentimento.

Example:

"2025-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Timestamp ISO-8601 da última mudança conhecida.

Example:

"2025-01-01T00:05:00.000Z"

expiresAt
string<date-time> | null
required

Expiração quando conhecida; no fluxo internacional é limitada pela validade máxima informada pelo ASPSP.

Example:

null

revokedAt
string<date-time> | null
required

Definido quando revogado; null caso contrário.

Example:

null