このトピックでは、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 オペレーションを呼び出し、SDK とサンプルコードを取得する方法については、「OpenAPI Explorer を使用したサーバー側 API オペレーションのデバッグと統合」をご参照ください。
この API は、OpenAPI Explorer で直接実行してデバッグし、SDK コード例 を生成できます。
リクエストパラメーター
パラメーター | 型 | 必須 | 説明 | 例 |
ProductCode | String | はい | 使用するソリューション。有効な値: eKYC: eKYC ソリューション。ユーザーはドキュメント認識と顔のライブネス検証の両方を完了します。 | eKYC |
MerchantBizId | String | はい | トラブルシューティング目的で定義する一意のビジネス識別子。値は最大 32 文字と数字の組み合わせにできます。 説明 Alibaba Cloud はこの値の一意性をチェックしません。トラブルシューティングを簡素化するために、この値が一意であることを確認してください。 | 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。値は最大 10 文字、数字、またはアンダースコア (_) の組み合わせにできます。 | 1234567890 |
IdSpoof | String | いいえ | ドキュメントのなりすまし防止検出を有効にするかどうかを指定します。
| Y |
Authorize | String | いいえ | 公式データベースに対する本人確認を有効にするかどうかを指定します。
説明 この機能は現在、中国本土の第二世代住民 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 中に認識結果ページを表示するかどうかを指定します。
| 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 | 中国 (香港) 身分証明書 (2003 年版) |
00000008 | 中国 (香港) 身分証明書 (2018 年版) |
00000007 | 香港・マカオ往来通行証 |
00000009 | 香港・マカオ居住者向け本土往来通行証 |
000000011 | マカオ (中国) 身分証明書 |
000000012 | 台湾居住者向け本土往来通行証 |
00000001 | 中国本土の第二世代住民 ID カード |
応答データ
パラメーター | 型 | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP Body | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF0**** |
Code | String | 詳細については、「応答コード」をご参照ください。 | Success | |
Message | String | 応答コードの詳細な説明。 | success | |
Result.TransactionId | String | 検証フロー全体の一意の識別子。このパラメーターは、課金統計および CheckResult API オペレーションリクエストを開始するために使用されます。 重要
| hksb7ba1b28130d24e015d******** | |
Result.TransactionUrl | String | ウェブ検証 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 | サービスが利用できません。トラブルシューティングのためにエンジニアに連絡してください。 |