Codat · Schema

Branding

Unified_API

Properties

Name Type Description
logo object
button object
sourceId string A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId`
View JSON Schema on GitHub

JSON Schema

codat-branding-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Branding",
  "title": "Branding",
  "type": "object",
  "properties": {
    "logo": {
      "$ref": "#/components/schemas/Branding/definitions/brandingLogo"
    },
    "button": {
      "$ref": "#/components/schemas/Branding/definitions/brandingButton"
    },
    "sourceId": {
      "type": "string",
      "format": "uuid",
      "example": "35b92968-9851-4095-ad60-395c95cbcba4",
      "description": "A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`."
    }
  },
  "definitions": {
    "brandingLogo": {
      "description": "Logo branding references.",
      "type": "object",
      "properties": {
        "full": {
          "$ref": "#/components/schemas/Branding/definitions/brandingImage"
        },
        "square": {
          "$ref": "#/components/schemas/Branding/definitions/brandingImage"
        }
      }
    },
    "brandingButton": {
      "type": "object",
      "description": "Button branding references.",
      "properties": {
        "default": {
          "$ref": "#/components/schemas/Branding/definitions/brandingImage"
        },
        "hover": {
          "$ref": "#/components/schemas/Branding/definitions/brandingImage"
        }
      }
    },
    "brandingImage": {
      "title": "Branding Image",
      "type": "object",
      "properties": {
        "image": {
          "$ref": "#/components/schemas/Branding/definitions/imageReference"
        }
      },
      "examples": []
    },
    "imageReference": {
      "type": "object",
      "title": "Image Reference",
      "description": "Image reference.",
      "properties": {
        "src": {
          "type": "string",
          "format": "uri",
          "description": "Source URL for image."
        },
        "alt": {
          "type": "string",
          "description": "Alternative text when image is not available."
        }
      }
    }
  },
  "examples": [
    {
      "logo": {
        "full": {
          "image": {
            "src": "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
            "alt": "xero full icon"
          }
        },
        "square": {
          "image": {
            "src": "https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png",
            "alt": "xero square icon"
          }
        }
      },
      "button": {
        "default": {
          "image": {
            "src": "https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png",
            "alt": "xero default button icon"
          }
        },
        "hover": {
          "image": {
            "src": "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
            "alt": "xero hover button icon"
          }
        }
      },
      "sourceId": "35b92968-9851-4095-ad60-395c95cbcba4"
    }
  ]
}