APIHub
Back to Explore

Branch Locator API

Branch Locator API

Finance
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

395ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/open-banking/v2.2/branches

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.

GET

/x-open-banking/v2.2/branches/country/{country}

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.

  • country (path, required) — The ISO country code e.g. "GB"
GET

/x-open-banking/v2.2/branches/country/{country}/town/{town}

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.

  • country (path, required) — The ISO country code e.g. "GB"
  • town (path, required) — Town name, not case sensitive
GET

/x-open-banking/v2.2/branches/geo-location/lat/{latitude}/long/{longitude}

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.

  • latitude (path, required) — Positive or negative decimal value in degrees. eg "51.50551621597067"
  • longitude (path, required) — Positive or negative decimal value in degrees. eg "-0.0180120225995"
  • radius (query, required) — Number of miles (1 to 10) as an integer. Default = 1
GET

/x-open-banking/v2.2/branches/postcode/{postcode}

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.

  • postcode (path, required) — Letters and numerals only. No spaces or special characters. eg. "SW1A1AA"
GET

/x-open-banking/v2.2/branches/sortcode/{sortcode}

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.

  • sortcode (path, required) — 6 digit number with no spaces or special characters. eg. "400003"

6 endpoints auto-detected

curl -X GET \
  "https://dikpeqbnwi3kx.cloudfront.net/open-banking/v2.2/branches"

dikpeqbnwi3kx.cloudfront.net · HTTPS only