このトピックでは、サーバーサイドで ID Verification の Id2MetaPeriodVerifyIntl API 操作と統合する方法について説明します。
API の説明
API 操作: Id2MetaPeriodVerifyIntl
リクエストメソッド: HTTPS POST
説明: この操作は、名前、ID カード番号、および ID カードの有効期間の開始日と終了日が、信頼できるソースと照合して真正かつ一貫性があることを検証します。
重要中国本土の第 2 世代居住者 ID カードのみがサポートされています。
QPS 制限: この 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
オンラインデバッグと統合
デバッグと統合を開始する前に、「OpenAPI Explorer を使用してサーバーサイド API をデバッグおよび統合する」ドキュメントを読んで、OpenAPI Explorer で API を呼び出し、SDK とそのコードを取得する方法を理解してください。
OpenAPI Explorer を使用すると、この API 操作の実行とデバッグ、およびSDK コードサンプルの生成が可能です。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 | 例 |
ProductCode | String | はい | 統合する製品ソリューション。 値を eKYC_Date_MIN に設定します。 | eKYC_Date_MIN |
SceneCode | String | いいえ | カスタム認証シナリオ ID。 この ID を使用して、コンソールで関連レコードをクエリできます。 ID は最大 10 文字で、文字、数字、およびアンダースコア (_) を含めることができます。 | 1234567890 |
MerchantBizId | String | はい | カスタマイズできる一意のビジネス識別子。 この識別子を使用して、問題の特定とトラブルシューティングを行います。 識別子は最大 32 文字で、文字と数字を含めることができます。 識別子が一意であることを確認してください。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | いいえ | カスタム ユーザー ID または特定のユーザーの別の識別子 (携帯電話番号やメールアドレスなど)。 このフィールドの値は、事前にハッシュ化などして機密化してください。 | a1b2c3d4e5f64g7h8i9j0k1l2m3n4**** |
DocType | String | はい | 証明書のタイプ。 8 桁の数字で一意に識別されます。 現在、中国本土の第 2 世代居住者 ID カードのみがサポートされています。 値を静的フィールド 00000001 に設定します。 詳細については、「証明書のタイプ」をご参照ください。 | 00000001 |
DocName | String | はい | ユーザーの名前。 | John Doe |
DocNo | String | はい | ユーザーの証明書番号。 | 411xxxxxxxxxxx0001 |
ValidityStartDate | String | はい | 有効期間の開始日。 フォーマットは YYYYMMDD です。 | 20201001 |
ValidityEndDate | String | はい | ID カードの有効期限。 フォーマットは YYYYMMDD です。 説明 ID カードが長期有効な場合、このパラメーターには long-term と入力してください。 | 20301001 |
レスポンスデータ
名前 | タイプ | 説明 | 例 | |
HTTP ステータスコード | 整数 | HTTP ステータスコード。 | 200 | |
HTTP 本文 | リクエスト ID | 文字列 | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
コード | 文字列 | success | ||
メッセージ | 文字列 | レスポンスコードの詳細な説明。 | success | |
Result.Passed | 文字列 | 最終的な認証結果。有効な値：
| Y | |
Result.SubCode | 文字列 | 認証結果の説明。詳細については、「ResultObject.SubCode エラーコード」をご参照ください。 | 200 | |
ステータスコード
HTTP ステータスコード | コード | メッセージの説明 |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | パラメーターは空にできません。 |
InvalidParameter | 無効なパラメーターです。 | |
403 | Forbidden.RAMUserAccessDenied | RAM ユーザーに AliyunAntCloudAuthFullAccess 権限を付与する必要があります。詳細については、「RAM ユーザーにサービスへのアクセスを承認する」をご参照ください。 |
Forbidden.AccountAccessDenied | 本人確認が有効化されており、アカウントに支払い遅延がないことを確認してください。 | |
Throttling.Api | API リクエストは速度制限のためブロックされています。 | |
500 | InternalError | 内部システムエラーです。トラブルシューティングについては、エンジニアにフィードバックを提供してください。 |
ResultObject.SubCode エラーコード
エラーコード | 課金対象 | 説明と提案 |
200 | はい | 情報は一貫性があります。認証は合格です。 |
202 | はい | 公式データベースにID 情報が見つかりません。 ユーザーの情報が間違っているか、不正な可能性があります。ユーザーに情報を確認して再試行するように依頼してください。 ユーザーの情報が正しいことが確認された場合は、手動レビュー用のエントリを提供してください。 |
223 | はい | 氏名とID カード番号が一致しないか、ID カードの有効期間の開始日と終了日が公式データベースの情報と一致しません。 ユーザーの情報が間違っているか、不正な可能性があります。ユーザーに情報を確認して再試行するように依頼してください。 |