Skip to main content
REST API

IB Partner API

Verify user IB membership in real time. A single endpoint, a single query parameter, a clear JSON response.

🔑

Authentication

All requests require a Bearer token. API keys are issued to Partner accounts only and must be kept confidential.

Authentication guide
🔍

User Status endpoint

GET /api/ib/user-status — check whether a user belongs to your IB and when they joined.

Endpoint reference
⚠️

Error codes

The API returns structured JSON errors with HTTP status codes 400, 401, and 429.

Error reference

Quick example

HTTP
GET /api/ib/user-status?user_id=a1b2c3d4-0000-0000-0000-000000000000
Authorization: Bearer YOUR_API_KEY
Response
{
  "is_under_ib": true,
  "date_joined": "2026-06-24T08:30:00.000Z"
}