在留カードAPI
概要
券面に記載されている在留カード等番号を入力し、在留カードまたは特定在留カードのICチップを読み取ることで、在留カードまたは特定在留カードの情報を全て取得します（取得項目は選択可能です）。また、在留カードまたは特定在留カードに格納されているチェックコードを検証することで真贋判定を行い、有効期限満了日と当日の日付を比較することで、有効性確認も同時に行います。真贋および有効性の確認後、在留カードまたは特定在留カードの情報を取得できます。
在留カードには第1世代と第2世代の2種類があり、一部の取得項目が異なります。各在留カードの取得項目については、「第1世代在留カードの取得項目」および「第2世代在留カードの取得項目」をご覧ください。
取得できる項目
アクセスコントロール
処理の流れ
対面
非対面
在留カード等番号の入力要求（サービスプロバイダ事業者）
SDKを利用して取得する在留カード等番号の入力を利用者に要求します。
在留カード等番号の入力（利用者）
在留カード等番号を入力し、サービスプロバイダ事業者に送信します。スマートフォンの場合は、OCR用のカメラが起動するので、在留カードの券面を映すことで在留カード等番号を読み取ることができ、入力の手間を省くことができます。OCRによる読み取りがうまくいかない場合は、別途在留カード等番号を入力するためのUIを用意いただく必要がございます。
在留カード・特定在留カードのデータ取得（サービスプロバイダ事業者）
SDKを利用して在留カードまたは特定在留カードのICチップを読み取り、利用者が入力した在留カード番号または特定在留カード番号を利用することで、在留カードまたは特定在留カードのデータを取得します。取得したデータは、署名検証・有効性確認・利用できる形式への変換を行うために、専用のAPIで送信します。
在留カード・特定在留カードの署名検証・有効性確認（プラットフォーム事業者）
APIで送信されたデータより、電子署名を取得し、署名検証による真贋判定を行います。署名検証後は、在留カードの有効期限満了日と当日の日時を比較することで、有効性確認を行います。第一世代の在留カードに限り、券面イメージ内の有効期限満了日を抽出し、そちらを照合するため、抽出失敗時はエラーを返却します。注意
紛失、出国済み、在留資格の取消しなど、失効理由を確認される場合は、出入国在留管理庁の提供する「在留カード等番号失効情報照会」を別途ご利 用ください。
紛失、出国済み、在留資格の取消しなど、失効理由を確認される場合は、出入国在留管理庁の提供する「在留カード等番号失効情報照会」を別途ご利 用ください。
在留カード・特定在留カードの情報取得（プラットフォーム事業者）
署名検証および有効性確認後、在留カードの情報を利用できる形式へ変換し、サービスプロバイダ事業者へ返却します。取得項目を選択している場合は、対象の項目のみ返却されます。
シーケンス図
対面
非対面
実装例
iOS
Android
React Native
Windows