List Open Finance Brasil participant institution brands

get

https://api-sandbox-v2-hml.openkeys.celcoin.sandbox.fsapps.app/open-keys/itp/api/v2/participants/brands

Retrieves a paginated and filterable list of financial institution brands participating in the Open Finance Brasil ecosystem. Returns detailed information about each institution including authorization server details, supported APIs, account type capabilities, and branding information. Supports advanced filtering by name, API family types, account support flags, and custom search criteria with accent-insensitive matching.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

1 to 999999

Page number for pagination results

pageSize

int32

1 to 999999

Number of items per page (maximum records returned per request)

string

length between 0 and 999999

Search text to filter brands by specific criteria. Must be used together with searchFields parameter.

searchFields

string

length between 0 and 999999

Semicolon-separated list of fields to search in. Available fields: CustomerFriendlyName, CustomerFriendlyDescription, OrganisationName. Required when search parameter is provided.

sort

string

length between 0 and 999999

Sort criteria for ordering results. Specify field names for sorting.

apiFamilyType

string

enum

length between 0 and 999999

Filter by specific API family type supported by the institution. Available types: payments-pix, payments-pix-recurring-payments, payments-pix-recurring-payments-automatic

Allowed:

flags

string

enum

length between 0 and 999999

Filter by account type support flags. 'pf' for individual person accounts (CPF), 'pj' for legal entity accounts (CNPJ)

Allowed:

priorityIds[]

array of strings

List of brand IDs to prioritize in the results ordering

priorityIds[]

Responses

200Paginated list of Open Finance Brasil participant institution brands with detailed metadata successfully returned.

401Authentication is required to access this resource. The client must provide valid credentials.

403The server understood the request but refuses to authorize it. Access is permanently forbidden and tied to the application logic.

409The request conflicts with the current state of the resource on the server.

422The request contains invalid or malformed data that cannot be processed.

500An unexpected error occurred on the server while processing the request.

defaultUnexpected error.