Create test user

POST

test

users

curl -X POST 'https://api.sandbox.wealthyhood.com/test/users' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_M2M_TOKEN' \
  -d '{
    "email": "test.user@example.com",
    "status": "INVESTED_WITH_CASH",
    "props": {
      "firstName": "John",
      "lastName": "Doe"
    }
  }'

const response = await fetch('https://api.sandbox.wealthyhood.com/test/users', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify({
    email: 'test.user@example.com',
    status: 'INVESTED_WITH_CASH',
    props: {
      firstName: 'John',
      lastName: 'Doe'
    }
  })
});

const { user } = await response.json();

{
  "user": {
    "_id": "64f0c51e7fb3fc001234abcd",
    "email": "test.user@example.com",
    "status": "INVESTED_WITH_CASH",
    "currency": "EUR",
    "portfolios": [...]
  }
}

These test endpoints are only available in development and staging environments. They are disabled in production for security reasons.

Create a test user account with a predefined status. This endpoint is useful for setting up test scenarios with users in various lifecycle states.

B2B Test User Builder Restriction: Only three statuses are allowed for B2B test user creation:

INVESTED - User with investments
INVESTED_WITH_CASH - User with investments and cash
INVESTED_WITH_SAVINGS - User with investments and savings

curl -X POST 'https://api.sandbox.wealthyhood.com/test/users' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_M2M_TOKEN' \
  -d '{
    "email": "test.user@example.com",
    "status": "INVESTED_WITH_CASH",
    "props": {
      "firstName": "John",
      "lastName": "Doe"
    }
  }'

const response = await fetch('https://api.sandbox.wealthyhood.com/test/users', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify({
    email: 'test.user@example.com',
    status: 'INVESTED_WITH_CASH',
    props: {
      firstName: 'John',
      lastName: 'Doe'
    }
  })
});

const { user } = await response.json();

{
  "user": {
    "_id": "64f0c51e7fb3fc001234abcd",
    "email": "test.user@example.com",
    "status": "INVESTED_WITH_CASH",
    "currency": "EUR",
    "portfolios": [...]
  }
}

Request body

string

required

Email address for the test user. Must be a valid email format.

string

required

User status. Must be one of the allowed statuses for B2B test user builder. Use GET /test/help/statuses to retrieve the list of valid status values.Allowed statuses:

INVESTED - User with investments
INVESTED_WITH_CASH - User with investments and cash
INVESTED_WITH_SAVINGS - User with investments and savings

object

Optional user properties to override defaults. If omitted, random values are used for firstName and lastName.

string

First name for the test user. Must be 1-100 characters. Optional.

string

Last name for the test user. Must be 1-100 characters. Optional.

Use the Get available statuses endpoint to see all available user status options.

Authorizations

Authorization

string

header

required

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

Body

application/json

string<email>

required

Email address for the test user

Example:

"test.user@example.com"

status

enum<string>

required

User status. Must be one of the allowed statuses for B2B test user builder.

Available options:

INVESTED,

INVESTED_WITH_CASH,

INVESTED_WITH_SAVINGS,

FULL_USER_NBG

Example:

"INVESTED_WITH_CASH"

props

object

Optional user properties to override defaults (e.g. firstName, lastName).

Show child attributes

Response

Test user created successfully

user

object

Test user object with populated portfolios

Show child attributes

Delete test userDelete a test user by email address. Useful for cleaning up test data.

curl -X POST 'https://api.sandbox.wealthyhood.com/test/users' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_M2M_TOKEN' \
  -d '{
    "email": "test.user@example.com",
    "status": "INVESTED_WITH_CASH",
    "props": {
      "firstName": "John",
      "lastName": "Doe"
    }
  }'

const response = await fetch('https://api.sandbox.wealthyhood.com/test/users', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify({
    email: 'test.user@example.com',
    status: 'INVESTED_WITH_CASH',
    props: {
      firstName: 'John',
      lastName: 'Doe'
    }
  })
});

const { user } = await response.json();

{
  "user": {
    "_id": "64f0c51e7fb3fc001234abcd",
    "email": "test.user@example.com",
    "status": "INVESTED_WITH_CASH",
    "currency": "EUR",
    "portfolios": [...]
  }
}

API documentation

Authentication

Automations

Universe Configuration

Users

Cash

Savings Vault

Bank Accounts

Account Closures

Deposits

Wallets

Withdrawals

Portfolios

Insights

Daily Summaries

Investment Products

Investment Orders

Savings Orders

Savings Details

Automations

Learn

Notification Settings

Transactions

Test

Request body

Authorizations

Body

Response

​Request body

Authorizations

Body

Response

Request body