POST/api/v1/zoloz/realid/initialize

ZOLOZ Real ID initialize API は、ZOLOZ で本人確認プロセスを初期化するために使用されます。本人確認プロセスの一意のトランザクション ID が生成され、ZOLOZ サーバーとの後続のすべてのインタラクションで使用されます。この API はべき等ではありません。

構造

リクエストパラメーター

フィールド名	データ型	最大長	デフォルト値	説明
bizId	String	32	-	必須。追跡目的の一意のビジネス ID。たとえば、加盟店のビジネス関連データベースからのシーケンス ID。注: ZOLOZ サーバーはこのフィールドの値の一意性チェックを実行しません。追跡を改善するために、加盟店サーバーでビジネス ID の一意性を保証することを強くお勧めします。
metaInfo	String	512	-	必須。SDK とユーザーのデバイスに関するメタ情報。アプリ SDK モードを使用する場合、その値は JSON 文字列形式の ZOLOZ SDK から取得されます。例： `"{\"apdidToken\":\"69b74bfe-bf7f-4d3b-ac59-907ee09e7955\",\"appName\":\"com.zoloz.atomic.client\",\"appVersion\":\"1.0.9\",\"bioMetaInfo\":\"3.46.0:2916352,0\",\"deviceModel\":\"MI 6\",\"deviceType\":\"android\",\"osVersion\":\"9\",\"zimVer\":\"1.0.0\"}"`。注: そのまま渡すだけでよいため、戻り値を変更しないでください。 H5 モードを使用する場合は、値を `MOB_H5` に設定します。
flowType	String	32	-	必須。本人確認フローのタイプを指定します。次の値がサポートされています。 `REALIDLITE_KYC`: アプリ SDK モードを使用する場合に、この値を指定します。 `H5_REALIDLITE_KYC`: H5 モードを使用する場合に、この値を指定します。
docType	String	16	-	オプション。ドキュメントの種類。たとえば、アップロードするドキュメントがパスポートの場合は、この属性の値を `00000001003` に設定します。このフィールドの値は、null または空の文字列にしないでください。Real ID でサポートされているドキュメントの種類については、サポートされているドキュメントの種類と返される OCR 結果を参照してください。注: `docType` または `autoDocTypes` のいずれかを指定してください。
autoDocTypes	List<String>	200	null	オプション。ドキュメントの種類のリストを指定します。`docType` または `autoDocTypes` のいずれかを指定してください。 `autoDocTypes` が指定されている場合、ZOLOZ はアップロードされたドキュメントを自動的に分類します。注：現在、パスポートは自動分類ではサポートされていません。シンガポール市民カード (00650000001) と PR カード (00650000002) は両方ともシンガポール市民カードとして分類されます。アップロードされたドキュメントを分類できなかった場合、または `autoDocTypes` リストに含まれていない場合、checkresult API は `NO_REQUIRED_ID` を返します。 `autoDocTypes` の項目の値は、有効な docType である必要があります。サポートされているドキュメントの種類については、サポートされているドキュメントの種類と返される OCR 結果を参照してください。
userId	String	64	-	必須。加盟店ユーザー ID、または特定のユーザーを識別するために使用できるその他の識別子。たとえば、携帯電話番号、メールアドレスなど。 userId フィールドの値を事前に非センシティブ化することを強くお勧めします。たとえば、値をハッシュ化します。
sceneCode	String	64	null	オプション。データ分析のためにビジネスシーンを指定します。異なるシーンのデータパフォーマンスを区別したい場合は、ビジネスの目的に応じて sceneCode フィールドを異なる値に設定することをお勧めします。たとえば、registration、withdraw、topUp、transfer、changePassword などです。
serviceLevel	String	32	REALID0001	オプション。なりすましチェックと顔のライブネス検出のサービスレベルを指定します。これらのパラメーターは、検出レベル、顔の動作、フレーム収集設定など、さまざまな統合モードに基づいて事前に構成されています。これらの構成をカスタマイズする必要がある場合は、productConfig 関連のフィールドを使用してください。 serviceLevel でサポートされている値は、serviceLevel にあります。
operationMode	String	32	STANDARD	オプション。本人確認プロセスが実行される操作モードを指定します。次の値がサポートされています。 `CLOSED`: すべてのアルゴリズムとリスク管理ルールは適用されません。この操作モードはテストフェーズで使用できるため、アルゴリズムとリスク管理ルールはテストプロセスに影響を与えません。 `STANDARD`: 標準の推奨レベルが適用されます。 `LOOSE`: 比較的緩いレベルが適用されます。この操作モードは、低リスクのシナリオで使用できます。 `STRICT`: 比較的厳格なレベルが適用されます。この操作モードは、高リスクのシナリオで使用できます。 `STANDARD_VC_CLOSED`: この操作モードを使用して、Velocity 機能を無効にできます。 `STANDARD_IDN_CLOSED`: この操作モードを使用して、IDN 機能を無効にできます。 `STANDARD_VC_IDN_CLOSED`: この操作モードを使用して、Velocity 機能と IDN 機能を無効にできます。注: 値が `STANDARD_VC_CLOSED`、`STANDARD_IDN_CLOSED`、または `STANDARD_VC_IDN_CLOSED` に設定されている場合、他のアルゴリズム機能は `STANDARD` と同じです。 IDN と Velocity の定義を以下に示します。 IDN および Velocity： IDN: ID ネットワークチェックを通じて偽造攻撃リスクが検出されたことを示します。たとえば、複数の ID に関連付けられた顔が検出された場合、または複数の顔に関連付けられた ID が検出された場合です。詳細については、checkresult \| API リファレンスを参照してください。 Velocity: Velocity チェックを通じて偽造攻撃リスクが検出されたことを示します。たとえば、過去一定期間における同じユーザー (userId、ID 番号、または deviceId で識別される) による攻撃 (偽 ID またはライブネス攻撃など) の試行回数が特定のしきい値に達した場合、Velocity チェックでは、クールダウン期間が経過するまでユーザーがさらに送信することを許可しません。
pages	String	32	指定されたドキュメントのすべてのページ	オプション。スキャンしてアップロードするドキュメントのページ番号をコンマ区切りで指定します。例: "1" (最初のページをスキャン)、"1,2" (最初と 2 番目のページをスキャン) 注: `autoDocTypes` が指定されている場合、`pages` は null である必要があります。 `pages` が null でない場合は、`INVALID_ARGUMENT` が返されます。
pageConfig	PageConfig		null	オプション。埋め込み H5 ページの構成設定を指定します。詳細については、pageConfig を参照してください。
h5ModeConfig	H5ModeConfig		null	オプション。H5 Real ID フローの構成設定を指定します。flowType フィールドで H5 モードが `H5_REALIDLITE_KYC` として指定されている場合に、このフィールドを設定します。詳細については、h5ModeConfig を参照してください。
productConfig	ProductConfig		null	オプション。Real ID プロダクトのより詳細な制御を指定します。詳細については、productConfig を参照してください。

ServiceLevel

ServiceLevel	サポートされている SDK モード	ドキュメント収集方法	なりすましチェックレベル	顔の動き	追加で収集される画像
REALID0001	ネイティブ SDK と Web SDK	手動キャプチャ	標準	まばたき	なし
REALID0002	ネイティブ SDK	自動キャプチャ	高度	まばたき	なし
REALID0002	Web SDK	手動キャプチャ	標準	まばたき	HKID は追加のマルチアングルフレームをキャプチャできます
REALID0003	ネイティブ SDK	自動キャプチャ	高度	次のリストから 2 つをランダムに選択: まばたき、口を開ける、頭を上げる、頭を下げる、頭を左に回す、頭を右に回す	なし
REALID0003	Web SDK	手動キャプチャ	標準	次のリストから 2 つをランダムに選択: まばたき、口を開ける、頭を上げる、頭を下げる、頭を左に回す、頭を右に回す	HKID は追加のマルチアングルフレームをキャプチャできます
REALID0004	ネイティブ SDK	ドキュメント位置合わせフレームなしの自動キャプチャ	標準	まばたき	なし
REALID0009	ネイティブ SDK	自動キャプチャ	高度	まばたき	閉眼フレーム
REALID0011	Web SDK	手動キャプチャ	標準	まばたき	HKID は追加のマルチアングルフレームをキャプチャできます閉眼フレーム
REALID0012	Web SDK	自動キャプチャ	高度	まばたき	なし

レスポンスパラメーター

フィールド名	データ型	説明
result	Result	必須。API リクエストの結果。ステータスやエラーコードなど、API リクエストの結果に関する情報が含まれています。
transactionId	String	オプション。本人確認プロセス用に ZOLOZ サーバーによって生成される一意のトランザクション ID。この ID は、Real ID checkresult API リクエストの入力パラメーターとして使用されます。注: プロセス中にエラーが発生した場合 (無効な引数など)、トランザクション ID は返されません。
clientCfg	String	オプション。クライアント構成情報。SDK 接続と動作に関するパラメーターが含まれています。result.resultStatus フィールドが `"S"` の場合にのみ、このフィールドの値が指定されます。

結果

結果処理ロジック

リクエスト結果によって、異なるアクションが実行されます。詳細については、以下を参照してください。

result.resultStatus の値が S の場合、ZOLOZ Real ID initialize API が正常に呼び出され、一意のトランザクション ID が返されます。
result.resultStatus の値が F の場合、ZOLOZ Real ID initialize API の呼び出しは失敗します。考えられる理由の詳細については、エラーコードとそのメッセージを確認してください。

一般的なエラーコード

一般的なエラーコードの完全なリストについては、一般的なエラーコードセクションの エラー処理 トピック。

API 固有のエラーコード

次の表は、Real ID initialize API に固有の考えられるエラーコードを示しています。

resultCode	resultStatus	説明
SUCCESS	S	API 呼び出しは成功しました。
HIGH_RISK	F	高リスクが検出されました。リスクエンジンによってユーザーアカウントは戦略的にクールダウンされています。
ACCOUNT_SERVICE_SUSPEND	F	ユーザーアカウントはリスクエンジンによってブラックリストに登録されています。
DEVICE_NOT_SUPPORT	F	デバイスタイプはサポートされていません。
OS_NOT_SUPPORT	F	デバイスのオペレーティングシステムはサポートされていません。
SDKVERSION_NOT_SUPPORT	F	ZOLOZ SDK のバージョンはサポートされていません。
INVALID_ARGUMENT	F	入力パラメーターが無効です。どのパラメーターが無効かの詳細については、結果メッセージまたは関連ログを確認してください。
SYSTEM_ERROR	F	その他の内部エラー。エラーの詳細については、返された結果メッセージと関連ログを確認してください。

サンプル

リクエストサンプル

統合モードによって、リクエスト構造がわずかに異なります。本人確認プロセスが H5 モードで開始された場合は、さらに h5ModeConfig というオブジェクトを指定する必要があります。詳細については、次の 2 つのリクエストサンプルを参照してください。

ネイティブ RealId リクエストサンプル

次のサンプルは、本人確認プロセスがアプリ SDK モードで開始された場合のリクエストの例を示しています。

{
  "bizId": "2017839040588699",
  "flowType": "REALIDLITE_KYC",
  "userId": "123456abcd",
  "autoDocTypes":["08520000001","08520000002"],
  "pageConfig":{
    "urlFaceGuide":"http://url-to-face-guide-page.htm"
  },
  "serviceLevel": "REALID0001",
  "operationMode": "STANDARD",
  "productConfig": {
    "deeperMode":"STANDARD",
    "cropDocImage": "Y",
    "landmarkCheck": [
      {"name":"kadPengenalan"},
      {"name":"mykadLogo"},
      {"name":"flagLogo"},
      {"name":"mscLogo"},
      {"name":"ghostFace"},
      {"name":"hibiscusLogo"},
      {"name":"coatOfArm"},
      {"name":"twinTower"}
    ],
    "hologramCheck": [
      {"name":"hologram"}
    ],
    "pageInfoCheck": [
      {"name":"id"},
      {"name":"symbol"},
      {"name":"name"}
    ],
    "preciseTamperCheck": "Y",
    "allowExpiredDocument": "Y",
    "faceAttributeCheck": {
      "occlusionCheck": {
        "details": [
          "eyesOcclusion",
          "noseOcclusion",
          "mouthOcclusion",
          "foreheadOcclusion",
          "chinOcclusion",
          "cheekOcclusion"
        ],
        "detectOpen": "Y",
        "needRetry": "Y"
      },
      "maskCheck": {
        "detectOpen": "Y",
        "needRetry": "N"
      },
      "glassesCheck": {
        "detectOpen": "Y",
        "needRetry": "N"
      },
      "hatCheck": {
        "detectOpen": "Y",
        "needRetry": "N"
      }
    },
    "consistencyCheck": [
      {
        "type": "commonConsistencyCheck"
      },
      {
        "details": [
          "NAME",
          "SEX"
        ],
        "type": "mrzVisualConsistencyCheck"
      },
      {
        "valueRange": [
          "CHN",
          "PHL"
        ],
        "type": "passportCountryCheck"
      }
    ],
    "advancedIdnRiskDetection": {
        "riskTypes": [
            "IDFAKE",
            "DUPLICATE",
            "BATCH_REGISTER",
            "DEEPFAKE"
            ],
        "timeWindow": {
            "endTime": 1724377636300,
            "startTime": 1724222116300
            }
        },
    "advancedIdnThreshold": "3",
    "checkAdvancedIdn": "Y",
    "checkBlacklist": "Y"
  },
  "metaInfo": "{
    \"deviceType\": \"deviceType\",
    \"appVersion\": \"1.0\",
    \"osVersion\": \"7.1.1\",
    \"appName\": \"com.company.wallet\",
    \"bioMetaInfo\": \"3.37.0:262144,0\",
    \"apdidToken\": \"mock-apdidToken\",
    \"deviceModel\": \"MI 6\",
    \"zimVer\": \"2.0.0\"
  }"
}

H5 RealId リクエストサンプル

統合モードによって、リクエスト構造がわずかに異なります。本人確認プロセスが H5 モードで開始された場合は、さらに h5ModeConfig というオブジェクトを指定する必要があります。詳細については、次の 2 つのリクエストサンプルを参照してください。

{
  "bizId": "2017839040588699",
  "flowType": "H5_REALIDLITE_KYC",
  "userId": "123456abcd",
  "autoDocTypes":["08520000001","08520000002"],
  "pageConfig":{
    "urlFaceGuide":"http://url-to-face-guide-page.htm"
  },
  "serviceLevel": "REALID0001",
  "operationMode": "STANDARD",
  "productConfig": {
    "deeperMode":"STANDARD",
    "cropDocImage": "Y",
    "landmarkCheck": [
      {"name":"kadPengenalan"},
      {"name":"mykadLogo"},
      {"name":"flagLogo"},
      {"name":"mscLogo"},
      {"name":"ghostFace"},
      {"name":"hibiscusLogo"},
      {"name":"coatOfArm"},
      {"name":"twinTower"}
    ],
    "hologramCheck": [
      {"name":"hologram"}
    ],
    "pageInfoCheck": [
      {"name":"id"},
      {"name":"symbol"},
      {"name":"name"}
    ],
    "preciseTamperCheck": "Y",
    "allowExpiredDocument": "Y",
    "faceAttributeCheck": {
      "occlusionCheck": {
        "details": [
          "eyesOcclusion",
          "noseOcclusion",
          "mouthOcclusion",
          "foreheadOcclusion",
          "chinOcclusion",
          "cheekOcclusion"
        ],
        "detectOpen": "Y",
        "needRetry": "Y"
      },
      "maskCheck": {
        "detectOpen": "Y",
        "needRetry": "N"
      },
      "glassesCheck": {
        "detectOpen": "Y",
        "needRetry": "N"
      },
      "hatCheck": {
        "detectOpen": "Y",
        "needRetry": "N"
      }
    },
    "consistencyCheck": [
      {
        "type": "commonConsistencyCheck"
      },
      {
        "details": [
          "NAME",
          "SEX"
        ],
        "type": "mrzVisualConsistencyCheck"
      },
      {
        "valueRange": [
          "CHN",
          "PHL"
        ],
        "type": "passportCountryCheck"
      }
    ],
    "advancedIdnRiskDetection": {
        "riskTypes": [
            "IDFAKE",
            "DUPLICATE",
            "BATCH_REGISTER",
            "DEEPFAKE"
            ],
        "timeWindow": {
            "endTime": 1724377636300,
            "startTime": 1724222116300
            }
        },
     "advancedIdnThreshold": "3",
     "checkAdvancedIdn": "Y",
     "checkBlacklist": "Y"
  },
  "metaInfo": "MOB_H5",
  "h5ModeConfig":{
    "completeCallbackUrl":"http://xxx.html",
    "interruptCallbackUrl":"http://xxx.html",
    "allowDegradation":"Y",
    "docFrontPageGuideUrl":"http://xxx.html",
    "docBackPageGuideUrl":"http://xxx.html",
    "facePageGuideUrl":"http://xxx.html"
  }
}

レスポンスサンプル

次のサンプルは、ZOLOZ サーバーから返されるレスポンスの例を示しています。

{
   "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "Success"
    },
  "transactionId":"G000000005FID20200304000000000001570702", 
  "clientCfg": "……"   
}

詳細情報

pageConfig

次の表は、pageConfig データモデルで指定できるフィールドを示しています。

フィールド名	データ型	最大長	説明
urlFaceGuide	String	256	オプション。顔ガイドページの URL を指定します。これは、顔のスキャン中にユーザーをガイドするためにカスタマイズできる H5 プロンプトページです。例: http://url-to-face-guide-page.html。

h5ModeConfig

次の表は、h5ModeConfig データモデルで指定できるフィールドを示しています。

フィールド名	データ型	最大長	デフォルト値	説明
state	String	128	の値 `transactionId`	オプション。顧客のコンテキストを回復するために使用される識別子。このフィールドは任意の文字列値に設定できます。その後、ZOLOZ SDK が加盟店のアプリケーションにコールバックするときに、値がパラメーターとして渡されます。値が設定されていない場合は、代わりに transactionId フィールドの値が使用されます。
completeCallbackUrl	String	128	-	必須。本人確認プロセス全体が完了したときにブラウザがリダイレクトされるコールバック URL を指定します。
interruptCallbackUrl	String	128	-	必須。プロセスが中断されたときにブラウザがリダイレクトされるコールバック URL を指定します。
locale	String	16	en	オプション。ウェブページの言語。現在、en (英語) / zh-CN (簡体字中国語) / zh-HK (繁体字中国語) / jp (日本語) / th (タイ語) / es (スペイン語) / pt (ポルトガル語) / fr (フランス語) / id (インドネシア語) / de (ドイツ語) / kr (韓国語) / vi (ベトナム語) をサポートしています。
isIframe	String	1	N	オプション。ウェブページを Iframe で開く必要がある場合は、このパラメーターを `Y` に設定する必要があります。次の値がサポートされています。 `Y` `N`
uiCfg	String	256	null	オプション。JSON 文字列形式のカスタム UI 構成。現在は `titlebarbgcolor`、`titlebartextcolor`、および `buttoncolor` のみをサポートしています。例: `"{\"titlebarbgcolor\":\"#ffffff\",\"titlebartextcolor\":\"#000000\",\"buttoncolor\":\"#3696fd\"}"`。
allowDegradation	String	1	N	オプション。ダウングレードモードが許可されている場合は、このパラメーターを `Y` に設定する必要があります。次の値がサポートされています。 `Y`: ダウングレードモードが許可されます。 `N`: ダウングレードモードは許可されません。注: このパラメーターが `Y` に設定されている場合、Zoloz がユーザーのブラウザが Web SDK をサポートしていないことを検出した場合、ユーザーはダウングレードモードに入ることを選択できます。ダウングレードモードに入ることを確認すると、Zoloz は写真の撮影のためにネイティブカメラシステムを起動します。デグレードモードではリスクが高くなる可能性があります。このソースからのトランザクションの eKYC 結果は Pending であり、再確認が必要です。
docFrontPageGuideUrl	String	128	null	オプション。ダウングレードモードのドキュメントガイドページの最初のページの URL を指定します。これは、ドキュメントの最初のページの収集においてユーザーをガイドするためにカスタマイズできる H5 プロンプトページです。このパラメーターが指定されていない場合は、デフォルトページが表示されます。
docBackPageGuideUrl	String	128	null	オプション。ダウングレードモードのドキュメントガイドページの 2 番目のページの URL を指定します。これは、ドキュメントの 2 番目のページの収集においてユーザーをガイドするためにカスタマイズできる H5 プロンプトページです。このパラメーターが指定されていない場合は、デフォルトページが表示されます。
facePageGuideUrl	String	128	null	オプション。ダウングレードモードの顔ガイドページの URL を指定します。これは、セルフィーの収集においてユーザーをガイドするためにカスタマイズできる H5 プロンプトページです。このパラメーターが指定されていない場合は、デフォルトページが表示されます。

productConfig

次の表は、productConfig データモデルで指定できるフィールドを示しています。

フィールド名	データ型	最大長	デフォルト値	説明	注記
cropDocImage	String	1	N	オプション。キャプチャした DOC 画像の背景をトリミングするかどうかを指定します。有効な値は次のとおりです。 `Y`: キャプチャした元の doc 画像からトリミングされた追加の doc 画像を返します注: 表と裏の両面がキャプチャされた場合は、2 番目の追加の doc 画像が返される場合があります `N`: デフォルト値。トリミングしません
cropFaceImage	String	1	N	オプション。キャプチャした FACE 画像の顔領域をトリミングするかどうかを指定します。有効な値は次のとおりです。 `Y`: キャプチャした元の顔画像からトリミングされた追加の顔画像を返します `N`: デフォルト値。トリミングしません
landmarkCheck	Array		null	オプション。DOC なりすましチェック内でランドマークチェックを実行するかどうかを指定します。ランドマークチェックは、選択したドキュメントにのみ適用されます。例: (MyKad) ランドマークチェックが必要な場合は、サポートされているランドマークコンポーネントの配列を指定する必要があります。このフィールドの有効な値については、DOC なりすましチェックの詳細を参照してください。
hologramCheck	Array		null	オプション。DOC なりすましチェック内でホログラムチェックを実行するかどうかを指定します。ホログラムチェックは、選択したドキュメントにのみ適用されます。例: (MyKad) ホログラムチェックが必要な場合は、サポートされているホログラムチェックコンポーネントの配列を指定する必要があります。このフィールドの有効な値については、DOC なりすましチェックの詳細を参照してください。
pageInfoCheck	Array		null	オプション。DOC なりすましチェック内で情報チェックを実行するかどうかを指定します。情報チェックは、選択したドキュメントにのみ適用されます。情報チェックが必要な場合は、サポートされている情報チェックコンポーネントの配列を指定する必要があります。このフィールドの有効な値については、DOC なりすましチェックの詳細を参照してください。
preciseTamperCheck	String	1	N	非推奨のフィールドであり、今後メンテナンスされません。API の互換性を確保するために、このフィールドは保持されます。オプション。精密改ざんチェックを実行するかどうかを指定します。精密改ざんチェックは、選択したドキュメントにのみ適用されます。次の値がサポートされています。 Y: はい N: 精密改ざんチェックを実行しません
allowExpiredDocument	String		ドキュメントの種類によってデフォルト値が異なり、次のように設定されます。 `Y`: パスポート (docType=00000001003) 以外のすべてのドキュメント `N`: パスポート (docType=00000001003)	オプション。期限切れのドキュメントを許可するかどうかを指定します。次の値がサポートされています。 `Y`: 期限切れのドキュメントを許可します。 `N`: 期限切れのドキュメントが検出された場合、Real ID プロセスを一時停止します。注: 無効な値はデフォルトオプションにフォールバックし、期限切れのドキュメントが検出された場合に Real ID プロセスを一時停止します。
docUiType	String	20	ネイティブ SDK: 2 Web SDK: 1	オプション。このパラメーターは、ID 写真を撮影する方法を指します。値は次のとおりです。 `1`: セルフキャプチャ。ユーザーは手動で ID 写真を撮影する必要があり、基本的ななりすまし防止機能のみを備えています。 `2`: ディープスキャン、ネイティブ SDK 専用。ZOLOZ SDK は ID 写真を自動的に位置合わせしてキャプチャし、印刷されたカラー画像の傍受などの高度ななりすまし防止機能を備えています。 `3`: オートスキャン、Web SDK 専用。ZOLOZ SDK は ID 写真を自動的に位置合わせしてキャプチャし、基本的ななりすまし防止機能のみを備えています。オートスキャンは、セルフスキャンと比較して、より優れたユーザーエクスペリエンスとより高品質のドキュメント画像を提供するため、WEB SDK に推奨されます。 `4`: トレーススキャン、ネイティブ SDK 専用。ZOLOZ SDK は、ドキュメントがカメラの範囲内で検出されると、ID 写真を自動的にキャプチャします。ユーザーエクスペリエンスを向上させることができますが、基本的ななりすまし防止機能のみを備えています。 `5`: マルチアングル、Web SDK の HKID 専用。ユーザーは異なる角度から 2 枚のドキュメント写真を撮影する必要があります。最初の写真では、カメラを ID ドキュメントに直接向け、その写真をキャプチャします。2 番目の写真では、ID ドキュメントをカメラに対して 30° 傾けて、その写真をキャプチャします。注: Deeper 機能は、ディープスキャンとオートスキャンの 2 つの収集方法に依存しています。Deeper 機能を有効にする場合は、実際のアプリケーションシナリオに基づいて適切な収集方法を選択し、最適な検出パフォーマンスを確保してください。ネイティブ SDK にはディープスキャンを、Web SDK にはオートスキャンを使用してください。これらの 2 つのモードを選択しないと、検出効果に大きな影響があります。	次の 10 個のパラメーターは、serviceLevel および operationMode よりも優先順位が高くなります。これらの 10 個のパラメーターのいずれかが渡されると、他のパラメーターのデフォルト値が有効になります。この場合、serviceLevel および operationMode の値が渡されても、有効になりません。 docUiType spoofMode livenessMode antiInjectionMode deeperMode actionCheckItems actionRandom actionFrame riskMode idnThreshold
spoofMode	String	10	STANDARD	オプション。このパラメーターは、ドキュメントのなりすまし防止レベルを指し、次のように定義されます。 `CLOSED`: すべてのアルゴリズムは適用されません。このなりすまし防止検出モードはテストフェーズで使用できるため、アルゴリズムとリスク管理ルールはテストプロセスに影響を与えません。 `STANDARD`: 標準の推奨レベルが適用されます。 `LOOSE`: 予約値であり、現在は使用できません。 `STRICT`: 予約値であり、現在は使用できません。
livenessMode	String	10	STANDARD	オプション。顔のライブネス検出チェックのライブネスレベルを指定します。次の値がサポートされています。 `CLOSED`: すべてのアルゴリズムは適用されません。このライブネス検出モードはテストフェーズで使用できるため、アルゴリズムとリスク管理ルールはテストプロセスに影響を与えません。 `STANDARD`: 標準の推奨レベルが適用されます。 `LOOSE`: 比較的緩いレベルが適用されます。このライブネス検出モードは、低リスクのシナリオで使用できます。 `STRICT`: 比較的厳格なレベルが適用されます。このライブネス検出モードは、高リスクのシナリオで使用できます。
antiInjectionMode	String	10	CLOSED	非推奨のフィールドであり、今後メンテナンスされません。API の互換性を確保するために、このフィールドは保持されます。オプション。インジェクション攻撃検出の anti-injection レベルを指定します。インジェクション攻撃検出は、ディープフェイク (顔交換写真やビデオ) を使用したインジェクション攻撃を効果的に阻止できます。次の値がサポートされています。 `CLOSED`: すべての anti-injection アルゴリズムは適用されません。ビジネスシナリオでインジェクション攻撃検出が必要ない場合は、有効にする必要はありません。 `STANDARD`: 標準の推奨レベルが適用されます。 `LOOSE`: 予約値です。現在、使用はサポートされていません。 `STRICT`: 予約値であり、現在は使用できません。注: インジェクション攻撃検出を有効にすると、誤拒否率と実行時間がわずかに増加します。この機能を有効にする前に、ZOLOZ テクニカルサポートチームにお問い合わせください。
deeperMode	String	10	CLOSED	オプション。AIGC 攻撃検出の Deeper レベルを指定します。Deeper 検出機能の詳細については、Deeper とはを参照してください。次の値がサポートされています。 `CLOSED`: Deeper に関するすべての機能は適用されません。たとえば、AIGC 検出アルゴリズム、端末リスク検出などです。ビジネスシナリオで AIGC 攻撃検出が必要ない場合は、有効にする必要はありません。 `STANDARD`: 標準の推奨レベルが適用されます。 `LOOSE`: 比較的緩いレベルが適用されます。この検出モードは、低リスクのシナリオで使用できます。 `STRICT`: 比較的厳格なレベルが適用されます。この検出モードは、高リスクのシナリオで使用できます。注: この機能を有効にする前に、Deeper プロダクトを購入してください。
actionCheckItems	List<String>		FACEBLINK	オプション。検出されるユーザーアクション。ユーザーエクスペリエンスを向上させるために、2 つ以上のアクションを使用することはお勧めしません。次の値がサポートされています。 `FACEBLINK`: ユーザーは目をまばたきする必要があります。 `MOUTHOPEN`: ユーザーは一度口を開ける必要があります。 `HEADSHAKE`: ユーザーは頭を振る必要があります。ユーザーが実行する左または右のヘッドシェイクが指定されます。 `HEADLOWER`: ユーザーは一度頭を下げる必要があります。 `HEADRAISE`: ユーザーは一度頭を上げる必要があります。
actionRandom	String	1	N	オプション。`actionCheckItems` で指定されたユーザーアクションがランダムな順序で検出されるかどうかを指定します。有効な値は次のとおりです。 `Y`: ランダム `N`: ランダムではありません。actionCheckItems の順序に従ってアクション検出が実行されます。
actionFrame	List<String>		null	オプション。このパラメーターは、他のフレーム画像のキャプチャを指し、次のように定義されます。 `EYECLOSE`: この値を設定すると、まばたき検出方法中に収集された閉眼フレームが返されます。
riskMode	String	10	STANDARD	オプション。このパラメーターは、RealID における多次元リスク管理ルール検証を指します。不審なトランザクションを傍受するために使用されます。値は次のとおりです。 `CLOSED`: リスク検出に関するすべてのアルゴリズムは適用されません。このリスク検出モードはテストフェーズで使用できるため、アルゴリズムとリスク管理ルールはテストプロセスに影響を与えません。 `STANDARD`: 標準の推奨レベルが適用されます。 `LOOSE`: 比較的緩いレベルが適用されます。このリスク検出モードは、低リスクのシナリオで使用できます。 `STRICT`: 比較的厳格なレベルが適用されます。このリスク検出モードは、高リスクのシナリオで使用できます。
idnThreshold	Integer		3	このパラメーターは非推奨となり、今後メンテナンスされません。API の互換性を確保するために、このパラメーターは引き続き保持されます。オプション。このパラメーターは、1 人のユーザーが異なる ID ドキュメントを使用するトランザクション、または 1 つの ID ドキュメントが異なるユーザーによって使用されるトランザクションをチェックするために使用されます。このようなトランザクション (異なる `userId` からの) の数がしきい値を超えると、現在のトランザクションは傍受されます。 0 より大きい整数がサポートされています。
faceAttributeCheck	faceAttributeCheck		null	オプション。このパラメーターは、顔属性を検出するかどうかを指定し、顔属性が検出されたときに再試行するかどうかを制御するために使用されます。	`faceAttributeCheck` パラメーターは、`livenessMode` よりも優先されます。たとえば、`occlusionCheck.detectOpen` が `N` に設定されている場合、`livenessMode` が `STRICT` に設定されていても、顔のオクルージョンチェックは無効になります。詳細については、顔のオクルージョンチェックは無効になっています。詳細については、faceAttributeCheck を参照してください。
consistencyCheck	List<ConsistencyCheckItem>		null	オプション。DOC なりすましチェック内で整合性チェックを実行するかどうかを指定します。整合性チェックは、選択したドキュメントにのみ適用されます。整合性チェックが必要な場合は、サポートされている情報チェックコンポーネントの配列を指定する必要があります。このフィールドの有効な値については、整合性チェックデータ構造を参照してください。
checkAdvancedIdn	String	-	N	オプション。IDN リスクチェックを有効にするかどうかを指定します。値: `Y`: 有効にします。 `N`: 無効にします。注: この機能を有効にするには、IDN を購入する必要があります。
advancedIdnRiskDetection	RiskDetection	-	RiskDetection	オプション。リスク検出。詳細については、RiskDetection を参照してください。注: このパラメーターは、`checkAdvancedIdn` が `Y` に設定されている場合にのみ有効になります。
advancedIdnThreshold	String	-	3	オプション。IDN リスクチェックのしきい値を 1 ～ 100 の範囲で指定します。指定されたしきい値を超えるリスクの高い履歴トランザクションに関連付けられたトランザクションはブロックされます。同じ `itemId` は 1 回だけカウントされます。注: このパラメーターは、`checkAdvancedIdn` が `Y` に設定されている場合にのみ有効になります。
checkBlacklist	String	1	N	オプション。ブラックリストリスクチェックを有効にするかどうか。値: `Y`: 有効にします。 `N`: 無効にします。注: この機能を有効にするには、ブラックリスト機能を購入する必要があります。

ConsistencyCheckItem データ構造

commonConsistencyCheck

フィールド名

データ型

値の範囲

説明

サポートされている ID / 国または地域 / docType / チェック対象の OCR フィールド

type

String

commonConsistencyCheck

DOC なりすましチェック内での OCR フィールドの整合性チェック

Mykad / マレーシア / 00600000001 / ID_NUMBER

表面: ID_NUMBER
裏面: ID_NUMBER_BACK の最初の 12 桁

mrzVisualConsistencyCheck

フィールド名	データ型	値の範囲	説明	サポートされている ID / 国または地域 / docType / チェック対象の OCR フィールド
type	String	mrzVisualConsistencyCheck	DOC なりすましチェック内で MRZ (機械読み取り可能ゾーン) と VIZ (目視検査ゾーン) の両方を持つ OCR フィールドの整合性チェック	-
details	List<String>	各 docType でサポートされている ocr フィールドを参照してください	整合性チェックの詳細な ocr フィールドを指定します。 `type` が `mrzVisualConsistencyCheck` として設定されている場合、`details` フィールドは必須であり、null にすることはできません。 ID ドキュメントでサポートされている OCR フィールドのみを入力できます。	MyVisa / マレーシア / 00600000011 / NAME SEX
details	List<String>	各 docType でサポートされている ocr フィールドを参照してください		パスポート (MRZ と VIZ の両方) / すべての国または地域 / 00000001006 / ID_NUMBER 国コード EXPIRY_DATE DATE_OF_BIRTH

passportCountryCheck

フィールド名	データ型	値の範囲	説明	サポートされている ID / 国または地域 / docType / チェック対象の OCR フィールド / デフォルトの国コード
type	String	passportCountryCheck	OCR 結果の `COUNTRY_CODE` がシステムによって検出された国と一致するかどうかを確認します。
valueRange	List<String>	同じにする必要がありますデフォルトの国コードと同じである必要があります。	type が passportCountryCheck の場合、`valueRange` は空にできません。サポートされている docType の許容値を参照してください。	以下の docType の場合、`valueRange` は、デフォルトの国または地域コードのリストである必要があります中国パスポート / 00860000888 / COUNTRY_CODE / CHN 中国台湾パスポート / 08860000002 / COUNTRY_CODE / TWN 中国マカオパスポート / 08530000002 / COUNTRY_CODE / CHN フィリピン旧パスポート / 00630000031 /COUNTRY_CODE / PHL フィリピン新パスポート /00630000032 /COUNTRY_CODE / PHL
valueRange	List<String>	各項目は ISO_3166-1_alpha-3 に準拠する必要があります		以下の docType の場合、`valueRange` はリストである必要があり、各項目は ISO_3166-1_alpha-3 に準拠する必要があります国際パスポート / 00000001003 / COUNTRY_CODE パスポート (MRZ と VIZ の両方)/ 00000001006 / COUNTRY_CODE

faceAttributeCheck

フィールド名	データ型	最大長	デフォルト値	説明
occlusionCheck	faceAttributeDetails		null	オプション。顔のオクルージョン属性を検出するかどうかを指定します。詳細については、faceAttributeDetails を参照してください。
maskCheck	faceAttributeDetails		null	オプション。マスク属性を検出するかどうかを指定します。詳細については、faceAttributeDetails を参照してください。
glassesCheck	faceAttributeDetails		null	オプション。眼鏡属性を検出するかどうかを指定します。詳細については、faceAttributeDetails を参照してください。
hatCheck	faceAttributeDetails		null	オプション。帽子属性を検出するかどうかを指定します。詳細については、faceAttributeDetails を参照してください。

faceAttributeDetails

フィールド名	データ型	最大長	デフォルト値	説明
detectOpen	String		null	顔属性を検出し、Real ID - checkresult API でその結果を返すかどうかを指定します。 `Y`: 顔属性検出を開きます `N`: 顔属性検出を閉じます
needRetry	String		null	指定された属性が検出されたときに再試行するかどうかを指定します。 `Y`: 指定された属性が検出されたら再試行する必要があります。 `N`: 指定された属性が検出されても再試行する必要はありません。注: `needRetry` が `Y` の場合、`detectOpen` は `Y` に設定する必要があります。
details	List<String>		null	顔属性の追加の詳細情報を返すかどうかを指定します。現在は occlusionCheck のみをサポートしています。使用可能なオプションは次のとおりです。 `eyesOcclusion`: 目のオクルージョン結果を返します `noseOcclusion`: 鼻のオクルージョン結果を返します `mouthOcclusion`: 口のオクルージョン結果を返します `foreheadOcclusion`: 額のオクルージョン結果を返します `chinOcclusion`: 顎のオクルージョン結果を返します `cheekOcclusion`: 頬のオクルージョン結果を返します注: `details` パラメーターが空でない場合、`detectOpen` は `Y` に設定する必要があります。 `details` パラメーターが指定されている場合、全体的な属性結果と特定の属性結果が Real ID - checkresult API で返されます。

RiskDetection

フィールド名

データ型

最大長

デフォルト値

説明

riskTypes

List<String>

["IDFAKE","DUPLICATE"]

オプション。クエリ対象のリスクの種類を指定します。次の 3 つの主要なリスクタイプがサポートされており、システムはそれらに含まれるサブリスクを自動的にクエリします。詳細については、IDN リスクの概要を参照してください。

IDFAKE: なりすまし ID。
DUPLICATE: 重複認証。
BATCH_REGISTER: バッチ登録。
DEEPFAKE: ディープフェイク顔

timeWindow

TimeWindow

オプション。リスククエリ時間枠は最大 180 日間のデータをサポートでき、デフォルトは過去 30 日間です。詳細については、TimeWindow を参照してください。

注: システムは 1 回のスキャンあたりのデータ量を 500,000 レコードに制限しています。クエリ時間枠内のデータ量が 500,000 レコードを超える場合、システムは設定した時間枠を動的に調整します。

TimeWindow

フィールド名	データ型	最大長	デフォルト値	説明
startTime	Long	-	現在時刻	オプション。リスククエリの開始時刻。13 桁のタイムスタンプを使用します。
endTime	Long	-	30 日前	オプション。リスククエリの終了時刻。13 桁のタイムスタンプを使用します。

変更ログ

日付	変更ログ
2024 年 9 月 20 日	次の 2 つのパラメーターが追加されました。 productConfig の consistencyCheck に passportCountryCheck が追加されました。 productConfig に checkBlacklist が追加されました。
2024 年 8 月 1 日	Deeper 関連のインターフェース情報の変更
2024 年 3 月 28 日	新しいパラメーター faceAttributeCheck が productConfig に追加されました。
2023 年 11 月 22 日	productConfig パラメーターに新しいフィールドが追加されました。
2022 年 5 月 22 日	リクエストに新しいパラメーター productConfig が追加されました。
2020 年 9 月 8 日	さらに 2 種類の本人確認書類がサポートされるようになりました: マレーシア MyKad とマカオID カード。リクエストに新しいパラメーター h5ModeConfig が追加されました。
2020 年 6 月 9 日	リクエストに新しいパラメーター pageConfig が追加されました。
2019 年 12 月 27 日	パラメーター productLevel の名前が serviceLevel に変更され、関連する説明が更新されました。
2019 年 12 月 20 日	次の 2 つのリクエストパラメーターが追加されました。 productLevel operationMode
2019 年 12 月 6 日	リリースされました。