Docs
Status
Supportk-id.comCompliance Studio
Endpointsセッション

管轄区域を更新する

既存のセッションを新しい管轄区域に移し、その管轄区域のルールで再評価します。 レスポンスは更新後のセッション、または新しい管轄区域が保護者の承認を必要とし、プレイヤーがまだ承認を得ていない場合はチャレンジです。

POST
/session/update-jurisdiction

Authorization

api-key
AuthorizationBearer <token>

In: header

Request Body

application/json

管轄更新リクエスト

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/session/update-jurisdiction" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672",    "jurisdiction": "US-CA"  }'
{  "session": {    "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672",    "kuid": "12b9fa0e-6d6d-4903-a1fc-f2233027b71d",    "etag": "e889efb9e8a985308e82bed78c5aef7f37f50cf36b7337bf654980d0bab7a574",    "status": "ACTIVE",    "permissions": [      {        "name": "public-profile",        "enabled": true,        "managedBy": "PLAYER",        "verifiedAgeThreshold": 18      }    ],    "allowances": [      {        "name": "string",        "type": "numerical",        "numericalValue": 0.1      }    ],    "ageStatus": "DIGITAL_MINOR",    "ageCategory": "digital-minor",    "dateOfBirth": "2005-04-15",    "jurisdiction": "US-CA",    "managedBy": "PLAYER",    "hasApproverEmail": true,    "ageVerification": {      "verifiedAge": 18,      "platformName": "apple-ios",      "declarationType": "confirmed",      "verificationId": "a50f4f73-3c0c-4720-a8b3-ec57ccb0aa34",      "verifiedAt": "2026-03-14T00:00:00Z",      "verifiedDob": "2008-03-15"    },    "requiredDataProcessingConsentFor": [      "string"    ]  },  "challenge": {    "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802",    "type": "CHALLENGE_PARENTAL_CONSENT",    "url": "https://example.com/challenge",    "oneTimePassword": "123456",    "childLiteAccessEnabled": true,    "kuid": "12b9fa0e-6d6d-4903-a1fc-f2233027b71d",    "jurisdiction": "US-CA",    "age": 13,    "dateOfBirth": "2005-04-15",    "otpExpiresAt": "2022-01-01T00:00:00Z",    "materialChange": {      "presentedDocuments": [        "string"      ],      "issuedAt": "2019-08-24T14:15:22Z",      "actionedAt": "2019-08-24T14:15:22Z",      "acceptanceDeadline": "2019-08-24T14:15:22Z"    },    "documents": [      {        "id": "privacy-policy",        "name": "Privacy Policy",        "url": "https://example.com/privacy",        "isDataNotice": false      }    ]  }}

セッションから保護者の連携を解除する POST

`/invite-parent` フローで以前に連携されたプレイヤーセッションから、保護者の連携を解除します。 成功すると、セッション上の保護者が設定した設定値はすべて消去され、`Session.Unlink` Webhookが発火します。権限と既存のプレイヤーデータはそのまま維持されます。 このAPIは `sessionId` に対して冪等です。連携がすでに解除された後に再度呼び出した場合は、元の `unlinkedAt` とともに200を返します。

セッションをアップグレードする POST

プレイヤーのセッションをアクティブなセッションにアップグレードします。要求された権限に保護者の同意が必要な場合はチャレンジを作成します。 セッションは `sessionId`、`kuid`、またはその両方で指定します。両方を指定すると、そのユーザーを既存のセッションに紐付けます。いずれも指定しない場合は不正なリクエストになります。 `options` はこの呼び出しで作成されるチャレンジの年齢保証を調整し、`materialChange` は同意のために提示する法的文書を指定します。`materialChange.acceptanceDeadline` を設定すると期限付きのアップグレードになります。保護者に承認リクエストのリンクがメールで送られ、その日時までに承認する必要があります。将来のUTCタイムスタンプは指定どおりに扱われ、最小の猶予期間も丸め処理もありません。数分後の期限はそのまま数分後です。省略した場合は期限なしで文書を提示します。 文書が変更されて再同意が必要な場合は `priorChallengeId` を設定してください。新しいチャレンジは保留中または進行中のチャレンジに優先し、その文書に追加されます（追加のみ）。以前のリンクは常に最新のものへ解決されます。 返されたチャレンジのワンタイムパスワードには有効期限があります。表示する直前に `/challenge/generate-otp` を呼び出し、チャレンジが進行中になるまで定期的に再生成してください。