Endpoints年齢確認
年齢確認リクエストのステータスを取得する
年齢確認リクエストの現在の状態を返します。年齢確認を開始した後のポーリングや、Webhookをサーバー側で確認する用途に使用します。 リクエストは `PENDING` から `IN_PROGRESS` へ進み、最終的に `PASS` または `FAIL` に確定します。確定したリクエストには、確認された内容(推定年齢、年齢カテゴリ、使用された方法)と、失敗した場合はその理由も含まれます。`PASS` と `FAIL` 以外はすべて処理中として扱ってください。
Authorization
api-key AuthorizationBearer <token>
In: header
Query Parameters
id*string
The ID of the age verification request
Match
^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$Format
uuidincludeDob?boolean
If set to true, includes the verified date of birth (dob) field in the response when available
Default
falseResponse Body
application/json
curl -X GET "https://example.com/age-verification/get-status?id=ae6d4729-af32-42ea-8ef2-ff46c7664802"{ "id": "ae6d4729-af32-42ea-8ef2-ff46c7664802", "status": "PASS", "age": { "low": 18, "high": 20 }, "ageCategory": "adult", "method": "id-document"}メールを送信する POST
チャレンジの詳細を指定のメールアドレスに送信します。多くの場合、保護者への同意リクエストの送信に使用します。 チャレンジは事前に作成されている必要があります。このAPIは配信のみを行います。再送する場合はもう一度呼び出してください。
アクセス年齢確認を実行する POST
アクセス年齢確認を開始し、iframeに表示するホスト型のURLを返します。既存のセッションをアップグレードするのではなく、確認済みの年齢に基づいてプロダクトや機能へのアクセスを制限する場合に使用します。 プレイヤーは返されたURLで年齢確認を完了します。結果は `/age-verification/get-status` またはWebhookから取得してください。