Branch API Specification - v2.1.1

Version Control

Version
Date
Author
Comments
2.0.018 Jul 2017Open Banking Open Data API Team

This is the baseline version.

2.1.022 Aug 2017Open Banking Open Data API Team

This release incorporates all known issues with 2.0.0 up to 18 Aug 2017. Please see the release notes for details.

2.1.112 Oct 2017Open Banking Open Data API Team

For Branch API, this release is identical to 2.1.0 API. Please see the 2.1.0  release notes for details. The MIG is from v2.2  (as recommended by PMG)

Overview

This specification includes all relevant artefacts for the Open Data Branch API Specification.

This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches. 

A branch is made up of:-

  • Identification - unique identification for the branch
  • SequenceNumber - 0 indicates that this is a main branch, 1..n indicates that it's either a sub or mobile branch.
  • Name - the branch name
  • Type - Physical or Mobile
  • CustomerSegment - The segment of customers that the branch serves e.g. Private, Retail, Business
  • Photo - you can supply a URL showing an image of the branch e.g. use Google streetview
  • Service/Facilty (see subsection below)
  • Accessibility (see subsection below)
  • Postal Address (see subsection below)

Postal Address

This is where the Branch is located and is a mixture of a postal address and the geographic coordinates (decimal Latitude & Longitude). For geolocation purposes, it is highly recommended that each branch is identified via the geographic coordinates.

Mobile branch addresses

Mobile branch specific attributes such as parking location and stop name can be added as a 0..7 free format AddressLine fields 

Services and Facilities/Other Services and Facilities

This allows the implementer to choose from standard services/facilities e.g. Parking and also allows the specification of other services/facilties using the OtherServiceFacility code block, where these are proprietary or currently missing from the standard code list. Periodic review of OtherServiceFacility information provided by each bank will allow us to decide if any of that information should be subsequently added to the standard code list.

Accessibility/Other Accessibility

This allows you to specify accessibility features of the branch e.g. Wheelchair access, and also allows specification of OtherAccessibility features, where these are proprietary or currently missing from the standard code list.

Availability

Deals with standard and non-standard e.g. seasonal opening days and times.

Specification

The following UML Class Diagram provides the hierarchical structure of the message in a graphical form, which is easier to digest.

  • Data Dictionary - provides detailed descriptions for each field in the message specification along with the associated code lists, constraints and other technical details such as cardinality, any pattern constraints, min, max length etc.
  • Swagger - the API specification written using the Swagger API specification format.

Compliance Report

Message Implementation Guide

Purpose

The message implementation guide (MIG) is designed to assist the implementers of the messaging specification by providing worked examples as to how the message fields should be completed in different scenarios.

The intention is that this will better ensure consistency. This guide should be read alongside the data dictionary which provides fuller information about the rules, constraints and guidelines that should be adhered to when populating the fields.

Format Notation

The format that we use in this document for field value assignment is:-

[] enclose a set of field values.

Where there are multiple records for a particular field, we depict this as [<record 1 value1>,< record 1 value2>…<recordn valuen>], whilst where we are showing that there is 1 field value in 1 record, and another field value in a 2nd record, I depict this as [<record1 value1>],[<record 2 value 1>],[<record 3 value 3>]

, seperates individual field values within a field value set.

“ surrounds a text or date field value.

Implementation Notes

Before implementing the message standard, it is very useful browsing current Branch Locator websites provided by your own organisation, in order to get a feel as to why you need to supply this information.


 How can I supply info about a physical branch?

Section NumberField NameCardinalityValues
1BrandName1..1"Lloyds"
2

Identification

1..1

“777204”

2SequenceNumber1..10
2Name0..1"BOURNE"
2Type1..1"Physical"
2Photo

2CustomerSegment1..*["Personal","Business"]
2OtherCustomerSegment

2ServiceAndFacility0..*

“NightSafe”

2OtherServiceAndFacility 0

2Accessibility0..*

“WheelchairAccess”

2OtherAccessibility

2Notes0..*

“No counter service Saturday”

3Notes

3Name1..1

["Monday“], ["Tuesday“],

["Wednesday“], ["Thursday“],

[" Friday“], ["Saturday"]

4OpeningTime1..1

["09:00“],["09:00“],["09:30“],

["09:00“],["09:00“],["09:00"]

4ClosingTime1..1

["17:00“],["17:00“],["17:30“],

["17:00“],["17:00“],["13:00"]

5

ContactType

1..1["Phone"],["Fax"] , ["Other"]
5ContactContent1..1[“+44-3457888444”],

[“+44-1245704705”],[“ChatURL”]

5ContactDescription0..1["Main Phone"],["Fax"],["Chat"],
5OtherContactType

6

AddressLine



6BuildingNumber0..18
6StreetName0..1

“NORTH STREET”

6TownName0..1"BOURNE"
6CountrySubDivision0..2

“LINCOLNSHIRE”

6Country

6PostCode1..1

“PE10 9ED”

7

Latitude M

1..1

52.768482

7Longitude M1..1

-0.37696

 How can I supply info about a mobile branch?

Section NumberField NameCardinalityValues
1BrandName1..1"Lloyds"
2

Identification

1..1

“NW007”

2SequenceNumber1..11
2Name 0..1“East Anglia Wroxham”
2Type1..1“Mobile”
2Photo 0..1Photo URL
2CustomerSegment 1..*

["Business","Corporate","Personal",

"Premier","Private","Select“,"Wealth“]

2OtherCustomerSegment

2ServiceAndFacility 0..*“NightSafe”
2OtherServiceAndFacility

2Accessibility 0..* “WheelchairAccess”
2OtherAccessibility

2Notes 0..1“No counter service Saturday”
3

Notes



3Name1..1"Tuesday“
4

OpeningTime

1..1“14:15”
4ClosingTime1..1“15:15”
5

ContactType

1..1["Phone"],["Fax"] , ["Other"]
5ContactContent1..1[“+44-3457888444”],

[“+44-1245704705”],[“ChatURL”]

5ContactDescription0..1["Main Phone"],["Fax"],["Chat"],
6

AddressLine



6BuildingNumber0..1

“Broadland Youth & Community Centre”

6StreetName


6TownName0..1

“Hoveton”

6CountrySubDivision


6Country0..1"GB"
6PostCode1..1

"NR128DJ"

7

Latitude

1..1

52.7140745

7Longitude1..1

1.4140166