> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # Add a team member with a role > Create a login for a new staff member (or link an existing account) and assign them a role. **Email new to Hyperprop (most common):** 1. You provide the member's email, name, and role. 2. Hyperprop creates a dedicated login with a strong **temporary password**. 3. The temporary password is returned **once** in this response (`tempPassword`) — copy it and share it with the member through a secure channel. 4. The member signs in at your dashboard URL and should change the password under Settings → Security. **Email already has a Hyperprop account:** The existing account is converted to a staff login and linked to your team. The response has `linkedExisting: true` and `tempPassword: null` — the person signs in with the password they already use. Note: a converted trader account can no longer log in to the trader terminal; removing them from the team converts it back to a regular account. **Important:** - An email that is already a staff login at another organization cannot be added (409 EMAIL_IN_USE). - The member's access is defined entirely by their role — see GET /organization/roles for the permission matrix. - Lost password? Use POST /organization/team/{memberId}/reset-password to generate a new temporary password. **Permissions:** requires **manage** access to "Team & roles" (admins have this by default). **Authentication:** Accepts either `Authorization: Bearer ` (dashboard) or `X-API-Key: hp_live_...` (programmatic). ## OpenAPI ````yaml /api-reference/openapi.json post /v1/organization/team openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. ## Authentication Two methods, depending on who is calling: ### Bearer Token (JWT) — users & dashboard Most endpoints accept a JWT via `Authorization: Bearer `. Used by the dashboard and client applications. ### API Key — organizations (prop firms) Organization endpoints also accept `X-API-Key: hp_live_...` for programmatic access from your backend — no browser session needed. Keys are managed by organization admins in the dashboard; each key carries permissions (`read`, `write`, `admin`) and can be rotated or revoked at any time. Keys are stored hashed (SHA-256) — the raw key is shown once at creation. Endpoints that create or modify data require `write` or `admin`. ## Quick Start ```bash # 1. List your trading plans (grab a tradingPlanId) curl "https://api.hyperprop.com/platform/v1/organization/trading-plans" \ -H "X-API-Key: hp_live_your_key_here" # 2. Create a trading account for a trader (by Hyperprop user ID or email) curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "", "email": "trader@example.com"}' ``` ## Response Envelope & Error Handling **Success** responses always wrap the payload: ```json { "success": true, "data": { ... }, "message": "optional human-readable note" } ``` **Errors** — including request-validation failures, auth failures, and errors proxied from the trade engine — always return this single uniform shape with a machine-readable `code` you can switch on: ```json { "success": false, "statusCode": 404, "error": "Not Found", "message": "No Hyperprop user found with that email. The trader must have a Hyperprop account before an account can be created for them.", "code": "TRADER_NOT_FOUND" } ``` Parse rule of thumb: check `success`; on `false`, switch on `code` (never on `message` text — messages can be reworded). Some errors carry additional structured context alongside these fields (e.g. payout rejections include a `consistency` block). Common codes: `VALIDATION_ERROR` (malformed payload/params), `UNAUTHORIZED`, `INSUFFICIENT_PERMISSIONS` / `NOT_ADMIN` (key lacks write/admin), `*_NOT_FOUND` (missing resource), `*_NOT_IN_ORG` (resource belongs to another organization), `IDEMPOTENCY_KEY_IN_PROGRESS` (duplicate in flight), `ENGINE_UNREACHABLE` (trade engine down — retry with the same idempotency key). Endpoint-specific codes (e.g. payout `OPEN_EXPOSURE`, `CONSISTENCY_BLOCKED`) are documented on each endpoint. ## Idempotency **Every mutating endpoint (POST, PUT, PATCH, DELETE) honors idempotency keys uniformly.** Send an `Idempotency-Key` header (the `X-Idempotency-Key` spelling is accepted as an alias) to retry any write safely without creating duplicates. How it works: - The key is scoped to your organization + the request path. The first request with a given key executes normally and its response is cached for **24 hours**. - A replay (same key, same path) within 24 hours returns the cached response with an `Idempotency-Replayed: true` response header — the operation is **not** executed again. - If a request with the same key is still in flight, the duplicate gets `409 IDEMPOTENCY_KEY_IN_PROGRESS` — back off and retry; you'll then receive the cached response. - 5xx responses are **not** cached, so retrying after a server error re-executes the request (that's what you want). 2xx-4xx responses are cached — if a request failed validation and you fix the payload, use a **fresh key**. - Keys are free-form strings up to 255 characters. Use something that identifies the operation on your side, e.g. `order-8814-attempt-1`. ```bash curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Idempotency-Key: order-8814-attempt-1" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "...", "traderId": "..."}' ``` This applies to account creation, account PATCH (status, currentBalance, metadata), rules, plans, lockouts, payouts, team, webhooks — every write on the platform API. Payouts additionally forward the key to the trade engine for engine-level double-withdrawal protection. ## Pagination & Sorting List endpoints support both styles: - **Cursor (recommended):** pass `?cursor=` from the previous response's `pagination.nextCursor`. Stable under concurrent writes. - **Offset:** `?limit=&offset=` with `pagination.total` / `hasMore` in the response. Sorting uses `?sort=field:direction` (e.g. `?sort=created_at:asc`); allowed fields are listed per endpoint. Default: `created_at:desc`. ## Custom Metadata Trading accounts, purchases, traders, plans, and rules all carry a free-form `metadata` JSON object. Use it to store your own references — payment IDs, campaign tags, payout records, internal notes. Hyperprop stores and returns it verbatim (and lets you filter list endpoints by it, e.g. `?metadata=stripePaymentId:pi_123`) but never interprets it. Update endpoints support `mergeMetadata: true` for shallow (top-level) merges instead of wholesale replacement. ## Webhooks Subscribe to account lifecycle events (`account.created`, `account.status_changed`, `account.updated`, `account.passed`, `account.failed`, and more) via the Webhooks endpoints. Deliveries are HMAC-SHA256 signed — verify `X-Hyperprop-Signature` with your endpoint secret, using `X-Hyperprop-Timestamp` for replay protection; `X-Hyperprop-Delivery` gives you a unique delivery ID for deduplication. Failed deliveries are retried with backoff, and you can redeliver any event from the dashboard or API. ## MCP Connector (AI Agents) The platform ships a built-in [MCP](https://modelcontextprotocol.io) server, so AI agents and assistants (Claude, Cursor, custom agents) can operate your organization directly — no integration code required. ```http Endpoint: POST https://api.hyperprop.com/platform/v1/mcp Transport: Streamable HTTP (stateless, JSON responses) Auth: X-API-Key header, Authorization: Bearer hp_live_..., or OAuth ``` **Claude web / desktop (Add custom connector):** paste the endpoint URL and leave the OAuth Client ID/Secret fields empty — the connector registers itself automatically. Claude opens a Hyperprop consent page where an org admin pastes the organization API key once; access then follows that key's permissions and ends if the key is revoked. (Under the hood: OAuth 2.1 with PKCE and dynamic client registration.) **Cursor / Claude Code — `mcp.json`:** ```json { "mcpServers": { "hyperprop": { "url": "https://api.hyperprop.com/platform/v1/mcp", "headers": { "X-API-Key": "hp_live_your_key_here" } } } } ``` **Available tools (12):** `list_trading_plans`, `list_trading_accounts`, `get_trading_account`, `get_account_audit_log`, `list_traders`, `get_trader`, `list_purchases`, `get_purchase`, `get_billing_summary` (read) · `create_trading_account`, `update_trading_account`, `record_payout` (write). Every tool call executes the corresponding REST endpoint with your key, so organization scoping, permissions, validation, audit logging, and webhooks apply exactly as documented on each endpoint. Read tools work with any key; write tools need `write`/`admin` permission — connect a **read-only key** if you want a strictly read-only agent. `create_trading_account` accepts an optional `idempotencyKey` so agent retries can't create duplicates, and `record_payout` implements the documented payout recipe (append to `metadata.payouts`, adjust `currentBalance`, audit-logged `reason`). ## Endpoint Groups - **Authentication** — Sign up, sign in, OAuth, MFA, password reset. No auth required for most. - **User** — Profile, notifications, demo accounts, audit logs. Requires **Bearer token** (JWT). - **Organization** — Trading accounts, plans, rules, traders, purchases, lockouts, billing, bulk operations, webhooks, analytics. Accepts **Bearer token** OR **API Key**. - **System** — Health checks. No auth required. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Authentication description: >- User authentication - signup, signin, signout, password reset, email verification, OAuth, and MFA - name: User description: >- User account management - profile, notifications, agreements, dismissals, and audit logs. Requires Bearer token. - name: Organization description: >- Organization management - profile, team, trading accounts, plans, and rules. Supports **dual authentication**: Bearer JWT token (dashboard users) OR X-API-Key (programmatic access). - name: Demo description: >- Demo account management - import, list, and delete demo trading accounts. Requires Bearer token. - name: Market Data description: CME futures contracts and market data. Requires Bearer token. - name: System description: System endpoints - health checks and connectivity paths: /v1/organization/team: post: tags: - Organization summary: Add a team member with a role description: >- Create a login for a new staff member (or link an existing account) and assign them a role. **Email new to Hyperprop (most common):** 1. You provide the member's email, name, and role. 2. Hyperprop creates a dedicated login with a strong **temporary password**. 3. The temporary password is returned **once** in this response (`tempPassword`) — copy it and share it with the member through a secure channel. 4. The member signs in at your dashboard URL and should change the password under Settings → Security. **Email already has a Hyperprop account:** The existing account is converted to a staff login and linked to your team. The response has `linkedExisting: true` and `tempPassword: null` — the person signs in with the password they already use. Note: a converted trader account can no longer log in to the trader terminal; removing them from the team converts it back to a regular account. **Important:** - An email that is already a staff login at another organization cannot be added (409 EMAIL_IN_USE). - The member's access is defined entirely by their role — see GET /organization/roles for the permission matrix. - Lost password? Use POST /organization/team/{memberId}/reset-password to generate a new temporary password. **Permissions:** requires **manage** access to "Team & roles" (admins have this by default). **Authentication:** Accepts either `Authorization: Bearer ` (dashboard) or `X-API-Key: hp_live_...` (programmatic). operationId: postV1OrganizationTeam requestBody: content: application/json: schema: $ref: '#/components/schemas/Model487' responses: '201': description: >- Member added. For new accounts the temporary password is only shown in this response; for linked existing accounts tempPassword is null. content: '*/*': schema: $ref: '#/components/schemas/Model490' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model39' '409': description: >- Email is already on your team (MEMBER_EXISTS) or is a staff login at another organization (EMAIL_IN_USE) content: '*/*': schema: $ref: '#/components/schemas/Model491' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model3' security: - Bearer: [] - X-API-Key: [] components: schemas: Model487: type: object properties: email: type: string description: >- Work email for the staff member. If the email is new to Hyperprop a dedicated login is created; if it already has a Hyperprop account, that account is linked to your team instead. example: sarah@propfirm.com x-format: email: true fullName: type: string description: Display name shown in the dashboard and audit log example: Sarah Johnson minLength: 1 maxLength: 120 roleId: type: string description: >- Role to assign. Get available roles (system presets + your custom roles) from GET /organization/roles. example: 7e0d1c9a-3f2b-4d5e-8a6f-1b2c3d4e5f60 x-format: guid: true required: - email - fullName - roleId Model490: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model489' Model39: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model491: type: object properties: statusCode: type: number example: 409 error: type: string example: Conflict message: type: string example: >- This email is already a staff login at another organization. Use a different email (a work alias like name+ops@yourfirm.com works). code: type: string example: EMAIL_IN_USE Model3: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model489: type: object example: id: 40e7760b-3768-4513-b8c3-8d12f0f1d1da email: sarah@propfirm.com fullName: Sarah Johnson roleId: 7e0d1c9a-3f2b-4d5e-8a6f-1b2c3d4e5f60 roleName: Support permissions: analytics: view traders: manage payouts: view plans: view webhooks: none operations: manage billing: none team: none settings: none tempPassword: Kw4n-Xr8t-Mz2p-Hq7v linkedExisting: false properties: id: type: string description: Member user ID email: type: string description: Member email (login) fullName: type: string description: Display name roleId: type: string description: Assigned role ID roleName: type: string description: Assigned role name permissions: $ref: '#/components/schemas/Model488' tempPassword: type: string description: >- Temporary password — shown ONCE, share securely with the member. Null when an existing account was linked (they keep their current password). linkedExisting: type: boolean description: >- True when the email already had a Hyperprop account and it was linked to your team instead of creating a new login Model488: type: object description: Effective permission map (domain → none/view/manage) securitySchemes: Bearer: type: apiKey name: Authorization in: header description: >- JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints. X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key for programmatic access. Format: "hp_live_{key}". Used by Organization endpoints as an alternative to Bearer token. Keys are managed in the dashboard. ```` ## Related topics - [Change a team member's role](/platform-api/organization/change-a-team-members-role.md) - [Get team members for your organization](/platform-api/organization/get-team-members-for-your-organization.md) - [Remove a team member](/platform-api/organization/remove-a-team-member.md) - [Generate a new temporary password for a team member](/platform-api/organization/generate-a-new-temporary-password-for-a-team-member.md) - [List roles (system presets + your custom roles)](/platform-api/organization/list-roles-system-presets-+-your-custom-roles.md)