はじめに
連携 / SDK
ユーザー認証
法人確認
トランザクションモニタリング
変更履歴document_subtypeは、Didit が認識した書類の具体的な種類を示します。たとえば、一般的な運転免許証ではなくクイーンズランド州の運転免許証であること、あるいは標準の運転免許証ではなく米国の商用運転免許証 (Commercial Driver’s License) であることを識別します。このページでは、このフィールドが返す可能性のあるすべての値を列挙します。
お使いのワークフローで受け付けるのは、これらのうちワークフローの書類設定ステップで選択したものだけです。以下のすべての値が有効になっていると想定せず、Management APIのワークフロー取得エンドポイント (OCRノードの
documents_allowed) を使って、ワークフローで受け付ける正確なリストを取得してください。命名パターン
document_subtypeの値は、次の2つの形式のいずれかです。
- カテゴリのみ:
{CATEGORY}。Didit が地域ごとに区別する必要のない書類 (ほとんどのパスポート、ほとんどの国民IDカード) に使われます。例:PASSPORT_GENERIC、ID_CARD_GENERIC。 - 地域プレフィックス付き:
{REGION}_{CATEGORY}。州、省、準州によって書式や分類が実際に異なる書類に使われます。例:QUEENSLAND_DRIVER_LICENSE_GENERIC(オーストラリア)、CALIFORNIA_COMMERCIAL_DL(米国)。地域プレフィックスは発行元の州または省の名称を大文字にし、スペースをアンダースコアに置き換えたものです。
すべてのサブタイプの値
以下の表は、レポートが返す可能性のあるdocument_subtypeの値をすべて列挙したもので、document_typeのファミリーごとにグループ化しています。地域プレフィックス付きのバリアントもすでに含まれています。たとえば、Driver’s Licenseの下にはDRIVER_LICENSE_GENERIC (ほとんどの国) とCALIFORNIA_DRIVER_LICENSE_GENERICの両方が別々の行として表示されます。
カテゴリのみのコードは1つの国に固有のものではありません。その書類のレジストリエントリに地域固有のバリアントがないすべての国で共有されます。たとえばID_CARD_GENERICは、約170か国の国民IDカードを対象としています。コードは必ずdocument_typeのグループと (ある場合は) 地域プレフィックスで照合し、1つのコードが1つの国に対応すると決して想定しないでください。
米国の運転免許証 標準免許と商用免許 (CDL)
document_typeは、標準の運転免許証と商用運転免許証 (CDL) のどちらでも"Driver's License"となり、両者を区別することはありません。区別はdocument_subtypeだけで行われます。
Didit が分類する米国の51の州および地域のうち48では、CDLにその州の{STATE}_DRIVER_LICENSE_GENERICとは別の{STATE}_COMMERCIAL_DLサブタイプが割り当てられます。 これらの州では、document_subtypeが_COMMERCIAL_DLで終わることを「CDLである」と判断する信頼できるシグナルとして扱えます。
extra_fields.dl_categoriesはCDLの信頼できるシグナルではない
一部の米国の免許証ではextra_fields.dl_categoriesも生成されます。これは、カードに印字されたクラスの文字 (A、B、C、…) をOCRで読み取ったリストです。これをCDLのシグナルとして使用しないでください。 現在、このフィールドが設定されるのは米国の運転免許証の構成のうちごく一部に限られます。また、クラスの文字の意味は州によって異なり、商用か非商用かという意味に正規化されていません。さらに、多くの免許証で実際に「商用」であることが示される裏書コードや制限コードは、現時点ではレポートにまったく含まれていません。現在、標準免許と商用免許を区別するための構造化された信頼できるシグナルはdocument_subtypeだけです。
最新の状態を保つ
新しいdocument_typeファミリーは、提供開始時に月次の変更履歴で告知されます。document_subtypeの追加 (たとえば既存の書類タイプの新しい地域別バリアント) は、現時点では個別に告知されません。Didit の書類レジストリは、新しい書類形式が追加されるにつれて継続的に拡大しています。このリストについて、Webhookペイロードにバージョン番号はありません。
連携でこれまでに見たことのないサブタイプを検出する必要がある場合は、値のセットが固定されていると想定せず、コードが認識しないdocument_subtypeの値をエラーにするのではなく「未分類、手動でレビュー」として扱ってください。また、このページ、またはManagement APIを使用してワークフローで受け付けるサブタイプのリストを定期的に確認してください。
関連情報
- 本人確認レポート:
document_type/document_subtypeフィールドの使われ方。 - 対応している本人確認書類: Didit が対応している国と書類タイプ。
- データモデル: 本人確認: 標準フィールドスキーマ。