Skip to main content
GET
/
parties
/
{partyId}
Get party details
curl --request GET \
  --url https://api.venlyfinance.com/api/v1/parties/{partyId} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.