v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Participants

List Open Finance Brasil participant institution 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.

get/open-keys/itp/api/v2/participants/brands

Query parameters

pageinteger

Example:1

Page number for pagination results

pageSizeinteger

Example:10

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

searchstring

Example:Finansystech

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

searchFieldsstring

Example:CustomerFriendlyName

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

sortstring

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

apiFamilyType'payments-pix' | 'payments-pix-recurring-payments' | 'payments-pix-recurring-payments-automatic'

Example:payments-pix

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

flags'pf' | 'pj'

Example:pf

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

priorityIds[]string[]

List of brand IDs to prioritize in the results ordering

Response

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

Example response

{
  "data": [
    {
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "settings": {
        "brandId": "66f4d9e296f18bc4606e1618",
        "sandboxUsersTests": [
          {
            "username": "usuario_teste",
            "password": "senha1234",
            "document": {
              "identification": "11122233344",
              "rel": "CPF"
            }
          }
        ],
        "updatedAt": "2024-09-26T03:51:03.642Z",
        "uptimeStatus": "OPERATIONAL",
        "id": "66f4da2796f18bc4606e2b87"
      }
    }
  ],
  "meta": {
    "total": 12,
    "page": 1,
    "pageSize": 10,
    "totalPages": 2
  }
}