Add a party to an account

Associates an existing party with this account in a specific role. A party can only have one role per account.

POST /accounts/{accountId}/party-roles

Add a party to an account

cURL

curl --request POST \
  --url https://api.venlyfinance.com/v1/accounts/{accountId}/party-roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roleType": "ACCOUNT_HOLDER"
}
'

201

{
  "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>"
      }
    }
  }
}

Authorizations

Authorization · string · header · required

OAuth2 client credentials flow. Token endpoints:

• Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
• Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

Path Parameters

accountId · string<uuid> · required

Body

application/json

partyId · string<uuid> · required

ID of the party to add to the account

roleType · enum<string> · required

Role type for party-account relationship

Available options: ACCOUNT_HOLDER

Response

201

application/json

Party role added

success · boolean

Indicates whether the request was successful

result · object

Represents the relationship between a Party and an Account

Show child attributes