Hampden & Co Accounts API is one of 29 APIs that Hampden & Co publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account. 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 45 schemas.
It is described by OpenAPI 3.2.0, at version 4.0.1.
Requests are made against a single base URL, /open-banking/v4.0/aisp.
The identity and technical contract details declared by the specification.
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
Meta
object
Meta Data relevant to the payload
3 properties
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
OBFileFormat
string
For a full list of enumeration values refer to ExternalDocumentFormat1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSe…
OBInternalSwitchStatusCode
string
Specifies the switch status for the account, in a coded form. For a full list of enumeration values refer to OBInternalSwitchStatusCode in OBInternalCodeSet [h…
StatusUpdateDateTime
string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in re…
Identification_1
string
Unique and unambiguous identification of the servicing institution.
OBInternalAccountStatus1Code
string
Specifies the status of account resource in code form. For a full list of enumeration values refer to OBInternalAccountStatus1Code in OBInternalCodeSet [here](…
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalAccountIdentifica…
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
Description_0
string
Specifies the description of the account type.
OBInternalAccountType1Code
string
Specifies the type of account (personal or business). For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OBInternalCodeSet [here](h…
Floor
string
Number that identifies the level within a building
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalFinancialInstitut…
OpeningDate
string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8…
OBFrequency2
string
For a full list of enumeration values refer to OBFrequency2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSets)
ActiveOrHistoricCurrencyCode_0
string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currenc…
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
OBError1
object
4 properties
1 required
Name_0
string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account n…
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
MaturityDate
string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the t…
Room
string
Information that locates and identifies a room to form part of an address
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
UnitNumber
string
Number that identifies the unit of a specific address .
OBBranchAndFinancialInstitutionIdentification5_0
object
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on t…
3 properties
2 required
Links
object
Links relevant to the payload
5 properties
1 required
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group) For a full list of enumeration values refer to OBExternalCashAccountType1Code OBInternalCodeSet [here]…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
BuildingNumber
string
Number that identifies the position of a building on a street.
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
OBReadAccount6
object
3 properties
1 required
StatementFrequencyAndFormat
array
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
BuildingName
string
Name of a referenced building.
StreetName
string
Name of a street or thoroughfare.
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBAccount6
object
Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched: Da…
14 properties
1 required
OBCommunicationMethod
string
For a full list of enumeration values see OBExternalCommunicationMethod2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeS…
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Hampden & Co publishes across the network.