Accept terms and conditions

Record acceptance of the currently-in-effect terms and privacy version for this account. All three consents must be true or the request is a 400. Requires a read_write key.

POST

https://demo.stxapp.iohttps://demo.stxapp.cahttps://api.on.stxapp.ca/api/v1/tnc/accept

Try it ▶

Try it

Base URL

Key ID stx_access_keyPrivate key (PEM or base64 seed) stx_private_key

Request

Send requestShow signed headersClear saved key

Every endpoint, in one place: the full Try it.

Signing happens in your browser with WebCrypto. Your private key is never sent anywhere; Send request sends your key ID and the signature to the demo host above. Only demo hosts are offered. The key ID and private key are saved in this browser's local storage, per jurisdiction, until you click Clear saved key. Use a demo key here, never a production one.

In the SDKs

• TypeScript: STX.acceptTerms()
• Python: STX.accept_terms()
• C#: STXTermsAndConditionsService.AcceptTermsAndConditionsAsync()

Request body

Field	Type	Required	Description
accept_house_rules	boolean,null	no	Acceptance of the house rules. Defaults to accept_terms AND accept_privacy when omitted.
accept_privacy	boolean	yes	Acceptance of the privacy policy. Must be true.
accept_terms	boolean	yes	Acceptance of the terms of use. Must be true.
device_id	string	yes	Identifier for the device recording the acceptance.

Responses

Status	Description	Schema
200	Success	object
400	A parameter was missing or invalid.	Error
401	Missing, malformed or unrecognized signature, or a timestamp outside the 30-second window. Body: {“error”:“Missing or invalid API key credentials”}	Error
403	This API key does not have write access. The account behind this key is not active, for example it is pending approval or suspended. Body: {“error”:“Your account is suspended. Contact support.”}, the message naming the account’s status.	Error
422	The acceptance was not recorded: no terms are in effect, the terms changed since you read them, or a consent value was refused. The body’s error says why.	Error

Example

Request:

curl --request POST \
  --url 'https://demo.stxapp.io/api/v1/tnc/accept' \
  --header 'X-STX-ACCESS-KEY: <key-id>' \
  --header 'X-STX-ACCESS-TIMESTAMP: <unix-ms>' \
  --header 'X-STX-ACCESS-SIGNATURE: <base64-ed25519>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accept_house_rules": true,
  "accept_privacy": true,
  "accept_terms": true,
  "device_id": "my-device-001"
}'

Response 200:

{
  "message": "string"
}

Response fields

Field	Type	Description
message	string	Always "Success" when the acceptance was recorded.