Identity Management

GET /user/{userId}/agreements

Requires authentication with server or user access token.

Returns platform and client Terms & Conditions acceptance status for specified user.

See also

Help us improve

Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.


GET /api/2/user/{userId}/agreements


required path parameter

The user's uuid or userId (not to be mistaken with the deprecated id).

Example request

curl -G \
   -d "oauth_token=[access token]"
SpidOAuthToken token = spidClient.getUserToken(code);
String responseJSON = spidClient.
    GET(token, "/user/42/agreements").

This example is an excerpt, see a full example

echo var_dump($client->api("/user/42/agreements"));

This example is an excerpt, see a full example

(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-user-token client "[code]")]
  (spid/GET client token "/user/42/agreements"))


This endpoint supports the JSON response format.

Success: 200 OK

Returns agreements object, containing boolean values whether latest agreements are accepted



Agreements item

The check mark indicates that the field always contains a valid non-empty value.

Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 420 Request Ratelimit exceeded

Sample response

    "agreements": {
        "platform": true,
        "client": true
        "agreements": {
            "platform": true,
            "client": true


Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.