Skip to main content
POST
/
parties
Create a new party
curl --request POST \
  --url https://api.venlyfinance.com/v1/parties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partyType": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "address": {
    "addressLine1": "123 Main Street",
    "city": "Amsterdam",
    "postalCode": "1012AB",
    "country": "NL"
  }
}
'
{
  "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:

Body

application/json
​
partyType
enum<string>
required

Type of party

Available options:
INDIVIDUAL,
ORGANISATION
​
externalId
string

Optional external reference ID

Maximum string length: 255
​
firstName
string

Required for INDIVIDUAL parties

Maximum string length: 100
​
lastName
string

Required for INDIVIDUAL parties

Maximum string length: 100
​
name
string

Organisation name. Required for ORGANISATION parties

Maximum string length: 255
​
vatNumber
string

VAT number. ORGANISATION parties only

Maximum string length: 50
​
address
object

Standardized address format used across all endpoints

Response

Party created

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