Skip to main content
GET
/
test
/
help
/
statuses
curl -X GET 'https://api.sandbox.wealthyhood.com/test/help/statuses' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_M2M_TOKEN'

{
  "statuses": [
    "INVESTED",
    "INVESTED_WITH_CASH",
    "INVESTED_WITH_SAVINGS"
  ]
}
These test endpoints are only available in development and staging environments. They are disabled in production for security reasons.
Retrieve a list of available user statuses that can be used when creating test users via the B2B test user builder. This endpoint helps you discover valid status values for the status parameter in the create user endpoint.
Three statuses are available 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 GET 'https://api.sandbox.wealthyhood.com/test/help/statuses' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_M2M_TOKEN'

{
  "statuses": [
    "INVESTED",
    "INVESTED_WITH_CASH",
    "INVESTED_WITH_SAVINGS"
  ]
}
Use this endpoint to discover valid status values before creating test users. Each status represents a different user lifecycle state with associated data and permissions.

Authorizations

​
Authorization
string
header
required

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

Response

List of available statuses

​
statuses
enum<string>[]
Available options:
INVESTED,
INVESTED_WITH_CASH,
INVESTED_WITH_SAVINGS
Example:
[
  "INVESTED",
  "INVESTED_WITH_CASH",
  "INVESTED_WITH_SAVINGS"
]