Get User List

Returns a paginated list of users matching the given filters. Scoped to the API key's financial institution. Each item's per-product KYC status, approval timestamp, and market value are read from the indexed user document.

Authorization

APIKeyHeader

x-api-key<token>

In: header

Query Parameters

user_account_id?|

Filter to the user with this partner-supplied account id.

product?|

Filter to users provisioned for this product.

crypto_kyc_status?|

Filter to users with this KYC state on their crypto account.

securities_kyc_status?|

Filter to users with this KYC state on their securities account.

roth_ira_kyc_status?|

Filter to users with this KYC state on their Roth IRA account.

robo_kyc_status?|

Filter to users with this KYC state on their robo account.

created_at_start?|

Lower bound (inclusive) on the user's created_at timestamp, UTC.

created_at_end?|

Upper bound (exclusive) on the user's created_at timestamp, UTC.

per_page?Per Page

Maximum number of users to return per page.

Default25

Range1 <= value <= 100

last_record_number?Last Record Number

Cursor returned from a previous response; pass to fetch the next page.

Default0

Range0 <= value

sort_order?PartnerListSortOrder

Sort order on sort_key. Defaults to descending (most recent first).

Default"desc"

Value in"asc" | "desc"

sort_key?Sort Key

Field to sort the results by. Defaults to created_at.

Default"created_at"

Response Body

`application/json`

curl -X GET "https://partner-api.investifi.com/v1/users/"

{
  "total_records": 0,
  "last_record_number": 0,
  "per_page": 0,
  "items": [
    {
      "accounts": [
        {
          "current_market_value": "34891.00",
          "kyc_approved_at": "2025-08-14T17:02:31Z",
          "kyc_status": "approved",
          "product": "securities"
        },
        {
          "current_market_value": "8223.50",
          "kyc_approved_at": "2025-08-14T17:02:31Z",
          "kyc_status": "approved",
          "product": "robo"
        },
        {
          "current_market_value": "12450.32",
          "kyc_approved_at": "2025-09-02T11:18:09Z",
          "kyc_status": "approved",
          "product": "crypto"
        },
        {
          "current_market_value": "43181.03",
          "kyc_status": "pending",
          "product": "roth_ira"
        }
      ],
      "historical_market_value": {
        "all_time": [],
        "past_day": [
          {
            "as_of": "2025-02-11T14:00:00Z",
            "cost_basis": "91000.00",
            "value": "98200.00"
          },
          {
            "as_of": "2025-02-12T13:00:00Z",
            "cost_basis": "91000.00",
            "value": "98745.85"
          }
        ],
        "past_month": [],
        "past_week": [],
        "past_year": []
      },
      "identities": {
        "core_ids": [
          {
            "id": "00002",
            "type": "FiservDNA"
          }
        ],
        "dbp_ids": [
          {
            "id": "0005",
            "type": "Q2"
          }
        ],
        "investifi_user_identifier": "b3f1c2a0-4d5e-6789-abcd-ef0123456789"
      },
      "terms_and_conditions": {
        "accepted_at": "2025-08-14T17:01:55Z",
        "version": "2"
      },
      "total_current_market_value": "98745.85",
      "user_account_id": "member-001"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get User List

Authorization

Query Parameters

Response Body

200application/json

422application/json

`application/json`

`application/json`