すべてのプロダクト
Search
ドキュメントセンター

ID Verification:初期化

最終更新日:May 20, 2025

このトピックでは、Initialize 操作を呼び出してドキュメント光学式文字認識 (OCR) リクエストを開始する方法について説明します。

検証リクエストを開始する

  • 操作名: Initialize。

  • エンドポイント: cloudauth-intl.cn-hongkong.aliyuncs.com.

  • リクエストメソッド: HTTPS POST。

  • 操作の説明: ドキュメント OCR プロセスを開始する前に、この操作を呼び出して、検証プロセスに含まれるさまざまな操作の トランザクション ID を取得する必要があります。

  • QPS 制限: API のクエリ/秒 (QPS) には制限が課せられます。 詳細については、「ID Verification - KYC サーバーサイド API の QPS 制限」をご参照ください。

リクエストパラメーター

パラメーター

タイプ

必須

説明

ProductCode

String

はい

使用するソリューション。 値を ID_OCR に設定します。

ID_OCR

SceneCode

String

いいえ

カスタム検証シナリオの ID。 ID Verification コンソールに ID を入力して、関連レコードをクエリできます。 文字、数字、およびアンダースコア (_) を含む 10 文字のカスタム値を指定できます。

1234567890

MerchantBizId

String

はい

トラブルシューティングに使用されるビジネスの一意の識別子です。 32 文字以内で英数字を含む値を指定できます。値が一意であることを確認してください。

説明

ID Verification は、値の一意性をチェックしません。 追跡のために、一意の値を指定することをお勧めします。

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

はい

環境パラメーター。クライアント SDK を使用して取得します。 詳細については、「Android」をご参照ください。

説明

取得したパラメーターを環境パラメーターとして指定します。 パラメーターを変更する必要はありません。

{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:1150****,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}

MerchantUserId

String

はい

顧客の ID。 携帯電話番号やメールアドレスなど、カスタム値を指定できます。 値を指定する前に、データマスキングを実行することをお勧めします。 たとえば、ハッシュを実行できます。

123456789

IdSpoof

String

いいえ

ドキュメントの偽造防止検出を有効にするかどうかを指定します。 有効な値:

  • Y: はい。

  • N (デフォルト): いいえ

Y

DocType

String

はい

ドキュメントタイプ。 ドキュメントタイプを一意に識別するために、8 桁の値を指定できます。 詳細については、このトピックの「ドキュメントタイプ」セクションを参照してください。

01000000

IdThreshold

String

いいえ

OCR の品質チェックのしきい値モード。 有効な値:

  • 0: デフォルトモード。

  • 1: 厳格モード。

  • 2: 緩和モード。

  • 3 (デフォルト): 品質チェックを無効にします。

0

CallbackUrl

String

いいえ

検証結果を通知するために使用されるコールバック URL。 デフォルトでは、GET メソッドを使用してコールバックリクエストが送信されます。 コールバック URL は https で始まる必要があります。 検証が完了すると、システムはコールバック URL にコールバックリクエストを送信し、次のフィールドをコールバックリクエストに自動的に追加します。

  • transactionId

  • passed

  • code

  • subcode

警告

コールバック URL が使用される前に、システムは URL にアクセスできるかどうかを確認します。 URL がインターネット経由でアクセスできない場合、状態コード 400 が返されます。

https://www.aliyun.com?callbackToken=100000****&transactionId=shaxxxx&passed=Y&subCode=200

CallbackToken

String

いいえ

重複防止および改ざん防止検証に使用されるセキュリティトークン。 カスタム値を指定できます。

このパラメーターを設定すると、コールバック URL に送信されるコールバックリクエストに CallbackToken フィールドが含まれます。

NMjvQanQgplBSaEI0sL86WnQplB

DocPageConfig

String

いいえ

ドキュメントの裏面を収集するかどうかを指定します。 値は JSON 配列文字列です。 有効な値:

OCR_ID_BACK: ドキュメントの裏面が収集されます。

説明

中国本土の居住者向け ID カードのみがサポートされています。

OCR_ID_BACK

ShowGuidePage

String

いいえ

ガイドページを表示するかどうかを指定します。 有効な値:

  • 1 (デフォルト): ガイドページを表示します。

  • 0: ガイドページを表示しません。

1

DocScanMode

String

いいえ

ドキュメントをスキャンするための OCR モード。 有効な値:

  • shoot (デフォルト): ドキュメントの写真を撮ります。

  • scan: ドキュメントをスキャンします。

  • auto: ドキュメントの写真を撮ることとドキュメントをスキャンすることを自動的に切り替えます。

shoot

ドキュメントタイプ

DocType

ドキュメント

01000000

パスポート (グローバル)

00000001

中国本土の居住者向け第2世代 ID カード

00000006

ID カード (香港 (中国)) (2003 バージョン)

00000008

ID カード (香港 (中国)) (2018 バージョン)

00000007

香港・マカオへの出入国許可証

00000009

香港・マカオ居住者向け中国本土旅行許可証

000000011

ID カード (マカオ (中国))

000000012

台湾居住者向け中国本土旅行許可証

レスポンスパラメーター

パラメーター

タイプ

説明

HTTP ステータスコード

Integer

HTTP ステータスコード。

200

HTTP 本文

RequestId

String

リクエスト ID。

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

Code

String

リクエストに対して返されるコード。 詳細については、このトピックの コードとメッセージの説明 セクションを参照してください。

Success

Message

String

リクエストに対して返されるメッセージ。

success

Result.TransactionId

String

検証プロセスの一意の識別子。 このパラメーターは課金に使用されます。 このパラメーターは、CheckResult 操作を呼び出すためにも使用されます。

説明

リクエストで無効なパラメーターに関するエラーなどのエラーが発生した場合、Result.TransactionId は返されません。

hksb7ba1b28130d24e015d694361****

コードとメッセージの説明

HTTP ステータスコード

コード

メッセージ

200

Success

リクエストは成功しました。

400

パラメーター不足

必須パラメーターが空になっています。

InvalidParameter

パラメーターが無効な値に設定されています。

403

禁止されています。RAMUserAccessDenied

必要なポリシー AliyunAntCloudAuthFullAccess が Resource Access Management (RAM) ユーザーにアタッチされていません。詳細については、「RAM ユーザーに ID Verification - KYC へのアクセスを承認する」をご参照ください。

禁止。アカウントアクセスが拒否されました

アカウントに支払い遅延が発生しています。アカウントへの入金をお試しの上、もう一度やり直すことをお勧めします。

Throttling.Api

API スロットリングがトリガーされます。

500

内部エラー

内部エラーが発生しました。エラーのトラブルシューティングを行うには、テクニカルサポートに連絡することをお勧めします。