/
Parties v3.1.1

Parties v3.1.1

Mar 14, 2019

Version Control

Version

Date

Author

Comments

Version

Date

Author

Comments

3.0

Sep 7, 2018 

OB R/W API Team

This is the baseline version. No change from RC3.

3.1-draft1

Sep 11, 2018 

OB R/W API Team

This is the initial draft version for 3.1.

Errata

  • Grammatical Fixes

3.1-draft2

Oct 5, 2018 

OB R/W API Team

Draft2 Changes:

  • Updated example URLs to version 3.1.

3.1

Nov 30, 2018

OB R/W API Team

Version 3.1 final release.

No changes from Version 3.1 RC1.

3.1.1-draft1

Jan 31, 2019 

OB R/W API Team

3.1.1-draft1 changes:

  • Updated account-request reference to account-access-consent.

3.1.1-RC1

Feb 15, 2019 

OB R/W API Team

3.1.1-RC1 changes:

  • Changed code snippet titles for consistency with other pages.

  • Renamed page to "Parties" to reflect the new end-point name.

  • Additional parties endpoint, data model and example.

Endpoints

Endpoints for the resource and available methods.

Resource

HTTP Operation

Endpoint

Mandatory?

Scope

Grant Type

Idempotency Key

Parameters

Request Object

Response Object

Resource

HTTP Operation

Endpoint

Mandatory?

Scope

Grant Type

Idempotency Key

Parameters

Request Object

Response Object

1

parties

GET

GET /accounts/{AccountId}/parties

Conditional

accounts

Authorization Code

No





OBReadParty3

2

parties

GET

GET /accounts/{AccountId}/party

Conditional

accounts

Authorization Code

No





OBReadParty2

3

parties

GET

GET /party

Conditional

accounts

Authorization Code

No





OBReadParty2

GET /accounts/{AccountId}/parties

If the ASPSP has chosen to implement the /accounts/{AccountId}/parties endpoint, the ASPSP may return details on the account owner(s)/holder(s) and operator(s).

GET /accounts/{AccountId}/party

If the ASPSP has chosen to implement the /accounts/{AccountId}/party endpoint, the ASPSP must return details on the account owner/holder:

  • In the case of a business, this will be the details of the business

  • In the case of a joint account, this will be the party that has given authorisation to the AISP to view the account. 

GET /party

If the ASPSP has chosen to implement the /party endpoint, the ASPSP must return details on the user that has authorised the account-access-consent with the ASPSP:

  • In the case of a business account, this will be the details of the party that has given authorisation to the AISP to view the account.

  • In the case of a joint account, this will be the party that has given authorisation to the AISP to view the account.

Data Model

The data dictionary section gives the detail on the payload content for the Party endpoints.

Reused Classes

OBParty2

This section describes the OBParty2 class which is reused as the Party resource in the OBReadParty2 and OBReadParty3 payloads.

The Party resource contains a set of elements that describes a party. The party may be linked to a specific account.

UML Diagram

Notes

  • Each ASPSP must determine appropriate format for the full legal name. This format should be documented on ASPSP developer portals.

Data Dictionary

Name

Occurence

XPath

EnhancedDefinition

Class

Codes

Pattern

Name

Occurence

XPath

EnhancedDefinition

Class

Codes

Pattern

OBParty2



OBParty2



OBParty2





PartyId

1..1

OBParty2/PartyId

A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.

Max40Text





PartyNumber

0..1

OBParty2/PartyNumber

Number assigned by an agent to identify its customer.

Max35Text





PartyType

0..1

OBParty2/PartyType

Party type

OBExternalPartyType1Code

Delegate
Joint
Sole



Name

0..1

OBParty2/Name

Name by which a party is known and which is usually used to identify that party.

Max70Text





FullLegalName

0..1

OBParty2/FullLegalName

The full legal name of the party.

Max350Text





LegalStructure

0..1

OBParty2/LegalStructure

Legal standing of the party.

OBExternalLegalStructureType1Code





BeneficialOwnership

0..1

OBParty2/BeneficialOwnership

A flag to indicate a party's beneficial ownership of the related account.

xs:boolean





AccountRole

0..1

OBParty2/AccountRole

A party's role with respect to the related account.

OBExternalAccountRole1Code





EmailAddress

0..1

OBParty2/EmailAddress

Address for electronic mail (e-mail).

Max256Text





Phone

0..1

OBParty2/Phone

Collection of information that identifies a phone number as defined by telecom services.

PhoneNumber



\+[0-9]{1,3}-[0-9()+\-]{1,30}

Mobile

0..1

OBParty2/Mobile

Collection of information that identifies a mobile phone number as defined by telecom services.

PhoneNumber



\+[0-9]{1,3}-[0-9()+\-]{1,30}

Relationships

0..1

OBParty2/Relationships

The Party's relationships with other resources.

OBPartyRelationships1





Account

0..1

OBParty2/Relationships/Account

Relationship to the Account resource.

OBRelationship1





Related

1..1

OBParty2/Relationships/Account/Related

Absolute URI to the related resource.

xs:anyURI





Id

1..1

OBParty2/Relationships/Account/Id

Unique identification as assigned by the ASPSP to uniquely identify the related resource.

Max40Text





Address

0..n

OBParty2/Address

Postal address of a party.

OBPostalAddress8





AddressType

0..1

OBParty2/Address/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement



AddressLine

0..5

OBParty2/Address/AddressLine

Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.

Max70Text





StreetName

0..1

OBParty2/Address/StreetName

Name of a street or thoroughfare.

Max70Text





BuildingNumber

0..1

OBParty2/Address/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text





PostCode

0..1

OBParty2/Address/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text





TownName

0..1

OBParty2/Address/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text





CountrySubDivision

0..1

OBParty2/Address/CountrySubDivision

Identifies a subdivision of a country eg, state, region, county.

Max35Text





Country

1..1

OBParty2/Address/Country

Nation with its own government, occupying a particular territory.

CountryCode



^[A-Z]{2,2}$

OBReadParty2

The OBReadParty2 object will be used for the call to: 

  • GET /accounts/{AccountId}/party

  • GET /party

The response to GET /accounts/{AccountId}/party and GET /party (if available) must contain at most one party.

UML Diagram

Data Dictionary

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Pattern

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Pattern

OBReadParty2

© Open Banking Limited 2019 | https://www.openbanking.org.uk/open-licence | https://www.openbanking.org.uk