feat: Add Brand Fetch logo link for logos (see #43) (#99)

* feat: Add Brand Fetch logo link for logos

* docs: brand fetch integration docs

* Document CLIENT_ID location?

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Juan José Mata <jjmata@jjmata.com>

---------

Signed-off-by: Juan José Mata <jjmata@jjmata.com>
Co-authored-by: Vincent Teo <vinteo@gmail.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This commit is contained in:
Juan José Mata
2025-08-11 13:34:54 -07:00
committed by GitHub
parent 1ae9e3e8fb
commit dd0cb60b56
12 changed files with 81 additions and 9 deletions

20
docs/hosting/logos.md Normal file
View File

@@ -0,0 +1,20 @@
# Account, Merchant and Security Logos
Sure has integration with the [Brand Fetch Logo Link](https://brandfetch.com/developers/logo-api) service to provide logos for accounts, merchants and securities.
Logos are currently matched in the following ways:
- For accounts, Plaid integration for the account is required and matched via FQDN (fully qualified domain name) from the Plaid integration
- For merchants, OpenAI integration is required and automatically matched to the merchant name and matched via FQDN
- For securities, logos are matched using the ticker symbol
> [!NOTE]
> Currently ticker symbol matching cannot specify the exchange and since US exchanges are prioritized, securities from other exchanges might not have the right logo.
## Enabling Brand Fetch Integration
A Brand Fetch Client ID is required and to obtain a client ID, sign up for an account [here](https://brandfetch.com/developers/logo-api).
Once you enter the Client ID into the Sure settings under the `Self hosting` section, logos from Brand Fetch integration will be enabled.
Alternatively, you can provide the client id using the `BRAND_FETCH_CLIENT_ID` environment variable to the web and worker services.
![CLIENT_ID screenshot](logos-clientid.png)