Clear two traders to share a device or address
Records that two of your traders may share a device or an address (same household, shared office…), with the reason and an end date. A shared device or address used by exactly cleared traders stops flagging them. They return as soon as something new appears: they hedge or copy each other, or a third trader uses the device.
curl -X POST "https://api.hyperprop.com/platform/v1/organization/risk/link-clearances" \
-H "X-API-Key: hp_live_your_key_here" -H "Content-Type: application/json" \
-d '{"traderIds":["2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b","9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"],"reason":"same_household"}'
Permissions: requires manage access to “Traders & accounts”. Full sign-in addresses and device ids need “Risk investigations”; without it they are shortened.
Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Traders & accounts.
curl --request POST \
--url https://api.hyperprop.com/platform/v1/organization/risk/link-clearances \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"traderIds": [
"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
],
"reason": "same_household",
"note": "Same flat, confirmed",
"expiresAt": "2027-02-13T00:00:00.000Z"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/link-clearances"
payload = {
"traderIds": ["2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b", "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"],
"reason": "same_household",
"note": "Same flat, confirmed",
"expiresAt": "2027-02-13T00:00:00.000Z"
}
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({
traderIds: ['2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b', '9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'],
reason: 'same_household',
note: 'Same flat, confirmed',
expiresAt: '2027-02-13T00:00:00.000Z'
})
};
fetch('https://api.hyperprop.com/platform/v1/organization/risk/link-clearances', 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/risk/link-clearances",
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([
'traderIds' => [
'2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b',
'9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'
],
'reason' => 'same_household',
'note' => 'Same flat, confirmed',
'expiresAt' => '2027-02-13T00:00:00.000Z'
]),
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/risk/link-clearances"
payload := strings.NewReader("{\n \"traderIds\": [\n \"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b\",\n \"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\"\n ],\n \"reason\": \"same_household\",\n \"note\": \"Same flat, confirmed\",\n \"expiresAt\": \"2027-02-13T00:00:00.000Z\"\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/risk/link-clearances")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"traderIds\": [\n \"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b\",\n \"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\"\n ],\n \"reason\": \"same_household\",\n \"note\": \"Same flat, confirmed\",\n \"expiresAt\": \"2027-02-13T00:00:00.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/link-clearances")
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 \"traderIds\": [\n \"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b\",\n \"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\"\n ],\n \"reason\": \"same_household\",\n \"note\": \"Same flat, confirmed\",\n \"expiresAt\": \"2027-02-13T00:00:00.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "<string>",
"clearance": {
"id": "<string>",
"traderIds": [
"<string>"
],
"traderNames": [
"<string>"
],
"reason": "same_household",
"note": "<string>",
"createdAt": "<string>",
"createdBy": {
"userId": "<string>",
"apiKeyId": "<string>",
"name": "Jane Analyst"
},
"expiresAt": "<string>",
"revokedAt": "<string>"
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid request data",
"code": "BAD_REQUEST"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "This API key does not have admin permissions",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}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/risk/link-clearances \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"traderIds": [
"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
],
"reason": "same_household",
"note": "Same flat, confirmed",
"expiresAt": "2027-02-13T00:00:00.000Z"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/link-clearances"
payload = {
"traderIds": ["2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b", "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"],
"reason": "same_household",
"note": "Same flat, confirmed",
"expiresAt": "2027-02-13T00:00:00.000Z"
}
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({
traderIds: ['2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b', '9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'],
reason: 'same_household',
note: 'Same flat, confirmed',
expiresAt: '2027-02-13T00:00:00.000Z'
})
};
fetch('https://api.hyperprop.com/platform/v1/organization/risk/link-clearances', 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/risk/link-clearances",
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([
'traderIds' => [
'2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b',
'9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'
],
'reason' => 'same_household',
'note' => 'Same flat, confirmed',
'expiresAt' => '2027-02-13T00:00:00.000Z'
]),
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/risk/link-clearances"
payload := strings.NewReader("{\n \"traderIds\": [\n \"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b\",\n \"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\"\n ],\n \"reason\": \"same_household\",\n \"note\": \"Same flat, confirmed\",\n \"expiresAt\": \"2027-02-13T00:00:00.000Z\"\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/risk/link-clearances")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"traderIds\": [\n \"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b\",\n \"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\"\n ],\n \"reason\": \"same_household\",\n \"note\": \"Same flat, confirmed\",\n \"expiresAt\": \"2027-02-13T00:00:00.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/link-clearances")
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 \"traderIds\": [\n \"2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b\",\n \"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\"\n ],\n \"reason\": \"same_household\",\n \"note\": \"Same flat, confirmed\",\n \"expiresAt\": \"2027-02-13T00:00:00.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "<string>",
"clearance": {
"id": "<string>",
"traderIds": [
"<string>"
],
"traderNames": [
"<string>"
],
"reason": "same_household",
"note": "<string>",
"createdAt": "<string>",
"createdBy": {
"userId": "<string>",
"apiKeyId": "<string>",
"name": "Jane Analyst"
},
"expiresAt": "<string>",
"revokedAt": "<string>"
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid request data",
"code": "BAD_REQUEST"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "This API key does not have admin permissions",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}