Get Account Parties

GET

/public/v3/customers/{customer_id}/accounts/{account_id}/party

Account party information is dependent on this data being made available by the customer's bank

Parameters

Parameter	Data type	Required?	Description
customer_id	string	yes	Customer ID
account_id	string	yes	Account ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

Parameter	Data type	Required?	Description
AccountId	string	yes	Account ID
PartyId	string	yes	Party ID
Name	string	no	Name
FullLegalName	string	no	Full Legal Name
LegalStructure	string	no	Legal Structure
PartyType	string	no	Party Type
PartyNumber	string	no	Party Number
EmailAddress	string	no	E-mail Address
Phone	string	no	Phone
Mobile	string	no	Mobile
BeneficialOwnership	boolean	no	Beneficial Ownership
AccountRole	string	yes	Account Role
Relationships	Party Relationship	no	Array of Relationships
Address	Party Address	no	Array of Party Addresses

Party Relationship

Parameter	Data type	Required?	Description
Account	Account	yes	Account Object
Related	string	yes	Related Account ID
ID	string	yes	ID

Party Address

Parameter	Data type	Required?	Description
AddressType	string	yes	Address Type
AddressLine	string	yes	Address Line
StreetName	string	yes	Street Name
BuildingNumber	string	yes	Building Number
PostCode	string	yes	Post Code
TownName	string	yes	Town Name
Country	string	yes	Country
CountrySubDivision	string	yes	Country Sub Division

Request example

1
2
3

curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/accounts/{account_id}/party' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'

Response example:

{
  "data": [
    {
      "AccountId": "123",
      "PartyId": "759553629",
      "Name": "Elon Musk",
      "FullLegalName": "Elon G Musk",
      "LegalStructure": "UK.OBIE.Individual",
      "PartyType": "Sole",
      "PartyNumber": "123456",
      "EmailAddress": "john@planky.com",
      "Phone": "+447000000000",
      "Mobile": "+447000000000",
      "BeneficialOwnership": "true",
      "AccountRole": "123456",
      "Relationships": {
        "Account": {
          "Related": "1234",
          "Id": "1234"
        }
      },
      "Address": [
        {
          "AddressType": "DeliveryTo",
          "AddressLine": "['1st Floor', 'Mayfair']",
          "StreetName": "Brook Street",
          "BuildingNumber": "52",
          "PostCode": "W1K 5DS",
          "TownName": "London",
          "Country": "United Kingdom",
          "CountrySubDivision": "South London"
        }
      ]
    }
  ]
}

Was this article helpful?

Friendly Score UK Ltd.

84 Brook Street

London W1K 5EH

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)