このトピックでは、Initialize オペレーションを呼び出して検証リクエストを開始する方法について説明します。
検証リクエストを開始する
オペレーション名:Initialize。
エンドポイント:cloudauth-intl.cn-hongkong.aliyuncs.com。
リクエストメソッド:HTTPS POST。
オペレーションの説明:検証プロセスを開始する前に、このオペレーションを呼び出して、検証プロセスに含まれるさまざまなオペレーションのトランザクション ID を取得する必要があります。
QPS 制限:API のクエリ/秒(QPS)に制限が課せられます。 詳細については、「ID Verification - KYC サーバーサイド API の QPS 制限」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
ProductCode | String | はい | 使用するソリューション。 値を FACE_VERIFY に設定します。 | FACE_VERIFY |
MerchantBizId | String | はい | ビジネスの一意の識別子。トラブルシューティングに使用されます。 32 文字以内で、英字と数字を含む値を指定できます。 値が一意であることを確認してください。 説明 ID Verification は、値の一意性をチェックしません。追跡のために、一意の値を指定することをお勧めします。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MetaInfo | String | はい | 環境パラメーター。JavaScript ファイルを追加し、getMetaInfo() 関数を呼び出すことによって取得されます。 詳細については、「モバイル H5 ページ経由で FACE_VERIFY に接続する」をご参照ください。 説明 取得したパラメーターを環境パラメーターとして指定します。パラメーターを変更する必要はありません。 |
|
MerchantUserId | String | はい | 顧客の ID。携帯電話番号やメールアドレスなどのカスタム値を指定できます。値を指定する前に、データマスキングを実行することをお勧めします。たとえば、ハッシュを実行できます。 | 123456789 |
ReturnUrl | String | はい | ビジネスページのリダイレクト URL。 | https://www.alibabacloud.com |
SceneCode | String | いいえ | カスタム検証シナリオの ID。 ID Verification コンソールに ID を入力して、関連レコードをクエリできます。 10 文字以内で、英字、数字、およびアンダースコア(_)を含むカスタム値を指定できます。 | 1234567890 |
FacePictureBase64 | String | いいえ | 画像の Base64 ベースのコンテンツ。 FacePictureBase64 パラメーターを指定して画像をアップロードする場合、画像は次の要件を満たしている必要があります。
| /9j/4AAQSkZJRgABAQAASASBC**** |
FacePictureUrl | String | いいえ | 画像の URL。 URL は、インターネット経由でアクセスできる HTTP または HTTPS URL である必要があります。 説明 ProductCode を FACE_VERIFY に設定する場合は、FacePictureBase64 と FacePictureUrl パラメーターの少なくとも 1 つを指定する必要があります。 | https://cn-shanghai-aliyun-cloudauth-****.oss-cn-shanghai.aliyuncs.com/verify/****.jpeg |
LanguageConfig | String | いいえ | カスタム言語構成。追加する言語構成を、構成テンプレートに基づいて JSON 文字列に変換します。次に、このパラメーターを指定して、カスタム言語構成を追加します。 詳細については、「カスタムテキストと国際化設定を構成する」をご参照ください。 説明 このパラメーターは、Web SDK モードを使用して統合する場合にのみ適用されます。このパラメーターは、PC ページを使用して統合する場合にはサポートされていません。 |
|
SecurityLevel | String | いいえ | 検証プロセスのさまざまなセキュリティレベルのモード。有効な値:
| 02 |
StyleConfig | String | いいえ | カスタム UI 構成。追加する UI 構成を、構成テンプレートに基づいて JSON 文字列に変換します。次に、このパラメーターを指定して、カスタム UI 構成を追加します。 詳細については、「ID Verification - KYC のカスタム UI 構成」をご参照ください。 |
|
Model | String | いいえ | 実行する生体検知のタイプ。有効な値:
説明
| PHOTINUS_LIVENESS |
DocVideo | String | いいえ | 証拠ビデオを保存するかどうかを指定します。有効な値:
説明
| N |
ShowGuidePage | String | いいえ | ガイドページを表示するかどうかを指定します。有効な値:
説明 この設定は PC ではサポートされていません。 | 1 |
ProcedurePriority | String | いいえ | モバイル H5 ページでの検証プロセス中に互換性の問題が発生した場合に、代替アクセス方法を表示するかどうかを指定します。有効な値:
説明
| url |
CallbackUrl | String | いいえ | 検証結果を通知するために使用されるコールバック URL。デフォルトでは、GET メソッドを使用してコールバックリクエストが送信されます。コールバック URL は https で始まる必要があります。検証が完了すると、システムはコールバック URL にコールバックリクエストを送信し、次のフィールドをコールバックリクエストに自動的に追加します。
警告 コールバック URL が使用される前に、システムは URL がアクセス可能かどうかを確認します。URL がインターネット経由でアクセスできない場合、状態コード 400 が返されます。 | https://www.aliyun.com?callbackToken=100000****&transactionId=shaxxxx&passed=Y&subCode=200 |
CallbackToken | String | いいえ | 重複防止および改ざん防止検証に使用されるセキュリティトークン。カスタム値を指定できます。 このパラメーターを構成すると、コールバック URL に送信されるコールバックリクエストに CallbackToken フィールドが含まれます。 | NMjvQanQgplBSaEI0sL86WnQplB |
AppQualityCheck | String | いいえ | 厳格な顔品質検出機能を有効にするかどうかを指定します。有効な値:
| Y |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP 本文 | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | リクエストに対して返されるコード。 詳細については、「コードとメッセージの説明」をご参照ください。 | Success | |
Message | String | リクエストに対して返されるメッセージ。 | Success | |
Result.TransactionId | String | 検証プロセスの一意の識別子。 このパラメーターは課金に使用されます。 このパラメーターは、CheckResult オペレーションの呼び出しにも使用されます。 説明 リクエストで無効なパラメーターに関するエラーなどのエラーが発生した場合、Result.TransactionId は返されません。 | hksb7ba1b28130d24e015d694361**** | |
Result.TransactionUrl | String | Web 検証 URL。 検証が完了すると、ReturnUrl リクエストパラメーターに指定された URL にリダイレクトされます。 重要
| https://www.alibabacloud.com/index.html?clientcfg=**** |
コードとメッセージの説明
HTTP ステータスコード | コード | メッセージの説明 |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | 必須パラメーターが空です。 |
InvalidParameter | パラメーターが無効な値に設定されています。 | |
401 | NoFaceDetected | 比較対象となる正式なソースの画像から顔の特徴を抽出できませんでした。別の画像をアップロードすることをお勧めします。 |
UnqualifiedPhoto | 指定された画像を読み取れないか、画像の解像度が要件を満たしていません。 有効な画像をアップロードすることをお勧めします。画像が鮮明で完全であり、障害物がなく、露出レベルが正常であり、画像が大きく傾いていないことを確認してください。 | |
ToolargeImage | 画像のサイズが大きすぎます。画像を圧縮するか、画像のアップロード方法を変更することをお勧めします。 | |
DownloadTimeout | URL からの画像のダウンロードがタイムアウトしました。 | |
403 | Forbidden.RAMUserAccessDenied | AliyunAntCloudAuthFullAccess ポリシーが Resource Access Management(RAM)ユーザーにアタッチされていません。 詳細については、「RAM ユーザーに ID Verification - KYC へのアクセスを承認する」をご参照ください。 |
Forbidden.AccountAccessDenied | アカウントの支払いが遅延しています。アカウントへの入金を行い、再試行することをお勧めします。 | |
Throttling.Api | API 速度制限がトリガーされました。 | |
500 | InternalError | 内部エラーが発生しました。エラーをトラブルシューティングするには、エンジニアにフィードバックを送信することをお勧めします。 |