Terms and Conditions
Every registered User of the Publisher's platform must accept the terms and conditions in order to start earning rewards in the system.
The table below outlines the available API calls and actions for terms and conditions.
Action | API call | Description |
|---|---|---|
GET /terms | Retrieves the terms and conditions document so that the user can acknowledge and agree to it. | |
POST /terms/accept | Endpoint used to accept the terms and conditions for a given user so that they can start earning rewards in the system. |
Retrieves the Terms and Conditions document so that the user can acknowledge and agree to it. To test the API, see Get terms and conditions.
HTTP status 200
Returns the Terms and Conditions objects with a 200 response code, if successful. For more information, see Status and response codes.
Body
Name | Data type | Description |
|---|---|---|
id | integer | Unique identifier for each Terms and Conditions document. This can be used to accept or deny in Accept T&Cs for a user. |
url | string | URL where the Terms and Conditions document is hosted. This is used to retrieve the document so that it can be displayed for the user to acknowledge. |
revision | string | Specific version of the Terms and Conditions being acknowledged by the user. |
Endpoint used to accept the Terms and Conditions for a given user so that they can start earning rewards in the system. To test the API, see Accept T&Cs for a user.
Name | Data type | Description |
|---|---|---|
publisher_user_id REQUIRED | string | Publisher's unique identifier for the user. This ID is sent by the publisher to to identify a user in the publisher’s system. |
tnc_id REQUIRED | integer | Unique id of the Terms and Conditions object. |
HTTP status 200
Returns the objects related to the user who accepted the Terms and Conditions with a 200 response code, if successful. For more information, see Status and response codes.
Body
Name | Data type | Description |
|---|---|---|
publisher_user_id | string | Publisher's unique identifier for the user. This ID is sent by the publisher to to identify a user in the publisher’s system. |
string | Email address linked to the user which can be used to directly communicate with the user. | |
account_status | enum | This indicates the status of the user in the system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system. Possible values:
|
