Endpoints年齢ゲート

年齢ゲートをチェックする。

年齢ゲートのチェックを実行し、プレイヤーがゲームに入れるかどうかを判定します。必要な場合は年齢チャレンジを作成します。 プレイヤーの管轄区域とあわせて、`dateOfBirth`、`age`、`kuid` のいずれか1つだけを指定してください。1つも指定しない場合、または複数を指定した場合は不正なリクエストになります。`kuid` を指定した場合は、保護者が登録済みの年齢が使用され、作成されるセッションまたはチャレンジはそのユーザーに紐付けられます。 レスポンスの `status` が次の操作を決めます。`PASS` はセッションが返され、プレイヤーはそのまま続行できます。`CHALLENGE` はチャレンジが返され、先に完了させる必要があります。`PROHIBITED` はプレイヤーがプレイできないため、いずれも返されません。理由は `prohibitedReason` で確認できます。 返されたチャレンジのワンタイムパスワードには有効期限があります。表示する直前に `/challenge/generate-otp` を呼び出し、チャレンジが進行中になるまで定期的に再生成してください。

POST
/age-gate/check
AuthorizationBearer <token>

In: header

Header Parameters

Kid-Target-Product-Id?integer

アカウントシステムプロダクトがプロダクト間の年齢ゲートチェックを実行するための任意のヘッダー。値は、同じ組織内の対象プロダクトのプロダクトIDである必要があります。対象プロダクト自体がアカウントシステムプロダクトであってはなりません。

Request Body

application/json

年齢ゲートをチェックする

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/age-gate/check" \  -H "Content-Type: application/json" \  -d '{    "jurisdiction": "US-CA",    "dateOfBirth": "2012-06-15",    "age": 13,    "kuid": "12b9fa0e-6d6d-4903-a1fc-f2233027b71d",    "platformAgeSignal": {      "name": "meta-horizon",      "category": "TN"    },    "subject": {      "id": "id-12345678-1234-1234-1234-123456789012"    },    "options": {      "termsOfServiceDocument": "xbox-tos",      "privacyPolicyDocument": "xbox-privacy-policy",      "additionalLegalLinks": [        "steam-tos",        "xbox-conduct"      ],      "playerAgeAssurance": {        "redirectUrl": "https://example.com/verify/complete"      }    }  }'

{  "status": "PASS",  "session": {    "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672",    "kuid": "12b9fa0e-6d6d-4903-a1fc-f2233027b71d",    "ageStatus": "LEGAL_ADULT",    "ageCategory": "adult",    "etag": "e889efb9e8a985308e82bed78c5aef7f37f50cf36b7337bf654980d0bab7a574",    "status": "ACTIVE",    "dateOfBirth": "2005-04-15",    "jurisdiction": "US-CA",    "managedBy": "PLAYER",    "permissions": [      {        "name": "text-chat-public",        "enabled": false,        "managedBy": "GUARDIAN"      },      {        "name": "text-chat-private",        "enabled": true,        "managedBy": "PLAYER"      },      {        "name": "forums",        "enabled": false,        "managedBy": "PROHIBITED"      }    ]  }}