ID Verification は顔検索をサポートしています。ID Verification コンソール、または本 API を呼び出して、顔グループを作成し、顔画像を追加できます。
API 情報
API 名: AddFaceRecord
リクエストメソッド: POST
トランスポートプロトコル: HTTPS
QPS 制限: 単一テナントに対するリクエストレートは 50 QPS に制限されます。
エンドポイント:
説明異なる ID Verification ソリューションは、異なるリージョンをサポートしており、データは各リージョン間で分離されています。ご自身のデータにアクセスするには、データが格納されているリージョンに対応する API ドメイン名を使用する必要があります。
シンガポール
パブリックエンドポイント:
cloudauth-intl.ap-southeast-1.aliyuncs.com内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
インドネシア (ジャカルタ)
パブリックエンドポイント:
cloudauth-intl.ap-southeast-5.aliyuncs.com内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
中国 (香港)
パブリックエンドポイント:
cloudauth-intl.cn-hongkong.aliyuncs.com内部エンドポイント:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
マレーシア (クアラルンプール)
パブリックネットワーク:
cloudauth-intl.ap-southeast-3.aliyuncs.com内部ネットワーク:
cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com
オンラインデバッグおよび連携
デバッグまたは連携を実施する前に、OpenAPI を使用したサーバー側 API のデバッグおよび連携手順をご参照ください。OpenAPI プラットフォーム上での API 呼び出し方法および SDK の取得方法について説明しています。
この API を直接実行およびデバッグするには、OpenAPI Explorer を使用します。また、SDK コード例を生成できます。
画像アップロード要件
画像形式: JPG、JPEG。
画像サイズ: 推奨サイズは 50 KB ~ 100 KB です。最大ファイルサイズは 10 MB です。1 MB を超える画像は、URL またはファイルストリームを使用してアップロードしてください。
画像解像度: 推奨解像度は 640×480 ピクセル(高さ × 幅)です。最大解像度は 1920×1080 ピクセルです。画像の高さは幅より大きくする必要があります。最適な結果を得るには、短辺を 720 ピクセルにスケーリングし、圧縮率を 0.8 に設定してください。
画像品質: 画像は鮮明で、適切な露出である必要があります。顔が暗すぎたり明るすぎたり、ハローが発生したりしないようにしてください。
顔検出: 画像に複数の顔が含まれている場合、システムはデフォルトで最も大きな顔を検出します。
リクエストパラメーター
顔画像をアップロードするには、以下のいずれかのパラメーターを使用します: FacePicture、FacePictureUrl、または FacePictureFileObject。
パラメーター | 型 | 説明 | 必須 | 例 |
ProductCode | string | プロダクトコード。これは静的フィールドです。値: FACE_ENROLL | はい | FACE_ENROLL |
FaceGroupCode | string | 顔グループのコード。 | はい | sgl****7uc |
MerchantUserId | string | カスタムの固有ユーザー ID(最大 32 文字)。
| いいえ | 130A2C10B9EE4D8488E35384FF03hst |
FacePicture | string | 顔画像の Base64 エンコード文字列。 | いいえ | base64 |
FacePictureUrl | string | 顔画像の URL。 | いいえ | https://example.com/test.jpg |
FacePictureFileObject | InputStream | 顔画像のローカルファイルストリーム。 この方法で画像をアップロードするには、Advance API を呼び出し、有効な InputStream オブジェクトを渡す必要があります。詳細については、「特殊シナリオ: ファイルアップロード用の Advance API の設定」をご参照ください。 | いいえ | 画像の InputStream オブジェクト |
FaceQualityCheck | string | 顔画像の品質チェックを実行するかどうかを指定します。
説明 予約機能です。現時点ではサポートされていません。 | いいえ | N |
レスポンスパラメーター
パラメーター | 型 | 説明 | 例 | |
HTTP ステータスコード | integer | HTTP ステータスコード。 | 200 | |
HTTP ボディ | RequestId | string | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | string | Success | ||
Message | string | リターンコードの説明。 | リクエストは正常に完了しました。 | |
Result.Passed | string | 登録結果。
| Y | |
Result.ExtFaceInfo | string | 登録結果の詳細(JSON 形式)。例をご参照ください。 詳細については、「ExtFaceInfo」をご参照ください。 | | |
ExtFaceInfo
パラメーター | 型 | 説明 | 例 |
faceQuality | string | 画像品質。
| HIGH |
リターンコード
HTTP ステータスコード | Code | 説明 |
200 | Success | リクエストは正常に完了しました。 |
400 | MissingParameter | 必須パラメーターが不足しています。 |
InvalidParameter | 指定されたパラメーターが無効です。 | |
403 | Forbidden.RAMUserAccessDenied | RAM ユーザーに必要な権限がありません。このユーザーに AliyunAntCloudAuthFullAccess 権限を付与してください。詳細については、「RAM ユーザーへの権限付与」をご参照ください。 |
Forbidden.AccountAccessDenied | アカウントへのアクセスが拒否されました。ID Verification が有効化されていること、およびアカウントに支払い遅延がないことを確認してください。 | |
Throttling.Api | API 呼び出しがスロットルされました。 | |
500 | InternalError | 内部システムエラーが発生しました。テクニカルサポートまでお問い合わせください。 |
503 | ServiceUnavailable | サービスが利用できません。テクニカルサポートまでお問い合わせください。 |