InvestiFiPartner APIBeta
Prod Environment
Getting started

Revoke Member Sessions

Requires the manage:sessions scope.

End every InvestiFi session of one member.

A Partner calls this route from their sign-out flow, to end a member's live sessions. This call must come from the Partner's Backend.

Parameters
body
The identifier of the member whose sessions must end.
Returns

An empty 204 No Content response.

Raises
HTTPException
400 Bad Request when the financial institution has no digital banking platform configured; 404 Not Found when the identifier matches no member of that financial institution, or none of the accounts it names has a user record.
https://partner-api.investifi.com/v1
POST
/sessions/revoke/

Authorization

APIKeyHeader
x-api-key<token>

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://partner-api.investifi.com/v1/sessions/revoke/" \  -H "Content-Type: application/json" \  -d '{    "user_account_id": "string",    "user_account_id_type": "investifi"  }'
Empty
{
  "detail": "Key does not have the required scope: manage:sessions."
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Disclosures

Returns the investment disclosures to render, in order. Called without a user, the response carries the primary disclosure alone, worded for the financial institution's type. This is the correct set for any surface rendered before a user is known, and needs no scope: the text is public legal copy that names no user. Naming a user narrows the response to that user's disclosures, adding a footnote for each product they have funded. This reveals which products the user holds, so it requires the read:user scope.

Users

Endpoints for retrieving member account, balance, and KYC data.