zopa Beneficiaries API is one of 12 APIs that zopa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Beneficiaries. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
1 operation
across 1 path,
and defines 38 schemas.
It is described by OpenAPI 3.0.0, at version 4.0.0.
Requests are made against a single base URL, /open-banking/v4.0/aisp.
The identity and technical contract details declared by the specification.
zopa Beneficiaries API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope.
It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.
TPPOAuth2Security — TPP client credential authorisation flow with the ASPSPPSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
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.
Identification_1
string
Unique and unambiguous identification of the servicing institution.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
UnitNumber
string
Number that identifies the unit of a specific address .
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
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…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
OBBeneficiary5
object
7 properties
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
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…
BuildingNumber
string
Number that identifies the position of a building on a street.
Floor
string
Number that identifies the level within a building
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For more information and a full list of values see Ex…
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties
1 required
Room
string
Information that locates and identifies a room to form part of an address
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…
BeneficiaryId
string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
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…
Reference
string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this…
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
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…
OBInternalBeneficiaryType1Code
string
Specifies the Beneficiary Type.
OBBranchAndFinancialInstitutionIdentification6_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…
5 properties
OBCashAccount5_0
object
Provides the details to identify the beneficiary account.
5 properties
2 required
StreetName
string
Name of a street or thoroughfare.
OBReadBeneficiary5
object
3 properties
1 required
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
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.
BuildingName
string
Name of a referenced building.
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…
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
object
Links relevant to the payload
5 properties
1 required
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:…
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs zopa publishes across the network.
