Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newcastle Permanent Building Society Common API

The Common API from Newcastle Permanent Building Society — 2 operation(s) for common.

Newcastle Permanent Building Society Common API is one of 14 APIs that Newcastle Permanent Building Society publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Common. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.0.3, at version 1.36.0.

Requests are made against a single base URL, https://mtls.dh.example.com/cds-au/v1.

2 operations 2 paths 18 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.36.0
Base URL
https://openbank.newcastlepermanent.com.au/cds-au/v1/banking/products
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Common 2
GET
/common/customer
Get Customer
getCustomer 6 params → 200400406
GET
/common/customer/detail
Get Customer Detail
getCustomerDetail 6 params → 200400406

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are CommonPAFAddress (22 properties), CommonOrganisation (14 properties), CommonSimpleAddress (8 properties), CommonPerson (7 properties). Each schema is shown below with its type and property counts.

CommonOrganisation
object
14 properties 4 required
CommonPhysicalAddressWithPurpose
CommonOrganisationDetail
CommonPersonDetail
CommonEmailAddress
object
3 properties 2 required
ResponseCommonCustomer
object
3 properties 2 required
ResponseCommonCustomerDetail
object
3 properties 2 required
ResponseErrorList
object
1 property 1 required
CommonPhysicalAddress
object
3 properties 1 required
Meta
object
ResponseCommonCustomer_data
object
3 properties 1 required
CommonPerson
object
7 properties 2 required
CommonSimpleAddress
object
8 properties 3 required
CommonPhoneNumber
object
7 properties 3 required
ResponseErrorList_errors
object
4 properties 3 required
Links
object
1 property 1 required
CommonPAFAddress
object
Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspostcorp/media/documents/austr…
22 properties 3 required
ResponseCommonCustomerDetail_data
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-permanent-common-api-openapi.yml Raw ↑

Other APIs Newcastle Permanent Building Society publishes across the network.

Newcastle Permanent Building Society Accounts API
Newcastle Permanent Building Society Banking Account Balances API
Newcastle Permanent Building Society Banking Account Direct Debits API
Newcastle Permanent Building Society Banking Account Scheduled Payments API
Newcastle Permanent Building Society Banking Account Transactions API
Newcastle Permanent Building Society Banking Accounts API
Newcastle Permanent Building Society Banking API
Newcastle Permanent Building Society Banking Payees API
Newcastle Permanent Building Society Banking Products API
Newcastle Permanent Building Society Customer API
Newcastle Permanent Building Society Direct Debits API
Newcastle Permanent Building Society Payees API