API docs by Redocly

Cumbuca Gateway API (1.0.0)

Download OpenAPI specification:

URL: https://cumbuca.com

API for accessing Open Finance Brazil data and managing consents.

This API exposes endpoints for:

  • Consent management (/consent-management)
  • OIDC authorization (/openid)
  • Open Finance Brazil data (/open-finance): accounts, credit cards, loans, financings, overdraft advances, invoice financings, investments, and customer data

The Open Finance data endpoints (/open-finance/*) expose aggregated financial data from transmitting institutions via Open Finance Brazil, providing a unified abstraction layer over connected account data.

Consent Management

Endpoints for creating and managing data-sharing consents.

Create a new consent request.

Creates a new data-sharing consent for the customer.

Open Finance - API Consentimento
Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{}

Generate a new authorisation URL for the consent identified by consentId.

Generates a new authorisation redirect URL for a consent that failed or was not completed.

Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

The consentId is the unique consent identifier and must be a URN (Uniform Resource Name), as defined in RFC 8141.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Renew the consent identified by consentId.

Renews an existing consent. The consent can only be renewed if it is in an active state and within the allowed renewal window.

Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

The consentId is the unique consent identifier and must be a URN (Uniform Resource Name), as defined in RFC 8141.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-customer-user-agent
required
string [ 1 .. 100 ] characters [\w\W\s]*

User-agent string of the end user.

x-fapi-customer-ip-address
required
string[\w\W\s]*

End user's IP address if they are currently logged in with the client.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get renewal history for the consent identified by consentId.

Returns details of all extensions (renewals) made to the specified consent.

Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

The consentId is the unique consent identifier and must be a URN (Uniform Resource Name), as defined in RFC 8141.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get details of the consent identified by consentId.

Returns the full details of the specified consent.

Open Finance - API Consentimento
Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

The consentId is the unique consent identifier and must be a URN (Uniform Resource Name), as defined in RFC 8141.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Revoke the consent identified by consentId.

Deletes or revokes the specified consent, terminating data-sharing authorisation.

Open Finance - API Consentimento
Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

The consentId is the unique consent identifier and must be a URN (Uniform Resource Name), as defined in RFC 8141.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "meta": {
    }
}

List registered participants and their APIs.

Returns all institutions registered in the Open Finance Brazil directory, including their Authorisation Server identifiers and available API resources.

Open Finance - Funções regulatórias para mapeamentos OpenID e OAuth 2.0
Authorizations:
BearerAuth
query Parameters
role
string

Filter results to OrgDomainRoleClaims containing the specified role. Role types are subject to change.

familyType
string

Filter results to ApiResources containing the specified familyType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Submit OIDC authorisation result.

Used in the App-to-App flow to exchange the authorisation code returned by the data provider for tokens, or to process an authorisation error.

Authorizations:
BearerAuth
Request Body schema: application/json
data
string

Responses

Request samples

Content type
application/json
{
  • "data": "code=LxSevzQNevQJM0yx4dhPo4oJHdYhAHG808ssYF2OlzC&id_token=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkVKU01fbW1UMV9qTTVieTM5aEttR01BSWNTM2lzQ3BPSlB5NVdnUmY3RUUifQ.eyJzdWIiOiJPRkMtNDkzOGI1ODIzZWQzNjMxNmQyZTVjYzY5M2YxNzljMTJjNTE0MjNlYTQ0NzJiYjgyZWI5YWYzNTE0NjEyYmI2MSIsImF1dGhfdGltZSI6MTY5NTY3NjE2MCwiYWNyIjoidXJuOmJyYXNpbDpvcGVuYmFua2luZzpsb2EyIiwibm9uY2UiOiIzNjE2YzM3NWFjMDZlODBjMTk3MjljMTkwOGEzYjkxMGQ3ODVlYzViZTkxOTZhN2YyZjllZjhmNDI1YmVlNWMxIiwiY19oYXNoIjoiRUVMd2FoU1FQUGt2WEZWZzJOZnRHUSIsInNfaGFzaCI6IndPN1hZbFB1c1FZMGtwOG1Ucmw3WVEiLCJhdWQiOiI1aUtkV3JCdlhFRjJHNWgwZ1RaMkMiLCJleHAiOjE2OTU2NzcwNjAsImlhdCI6MTY5NTY3NjE2MCwiaXNzIjoiaHR0cHM6Ly9vYmIucWEub29iLm9wdXMtc29mdHdhcmUuY29tLmJyLyJ9.SNBN_Buh_Y0iLuJGP4bgSHYnSKC_g76R0CpWEVRJua788RNoJpAzhAm6Ah6vOb2nD-H4Yq2MAjRy_Fkh7ruziBaJ4ebDexxQ2GAocBgrmQ2JwI-Q-1D4Xm1WuSS6OSm04Kk0CiV8MylidwxF_4XS40uWqxTJQcgG8dP4NC9-ty8S6a-6oGs0MekjOqm9mU0aFDwS8fRGZ8TU-8AT15hiMQ9sXsgNlfrci0MQi9Jb6t9o4c93mKCLhGypYswjs1MjVoXD3K6btZ2NSZYBQROtTK_tl9HkvW1uRVhNVZjzwDs1DJrvZpLP48es8YPxFtYAAKsuwiB8bza58MYKvvW81A&state=dXJuOmFtYXppbmdiYW5rOjdlOWYxMDhmLWE3MDktNDBlNi1iMzQ2LTNjNGZiMzBjNjcyNnwx"
}

Response samples

Content type
application/json
{
  • "error": "access_denied",
  • "error_description": "Error in user authentication"
}

Resources

Endpoints for listing resources linked to a consent, following Open Finance Brazil standards.

List consented resources.

Returns the list of resources held by the customer at the data provider and covered by the active consent.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Customer Data

Endpoints for querying customer registration data (individuals and businesses), following Open Finance Brazil standards.

Get personal customer identification records.

Returns the identification records for the individual customer held at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get business customer identification records.

Returns the identification records for the business customer held at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get personal customer qualification records.

Returns the qualification records (financial profile) for the individual customer held at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get business customer qualification records.

Returns the qualification records (financial profile) for the business customer held at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get personal customer financial relationships.

Returns the financial relationship records and authorised representatives for the individual customer at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get business customer financial relationships.

Returns the financial relationship records and authorised representatives for the business customer at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Credit Cards

Endpoints for querying credit card account data, following Open Finance Brazil standards.

List credit card accounts.

Returns the list of credit card (post-paid payment) accounts held by the customer at the data provider and covered by the active consent.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get credit card account details.

Returns the identification data for the credit card account identified by creditCardAccountId.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string

Uniquely identifies the credit card account, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get credit card account limits.

Returns the credit limits for the account identified by creditCardAccountId.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string

Uniquely identifies the credit card account, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List credit card transaction history.

Returns the historical transaction list (up to the last 12 months) for the credit card account identified by creditCardAccountId.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string

Uniquely identifies the credit card account, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List recent credit card transactions (last 7 days).

Returns the recent transaction list (last 7 days) for the credit card account identified by creditCardAccountId.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string

Uniquely identifies the credit card account, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List credit card bills.

Returns the list of bills for the credit card account identified by creditCardAccountId.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string

Uniquely identifies the credit card account, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List transactions for a specific bill.

Returns the list of transactions for the bill identified by billId on the credit card account identified by creditCardAccountId.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string

Uniquely identifies the credit card account, preserving immutability rules within the data provider.

billId
required
string

Identifies the bill.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Accounts

Endpoints for querying payment and deposit account data, following Open Finance Brazil standards.

List consented accounts.

Returns the list of accounts consented by the customer.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get account details.

Returns the identification data for the account identified by accountId.

Authorizations:
BearerAuth
path Parameters
accountId
required
string

Identifier for a demand deposit, savings, or prepaid payment account.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get account balances.

Returns the balance information for the account identified by accountId.

Authorizations:
BearerAuth
path Parameters
accountId
required
string

Identifier for a demand deposit, savings, or prepaid payment account.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List account transaction history.

Returns the historical transaction list for the account identified by accountId.

Authorizations:
BearerAuth
path Parameters
accountId
required
string

Identifier for a demand deposit, savings, or prepaid payment account.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List recent account transactions (last 7 days).

Returns the recent transaction list (last 7 days) for the account identified by accountId.

Authorizations:
BearerAuth
path Parameters
accountId
required
string

Identifier for a demand deposit, savings, or prepaid payment account.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get account overdraft limits.

Returns the overdraft limits for the account identified by accountId.

Authorizations:
BearerAuth
path Parameters
accountId
required
string

Identifier for a demand deposit, savings, or prepaid payment account.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Loans

Endpoints for querying loan credit operation data, following Open Finance Brazil standards.

List loan contracts.

Returns the list of loan contracts held by the customer at the data provider and covered by the active consent.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get loan contract details.

Returns the data for the loan contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List loan contract warranties.

Returns the list of warranties linked to the loan contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get loan contract payment data.

Returns the payment data for the loan contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get loan contract instalment schedule.

Returns the scheduled instalments for the loan contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Financings

Endpoints for querying financing credit operation data, following Open Finance Brazil standards.

List financing contracts.

Returns the list of financing contracts held by the customer at the data provider and covered by the active consent.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get financing contract details.

Returns the data for the financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List financing contract warranties.

Returns the warranties linked to the financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get financing contract payment data.

Returns the payment data for the financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get financing contract instalment schedule.

Returns the scheduled instalments for the financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Overdraft Advances

Endpoints for querying overdraft advance data, following Open Finance Brazil standards.

List consented overdraft advance contracts.

Returns the list of overdraft advance contracts consented by the customer.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get overdraft advance contract details.

Returns the data for the overdraft advance contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List overdraft advance contract warranties.

Returns the warranties linked to the overdraft advance contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get overdraft advance contract payment data.

Returns the payment data for the overdraft advance contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get overdraft advance contract instalment schedule.

Returns the scheduled instalments for the overdraft advance contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Invoice Financings

Endpoints for querying discounted credit rights (invoice financings) data, following Open Finance Brazil standards.

List consented invoice financing contracts.

Returns the list of invoice financing (receivables advance) contracts consented by the customer.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get invoice financing contract details.

Returns the data for the invoice financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List invoice financing contract warranties.

Returns the warranties linked to the invoice financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get invoice financing contract payment data.

Returns the payment data for the invoice financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get invoice financing contract instalment schedule.

Returns the scheduled instalments for the invoice financing contract identified by contractId.

Authorizations:
BearerAuth
path Parameters
contractId
required
string

Contract identifier for all types of credit operations.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Investments - Bank Fixed Income

Endpoints for querying bank fixed income investment data, following Open Finance Brazil standards.

List bank fixed income investments.

Returns the list of bank fixed income investment positions held by the customer at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get bank fixed income investment details.

Returns the data for the bank fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get bank fixed income investment position.

Returns the current balance/position for the bank fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List bank fixed income investment transactions.

Returns the transaction history for the bank fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List recent bank fixed income investment transactions.

Returns recent transactions (last 7 days) for the bank fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Investments - Credit Fixed Income

Endpoints for querying credit fixed income investment data, following Open Finance Brazil standards.

List credit fixed income investments.

Returns the list of credit fixed income investment positions held by the customer at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get credit fixed income investment details.

Returns the data for the credit fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get credit fixed income investment position.

Returns the current balance/position for the credit fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List credit fixed income investment transactions.

Returns the transaction history for the credit fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List recent credit fixed income investment transactions.

Returns recent transactions (last 7 days) for the credit fixed income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Investments - Variable Income

Endpoints for querying variable income investment data, following Open Finance Brazil standards.

List variable income investments.

Returns the list of variable income (equity) investment positions held by the customer at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get variable income investment details.

Returns the data for the variable income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get variable income investment position.

Returns the current balance/position for the variable income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List variable income investment transactions.

Returns the transaction history for the variable income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List recent variable income investment transactions.

Returns recent transactions (last 7 days) for the variable income investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get broker note details.

Returns the broker note identified by brokerNoteId.

Authorizations:
BearerAuth
path Parameters
brokerNoteId
required
string

Uniquely identifies the broker note, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Investments - Treasury Bonds

Endpoints for querying Tesouro Direto (Brazilian treasury bond) investment data, following Open Finance Brazil standards.

List Tesouro Direto investments.

Returns the list of Tesouro Direto (Brazilian treasury bond) investment positions held by the customer at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get Tesouro Direto investment details.

Returns the data for the Tesouro Direto investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get Tesouro Direto investment position.

Returns the current balance/position for the Tesouro Direto investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List Tesouro Direto investment transactions.

Returns the transaction history for the Tesouro Direto investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List recent Tesouro Direto investment transactions.

Returns recent transactions (last 7 days) for the Tesouro Direto investment identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Investments - Funds

Endpoints for querying investment fund data, following Open Finance Brazil standards.

List investment fund positions.

Returns the list of investment fund positions held by the customer at the data provider.

Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get investment fund position details.

Returns the data for the investment fund position identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Get investment fund position balance.

Returns the current balance/position for the investment fund identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List investment fund transactions.

Returns the transaction history for the investment fund identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

List recent investment fund transactions.

Returns recent transactions (last 7 days) for the investment fund identified by investmentId.

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

Uniquely identifies the customer's relationship with the investment product, preserving immutability rules within the data provider.

header Parameters
x-authorisation-server-id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Authorisation Server identifier for the consent's data provider, obtained from the participants list.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Consent identifier to be used in this operation, obtained from the consent creation response.

Responses

Response samples

Content type
application/json
{}

Authentication

Endpoint para obtenção de tokens de acesso via fluxo Client Credentials do OAuth 2.0.

Request an access token.

Issues an OAuth 2.0 access token and refresh token using the Client Credentials grant type. The returned access token must be sent as a Bearer token in the Authorization header of every subsequent API call. Cache and reuse the access token until it expires, then use the refresh token to obtain a new one without re-presenting client credentials.

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Value: "client_credentials"

Must be client_credentials.

scope
string

Optional space-separated list of requested scopes.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "scope": "string",
  • "refresh_token": "string",
  • "refresh_token_expires_in": 0
}

Refresh an access token.

Issues a new access token using an existing refresh token, without requiring client credentials again. The response follows the same shape as POST /auth/v1/token and may include a rotated refresh token.

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Value: "refresh_token"

Must be refresh_token.

refresh_token
required
string

The refresh token returned by a previous call to POST /auth/v1/token or POST /auth/v1/refresh.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "scope": "string",
  • "refresh_token": "string",
  • "refresh_token_expires_in": 0
}