Skip to main content
GET
/
parties
/
{partyId}
Get party details
curl --request GET \
  --url https://api.venlyfinance.com/v1/parties/{partyId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "result": {
    "id": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
    "externalId": "user-12345",
    "partyType": "INDIVIDUAL",
    "status": "ACTIVE",
    "firstName": "Jane",
    "lastName": "Doe",
    "kycStatus": "VERIFIED",
    "address": {
      "addressLine1": "1 Example Street",
      "city": "Amsterdam",
      "postalCode": "1011AB",
      "country": "NL"
    },
    "createdAt": "2026-01-15T09:30:00",
    "updatedAt": "2026-01-15T09:30:00",
    "version": 0
  }
}
Returns the full party record, including kycStatus/kybStatus, address, and version. Send the version back when updating the party — see safe updates.

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow. Token endpoints:

Path Parameters

​
partyId
string<uuid>
required

Unique party identifier

Response

Party details

​
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.