このトピックでは、Initialize 操作を呼び出して電子的な顧客確認 (eKYC) リクエストを開始する方法について説明します。
認証リクエストの開始
-
API 操作: Initialize
-
リクエストメソッド: HTTPS POST
-
説明: 各 eKYC 認証フローの前にこの API 操作を呼び出して、transactionId と transactionUrl を取得します。これらの値は、単一の認証リクエスト内のすべての API 操作を関連付けるために使用されます。
-
この API 操作には専用の QPS 制限があります。詳細については、「ID Verification サーバーサイド API 操作の QPS 制限」をご参照ください。
-
エンドポイント:
説明内部ネットワークアクセスの利点: 内部ネットワークは、同一リージョン内の Alibaba Cloud プロダクト間のプライベートな通信ネットワークです。ご利用のビジネスサーバーが対応する Alibaba Cloud リージョンにデプロイされている場合、内部の同一リージョンエンドポイントを使用して ID Verification サービスにアクセスできます。これにより、より安全で安定した通信が可能になります。
中国以外からのアクセスの最適化に関する提案: 中国以外のネットワーク環境は複雑になる可能性があります。統合ソリューションを最適化し、ネットワーク遅延を削減し、リクエストの失敗を最小限に抑えるには、「サーバーサイドのネットワーク遅延分析と最適化」をご参照ください。
中国 (香港)
パブリックネットワーク:
cloudauth-intl.cn-hongkong.aliyuncs.com内部ネットワーク:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
オンラインでのデバッグと統合
API 操作をデバッグおよび統合する前に、「OpenAPI Explorer を使用したサーバーサイド API 操作のデバッグと統合」で、API 操作の呼び出し方法、および OpenAPI Explorer で SDK とサンプルコードを取得する方法をご確認ください。
OpenAPI Explorer を使用して、この API 操作を直接デバッグし、 SDK コードサンプルを生成できます。
リクエストパラメーター
|
名前 |
タイプ |
必須 |
説明 |
例 |
|
ProductCode |
String |
はい |
使用するプロダクトソリューション。有効な値: eKYC: eKYC ソリューションでは、ユーザーはドキュメント検出と生体検知フローを完了する必要があります。 |
eKYC |
|
MerchantBizId |
String |
はい |
カスタマイズする一意のビジネス ID。問題の追跡とトラブルシューティングに使用されます。ID は最大 32 文字で、英数字を含めることができます。ID が一意であることを確認してください。 説明
Alibaba Cloud はこの ID が一意であるかどうかをチェックしません。追跡を容易にするために、ID が一意であることを確認してください。 |
e0c34a77f5ac40a5aa5e6ed20c35**** |
|
MetaInfo |
String |
はい |
MetaInfo 環境パラメーター。JS ファイルを介して getMetaInfo() 関数を呼び出して取得する必要があります。MetaInfo の取得方法の詳細については、対応するプラットフォームのクライアント統合ドキュメントをご参照ください。 重要
|
|
|
MerchantUserId |
String |
はい |
カスタムユーザー ID、または携帯電話番号やメールアドレスなどの他の一意の識別子。この値は、ハッシュ化などで事前にマスキング処理を施すことを強く推奨します。 |
123456789 |
|
ReturnUrl |
String |
いいえ |
プロセス完了後にユーザーがリダイレクトされる URL。 重要
このパラメーターは、カプセル化に iframe を使用する場合にのみオプションです。 |
https://www.alibabacloud.com |
|
DocType |
String |
はい |
ドキュメントタイプ。8 桁の数字で構成される一意の識別子です。詳細については、以下の表をご参照ください。 |
01000000 |
|
SceneCode |
String |
いいえ |
カスタム認証シナリオ ID。この ID を使用して、コンソールで関連レコードをクエリできます。ID は最大 10 文字で、英字、数字、アンダースコア (_) を含めることができます。 |
1234567890 |
|
IdSpoof |
String |
いいえ |
ドキュメントのなりすまし防止検出機能を有効にするかどうかを指定します:
|
Y |
|
Authorize |
String |
いいえ |
公式データベースに対する本人確認を有効にするかどうかを指定します:
説明
この機能は現在、中国本土の第 2 世代住民 ID カードでのみ利用可能です。 |
F |
|
LanguageConfig |
String |
いいえ |
カスタム言語設定。追加したい言語設定を設定テンプレートに基づいて JSON 文字列に変換します。その後、このパラメーターを指定してカスタム言語設定を追加します。詳細については、「国際化言語とカスタムテキストのサポート」をご参照ください。 |
|
|
SecurityLevel |
String |
いいえ |
認証フローの異なるセキュリティレベルを表すモード。有効な値:
|
02 |
|
StyleConfig |
String |
いいえ |
カスタム UI 設定。追加したい UI 設定を設定テンプレートに基づいて JSON 文字列に変換します。その後、このパラメーターを指定してカスタム UI 設定を追加します。詳細については、「IDV UI スタイルのカスタマイズ」をご参照ください。 |
|
|
IdThreshold |
String |
いいえ |
カスタム OCR 品質検出のしきい値モード:
|
0 |
|
Model |
String |
いいえ |
実行する生体検知のタイプ:
説明 サポートされている SDK のバージョンについては、「SDK リリースノート」をご参照ください。 |
PHOTINUS_LIVENESS |
|
DocVideo |
String |
いいえ |
認証ビデオを保存するかどうかを指定します。
説明 ビデオファイルはサイズが大きいため、ネットワークが不安定な場合、システムは重要な認証イメージの送信を優先するためにビデオファイルを破棄することがあります。 |
N |
|
ShowBlbumIcon |
String |
いいえ |
光学文字認識 (OCR) ステップで、アルバムアップロードのエントリを表示するかどうかを指定します:
|
1 |
|
ShowOcrResult |
String |
いいえ |
光学文字認識 (OCR) ステップで、OCR 結果ページを表示するかどうかを指定します:
|
1 |
|
ShowGuidePage |
String |
いいえ |
ガイドページを表示するかどうかを指定します: 説明
このスイッチは PC ではサポートされていません。
|
1 |
|
ProcedurePriority |
String |
いいえ |
モバイル H5 認証中に互換性の問題が発生した場合に、フォールバックソリューションを許可するかどうかを指定します。
説明
|
url |
|
CallbackUrl |
String |
いいえ |
認証結果通知用の Webhook アドレス。コールバックリクエストメソッドはデフォルトで GET です。Webhook アドレスは
警告
|
https://www.aliyun.com?callbackToken=100000****&transactionId=shaxxxx&passed=Y&subCode=200 |
|
CallbackToken |
String |
いいえ |
生成するセキュリティトークン。リプレイ防止および改ざん防止チェックに使用されます。 このパラメーターを設定すると、CallbackToken フィールドが CallbackUrl コールバックに含まれます。 |
NMjvQanQgplBSaEI0sL86WnQplB |
|
AppQualityCheck |
String |
いいえ |
顔の厳格な品質検出を有効にするかどうかを指定します: 重要
この機能は Web SDK ではサポートされていません。
|
Y |
|
EditOcrResult |
String |
いいえ |
ユーザーが OCR 結果ページで情報を編集できるかどうかを指定します。
|
0 |
ドキュメントタイプ一覧
|
DocType |
対応ドキュメント |
|
01000000 |
グローバルパスポート |
|
00000006 |
香港 ID カード (2003 年版) |
|
00000008 |
香港 ID カード (2018 年版) |
|
00000007 |
香港・マカオ往来通行証 |
|
00000009 |
香港・マカオ住民の中国本土への旅行許可証 |
|
000000011 |
マカオ ID カード |
|
000000012 |
台湾住民の中国本土への旅行許可証 |
|
00000001 |
中国本土の第 2 世代住民 ID カード |
戻りデータ
|
名前 |
タイプ |
説明 |
例 |
|
|
HTTP ステータスコード |
Integer |
HTTP ステータスコード。 |
200 |
|
|
HTTP 本文 |
RequestId |
String |
リクエスト ID。 |
130A2C10-B9EE-4D84-88E3-5384FF0**** |
|
Code |
String |
Success |
||
|
Message |
String |
応答コードの詳細な説明。 |
success |
|
|
Result.TransactionId |
String |
認証フロー全体の一意の識別子。このフィールドは、課金統計および CheckResult API 操作リクエストの開始に使用されます。 重要
|
hksb7ba1b28130d24e015d6******** |
|
|
Result.TransactionUrl |
String |
Web 認証 URL。認証後、ユーザーは ReturnUrl リクエストパラメーターに基づいてリダイレクトされます。 重要
|
https://www.alibabacloud.com/index.html?clientcfg=**** |
|
|
Result.Protocol |
String |
hksb7ba1b28130d24e015d********* |
||
応答コード
HTTP ステータスコード | コード | 説明 |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | パラメーターを空にすることはできません。 |
InvalidParameter | 無効なパラメーターです。 | |
401 | Forbidden.ExceptionRepeatedInvoke | 異常な呼び出しの繰り返し回数が制限を超えました。 |
403 | Forbidden.RAMUserAccessDenied | RAM ユーザーに AliyunAntCloudAuthFullAccess 権限を付与する必要があります。詳細については、「RAM ユーザーへのサービスへのアクセス権限の付与」をご参照ください。 |
Forbidden.AccountAccessDenied | ID Verification を有効にし、アカウントに支払い遅延がないことを確認してください。 | |
Throttling.Api | API リクエストは速度制限によりブロックされています。 | |
500 | InternalError | 内部システムエラー。トラブルシューティングのため、エンジニアにフィードバックを提供してください。 |
503 | ServiceUnavailable | サービスは利用できません。トラブルシューティングのためにエンジニアにお問い合わせください。 |