Rebind a customer to a new Hyperprop login (support flow)
Move a soulbound customer to a new Hyperprop login in one atomic operation. There is no plain “release” — every customer always has exactly one bound login, so a lost login is fixed by rebinding, never by leaving the customer unbound.
Use this when a customer lost access to their Hyperprop login (forgot password AND lost the email — normal password reset covers everything else):
- Customer contacts YOUR support
- The customer creates their new Hyperprop account (signs up) and verifies its email
- You create an account for the customer with
unassigned: trueandclaimEmailset to that email. When they open the Hyperprop app with the new login, the claim is refused (the customer is still bound to the old login) and you receiveaccount.claim_refused - You rebind here with that
claimEmail(or the event’sattemptedUserIdastraderId) — find the binding viaGET /trader-bindings?customerId=...or the event’sbindingId. The pending account then links the next time the new login is loaded
What happens:
- The binding now points at the new login (
boundVia: "rebind") - Every still-active account (
not_started/in_progress) linked to the OLD login is set tofailedwith the violation reason “Identity rebound by the firm …” — the old login can never trade this customer’s accounts again. Anaccount.failedwebhook fires per account, and the old login’s open trading sessions end immediately. - Terminal accounts (
passed/failed/expired) are untouched — history stays with the old identity for audit. - Unlinked accounts with pending import keys are now redeemable only by the new login.
- Give the customer new accounts by creating them for the new login (or unassigned with an import key) — failed accounts are not transferred.
- Billing note: activating an account under the new login (redeeming a pending key, or a new linked create) counts as a fresh market data activation for that login — a new billing cycle (platform + market data) starts, on top of what the old login already consumed. Billing follows logins, not customers.
Safety checks:
- The new login must have tried to claim an account of this customer (step 3), or already trade with your firm. Any other email or ID, including one with no Hyperprop login, gets the same
404 TRADER_NOT_FOUND. - One login = one customer per firm: if the new login already belongs to a different customer of yours, the rebind is refused with
409 NEW_LOGIN_ALREADY_BOUND. - Rebinding to the already-bound login is a no-op and returns
400 SAME_LOGIN.
Permissions: organization admins (or API key). Supports idempotency keys.
Error codes: BINDING_NOT_FOUND, TRADER_NOT_FOUND, SAME_LOGIN, NEW_LOGIN_ALREADY_BOUND, REBIND_ERROR.
Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Team & roles.
curl --request POST \
--url https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"traderId": "11111111-1111-4111-8111-111111111111",
"email": "customer-new@example.com"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind"
payload = {
"traderId": "11111111-1111-4111-8111-111111111111",
"email": "customer-new@example.com"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
traderId: '11111111-1111-4111-8111-111111111111',
email: 'customer-new@example.com'
})
};
fetch('https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'traderId' => '11111111-1111-4111-8111-111111111111',
'email' => 'customer-new@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind"
payload := strings.NewReader("{\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"email\": \"customer-new@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"email\": \"customer-new@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"email\": \"customer-new@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Customer rebound — 2 active account(s) on the old login were failed",
"data": {
"binding": {
"id": "<string>",
"organizationId": "<string>",
"customerId": "acme-cust-4471",
"userId": "<string>",
"email": "customer-new@example.com",
"boundAt": "<string>",
"boundVia": "rebind"
},
"failedAccounts": [
{
"id": "<string>",
"accountNumber": "ACC-M3X7K9P2",
"previousStatus": "in_progress"
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "This customer is already bound to that Hyperprop login",
"code": "SAME_LOGIN"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Only organization admins can perform this action",
"code": "NOT_ADMIN"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "No login with that email or user ID can be bound to this customer",
"code": "TRADER_NOT_FOUND"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "That Hyperprop login already belongs to another customer of yours",
"code": "NEW_LOGIN_ALREADY_BOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}Authorizations
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Headers
Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.
255Body
curl --request POST \
--url https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"traderId": "11111111-1111-4111-8111-111111111111",
"email": "customer-new@example.com"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind"
payload = {
"traderId": "11111111-1111-4111-8111-111111111111",
"email": "customer-new@example.com"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
traderId: '11111111-1111-4111-8111-111111111111',
email: 'customer-new@example.com'
})
};
fetch('https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'traderId' => '11111111-1111-4111-8111-111111111111',
'email' => 'customer-new@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind"
payload := strings.NewReader("{\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"email\": \"customer-new@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"email\": \"customer-new@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trader-bindings/{bindingId}/rebind")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"email\": \"customer-new@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Customer rebound — 2 active account(s) on the old login were failed",
"data": {
"binding": {
"id": "<string>",
"organizationId": "<string>",
"customerId": "acme-cust-4471",
"userId": "<string>",
"email": "customer-new@example.com",
"boundAt": "<string>",
"boundVia": "rebind"
},
"failedAccounts": [
{
"id": "<string>",
"accountNumber": "ACC-M3X7K9P2",
"previousStatus": "in_progress"
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "This customer is already bound to that Hyperprop login",
"code": "SAME_LOGIN"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Only organization admins can perform this action",
"code": "NOT_ADMIN"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "No login with that email or user ID can be bound to this customer",
"code": "TRADER_NOT_FOUND"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "That Hyperprop login already belongs to another customer of yours",
"code": "NEW_LOGIN_ALREADY_BOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}