Branding - MX Documentation

For convenience, this API also includes an endpoint for getting information about brand colors, the logo, and the institution name that can be used for data-recipient UI theming to better match the financial institution. This is considered public information and doesn’t require any client authentication to view. Endpoint: GET /settings

curl -i -X GET 'https://base.url.com/settings' \
 -H 'Accept: application/json'

{
  "theme": {
    "brand100": "#F3F9FC",
    "brand300": "#188CBB",
    "brand400": "#0F759F",
    "institution_name": "Epic Bank",
    "logo": {
      "name": "logo.svg",
      "size": 12182,
      "url": "/images/logo.svg"
    }
  }
}

Theme Fields

Name	Data Type	Description
`theme.brand100`	String	Hex color value. Used as a background for selected or active elements. Almost always paired with `brand400`.
`theme.brand300`	String	Hex color value. The most prominent brand color. Used for primary buttons.
`theme.brand400`	String	Hex color value. Used as the foreground color for selected and active elements.
`theme.institution_name`	String	The human-readable name of the financial institution.
`theme.logo.name`	String	The name and extension of the logo file.
`theme.logo.size`	Integer	The size in bytes of the logo file.
`theme.logo.url`	String	The relative URL of the image.
`theme.logo`	Object	JSON object containing all information regarding the logo.
`theme`	Object	JSON object containing all theming information.