v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Participants

Get Open Finance Brasil participant institution brand by ID

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.

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

Path parameters

idstring required

Unique identifier of the brand to retrieve detailed information

Response

Detailed Open Finance Brasil participant institution brand information successfully returned.

idstring required

Unique identifier of the brand record in the local database

createdAtstring required

Record creation date and time

updatedAtstring required

Record last update date and time

deletedAtstring required

Record deletion date and time (soft delete)

AuthorisationServerIdstring 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.

CustomerFriendlyDescriptionstring 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.

CustomerFriendlyLogoUristring 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.

CustomerFriendlyNamestring 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.

OpenIDDiscoveryDocumentstring required

URL of the OpenID Connect discovery document for the institution's authorization server. Contains metadata about the OAuth2/OIDC endpoints and capabilities.

OrganisationIdstring required

Unique identifier of the parent organization in the Open Finance Brasil directory

ParentAuthorisationServerIdstring

Identifier of the parent authorization server, if this brand is part of a larger organization structure

OrganisationNamestring required

Official legal name of the organization as registered in the Open Finance Brasil directory

strIdstring

Additional string identifier of the brand when available

Example response

{
  "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"
  }
}