> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wealthyhood.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get available statuses

> Retrieve a list of all available user statuses for test user creation.

<Warning>
  These test endpoints are **only available in development and staging environments**. They are disabled in production for security reasons.
</Warning>

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.

<Info>
  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
</Info>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.sandbox.wealthyhood.com/test/help/statuses' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_M2M_TOKEN'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.sandbox.wealthyhood.com/test/help/statuses', {
    headers: {
      'Authorization': `Bearer ${token}`,
      'Accept': 'application/json'
    }
  });

  const { statuses } = await response.json();
  console.log('Available statuses:', statuses);
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "statuses": [
      "INVESTED",
      "INVESTED_WITH_CASH",
      "INVESTED_WITH_SAVINGS"
    ]
  }
  ```
</ResponseExample>

<Tip>
  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.
</Tip>


## OpenAPI

````yaml GET /test/help/statuses
openapi: 3.0.3
info:
  title: Wealthyhood Test API
  version: 1.0.0
  description: >
    Test endpoints for sandbox environments. These endpoints allow you to create
    test users, simulate deposits,

    send test app notifications, and manage test data.


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


    All requests require a bearer token.
servers:
  - url: https://{host}
    variables:
      host:
        default: api.sandbox.wealthyhood.com
        description: Wealthyhood API host name (sandbox environment).
security:
  - bearerAuth: []
tags:
  - name: Test
    description: Test endpoints for sandbox environments.
paths:
  /test/help/statuses:
    get:
      tags:
        - Test
      summary: Get available statuses
      description: Retrieve a list of available user statuses for B2B test user creation.
      responses:
        '200':
          description: List of available statuses
          content:
            application/json:
              schema:
                type: object
                properties:
                  statuses:
                    type: array
                    items:
                      type: string
                      enum:
                        - INVESTED
                        - INVESTED_WITH_CASH
                        - INVESTED_WITH_SAVINGS
                        - FULL_USER_NBG
                    example:
                      - INVESTED
                      - INVESTED_WITH_CASH
                      - INVESTED_WITH_SAVINGS
                      - FULL_USER_NBG
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
components:
  responses:
    UnauthorizedError:
      description: Unauthorized – missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Authentication required
            code: UNAUTHORIZED
    ForbiddenError:
      description: >-
        Forbidden – valid credentials but insufficient permissions or endpoint
        not available in this environment.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Endpoint not available in production
            code: FORBIDDEN
  schemas:
    Error:
      type: object
      required:
        - message
        - code
      properties:
        message:
          type: string
          example: Invalid amount
        code:
          type: string
          example: BAD_REQUEST
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````