---
title: "Get Open Finance Brasil participant institution brand by ID"
method: GET
path: "/open-keys/itp/api/v2/participants/brands/{id}"
tags: ["Participants"]
---

# Get Open Finance Brasil participant institution brand by ID

`GET /open-keys/itp/api/v2/participants/brands/{id}`

## Request

- Base URL: `https://sandbox.openfinance.celcoin.dev`
- URL: `https://sandbox.openfinance.celcoin.dev/open-keys/itp/api/v2/participants/brands/{id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `http://localhost:8080/auth/realms/master/protocol/openid-connect/token` scopes: `openkeys_admin`, `user_owner_app`, `app`, `journey`

Retrieves detailed information about a specific financial institution brand participating in the Open Finance Brasil ecosystem. Returns comprehensive data including authorization server details, supported API capabilities, account type support flags, organization information, OpenID Connect configuration, and branding elements. This endpoint provides complete institutional metadata required for payment initiation and consent flows.

## Path parameters

- `id` string, required

## Response `200`

Detailed Open Finance Brasil participant institution brand information successfully returned.

- Brand
  - `id` string, required: Unique identifier of the brand record in the local database
  - `createdAt` string, required: Record creation date and time
  - `updatedAt` string, required: Record last update date and time
  - `deletedAt` string, required: Record deletion date and time (soft delete)
  - `AuthorisationServerId` string, required: Unique identifier of the Open Finance Brasil participant institution's authorization server. Corresponds to the authorization server ID registered in the ecosystem's central directory.
  - `CustomerFriendlyDescription` string, required: Customer-friendly description of the brand directed to the end customer. Used to present clear information about the financial institution in the user interface during the consent and authentication process.
  - `CustomerFriendlyLogoUri` string, required: URL of the brand logo image for display to the end customer. Must be a valid and accessible URL pointing to the official logo of the financial institution as registered in the Open Finance Brasil directory.
  - `CustomerFriendlyName` string, required: Customer-friendly name of the brand as presented to the end customer. Represents the commercial name of the financial institution used in communication with users during consent and authentication flows in Open Finance Brasil.
  - `Flags` BrandFlags, required
    - `Suporta Contas PF` string[]: Array indicating support for individual person accounts
    - `Suporta Contas PJ` string[]: Array indicating support for legal entity accounts
  - `OpenIDDiscoveryDocument` string, required: URL of the OpenID Connect discovery document for the institution's authorization server. Contains metadata about the OAuth2/OIDC endpoints and capabilities.
  - `OrganisationId` string, required: Unique identifier of the parent organization in the Open Finance Brasil directory
  - `ParentAuthorisationServerId` string: Identifier of the parent authorization server, if this brand is part of a larger organization structure
  - `OrganisationName` string, required: Official legal name of the organization as registered in the Open Finance Brasil directory
  - `strId` string: Additional string identifier of the brand when available
  - `ApiFamilyType` BrandApiFamilyType, required
    - `payments-pix-recurring-payments-automatic` boolean: Indicates support for PIX automatic recurring payments API
    - `payments-pix` boolean: Indicates support for PIX payments API
    - `payments-pix-recurring-payments` boolean: Indicates support for PIX recurring payments API
  - `settings` BrandSettings
    - `brandId` string, required: Brand identifier associated with the settings.
    - `sandboxUsersTests` BrandSettingsSandboxUsersTests[]: List of test users available for sandbox environment.
      - `username` string, required: Username for sandbox environment testing.
      - `password` string, required: Password for sandbox environment testing.
      - `document` BrandSettingsSandboxUsersTestsDocument, required
        - `identification` string, required: Identification document number.
        - `rel` string, required: Type of identification document (CPF, CNPJ).
    - `updatedAt` string: Date and time of the last settings update.
    - `uptimeStatus` string: Operational status of the brand (OPERATIONAL, MAINTENANCE, etc.).
    - `id` string, required: Unique identifier of the settings.
  - `organisationBrands` BrandOrganisationBrands[]: List of other brands belonging to the same organization.
    - `AuthorisationServerId` string, required: Unique identifier of the brand's authorization server.
    - `CustomerFriendlyDescription` string, required: Customer-friendly description of the brand for display.
    - `CustomerFriendlyLogoUri` string, required: URL of the brand logo for customer display.
    - `CustomerFriendlyName` string, required: Customer-friendly name of the brand for display.
    - `Flags` object, required: Brand capability flags.
    - `OpenIDDiscoveryDocument` string, required: URL of the OpenID Connect discovery document.
    - `OrganisationId` string, required: Parent organization identifier.
    - `ParentAuthorisationServerId` string: Parent authorization server identifier.
    - `OrganisationName` string, required: Official name of the organization.
    - `strId` string: Additional string identifier of the brand when available.
    - `ApiFamilyType` object, required: API family types supported by the brand.
    - `id` string, required: Unique identifier of the brand.

## Other responses

- `401`: Authentication is required to access this resource. The client must provide valid credentials.
- `403`: The server understood the request but refuses to authorize it. Access is permanently forbidden and tied to the application logic.
- `409`: The request conflicts with the current state of the resource on the server.
- `422`: The request contains invalid or malformed data that cannot be processed.
- `500`: An unexpected error occurred on the server while processing the request.
- `default`: Unexpected error.

---

[API](https://skmtc.dev/celcoin/apis/api-para-transa-es.md) - [All operations](https://skmtc.dev/celcoin/apis/api-para-transa-es/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/api-para-transa-es/revisions/85dd6188a37b?raw)