Skip to main content

Terms

GET 

/authenticate/terms

The purpose of this endpoint is to provide the text, links and buttons you can use to get a users agreement and consent prior to authenticating them in-game (your dialog should look similar to the example below). This text will be localized based on the Accept-Language header, into one of our supported languages (note: our full Terms of Use and Privacy Policy are currently in English-only). If you are authenticating using platform SSO, you must call this endpoint with the X-Modio-Portal header set, so the text is localized to match the platforms requirements. A successful response will return a Terms Object.

Example Dialog:

IMPORTANT: It is a requirement of the Game Terms with mod.io, and the platforms mod.io is used on, to ensure the user provides consent and has agreed to the latest Terms of Use and Privacy Policy of mod.io. The users agreement must be collected prior to using a 3rd party authentication flow (including but not limited to Steam, PSN, Nintendo and Xbox Live). You only need to collect the users agreement once, and also each time these policies are updated.

To make this easy to manage, all of the 3rd party authentication flows have a terms_agreed field which should be set to false by default (unless the user has just agreed to the terms in which case it can be set to true for just that request). If the user has agreed to the latest policies, their authentication will proceed as normal, however if their agreement is required and terms_agreed is set to false an error 403 Forbidden (error_ref 11074) will be returned. When you receive this error, you must collect the users agreement by showing this dialog, before resubmitting the authentication flow with terms_agreed set to true (for just this request, future requests should default to false and mod.io will tell you if you need to recollect the users agreement), which will be recorded. See the full details of the mod.io authentication process.

NOTE: You must make sure the Terms of Use and Privacy Policy are correctly linked, or displayed inline using the agreements endpoints to get the latest versions.

If you wish to display the agreements in a web browser overlay, we recommend using the following URLs:

tip

The /legal part of the URL is optional and removes all menus and the ?no_links=true part of the URL is optional and removes all links.

NOTE: You can use your own text and process, but be aware that you are responsible for ensuring that the users agreement is properly collected and reported. Failure to do so correctly is a breach of the Game Terms with mod.io. If your game does not authenticate users or only uses the email authentication flow, you do not need to implement this dialog, but you should link to the mod.io Terms of Use and Privacy Policy in your Privacy Policy/EULA.

Responses​

Successful Request