Skip to main content
GET
/
parties
List all parties
curl --request GET \
  --url https://api.venlyfinance.com/api/v1/parties \
  --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>"
      }
    }
  ],
  "pagination": {
    "pageNumber": 123,
    "pageSize": 123,
    "numberOfElements": 123,
    "numberOfPages": 123,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer<int32>
default:1

Page number (1-based indexing)

Required range: x >= 1
size
integer<int32>
default:100

Number of items per page

Required range: x >= 1
sortOn
string
default:createdAt

Field to sort by

sortOrder
enum<string>
default:ASC

Sort direction

Available options:
ASC,
DESC
partyType
enum<string>

Filter by party type Type of party

Available options:
INDIVIDUAL,
ORGANISATION
status
enum<string>

Status of a party

Available options:
ACTIVE,
SUSPENDED,
BLOCKED
externalId
string

Filter by external ID (exact match)

Response

List of parties

success
boolean

Indicates whether the request was successful

result
object[]
pagination
object

Pagination metadata