swagger: "2.0"
schemes:
  - https
host: dikpeqbnwi3kx.cloudfront.net
info:
  contact:
    x-twitter: HSBC_UK
  title: Branch Locator API
  version: 2.2.1
  x-apisguru-categories:
    - financial
  x-logo:
    url: https://twitter.com/HSBC_UK/profile_image?size=original
  x-origin:
    - format: swagger
      url: https://developer.hsbc.com/assets/swaggers/open-branch-locator-swagger.json
      version: "2.0"
  x-providerName: hsbc.com
  x-serviceName: branches
consumes:
  - application/json
produces:
  - application/prs.openbanking.opendata.v2.2+json
paths:
  /open-banking/v2.2/branches:
    get:
      description: This API will return the branch details for all branches and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/BranchDefinitionMeta"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition400"
        "408":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition408"
        "429":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition429"
        "500":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition500"
        "503":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition503"
      tags:
        - Branches
  "/x-open-banking/v2.2/branches/country/{country}":
    get:
      description: This extended API will return the branch details for all branches in the specified country. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
      parameters:
        - description: The ISO country code e.g. &quot;GB&quot;
          in: path
          name: country
          required: true
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/BranchDefinitionMeta"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition400"
        "408":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition408"
        "429":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition429"
        "500":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition500"
        "503":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition503"
      tags:
        - Branches
  "/x-open-banking/v2.2/branches/country/{country}/town/{town}":
    get:
      description: This extended API will return the branch details for all branches in the specified town. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
      parameters:
        - description: The ISO country code e.g. &quot;GB&quot;
          in: path
          name: country
          required: true
          type: string
        - description: Town name, not case sensitive
          in: path
          name: town
          required: true
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/BranchDefinitionMeta"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition400"
        "408":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition408"
        "429":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition429"
        "500":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition500"
        "503":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition503"
      tags:
        - Branches
  "/x-open-banking/v2.2/branches/geo-location/lat/{latitude}/long/{longitude}":
    get:
      description: This API will return the branch details for all branches within a specified radius (1 to 10 miles) of the specified latitude and longitude. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
      parameters:
        - description: Positive or negative decimal value in degrees. eg &quot;51.50551621597067&quot;
          in: path
          name: latitude
          required: true
          type: string
        - description: Positive or negative decimal value in degrees. eg &quot;-0.0180120225995&quot;
          in: path
          name: longitude
          required: true
          type: string
        - description: Number of miles (1 to 10) as an integer. Default = 1
          in: query
          name: radius
          required: true
          type: number
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/BranchDefinitionMeta"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition400"
        "408":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition408"
        "429":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition429"
        "500":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition500"
        "503":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition503"
      tags:
        - Branches
  "/x-open-banking/v2.2/branches/postcode/{postcode}":
    get:
      description: This extended API will return the branch details for all branches within a 5 mile radius of the specified postcode. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
      parameters:
        - description: Letters and numerals only. No spaces or special characters. eg. &quot;SW1A1AA&quot;
          in: path
          name: postcode
          required: true
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/BranchDefinitionMeta"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition400"
        "408":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition408"
        "429":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition429"
        "500":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition500"
        "503":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition503"
      tags:
        - Branches
  "/x-open-banking/v2.2/branches/sortcode/{sortcode}":
    get:
      description: This extended API will return the branch details for a branch specified by its sort code. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
      parameters:
        - description: 6 digit number with no spaces or special characters. eg. &quot;400003&quot;
          in: path
          name: sortcode
          required: true
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/BranchDefinitionMeta"
        "400":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition400"
        "408":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition408"
        "429":
          description: Bad request
          schema:
            $ref: "#/definitions/ErrorDefinition429"
        "500":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition500"
        "503":
          description: System error
          schema:
            $ref: "#/definitions/ErrorDefinition503"
      tags:
        - Branches
definitions:
  BranchDefinition:
    description: Environment of the branch
    properties:
      Brand:
        additionalProperties: false
        description: Brand owned by an organisation
        items:
          description: Brand owned by an organisation
          properties:
            Branch:
              additionalProperties: false
              description: Information that locates and identifies a specific branch of a financial institution.
              items:
                description: Information that locates and identifies a specific branch of a financial institution.
                properties:
                  Accessibility:
                    description: Accessibility is the ability and ease a customer can access a service, good, associate, or facility. Features which make the Bank accessible to disabled people
                    items:
                      description: Accessibility is the ability and ease a customer can access a service, good, associate, or facility. Features which make the Bank accessible to disabled people
                      enum:
                        - AutomaticDoors
                        - AudioCashMachine
                        - ExternalRamp
                        - HelpingHandUnit
                        - InductionLoop
                        - InternalRamp
                        - LevelAccess
                        - LowerLevelCounter
                        - Other
                        - WheelchairAccess
                      type: string
                    title: Accessibility
                    type: array
                  Availability:
                    additionalProperties: false
                    description: Days and times defining when the branch is available for use by a customer
                    properties:
                      NonStandardAvailability:
                        additionalProperties: false
                        description: Non-standard hours of availability for a branch of an organisation
                        properties:
                          Day:
                            additionalProperties: false
                            description: Working day information
                            items:
                              description: Working day information
                              properties:
                                Name:
                                  description: Specifies the day of the week
                                  enum:
                                    - Friday
                                    - Monday
                                    - Saturday
                                    - Sunday
                                    - Thursday
                                    - Tuesday
                                    - Wednesday
                                  title: Name
                                  type: string
                                Notes:
                                  description: Specify any note that is related the particular opening day e.g. Closed half day on Monday
                                  maxLength: 2000
                                  minLength: 1
                                  title: Notes
                                  type: string
                                OpeningHours:
                                  additionalProperties: false
                                  description: Opening & Closing Times of a branch of an organisation
                                  items:
                                    description: Opening & Closing Times of a branch of an organisation
                                    properties:
                                      ClosingTime:
                                        description: |-
                                          A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
                                          Note on the time format:
                                          1) beginning / end of calendar day
                                          00:00:00 = the beginning of a calendar day
                                          24:00:00 = the end of a calendar day
                                          2) fractions of second in time format
                                          Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
                                        pattern: ^(2[0-3]|[01][0-9]):?([0-5][0-9])$
                                        title: ClosingTime
                                        type: string
                                      OpeningTime:
                                        description: |-
                                          A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
                                          Note on the time format:
                                          1) beginning / end of calendar day
                                          00:00:00 = the beginning of a calendar day
                                          24:00:00 = the end of a calendar day
                                          2) fractions of second in time format
                                          Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
                                        pattern: ^(2[0-3]|[01][0-9]):?([0-5][0-9])$
                                        title: OpeningTime
                                        type: string
                                    required:
                                      - OpeningTime
                                      - ClosingTime
                                    type: object
                                  minItems: 1
                                  title: OpeningHours
                                  type: array
                              required:
                                - Name
                                - OpeningHours
                              type: object
                            maxItems: 7
                            minItems: 0
                            title: Day
                            type: array
                          EndDate:
                            description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.'
                            format: date
                            title: EndDate
                            type: string
                          Name:
                            description: Name provided for non-standard opening periods e.g. Christmas
                            maxLength: 140
                            minLength: 1
                            title: Name
                            type: string
                          Notes:
                            description: Notes related to the Non-standard hours e.g. During shrimp season, the branch has extended opening hours
                            maxLength: 2000
                            minLength: 1
                            title: Notes
                            type: string
                          StartDate:
                            description: 'A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.'
                            format: date
                            title: StartDate
                            type: string
                        required:
                          - Name
                        title: NonStandardAvailability
                        type: object
                      StandardAvailability:
                        additionalProperties: false
                        description: Standard hours of availability for the branch of the organisation
                        properties:
                          Day:
                            additionalProperties: false
                            description: Working day information
                            items:
                              description: Working day information
                              properties:
                                Name:
                                  description: Specifies the day of the week
                                  enum:
                                    - Friday
                                    - Monday
                                    - Saturday
                                    - Sunday
                                    - Thursday
                                    - Tuesday
                                    - Wednesday
                                  title: Name
                                  type: string
                                Notes:
                                  description: Specify any note that is related the particular opening day e.g. Closed half day on Monday
                                  maxLength: 2000
                                  minLength: 1
                                  title: Notes
                                  type: string
                                OpeningHours:
                                  additionalProperties: false
                                  description: Opening & Closing Times of a branch of an organisation
                                  items:
                                    description: Opening & Closing Times of a branch of an organisation
                                    properties:
                                      ClosingTime:
                                        description: |-
                                          A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
                                          Note on the time format:
                                          1) beginning / end of calendar day
                                          00:00:00 = the beginning of a calendar day
                                          24:00:00 = the end of a calendar day
                                          2) fractions of second in time format
                                          Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
                                        pattern: ^(2[0-3]|[01][0-9]):?([0-5][0-9])$
                                        title: ClosingTime
                                        type: string
                                      OpeningTime:
                                        description: |-
                                          A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
                                          Note on the time format:
                                          1) beginning / end of calendar day
                                          00:00:00 = the beginning of a calendar day
                                          24:00:00 = the end of a calendar day
                                          2) fractions of second in time format
                                          Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
                                        pattern: ^(2[0-3]|[01][0-9]):?([0-5][0-9])$
                                        title: OpeningTime
                                        type: string
                                    required:
                                      - OpeningTime
                                      - ClosingTime
                                    type: object
                                  minItems: 1
                                  title: OpeningHours
                                  type: array
                              required:
                                - Name
                                - OpeningHours
                              type: object
                            maxItems: 7
                            minItems: 1
                            title: Day
                            type: array
                        required:
                          - Day
                        title: StandardAvailability
                        type: object
                    required:
                      - StandardAvailability
                    title: Availability
                    type: object
                  ContactInfo:
                    additionalProperties: false
                    description: Communication device number or electronic address used for communication.
                    items:
                      description: Communication device number or electronic address used for communication.
                      properties:
                        ContactContent:
                          description: Collection of information that identifies a phone/Fax number/ email, as defined by telecom services.
                          maxLength: 256
                          minLength: 1
                          title: ContactContent
                          type: string
                        ContactDescription:
                          description: Description of contact such as main phone number, alternate phone number, Fax number, alternate fax number, email and alternate email
                          maxLength: 70
                          minLength: 1
                          title: ContactDescription
                          type: string
                        ContactType:
                          description: Contact type such Phone, Fax and email
                          enum:
                            - AlternateEmail
                            - AlternateFax
                            - AlternatePhone
                            - Email
                            - Fax
                            - Other
                            - Phone
                          title: ContactType
                          type: string
                        OtherContactType:
                          additionalProperties: false
                          description: Other contact type which is not in the standard code list
                          properties:
                            Code:
                              description: The four letter Mnemonic used whithin an XML file to identify a code
                              maxLength: 4
                              minLength: 0
                              pattern: ^\w{0,4}$
                              title: Code
                              type: string
                            Description:
                              description: Description to describe the purpose of the code
                              maxLength: 350
                              minLength: 1
                              title: Description
                              type: string
                            Name:
                              description: Long name associated with the code
                              maxLength: 70
                              minLength: 1
                              title: Name
                              type: string
                          required:
                            - Name
                            - Description
                          title: OtherContactType
                          type: object
                      required:
                        - ContactType
                        - ContactContent
                      type: object
                    title: ContactInfo
                    type: array
                  CustomerSegment:
                    description: The marketing segment which the branch is able to address in terms of customer type. Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another
                    items:
                      description: The marketing segment which the branch is able to address in terms of customer type. Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another
                      enum:
                        - Business
                        - Corporate
                        - Other
                        - Personal
                        - Private
                        - Premier
                        - Select
                        - SME
                        - Wealth
                      type: string
                    minItems: 1
                    title: CustomerSegment
                    type: array
                  Identification:
                    description: Unique and unambiguous identification of a branch of a financial institution.
                    maxLength: 35
                    minLength: 1
                    title: Identification
                    type: string
                  Name:
                    description: Name by which a branch is known and which is usually used to identify that branch.
                    maxLength: 140
                    minLength: 1
                    title: Name
                    type: string
                  Note:
                    description: Summary description of services, facility and availability.
                    maxLength: 2000
                    minLength: 1
                    title: Note
                    type: string
                  OtherAccessibility:
                    additionalProperties: false
                    description: Enter any new code , name and description for any other Accessibility
                    items:
                      description: Enter any new code , name and description for any other Accessibility
                      properties:
                        Code:
                          description: The four letter Mnemonic used within an XML file to identify a code
                          maxLength: 4
                          minLength: 0
                          pattern: ^\w{0,4}$
                          title: Code
                          type: string
                        Description:
                          description: Description to describe the purpose of the code
                          maxLength: 350
                          minLength: 1
                          title: Description
                          type: string
                        Name:
                          description: Long name associated with the code
                          maxLength: 70
                          minLength: 1
                          title: Name
                          type: string
                      required:
                        - Name
                        - Description
                      type: object
                    title: OtherAccessibility
                    type: array
                  OtherCustomerSegment:
                    additionalProperties: false
                    description: Enter a new code , name and description for any other Customer Segment
                    items:
                      description: Enter a new code , name and description for any other Customer Segment
                      properties:
                        Code:
                          description: The four letter Mnemonic used within an XML file to identify a code
                          maxLength: 4
                          minLength: 0
                          pattern: ^\w{0,4}$
                          title: Code
                          type: string
                        Description:
                          description: Description to describe the purpose of the code
                          maxLength: 350
                          minLength: 1
                          title: Description
                          type: string
                        Name:
                          description: Long name associated with the code
                          maxLength: 70
                          minLength: 1
                          title: Name
                          type: string
                      required:
                        - Name
                        - Description
                      type: object
                    title: OtherCustomerSegment
                    type: array
                  OtherServiceAndFacility:
                    additionalProperties: false
                    description: Enter any new code , name and description for any Other Facility
                    items:
                      description: Enter any new code , name and description for any Other Facility
                      properties:
                        Code:
                          description: The four letter Mnemonic used within an XML file to identify a code
                          maxLength: 4
                          minLength: 0
                          pattern: ^\w{0,4}$
                          title: Code
                          type: string
                        Description:
                          description: Description to describe the purpose of the code
                          maxLength: 350
                          minLength: 1
                          title: Description
                          type: string
                        Name:
                          description: Long name associated with the code
                          maxLength: 70
                          minLength: 1
                          title: Name
                          type: string
                      required:
                        - Name
                        - Description
                      type: object
                    title: OtherServiceAndFacility
                    type: array
                  Photo:
                    description: Image related to the branch
                    title: Photo
                    type: string
                  PostalAddress:
                    additionalProperties: false
                    description: Information that locates and identifies a specific address, as defined by postal services.
                    properties:
                      AddressLine:
                        description: Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.
                        items:
                          description: maxLength 70 text
                          maxLength: 70
                          minLength: 1
                          type: string
                        maxItems: 7
                        minItems: 0
                        title: AddressLine
                        type: array
                      BuildingNumber:
                        description: Name or Number that identifies the position of a building on a street.
                        maxLength: 350
                        minLength: 1
                        title: BuildingNumber
                        type: string
                      Country:
                        description: Nation with its own government, occupying a particular territory.
                        pattern: "[A-Z]{2}"
                        title: Country
                        type: string
                      CountrySubDivision:
                        description: Identifies a subdivision of a country, for instance state, region, county.
                        items:
                          description: maxLength 35 text
                          maxLength: 35
                          minLength: 1
                          type: string
                        maxItems: 2
                        minItems: 0
                        title: CountrySubDivision
                        type: array
                      GeoLocation:
                        additionalProperties: false
                        description: Geographic location of the ATM specified by geographic coordinates or UTM coordinates.
                        properties:
                          GeographicCoordinates:
                            additionalProperties: false
                            description: Location on the earth specified by two numbers representing vertical and horizontal position.
                            properties:
                              Latitude:
                                description: Latitude measured in decimal degrees
                                pattern: ^-?\d{1,3}\.\d{1,8}$
                                title: Latitude
                                type: string
                              Longitude:
                                description: |-
                                  Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory.
                                  The longitude is measured in decimal degrees.
                                pattern: ^-?\d{1,3}\.\d{1,8}$
                                title: Longitude
                                type: string
                            required:
                              - Latitude
                              - Longitude
                            title: GeographicCoordinates
                            type: object
                        required:
                          - GeographicCoordinates
                        title: GeoLocation
                        type: object
                      PostCode:
                        description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
                        maxLength: 16
                        minLength: 1
                        title: PostCode
                        type: string
                      StreetName:
                        description: Name of a street or thoroughfare.
                        maxLength: 70
                        minLength: 1
                        title: StreetName
                        type: string
                      TownName:
                        description: Name of a built-up area, with defined boundaries, and a local government.
                        maxLength: 35
                        minLength: 1
                        title: TownName
                        type: string
                    required:
                      - PostCode
                    title: PostalAddress
                    type: object
                  SequenceNumber:
                    description: Sequence Number that is used in conjunction with Identification to uniquely identify a branch. Physical branches should have 0 assigned, mobile and sub branches should have 1,2,3....etc. assigned.
                    maxLength: 35
                    minLength: 1
                    title: SequenceNumber
                    type: string
                  ServiceAndFacility:
                    description: Service/Facilities offered at a branch.
                    items:
                      description: Service/Facilities offered at a branch.
                      enum:
                        - AssistedServiceCounter
                        - ExternalATM
                        - AccountVerificationService
                        - BusinessCounter
                        - BureauDeChange
                        - BusinessDepositTerminal
                        - BusinessITSupport
                        - CardIssuanceFacility
                        - CollectionLockers
                        - CounterServices
                        - ExternalQuickServicePoint
                        - InternalQuickServicePoint
                        - InternalATM
                        - LodgementDevice
                        - MortgageAdvisor
                        - MeetingRooms
                        - NightSafe
                        - OnlineBankingPoint
                        - OnDemandCurrency
                        - Other
                        - Parking
                        - PremierCounter
                        - QuickDeposit
                        - SaturdayCounterService
                        - StatementPrinter
                        - SelfServiceAccountOpening
                        - VideoBanking
                        - WiFi
                      type: string
                    title: ServiceAndFacility
                    type: array
                  SortCode:
                    description: United Kingdom (UK) Sort Code - identifies British financial institutions on the British national clearing systems. The sort code, which is a six-digit number, is usually formatted as three pairs of numbers, for example 12-34-56. It identifies both the bank and the branch(s) where the account is held.
                    items:
                      description: maxLength 8 text
                      maxLength: 8
                      minLength: 1
                      type: string
                    title: SortCode
                    type: array
                  Type:
                    description: Codeset to indicate if a branch is physically in 1 location or is mobile
                    enum:
                      - Mobile
                      - Physical
                    title: Type
                    type: string
                required:
                  - Identification
                  - SequenceNumber
                  - Type
                  - CustomerSegment
                  - PostalAddress
                type: object
              minItems: 1
              title: Branch
              type: array
            BrandName:
              description: Brand Name that an organisation uses to market its products or services to a consumer
              maxLength: 140
              minLength: 1
              title: BrandName
              type: string
          required:
            - BrandName
            - Branch
          type: object
        minItems: 1
        title: Brand
        type: array
    required:
      - Brand
    type: object
  BranchDefinitionMeta:
    properties:
      data:
        items:
          $ref: "#/definitions/BranchDefinition"
        type: array
      meta:
        $ref: "#/definitions/MetaDefinition"
    required:
      - meta
      - data
  ErrorDefinition400:
    additionalProperties: false
    properties:
      description:
        enum:
          - You have sent a request which could not be understood.
        type: string
      status:
        enum:
          - "400"
        type: string
      title:
        enum:
          - Bad request
        type: string
    required:
      - status
      - title
      - description
    title: 400 Error object
    type: object
  ErrorDefinition408:
    additionalProperties: false
    properties:
      description:
        enum:
          - Your client has failed to submit a request, and a timeout has occurred.
        type: string
      status:
        enum:
          - "408"
        type: string
      title:
        enum:
          - Client timeout
        type: string
    required:
      - status
      - title
      - description
    title: 408 Error object
    type: object
  ErrorDefinition429:
    additionalProperties: false
    properties:
      description:
        enum:
          - You have requested this resource too often. Slow down.
        type: string
      status:
        enum:
          - "429"
        type: string
      title:
        enum:
          - Too many requests
        type: string
    required:
      - status
      - title
      - description
    title: 429 Error object
    type: object
  ErrorDefinition500:
    additionalProperties: false
    properties:
      description:
        enum:
          - An error occurred on the server. No further information is available.
        type: string
      status:
        enum:
          - "500"
        type: string
      title:
        enum:
          - Internal server error
        type: string
    required:
      - status
      - title
      - description
    title: 500 Error object
    type: object
  ErrorDefinition503:
    additionalProperties: false
    properties:
      description:
        enum:
          - The service is temporarily unavailable.
        type: string
      status:
        enum:
          - "503"
        type: string
      title:
        enum:
          - Service temporarily unavailable
        type: string
    required:
      - status
      - title
      - description
    title: 503 Error object
    type: object
  MetaDefinition:
    additionalProperties: false
    properties:
      Agreement:
        enum:
          - Use of the APIs and any related data will be subject to the terms of the Open Licence and subject to terms and conditions
        type: string
      LastUpdated:
        format: date-time
        type: string
      License:
        description: Open Banking License
        enum:
          - https://www.openbanking.org.uk/open-licence
        format: uri
        type: string
      TermsOfUse:
        description: Open Banking Terms of Use
        enum:
          - https://www.openbanking.org.uk/terms
        format: uri
        type: string
      TotalResults:
        type: integer
    required:
      - LastUpdated
      - TotalResults
      - Agreement
      - License
      - TermsOfUse
    title: Meta data
    type: object
