User
Accept an agreement
Records user acceptance of an agreement. Organization admins can only accept “organization” category agreements. Organization view-only users cannot accept any agreements. Regular users can accept all categories except “organization”. Stores IP address and user agent for audit.
POST
/
v1
/
user
/
agreements
/
{id}
/
accept
Accept an agreement
curl --request POST \
--url https://api.hyperprop.com/platform/v1/user/agreements/{id}/acceptimport requests
url = "https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept', 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/user/agreements/{id}/accept",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept"
req, _ := http.NewRequest("POST", url, nil)
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/user/agreements/{id}/accept")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Agreement \"Terms of Service\" accepted successfully",
"data": {
"agreement_id": "550e8400-e29b-41d4-a716-446655440000",
"accepted_at": "2025-01-20T14:30:00.000Z"
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Agreement already accepted",
"code": "AGREEMENT_ALREADY_ACCEPTED"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "Organization admins can only accept organization agreements",
"code": "ORG_ADMIN_WRONG_CATEGORY"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "Agreement not found",
"code": "AGREEMENT_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Related topics
Get all agreementsRate limits & quotasNotify market-data access grantedIntroductionGet your organization profile⌘I
Accept an agreement
curl --request POST \
--url https://api.hyperprop.com/platform/v1/user/agreements/{id}/acceptimport requests
url = "https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept', 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/user/agreements/{id}/accept",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept"
req, _ := http.NewRequest("POST", url, nil)
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/user/agreements/{id}/accept")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/agreements/{id}/accept")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Agreement \"Terms of Service\" accepted successfully",
"data": {
"agreement_id": "550e8400-e29b-41d4-a716-446655440000",
"accepted_at": "2025-01-20T14:30:00.000Z"
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Agreement already accepted",
"code": "AGREEMENT_ALREADY_ACCEPTED"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "Organization admins can only accept organization agreements",
"code": "ORG_ADMIN_WRONG_CATEGORY"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "Agreement not found",
"code": "AGREEMENT_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}