Verify with Wallet APIの概要

エンタイトルメントの申請

Verify with Wallet APIを使用する場合は、デベロッパアカウントにエンタイトルメントが割り当てられている必要があります。Apple Developer ProgramのAccount Holderは、Verify with Wallet APIのエンタイトルメントを申請できます。申請はバンドルID（アプリの固有識別子）単位で許可され、割り当てられたエンタイトルメントは、そのバンドルIDに関連付けられている1つのバイナリでのみ使用できます。

エンタイトルメントを受けるアプリの利用要件は以下の通りです。

• 該当する地域において、同じ商品やサービスを利用する各ユーザーに、年齢／本人確認に関する同等のプロセスを義務付けている場合。
• 以下のいずれかのカテゴリに該当する場合。

• アクセス（警備／物理的なセキュリティ）
• 航空旅行
• 酒類の購入（事前注文と配送）
• レンタカー
• 金融サービス
• ギグエコノミー
• 行政サービス
• ヘルスケア
• ホスピタリティ
• 保険
• スクーターレンタル
• チケット

これらのカテゴリでは、デベロッパは従来の確認方法に代わる安全でプライバシーを重視した代替手段を得ることができ、ユーザーが手動で個人情報をアップロードする必要がなくなります。上記以外のカテゴリに関心をお持ちの場合は、エンタイトルメント申請フォームにVerify with Wallet APIをどのように使用されたいかをご記載ください。今後の導入について検討いたします。

提供する必要がある情報

アプリ情報

• アプリ名
• バンドルID（アプリ固有の識別子）
• App StoreまたはTestFlightのURL
• App ClipアプリID（利用可能な場合）
• アプリを通じて提供する商品やサービスのうち年齢／本人確認が必要になる内容の説明
• AppleウォレットのIDを使用していないユーザーの年齢／本人確認プロセスのスクリーンショット

リクエスト可能なデータ

使用に関する情報

• アプリを通じて提供する商品やサービスのうち、年齢／本人確認が必要となる内容と、現在の確認方法を説明します。
• AppleウォレットのIDを使用するユーザーに対して提案される年齢／本人確認プロセスのスクリーンショットと、AppleウォレットのIDを使用していないユーザーに対する既存または提案される年齢／本人確認プロセスのスクリーンショットをアップロードします。
• アプリのプライバシーポリシーと、Verify with Wallet用に各種データを収集または保持する各サードパーティのプライバシーポリシーへのURLリンクを提供します。

APIの実装

Verify with Wallet APIのエンタイトルメントを受け取ったら、PassKitフレームワークでVerify with Wallet APIを呼び出し、リクエストする情報を指定できます。アプリ間で一貫した体験を提供できるように、APIには専用のボタンが一式用意されています。年齢／本人確認を求める必要があるアプリでご利用ください。ボタンをタップすると、情報共有のリクエストについて説明するシートが表示され、ユーザーは同意するかキャンセルするかを選択できます。ユーザーが同意すると、アプリには暗号化された応答が届き、サーバに渡されて復号と検証が行われます。

ローカライズされたボタン

ドキュメント、ビデオ、リソース

• AppleウォレットのID：プライバシーとセキュリティの概要
• ヒューマンインターフェイスガイドライン：本人確認
• ウォレットパスのIDデータのリクエスト
• ウォレットIDリクエストの確認
• PKIdentityDriversLicenseDescriptor
• PKIdentityNationalIDCardDescriptor
• サンプルデータとシミュレータキー
• ウォレットおよびApple mDL Developer Integratorプロファイル
• デベロッパフォーラム
• フィードバックアシスタント

発行機関証明書

ユーザーの発行機関のペイロードを確認するには、その発行機関のWebサイトからIACA証明書をダウンロードして使用する必要があります。

米国

• アリゾナ州のIACA証明書
• カリフォルニア州のIACA証明書
• コロラド州のIACA証明書
• ジョージア州のIACA証明書
• ハワイ州のIACA証明書
• アイオワ州のIACA証明書
• メリーランド州のIACA証明書
• ニューメキシコ州のIACA証明書
• オハイオ州のIACA証明書
• プエルトリコのIACA証明書

日本

• 日本政府のIACA証明書

  注：関連法により、マイナンバーカードを用いた本人確認サービスでは、機能の認定プロセスを経る必要があります。詳しくは、日本のデジタル庁のWebサイトをご参照ください。

よくある質問

APIの使用

エンタイトルメントが付与されたのち、デベロッパアカウントとXcodeプロジェクトを設定するにはどうすればよいですか？

Apple Developer Webサイトの「Certificates, Identifiers, & Profiles（証明書、ID、プロファイル）」セクションで、以下の操作を行います。

1. マーチャントIDを作成します。マーチャントIDをすでにお持ちで、Apple Payで使用している場合は、ここで再利用できます。
2. マーチャントIDの「Identity Access Certificate（IDアクセス証明書）」を作成します。これは、「Edit or Configure a Merchant ID（マーチャントIDの編集または設定）」ページの「Identity（ID）」タブに表示されます。
   1. 暗号化証明書の秘密鍵は、APIから返されたencryptedDataを復号するためにサーバで使用されます。
3. アプリIDに「In App Identity Presentment（アプリでのID提示）」機能を追加します。これは、「Edit your App ID Configuration（アプリIDの設定を編集）」ページの「Additional Capabilities（追加機能）」タブに表示されます。
4. アプリIDに「In App Identity Presentment Merchant IDs（アプリでのID提示のマーチャントID）」機能を追加し、関連付けられているマーチャントIDを選択します。
5. これらの変更を含むプロビジョニングプロファイルを新規作成します。

また、アプリのエンタイトルメントplistファイルを手動で構成する必要があります。

エンタイトルメント 1：

エンタイトルメントを申請して、エンタイトルメントの取得が必要な本人確認書類のタイプを選択します。

"com.apple.developer.in-app-identity-presentment": {
    "document-types": [
        "us-drivers-license"
    ],
    "elements": [
        "given-name",
        "family-name",
        "portrait",
        "address",
        "issuing-authority",
        "document-expiration-date",
       	"document-number",
        "driving-privileges",
        "age",
        "date-of-birth"
    ]
},

エンタイトルメントのリストをフィルタリングして、エンタイトルメントを申請したものだけにします。

エンタイトルメント 2：

"com.apple.developer.in-app-identity-presentment.merchant-identifiers": [
    “your-merchant-id-goes-here”
]

Apple Payで同じマーチャントIDを使用している場合でも、このエンタイトルメントを追加する必要があります。Apple Payのcom.apple.developer.in-app-paymentsエンタイトルメントは、本人確認では認識されません。

ブラウザベースのオンライン提示では、W3Cが定めるmDoc request APIをサポートする予定です。最終的な定義は未定ですが、適切なプライバシーとセキュリティのガイドラインを満たすサードパーティアプリからの適合するID認証情報を提示することが可能になります。

APIの使用をテストするにはどうすればよいですか？

APIの使用をテストするには、いくつかの方法があります。

• iOSシミュレータを使用する：シミュレータにはモックデータがプリロードされており、APIとの統合をテストできます。シミュレータのモックデータからの応答を検証するために必要なキーやその他のリソースについて、詳しくはサンプルデータとシミュレータキーバンドルをダウンロードしてください。
• iOSデバイスの場合：ウォレットおよびApple mDL Developer Integratorプロファイルをインストールすると、APIは実際のデバイス署名を含むモックデータを返しますが、発行者の署名は返しません。
• テストサンプル：サンプルデータとシミュレータキーバンドルには、検証に必要なキーと証明書を網羅した応答のサンプルが含まれています。このサンプルを使用して、応答検証ロジックをテストできます。

IDデータのリクエストに使用する記述子を教えてください。

IDデータのリクエストには、PKIdentityNationalIDCardDescriptorを使用します。

注：日本固有のエレメントは、API region（APIの地域）をJPに設定した場合にのみ取得できます。