Skip to main content
POST
/
accounts
Create a new account
curl --request POST \
  --url https://api.venlyfinance.com/api/v1/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "user-12345",
  "party": {
    "partyType": "INDIVIDUAL",
    "firstName": "John",
    "lastName": "Doe",
    "address": {
      "addressLine1": "123 Main Street",
      "city": "Amsterdam",
      "postalCode": "1012AB",
      "country": "NL"
    }
  },
  "autoCreateWallet": true,
  "defaultChain": "BASE"
}
'
{
  "success": true,
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "status": "ACTIVE",
    "partyRoles": [
      {
        "partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "roleType": "ACCOUNT_HOLDER",
        "status": "ACTIVE",
        "party": {
          "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.

Headers

​
Idempotency-Key
string<uuid>

Unique key for idempotent requests (UUID recommended)

Body

application/json

Create a new account. You can either:

  • Reference an existing party by providing partyId
  • Create a new party inline by providing party object with full party details

If neither is provided, an account without a party association will be created.

​
externalId
string
required

Unique external reference for this account

Maximum string length: 255
​
partyId
string<uuid>

ID of an existing party to associate as account holder

​
party
object
Example:
{
  "partyType": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "address": {
    "addressLine1": "123 Main Street",
    "city": "Amsterdam",
    "postalCode": "1012AB",
    "country": "NL"
  }
}
​
autoCreateWallet
boolean
default:true

Automatically create a wallet for this account

​
defaultChain
enum<string>
Available options:
BASE

Response

Account created

​
success
boolean

Indicates whether the request was successful

​
result
object