Skip to main content
GET
/
investors
/
{investor_id}
/
cash-management
/
eligibility
Check enrollment eligibility
curl --request GET \
  --url https://api.bluumfinance.com/v1/investors/{investor_id}/cash-management/eligibility \
  --header 'Authorization: Basic <encoded-value>'
{
  "object": "cash_management_eligibility",
  "livemode": true,
  "investor_id": "<string>",
  "program_id": "<string>",
  "eligible": true,
  "eligible_currencies": [
    "<string>"
  ],
  "requirements": [
    {
      "type": "disclosure_acceptance",
      "status": "required",
      "disclosure_id": "<string>"
    }
  ],
  "ineligible_reasons": [
    {
      "code": "<string>",
      "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
Example:

"inv_01j9x8m2k7qpzwv3t5r6y8n0ab"

Query Parameters

program_id
string
required
Example:

"cmp_01j9x8m2k7qpzwv3t5r6y8n0ab"

Response

200 - application/json

Eligibility result

object
string
Example:

"cash_management_eligibility"

livemode
boolean
investor_id
string
program_id
string
eligible
boolean
status
enum<string>
Available options:
eligible,
pending_requirements,
not_eligible,
restricted,
not_checked
eligible_currencies
string[]
requirements
object[]
ineligible_reasons
object[]