Organization
Remove lockout from account
Remove (cancel) the active lockout on a trading account. Admin can remove any lockout regardless of who created it.
The unlock is pushed to the running trade engine immediately (with a periodic engine resync as the fallback within ~15 seconds), so the trader can resume trading right away.
DELETE
/
v1
/
organization
/
lockouts
/
{accountId}
Remove lockout from account
curl --request DELETE \
--url https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "Risk review completed, account cleared"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}"
payload = { "reason": "Risk review completed, account cleared" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Risk review completed, account cleared'})
};
fetch('https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}', 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/lockouts/{accountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'Risk review completed, account cleared'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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/lockouts/{accountId}"
payload := strings.NewReader("{\n \"reason\": \"Risk review completed, account cleared\"\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Authorization", "<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.delete("https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Risk review completed, account cleared\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Risk review completed, account cleared\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Lockout removed successfully",
"data": {
"accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"removed": true,
"reason": "Risk review completed, account cleared"
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"statusCode": 404,
"error": "Not Found",
"message": "No active lockout found for this account",
"code": "NO_ACTIVE_LOCKOUT"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Authorizations
BearerX-API-Key
JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.
Path Parameters
Account ID to unlock
Body
application/json
Reason for removing the lockout
Minimum string length:
3Example:
"Risk review completed, account cleared"
Related topics
Remove account lockoutCreate or update account lockoutGet lockout status for accountGet account lockout statusList all active lockouts⌘I
Remove lockout from account
curl --request DELETE \
--url https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "Risk review completed, account cleared"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}"
payload = { "reason": "Risk review completed, account cleared" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Risk review completed, account cleared'})
};
fetch('https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}', 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/lockouts/{accountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'Risk review completed, account cleared'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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/lockouts/{accountId}"
payload := strings.NewReader("{\n \"reason\": \"Risk review completed, account cleared\"\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Authorization", "<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.delete("https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Risk review completed, account cleared\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/lockouts/{accountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Risk review completed, account cleared\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Lockout removed successfully",
"data": {
"accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"removed": true,
"reason": "Risk review completed, account cleared"
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"statusCode": 404,
"error": "Not Found",
"message": "No active lockout found for this account",
"code": "NO_ACTIVE_LOCKOUT"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}