Skip to main content
GET
/
accounts
/
{accountId}
/
party-roles
List party roles for an account
curl --request GET \
  --url https://api.venlyfinance.com/v1/accounts/{accountId}/party-roles \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "result": [
    {
      "partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roleType": "ACCOUNT_HOLDER",
      "status": "ACTIVE",
      "party": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalId": "<string>",
        "partyType": "INDIVIDUAL",
        "status": "ACTIVE",
        "firstName": "<string>",
        "lastName": "<string>",
        "kycStatus": "PENDING",
        "name": "<string>",
        "vatNumber": "<string>",
        "kybStatus": "PENDING",
        "address": {
          "addressLine1": "<string>",
          "city": "<string>",
          "postalCode": "<string>",
          "country": "<string>",
          "addressLine2": "<string>",
          "state": "<string>"
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.venlyfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow. Token endpoints:

Path Parameters

​
accountId
string<uuid>
required

Response

List of party roles

​
success
boolean

Indicates whether the request was successful

​
result
object[]