Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel1
stylenone

1. Overview

The parties resource is used by an AISP to retrieve the details on the account owner(s)/holder(s) and operator(s) for a specific account identified by AccountId.

...

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

2. Endpoints

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

...

{

  "Data": {

    "Party": [

      {

        "PartyId": "Party07",

        "PartyNumber": "6798",

        "PartyType": "Sole",

        "Name": "Zubair”,

        "FullLegalName": "XYZ Limited",

        "LegalStructure": "BH.OBF.XYZLimited",

        "BeneficialOwnership": true,

        "AccountRole": "BH.OBF.Principal",

        "EmailAddress": "contact@xyz.com",

        "Relationships": {

          "Account": {

            "Related": "www.TBC.com",

            "Id": "7985"

          }

        },

        "Address": [

          {

            "AddressType": "Business",

            "AddressLine": "ABC Bank, Diplomatic Area”

            "BuildingNumber": "Building 152",

            “RoadNumber”: “Road 1703”,

            “BlockNumber”: “Block 317”,

            "City": "Manama",

            "Country": "Bahrain",

          }

        ]

      },

      {

        "PartyId": "Party08",

        "PartyNumber": "6799",

        "PartyType": "Delegate",

        "Name": "Asif Khan",

        "FullLegalName": "Asif Arif Khan",

        "LegalStructure": "BH.OBF.Individual",

        "BeneficialOwnership": true,

        "AccountRole": "BH.OBF.Administrator",

        "EmailAddress": "asif@xyz.com",

        "Relationships": {

          "Account": {

            "Related": "www.TBC.com",

            "Id": "7995"

          }

        },

      }

    ]

  },

"Links": {

    "Self": "www.TBC.com"

  },

  "Meta": {

    "TotalPages": 01,

    "FirstAvailableDateTime": "2020-03-26T09:10:17.596+03:00”,

    }

}

4.2

...

Account Owner

4.2.1Get Account Party Request

...

{

  "Data": {

    "Party": [

      {

        "PartyId": "Party07",

        "PartyNumber": "6798",

        "PartyType": "Sole",

        "Name": "XYZ",

        "FullLegalName": "XYZ Limited",

        "LegalStructure": "BH.OBF.XYZLimited",

        "BeneficialOwnership": true,

        "AccountRole": "BH.OBF.Principal",

        "EmailAddress": "contact@xyz.com",

        "Relationships": {

          "Account": {

            "Related": "www.TBC.com",

            "Id": "7985"

          }

        },

        "Address": [

          {

            "AddressType": "Business",

            "AddressLine": "ABC Bank, Diplomatic Area”

            "BuildingNumber": "Building 152",

            “RoadNumber”: “Road 1703”,

            “BlockNumber”: “Block 317”,

            "City": "Manama",

            "Country": "Bahrain",

             }

        ]

      },

    ]

  },

"Links": {

    "Self": "www.TBC.com"

  },

  "Meta": {

    "TotalPages": 01

    }

}

4.3

...

Authorised User

4.3.1Get Party Request

GET /party

Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00

x-fapi-customer-ip-address: 204.35.213.15

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Accept: application/json

...