User Status

Check whether a specific user belongs to your IB.

Endpoint

GET https://base-url/api/ib/user-status

Requires Authorization: Bearer <YOUR_API_KEY> — see Authentication.

Parameter	Type	Required	Description
`user_id`	string (UUID)	✅ Yes	The ID of the user to look up

GET /api/ib/user-status?user_id=a1b2c3d4-0000-0000-0000-000000000000
Authorization: Bearer YOUR_API_KEY

{
  "is_under_ib": true,
  "date_joined": "2026-06-24T08:30:00.000Z"
}

{
  "is_under_ib": false,
  "date_joined": null
}

Field	Type	Description
`is_under_ib`	boolean	`true` if the user belongs to your IB; `false` otherwise
`date_joined`	string \| null	ISO 8601 UTC timestamp of when the user joined under your IB. `null` when `is_under_ib` is `false`

Status	Body	Cause
`400 Bad Request`	`{"error":"Invalid user_id format"}`	`user_id` is missing or not a valid UUID
`401 Unauthorized`	`{"error":"Unauthorized"}`	API key is missing, invalid, or non-Partner
`429 Too Many Requests`	`{"error":"Too many failed lookups. Please try again later."}`	Rate limit exceeded

See the Error Codes reference for full details.

No additional user data is returned — only IB membership status and join date.
This endpoint is scoped solely to checking membership within your Partner account; it cannot query other Partners.
A 200 response with is_under_ib: false means the user exists but is not under your IB — it is not an error condition.