Skip to main content
POST
/
investors
/
{investor_id}
/
cash-sweep
/
enroll
Enroll in cash sweep
curl --request POST \
  --url https://api.bluumfinance.com/v1/investors/{investor_id}/cash-sweep/enroll \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apr_tier_name": "<string>",
  "disclosure_acceptances": [
    {
      "disclosure_id": "<string>",
      "signed_at": "2023-11-07T05:31:56Z",
      "ip_address": "<string>",
      "user_agent": "<string>",
      "actor_ref": "<string>"
    }
  ]
}
'
{
  "id": "<string>",
  "object": "cash_sweep_enrollment",
  "created": 123,
  "livemode": true,
  "metadata": {},
  "investor_id": "<string>",
  "brokerage_account_id": "<string>",
  "apr_tier_name": "<string>",
  "apr_tier_id": "<string>",
  "account_rate_bps": 123,
  "enrolled_at": "2023-11-07T05:31:56Z",
  "unenrolled_at": "2023-11-07T05:31:56Z",
  "accepted_disclosures": [
    "<string>"
  ],
  "cutoff_acknowledgement": {
    "cutoff": "11:45 AM ET",
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Path Parameters

​
investor_id
string
required

Investor ID (prefixed, e.g. inv_...)

Body

application/json
​
variant
enum<string>
required

Cash sweep variant

Available options:
non_shariah,
shariah
​
apr_tier_name
string
required

APR tier to assign

​
disclosure_acceptances
object[]

Optional inline disclosure acceptances. Each entry MUST carry the disclosure_id it acknowledges — one timestamp shared across "all missing" was audit-incorrect because the user consents to each disclosure individually. Equivalent to pre-recording via POST /v1/investors/{investor_id}/disclosures/acceptances. The service rejects entries with a disclosure_id outside the required set for this enrollment or duplicate ids.

Response

Enrollment initiated

​
id
string

Prefixed enrollment ID (e.g. cse_...)

​
object
enum<string>
Available options:
cash_sweep_enrollment
​
created
integer

Unix timestamp of creation

​
livemode
boolean
​
metadata
object
​
investor_id
string
​
brokerage_account_id
string
​
variant
enum<string>
Available options:
non_shariah,
shariah
​
status
enum<string>
Available options:
pending_enrollment,
active,
pending_unenrollment,
inactive
​
apr_tier_name
string | null
​
apr_tier_id
string | null
​
account_rate_bps
integer | null
​
enrolled_at
string<date-time> | null
​
unenrolled_at
string<date-time> | null
​
accepted_disclosures
string[]

Ids of every HYC disclosure that was acknowledged on the way to this enrollment (pre-recorded + newly recorded inline on this request). Returned on the enroll response so the partner UI can show the full list without a follow-up GET on the disclosure-acceptances endpoint.

​
cutoff_acknowledgement
object

Acknowledgement of the High Yield Cash 11:45 AM ET processing cutoff. Returned on unenroll (and surfaced where else relevant) so partner UIs can render deterministic copy about when the request will take effect, without re-implementing the timezone math.