メールを送信する
チャレンジの詳細を指定のメールアドレスに送信します。多くの場合、保護者への同意リクエストの送信に使用します。 チャレンジは事前に作成されている必要があります。このAPIは配信のみを行います。再送する場合はもう一度呼び出してください。
Authorization
api-key In: header
Header Parameters
アカウントシステムプロダクトがプロダクト間の年齢ゲートチェックを実行するための任意のヘッダー。値は、同じ組織内の対象プロダクトのプロダクト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/challenge/send-email" \ -H "Content-Type: application/json" \ -d '{ "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802" }'{}{ "error": "NOT_FOUND", "errorMessage": "Challenge not found"}決済確認を添えてメールを送信する POST
保護者への同意リクエストをメールで送信する際に、その背後にある購入について成人がすでに決済を完了したというアテステーションを添えます。 `paymentVerification` が必須である点を除き、`/challenge/send-email` と同じです。添えるべき決済がない場合は、そちらのAPIを使用してください。このアテステーションは、組織でTransactions機能が有効になっている場合にのみ読み取られ、それ以外の場合は無視されます。
年齢確認リクエストのステータスを取得する GET
年齢確認リクエストの現在の状態を返します。年齢確認を開始した後のポーリングや、Webhookをサーバー側で確認する用途に使用します。 リクエストは `PENDING` から `IN_PROGRESS` へ進み、最終的に `PASS` または `FAIL` に確定します。確定したリクエストには、確認された内容(推定年齢、年齢カテゴリ、使用された方法)と、失敗した場合はその理由も含まれます。`PASS` と `FAIL` 以外はすべて処理中として扱ってください。