決済確認を添えてメールを送信する

保護者への同意リクエストをメールで送信する際に、その背後にある購入について成人がすでに決済を完了したというアテステーションを添えます。 `paymentVerification` が必須である点を除き、`/challenge/send-email` と同じです。添えるべき決済がない場合は、そちらのAPIを使用してください。このアテステーションは、組織でTransactions機能が有効になっている場合にのみ読み取られ、それ以外の場合は無視されます。

Authorization

api-key

AuthorizationBearer <token>

In: header

Header Parameters

Kid-Target-Product-Id?integer

Optional header for Account System Products to perform cross-product age gate checks. The value must be the product ID of the target product within the same organization. The target product must not itself be an Account System Product.

Request Body

application/json

Send email with payment verification request

TypeScript Definitions

Use the request body type in TypeScript.

challengeId*string

The ID of the challenge

Match^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$

Formatuuid

email?string

The email address of the parent or guardian. If omitted, the guardian on record for the challenge is used.

Formatemail

locale?string

The locale to use for the email using IETF BCP 47.

Match^[A-Za-z]{2,3}(-[A-Za-z0-9]+)*$

paymentVerification*

Your attestation that an adult completed a payment for this purchase through your merchant of record. k-ID neither processes nor witnesses the payment, so you are responsible for sending only real, completed payments.

k-ID carries the attestation into the parental-consent flow unchanged, as a signed claim on the challenge token, and decides there whether it satisfies consent. It never shortens or removes a step on its own: where the attestation does not qualify, the parent completes the standard parental-consent flow.

Describe the payment using k-ID's fields rather than your provider's; k-ID reads the same fields whichever provider you use.

Only read on a parental-consent challenge, and only when the Transactions capability is enabled for your organization. Otherwise it is ignored.

Response Body

`application/json`

curl -X POST "https://example.com/challenge/send-email-with-payment-verification" \  -H "Content-Type: application/json" \  -d '{    "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802",    "paymentVerification": {      "provider": "xsolla",      "invoiceId": "2110445753",      "payerEmail": "parent@example.com",      "instrument": "card",      "funding": "credit"    }  }'

{}

{  "error": "NOT_FOUND",  "errorMessage": "Challenge not found"}

決済確認を添えてメールを送信する

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

Example Not found

Example Invalid email

Example Email mismatch

Example Approver required

`application/json`

`application/json`