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

ParameterData typeRequired?Description
customer_idstringyesCustomer ID
account_idstringyesAccount ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
AccountIdstringyesAccount ID
PartyIdstringyesParty ID
NamestringnoName
FullLegalNamestringnoFull Legal Name
LegalStructurestringnoLegal Structure
PartyTypestringnoParty Type
PartyNumberstringnoParty Number
EmailAddressstringnoE-mail Address
PhonestringnoPhone
MobilestringnoMobile
BeneficialOwnershipbooleannoBeneficial Ownership
AccountRolestringyesAccount Role
RelationshipsParty RelationshipnoArray of Relationships
AddressParty Addressno Array of Party Addresses

Party Relationship

ParameterData typeRequired?Description
AccountAccountyesAccount Object
RelatedstringyesRelated Account ID
IDstringyesID

Party Address

ParameterData typeRequired?Description
AddressTypestringyesAddress Type
AddressLinestringyesAddress Line
StreetNamestringyesStreet Name
BuildingNumberstringyesBuilding Number
PostCodestringyesPost Code
TownNamestringyesTown Name
CountrystringyesCountry
CountrySubDivisionstringyesCountry Sub Division

Request example

1 curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/accounts/{account_id}/party'

Response example:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 { "data": [ { "AccountId": "123", "PartyId": "759553629", "Name": "Elon Musk", "FullLegalName": "Elon G Musk", "LegalStructure": "UK.OBIE.Individual", "PartyType": "Sole", "PartyNumber": "123456", "EmailAddress": "john@friendlyscore.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.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

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: 781963)