Skip to main content
PATCH
/
parties
/
{partyId}
Update party details
curl --request PATCH \
  --url https://api.venlyfinance.com/v1/parties/{partyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "name": "<string>",
  "vatNumber": "<string>"
}
'
{
  "success": true,
  "result": {
    "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

​
partyId
string<uuid>
required

Unique party identifier

Body

application/json

Update party details. Only fields applicable to the party type can be updated. For Individuals: firstName, lastName, address For Organisations: name, vatNumber, address

​
version
integer<int64>
required

Current version of the party for optimistic locking

​
firstName
string

First name (Individual only)

Maximum string length: 100
​
lastName
string

Last name (Individual only)

Maximum string length: 100
​
name
string

Organisation name (Organisation only)

Maximum string length: 255
​
vatNumber
string

VAT number (Organisation only)

Maximum string length: 50
​
address
object

Standardized address format used across all endpoints

Response

Party updated

​
success
boolean

Indicates whether the request was successful

​
result
object

A party represents an Individual or Organisation that can hold accounts. The partyType field determines which additional fields are present.