概要
API URL： POST
/api/v1/zoloz/idrecognition/asyncrecognizeAPI の説明： ZOLOZ ID 認識 asyncrecognize API は、非同期ドキュメント認識リクエストを初期化します。 recognize API を頻繁に呼び出す必要がある場合は、ネットワークの変動による応答タイムアウトを回避するために、asyncrecognize API を使用することをお勧めします。 API 呼び出しが完了すると、asynccheckresult API を使用してドキュメント検証結果を非同期に取得できます。
リクエスト
フィールドの仕様
フィールド名 | データ型 | 最大長 | デフォルト値 | 説明 | 例 |
bizId | 文字列 | 32B | - | 必須。追跡のためにクライアントが保持する一意の ID です。 | "trans-test-1234" |
docType | 文字列 | 32B | null | 任意。 ドキュメントの種類を指定します。
注： | "00000001003" |
autoDocTypes | リスト<文字列> | 200 | null | 任意。 ドキュメントの種類のリストを指定します。 パラメータ
サポートされているドキュメントの種類については、サポートされているドキュメントの種類と返される OCR 結果を参照してください。 | [ "08520000001", "08520000002" ] |
autoDocCategory | リスト<文字列> | - | null | 任意。任意。ドキュメントの種類のリストを指定します。 パラメータ
注： 統合のために必要な互換性のある操作を行ってください。 たとえば、返された | "ID_CARD" |
frontPageImage | 文字列 | 5MB | - | 必須。 ドキュメントの表面画像は、Base64 エンコードされた JPG、JPEG、PNG、および BMP 形式をサポートしています。 注： | "/9j/4AA..[省略]..PxA=" |
backPageImage | 文字列 | 5MB | - | 任意。必須。 ドキュメントの裏面画像は、Base64 エンコードされた JPG、JPEG、PNG、および BMP 形式をサポートしています。 注： | "/9j/4AA..[省略]..PxA=" |
operationMode | 文字列 | 32 | STANDARD | 任意。本人確認プロセスを実行する操作モードを指定します。 次の値がサポートされています。
| "STANDARD" |
sceneCode | 文字列 | 64 | null | 任意。 データ分析のためにビジネスシーンを指定します。 異なるシーンのデータパフォーマンスを区別したい場合は、 | "changePassword" |
userId | 文字列 | 64 | null | 任意。加盟店ユーザー ID、または特定のユーザーを識別するために使用できるその他の識別子。 たとえば、携帯電話番号、メールアドレスなど。 userId フィールドの値は、たとえば値をハッシュ化することにより、事前に非センシティブ化することを強くお勧めします。 | "trans-abc-1234" |
productConfig | ProductConfig | - | null | オプション。IDR プロダクトの詳細な制御を指定します。詳細については、「 productConfig」をご参照ください。 | { "consistencyCheck": [ { "type": "commonConsistencyCheck" }, { "details": [ "NAME", "SEX" ], "type": "mrzVisualConsistencyCheck" } ] } |
ProductConfig
フィールド名 | データ型 | 最大長 | デフォルト値 | 説明 | 例 |
pageInfoCheck | 配列 | - | null | 任意。 DOC なりすましチェックにおけるページ情報チェックを指定します。 詳細な検査項目については、DOC なりすましチェックコンポーネント を参照してください。 注：ページ情報チェックは、中国香港の身分証明書とマレーシアの Mykad にのみ適用されます。 | [ {"name":"id"}, {"name":"symbol"}, {"name":"name"} ] |
consistencyCheck | リスト<ConsistencyCheckItem> | - | null | 任意。 整合性チェックを実行するかどうかを指定します。 整合性チェックは、特定のドキュメントの特定のフィールドにのみ適用されます。 整合性チェックが必要な場合は、サポートされている情報チェックコンポーネントの配列を指定する必要があります。 このフィールドの有効な値については、整合性チェックデータ構造 を参照してください。 | [ { "type": "commonConsistencyCheck" }, { "details": [ "NAME", "SEX" ], "type": "mrzVisualConsistencyCheck" }, { "valueRange": [ "CHN", "PHL" ], "type": "passportCountryCheck" } ] |
allowExpiredDocument | 文字列 | - | ドキュメントの種類によってデフォルト値が異なります。
| 任意。期限切れのドキュメントを許可するかどうかを指定します。 次の値がサポートされています。
注：
| "N" |
cropFaceImageFromDoc | 文字列 | 1 | N | 任意。キャプチャされたドキュメント画像の顔領域を切り抜くかどうかを指定します。 有効な値は次のとおりです。
| "Y" |
enableOCR | 文字列 | - | N | 任意。OCR 機能を有効にするかどうか。 値は次のとおりです。
| "Y" |
spoofMode | 文字列 | 10 | CLOSED | 任意。このパラメータは、ドキュメントのなりすまし防止レベルを指し、次のように定義されます。
注：この機能を使用するには、Spoof プロダクトを購入する必要があります。 | "STANDARD" |
deeperMode | 文字列 | 10 | CLOSED | 任意。AIGC 攻撃検出の Deeper レベルでは、Deeper 検出機能の詳細な紹介を提供しています。 詳細については、Deeper とは を参照してください。 このパラメータは、次の値をサポートしています。
| "標準" |
ConsistencyCheckItem データ構造
共通整合性チェック
フィールド名 | データ型 | 値の範囲 | 説明 | サポートされているID / 国または地域 / docType / チェック対象のOCRフィールド |
type | String | commonConsistencyCheck | DOCなりすましチェック内のOCRフィールドの整合性チェック | Mykad / マレーシア / 00600000001 / ID_NUMBER
|
mrzVisualConsistencyCheck
フィールド名 | データ型 | 値の範囲 | 説明 | サポートされているID / 国または地域 / docType / チェックする OCR フィールド |
タイプ | String | mrzVisualConsistencyCheck | DOC なりすましチェック内で MRZ（機械可読ゾーン）と VIZ（目視検査ゾーン）の両方を持つ OCR フィールドの一貫性チェック | - |
詳細 | 文字列リスト | 各 docType でサポートされている OCR フィールドを参照してください | 整合性チェックのために OCR フィールドを詳細に指定します。
| MyVisa / マレーシア / 00600000011 /
|
パスポート（MRZ と VIZ の両方）/ CHN、HKG、TWN、MAC、PHL、SGP、MYS / 00000001006 /
| ||||
香港・マカオ渡航許可証/中国/ 00860000011
|
パスポートの国籍確認
フィールド名 | データ型 | 値の範囲 | 説明 | サポートされているID / 国または地域 / docType / チェックする OCR フィールド / デフォルトの国コード |
type | String | passportCountryCheck | OCR 結果の | |
valueRange | List<String> | 各値は同じにする必要があります 各値は、デフォルトの国コードと同じである必要があります。 | OCR 結果の
サポートされているドキュメントタイプと返される OCR 結果 を参照してください。 | 以下の docType の場合、
|
各値は ISO_3166-1_alpha-3 に準拠する必要があります。 | 以下の docType の場合、
|
リクエストサンプル
POST /api/v1/zoloz/idrecognition/asyncrecognize HTTP/1.1Content-Type: application/json; charset=UTF-8Client-Id: 5X67656YXXXXXX
Request-Time: 2024-01-04T12:08:56+05:30Signature: algorithm=RSA256, signature=xxxxxxxxxxxx
{
"bizId": "trans-test-1234", // ビジネスID
"autoDocTypes":["08520000001","08520000002"], // 自動ドキュメントタイプ
"frontPageImage": "/9j/4AA..[omitted]..PxA=", // 表面画像
"backPageImage": "/9j/4AA..[omitted]..PxA=", // 裏面画像
"productConfig": { // プロダクト設定
"deeperMode": "STANDARD", // 詳細モード
"consistencyCheck": [ // 整合性チェック
{
"type": "commonConsistencyCheck" // 共通整合性チェック
},
{
"details": [ // 詳細
"NAME", // 名前
"SEX" // 性別
],
"type": "mrzVisualConsistencyCheck" // MRZ視覚整合性チェック
},
{
"valueRange": [ // 値の範囲
"CHN", // 中国
"PHL" // フィリピン
],
"type": "passportCountryCheck" // パスポートの国籍チェック
}
],
"pageInfoCheck": [ // ページ情報チェック
{
"name": "id" // ID
},
{
"name": "symbol" // シンボル
},
{
"name": "name" // 名前
}
],
"allowExpiredDocument": "Y", // 期限切れドキュメントを許可する
"cropFaceImageFromDoc": "Y", // ドキュメントから顔画像をトリミングする
"enableOCR": "Y", // OCRを有効にする
"spoofMode": "STANDARD" // なりすましモード
},
"operationMode": "STANDARD", // 操作モード
"sceneCode": "changePassword", // シーンコード
"userId": "userid_1234" // ユーザーID
}レスポンス
フィールド仕様
フィールド名 | データ型 | 説明 | 例 |
result | CommonResult | 必須です。一般的な結果については、 付録をご参照ください。 | { "resultCode": "PROCESSING", "resultStatus": "S", "resultMessage": "It is still under processing" } |
transactionId | String | 必須。 トランザクション ID 注: システムは、トランザクションが処理段階に入った後にのみ
| "G000000005FID2020030400000000000157****" |
レスポンスサンプル
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8Response-Time: 2024-01-19T21:56:15-0800Signature: algorithm=RSA256, signature=xxxxxxxxxxxxxxxxxx
{
"transactionId": "G000000005FID20200304000000000000157****", // トランザクションID
"result": {
"resultCode":"PROCESSING", // 結果コード
"resultStatus":"S", // 結果ステータス
"resultMessage":"It is still under processing" // 処理中です }
}付録
レスポンスパラメータ
説明：API 呼び出しのステータスを示す統一データ構造です。
フィールドの仕様：
フィールド名 | データ型 | 必須 | 値の範囲 | 説明 | サンプル値 |
resultCode | 文字列 | true | 結果コード | "SUCCESS" | |
結果ステータス | 文字列 | true（真） | "S": 成功 "F": 失敗 | 結果ステータス | "S" |
結果メッセージ | 文字列 | true（真） | 結果の説明 | "成功" |
"resultCode" のビジネスレベルでの値の範囲:
resultCode | 説明 |
SUCCESS | 成功 |
SYSTEM_ERROR | その他の内部エラー |
INVALID_ARGUMENT | 入力パラメータが不正です |