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