The age gate now says why a player is prohibited

/age-gate/check now says why it returned PROHIBITED. Until now, a player in a jurisdiction where the product isn't offered got the same PROHIBITED as a player who was too young, so you couldn't tell them apart.

What's new

  • prohibitedReason on /age-gate/check. Set when status is PROHIBITED. The checks run in this order, and the first one that applies is returned:
    1. JURISDICTION_UNAVAILABLE: the product isn't available in the player's jurisdiction.
    2. PROHIBITED_IN_JURISDICTION: the product is prohibited for every player in the player's jurisdiction.
    3. BELOW_MINIMUM_AGE: the player is below the product's minimum age.
  • minimumAge on /age-gate/check. Set with BELOW_MINIMUM_AGE. It's the minimum age the player was checked against.
  • PROHIBITED_IN_JURISDICTION on widget status. /widget/get-status can now report this reason too.

Compatibility

The new fields on /age-gate/check are additive, and status keeps its meaning. /widget/get-status can return a new prohibitedReason value, PROHIBITED_IN_JURISDICTION. If your client rejects unknown enum values, update it before relying on this.

If you generate a client from the OpenAPI specification, the widget status reason type is now named ProhibitedReason, and both endpoints share it.

Documentation

On this page