Partner API Docs
Partner api

Get User Detail

Returns the user-detail payload for the given user account. :param user_account_id: Partner-supplied user identifier (e.g. CIF, member number). :param api_key: Resolved Partner API key, providing the FI scope for the lookup. :return: User-detail response with total market value and the per-product account list. :raises HTTPException: 404 Not Found when no user exists for the given account ID within the partner's FI.

GET
/users/{user_account_id}/

Authorization

APIKeyHeader
x-api-key<token>

In: header

Path Parameters

user_account_id*User Account Id

Response Body

application/json

application/json

curl -X GET "https://partner-api.cryptofi-dev.com/v1/users/string/"
{
  "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"
    }
  ],
  "total_current_market_value": "98745.85",
  "user_account_id": "member-001"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}