Get Institution Branding

📘

Note

Before you can retrieve the institution branding, the customer needs to be registered with Open Banking and have at least one financial account connected. This is done using the Register Open Banking Customer endpoint.

The Get Institution Branding endpoint enables you to retrieve branding information for a specific financial institution. The endpoint returns logo URLs, colours, and other branding assets for the institution. This is a free Open Banking management endpoint.

You can retrieve a customer's branding by making a GET request to the Get Institution Branding endpoint, with the institution identifier included in the URL. You can retrieve the institution_id from the responses of either the Get All Customer Accounts or Register Open Banking Account Customer endpoints.

https://uat-api.thredd.com/api/v1/open-banking/institutions/{institution_id}/branding

The request header must include the client-id for the request, and an optional partner-id. See the below example.

curl --request GET \
     --url https://uat-api.thredd.com/api/v1/open-banking/institutions/4222/branding \
     --header 'accept: application/json' \
     --header 'client-id: ClientA' \
     --header 'partner-id: 1234567890123'

If successful, a 200 response is returned with the customer's branding details.

{
  "branding": {
    "logo": "https://example.com/logo.svg",
    "alternateLogo": "https://example.com/alternateLogo.svg",
    "icon": "https://example.com/icon.svg",
    "primaryColor": "#0167AE",
    "tile": "https://example.com/tile.svg"
  }
}

📘

More Information

• To view this endpoint in the API Explorer, see Get Institution Branding.
• To view details on the fields included in this endpoint, see Get Institution Branding - Field Descriptions.