S. No.

Resource

HTTP Operation

Endpoint

Mandatory

Scope

Grant Type

Idempotency Key

Parameter

Request Object

Response Object

2.1

parties

GET

GET /accounts/{AccountId}/parties

Conditional

accounts

Authorisation Code

No

OBReadParties

2.2

parties

GET

GET /accounts/{AccountId}/party

Conditional

accounts

Authorisation Code

No

OBReadParty

2.3

parties

GET

GET /accounts/party

Conditional

accounts

Authorisation Code

No

OBReadParty

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBPartyDetail

OBPartyDetail

OBPartyDetail

PartyId

1..1

OBPartyDetail/PartyId

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

String

PartyNumber

0..1

OBPartyDetail/PartyNumber

Number assigned by an agent to identify its user/customer.

String

PartyType

0..1

OBPartyDetail/PartyType

Party Type

String

Enum

• Delegate

• Joint

• Sole

Name

0..1

OBPartyDetail/Name

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

String

FullLegalName

0..1

OBPartyDetail/FullLegalName

The full legal name of the party.

String

LegalStructure

0..1

OBPartyDetail/LegalStructure

Legal standing of the party.

String

Enum

• BH.OBF.CIC

• BH.OBF.CIO

• BH.OBF.Charity

• BH.OBF.CoOp

• BH.OBF.GeneralPartnership

• BH.OBF.Individual

• BH.OBF.LimitedLiabilityPartnership

• BH.OBF.LimitedPartnership

• BH.OBF.PrivateLimitedCompany

• BH.OBF.PublicLimitedCompany

• BH.OBF.ScottishLimitedPartnership

• BH.OBF.Sole   

BeneficialOwnership

0..1

OBPartyDetail/BeneficialOwnership

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

xs:boolean

AccountRole

0..1

OBPartyDetail/AccountRole

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

String

Enum:

• BH.OBF.Administrator

• BH.OBF.Beneficiary

• BH.OBF.CustodianForMinor

• BH.OBF.Granter

• BH.OBF.LegalGuardian

• BH.OBF.OtherParty

• BH.OBF.PowerOfAttorney

• BH.OBF.Principal

• BH.OBF.Protector

• BH.OBF.RegisteredSha

EmailAddress

0..1

OBPartyDetail/EmailAddress

Address for electronic mail (e-mail).

String

Phone

0..1

OBPartyDetail/Phone

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

String

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

Mobile

0..1

OBPartyDetail/Mobile

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

String

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

Relationships

0..1

OBPartyDetail/Relationships

The Party's relationships with other resources.

OBPartyDetail/Relationships

Account

0..1

OBPartyDetail/Relationships/Account

Relationship to the Account resource.

OBPartyDetail/Relationships/Account

Related

1..1

OBPartyDetail/Relationships/Account/Related

Absolute URI to the related resource.

String

Id

1..1

OBPartyDetail/Relationships/Account/Id

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

String

Address

0..n

OBPartyDetail/Address

Postal address of a party.

OBPartyDetail/Address

AddressType

0..1

OBPartyDetail/Address/AddressType

Identifies the nature of the postal address.

String

Enum:

• Business

• Correspondence

• DeliveryTo

• MailTo

• POBox

• Postal

• Residential

• Statement

AddressLine

0..7

OBPartyDetail/Address/AddressLine

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

String

StreetName

0..1

OBPartyDetail/Address/StreetName

Name of a street or thoroughfare.

String

BuildingNumber

0..1

OBPartyDetail/Address/BuildingNumber

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

String

PostCode

0..1

OBPartyDetail/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.

String

TownName

0..1

OBPartyDetail/Address/TownName

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

String

CountrySubDivision

0..1

OBPartyDetail/Address/CountrySubDivision

Identifies a subdivision of a country such as state, region, country.

String

Country

0..1

OBPartyDetail/Address/Country

Nation with its own government.

String

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

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBReadParty

OBReadParty

OBReadParty

Data

1..1

OBReadParty/Data

OBReadParty/Data

Party

0..1

OBReadParty/Data/Party

OBPartyDetail

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBReadParties

OBReadParties

OBReadParties

Data

1..1

OBReadParties/Data

OBReadParties/Data

Party

0..n

OBReadParties/Data/Party

OBPartyDetail