Get User Detail
Requires the read:user scope.
Returns the user-detail payload for the given user account.
- user_account_id
- Partner-supplied user identifier (e.g. CIF, member number).
- user_account_id_type
- Identifier system the user_account_id is expressed in.
User-detail response with total market value and the per-product account list.
- HTTPException
- 400 Bad Request when the financial institution has no vendor configured for the requested user_account_id_type; 404 Not Found when no user exists for the given account ID within the partner's financial institution.
Authorization
APIKeyHeader Partner API key, required on every endpoint except "GET /health". Your financial institution issues and revokes these keys from the InvestiFi Ops Center. Each key carries an environment-identifying prefix such as "ifi_prod_" plus a fixed set of scopes, so a valid key still returns 403 Forbidden on an endpoint whose scope it was not granted; the response "detail" names the check that failed.
In: header
Path Parameters
Query Parameters
How to interpret user_account_id: "investifi" (InvestiFi user account id), "core" (banking-core member number / CIF), or "dbp" (digital-banking-provider user id). A core or dbp id is resolved to the InvestiFi user account before lookup.
"investifi" | "core" | "dbp"Response Body
application/json
application/json
application/json
curl -X GET "https://partner-api.investifi.com/v1/users/string/?user_account_id_type=investifi"{
"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": "Key does not have the required scope: read:user."
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Users
Endpoints for retrieving member account, balance, and KYC data.
Get User List
Requires the `read:user` scope. 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.