ID Verification:身分証明書 OCR （最小限プラン）

名前

タイプ

必須

説明

例

ProductCode

文字列

はい

使用するプロダクトプラン。 値を ID_OCR_MIN に設定して、身分証明書 OCR API を使用します。

ID_OCR_MIN

SceneCode

文字列

いいえ

認証シナリオのカスタム ID 。 この ID を使用して、コンソールで関連レコードをクエリできます。 ID は最大 10 文字で、文字、数字、およびアンダースコア (_) を使用できます。

1234567890

MerchantBizId

文字列

はい

問題の追跡とトラブルシューティングに使用されるカスタムの一意のビジネス ID 。 ID は最大 32 文字で、文字と数字を含めることができます。 ID が一意であることを確認してください。

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

文字列

はい

カスタムユーザー ID または特定のユーザーの別の識別子 (携帯電話番号やメールアドレスなど)。 この値は事前にハッシュ化などして機密化することを強くお勧めします。

123456789

IdOcrPictureBase64

文字列

はい

身分証明書の表面側の base64 エンコードされた画像。 [IdOcrPictureBase64] (base64 エンコードされた写真) を使用して身分証明書の写真を提供する場合は、写真のサイズを確認してください。 サイズが大きすぎる写真は提供しないでください。

base64

IdOcrPictureUrl

文字列

はい

身分証明書の表面側の画像の URL 。 URL は、インターネット経由でアクセスできる HTTP または HTTPS リンクでなければなりません。

https://***

DocType

文字列

はい

身分証明書のタイプ。 8 桁の数字で構成される一意の識別子です。 詳細については、「ドキュメントタイプのリスト」をご参照ください。

F

Ocr

文字列

はい

ドキュメント情報を自動的に抽出するために OCR 機能を有効にするかどうかを指定します。

• T: OCR 機能を有効にします。

• F: OCR 機能を無効にします。

T

IdFaceQuality

文字列

いいえ

身分証明書の顔の品質スコアを返すかどうかを指定します。 この機能はデフォルトで無効になっています。

• T: 顔の品質スコアを返します。

• F: 顔の品質スコアを返しません。

F

Spoof

文字列

いいえ

身分証明書のなりすまし対策機能を有効にするかどうかを指定します。 この機能はデフォルトで無効になっています。

• T: なりすまし対策機能を有効にします。

• F: なりすまし対策機能を無効にします。

F

IdThreshold

文字列

いいえ

3

CardSide

文字列

いいえ

身分証明書の面を指定します。 このパラメータを渡さない場合、デフォルトで表面側が使用されます。

• OCR_ID_FACE (デフォルト): 表面側

• OCR_ID_NATIONAL_EMBLEM: 国章側

OCR_ID_NATIONAL_EMBLEM

名前

タイプ

説明

例

HTTP ステータスコード

整数

HTTP ステータスコード。

200

HTTP 本文

RequestId

文字列

リクエスト ID 。

130A2C10-B9EE-4D84-88E3-5384FF039****

Result.TransactionId

文字列

認証プロセス全体の一意の ID 。

hksb7ba1b28130d24e015d694361b****

Code

文字列

ステータスコード。

Success

Message

文字列

レスポンスコードの詳細な説明。

success

Result.Passed

文字列

認証結果。 有効な値:

• Y: 合格

• N: 不合格

Y

Result.SubCode

文字列

認証結果の説明。 詳細については、「ResultObject.SubCode エラーコード」をご参照ください。

200

Result.ExtIdInfo

文字列

身分証明書認識結果に関する情報。 JSON 形式については、右側の例を参照してください。 詳細については、「ExtIdInfo」をご参照ください。

{
  "idFaceQualityScore": 98.0,
  "ocrIdInfo": {
    "expiryDate": "",
    "originOfIssue": "公安部出入国管理局", // 翻訳済みコメント
    "englishName": "LI SI",
    "sex": "Male",
    "name": "李四", // 翻訳済みコメント
    "idNumber": "H11111112",
    "issueDate": "2013-01-02",
    "birthDate": "1990-02-21"
  },
  "spoofInfo": {
    "spoofResult": "Y",
    "spoofType": [
      "SCREEN_REMARK"
    ]
  }
}