getLastAcceptedTOS — Checking SiteLock Terms of Service acceptance status

Upon accessing their SiteLock Dashboard for the first time, the user must accept the SiteLock Terms of Service (TOS) before proceeding. The user is presented with the current version of the Terms of Service and must check a box accepting the terms. Users will also be asked to accept the Terms of Service when a new version is released.

SiteLock partners can check on Terms of Service status of their accounts, including the acceptance date and TOS version by using the getLastAcceptedTOS method.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

  • SiteLockOnlineRequest: This element is used to delineate the full API request.

    • authentication: The partner’s username, password, and branding

      • username: The partner’s API username

      • password: The partner’s API password

      • partner: (Optional) The brand name to use in messaging

    • getLastAcceptedTOS: The method name

    • account_id: The SiteLock account ID for which to retrieve the TOS status

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getLastAcceptedTOS>
        <account_id>2468013</account_id>
    </getLastAcceptedTOS>
</SiteLockOnlineRequest>

Response format

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • getLastAcceptedTOS: The method name

      • accepted_at: The date and time of the TOS acceptance

      • login: The login ID of the user that accepted the TOS

      • status: Either ok or error

      • tos_version_id: The TOS version presented on the dashboard

      • message: The error message if status is error.

Example success response

<SiteLockOnlineResponse>
    <getLastAcceptedTOS>
        <accepted_at>2019-05-07 11:06:24</accepted_at>
        <login>[email protected]</login>
        <status>ok</status>
        <tos_version_id>2</tos_version_id>
    </getLastAcceptedTOS>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <getLastAcceptedTOS>
        <message>User has not accepted TOS.</message>
        <status>error</status>
    </getLastAcceptedTOS>
</SiteLockOnlineResponse>

The error response returns a message describing the error, usually that the user hasn’t yet accepted the Terms of Service.