Retrieve Parties
GET {{base_url}}/banking/v2/parties
This endpoint can be used to retrieve party information.
Query Parameters
| Field | Type | Description |
|---|
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| partyType | string | {Joint, Sole, Delegate} |
| pageId | string | Page offset of results |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the party |
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| name | string | Name of the party |
| email | string | Email address of the party |
| phoneNumber | string | Phone number of the party |
| address | object | Address of the party |
| address->addressType | string | {Business, Correspondence, Delivery to, Mail to, PO Box, Postal, Residential, Statement} |
| address->address | string | Address of the party |
| partyType | string | {Joint, Sole, Delegate} |
| externalId | string | An Id linked to an external source |
| source | string | Source of data import {OPENBANKING} |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | { error : "Missing/Invalid pageId” } |
| Invalid partyType | 400 Bad Request | { error : "Missing/Invalid partyType” } |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
bankId | null | | Unique identifier for the bank |
accountId | null | | Unique identifier for the bank acount |
partyType | null | | Party type {Joint, Sole, Delegate} |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"id":"53f8b527-bb0c-4925-a2b1-8bf6356144ab","bankId":23,"accountId":"dec1b653-ba2a-41f0-8915-8a9bb6804d70","name":"JULIA RESEARCH LTD","email":"","phoneNumber":"","partyType":"","address":[],"externalId":"7t9xg8rmekakd68o01c97lvcjzmf06nwcf4l","source":"OPENBANKING"}],"links":{}}