マイナポータルAPI
在留手続申請API
公開日
更新日
「在留手続申請API」とは
これまで、所属機関等の職員の方や、所属機関から依頼を受けた弁護士・行政書士の方等しかできなかった在留諸申請手続を、令和４年３月から、外国人本人の方々についても在留申請手続をオンラインで行うことが可能となりました。
在留手続申請APIは、マイナンバーカードをお持ちの個人の方等から当該申請を、APIの利用を希望する者が提供できるよう作成し、公開するものです。
概要
本サービスでは、マイナンバーカードを利用し、電子申請にて在留に関わる手続を申請可能とするため、「アカウント登録機能/利用者認証機能」「申請機能」「照会機能」を提供します。
※「問診機能」「補正機能」「取下げ機能」は本サービスには含まれません。
提供API一覧
| 業務 | API | 概要 |
|---|---|---|
| 利用者認証 | 民間サービス事業者認証API | 民間サービス事業者の認証を行うAPI。 |
| 利用者認証 | 申請者認証API | サービス利用者が本サービスを用いて手続の申請及び申請状況の照会等を行う際に、電子証明書を利用した場合の申請者用アカウントの作成及び申請者認証を行うAPI。 |
| 申請 | 申請データ送信API（既存電子申請システム形式） | サービス利用者から送信された既存電子申請システム形式の申請データを受信するためのAPI。 |
| 申請 | 申請受付番号確認API | 申請が正常に受け付けられた後、受付番号を通知するためのAPI。 |
| 照会 | 申請一覧取得API | 申請者に紐づく、OSS申請単位の一覧情報を送信するAPI。 |
| 照会 | 申請状況詳細取得API | 申請者が行った申請の中から、指定されたOSS申請に紐づいた各手続の詳細なステータスを送信するAPI。 |
| 照会 | メッセージ詳細取得API | 対象各サービス機関から受領したメッセージを送信するAPI。 |
| アカウント更新 | アカウント更新API | 申請者認証APIでアカウントを登録したサービス利用者が、電子証明書の有効期限が切れた等により申請状況が確認できなくなった場合に、アカウントを更新するAPI。 |
活用事例
在留手続申請APIを活用している事例を公開しています。
【在留申請】外国人留学生を受入れる大学職員が、Visa Speasyにおいて、在留資格申請受付から入国管理局へのオンライン申請、CoEデータの受取り・送付、入学後の在籍管理まで一気通貫で対応・管理を行うことで、大学職員の受入手続き業務を軽減し、注力分野へのリソース活用ができるサービスです。（利用API：在留手続申請API）
【在留申請】nicrasを使えば、エクセルベースで申請書入力と申請データ送信を行うことができます。地方入国管理局に出向く手間は勿論のこと、在留申請オンライン画面で１件ずつ膨大な項目数を入力する手間を省いた、行政書士や弁護士の方々等、在留申請取次業務に携わる方々向けのソリューションです。（利用API：在留手続申請API）
【在留申請】「visadas（ビザダス）」は、外国人雇用のためのビザ申請をオンラインでサポートするサービスです。書類作成や入国管理局への訪問、行政書士への依頼を不要にし、申請手続きを簡素化することを目指しています。（利用API：在留手続申請API）
「在留手続申請API」の利用にあたって
APIの利用を開始するためには、本サイトにて利用規約（PDF／359KB）、機密保持誓約書（PDF／163KB）をご確認のうえ、API利用申請フォームから仕様書の取得申請や利用申請を行ってください。なお、API利用申請フォームを利用する際、初めての方はユーザーアカウントの新規登録が必要になります。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。
申請内容がデジタル庁の審査により承認されると、開発が可能となります。
（審査後に開示されるエンドポイントなどの情報を開発ベンダーなど第三者に共有する場合は、デジタル庁が申請内容を確認後に案内する「第三者開示承諾願」をAPI利用申請フォームにてご提出ください。）
利用手順の詳細は、API利用申請者向け手引書（PDF／3.6MB）をご参照ください。
なお、利用検討にあたり疑問等が生じた際は、随時API利用申請フォームのお問合せにてご連絡ください。
APIの利用までの流れ
APIの利用申請をしてからサービス利用開始までの参考期間として約半年から約1年ほどかかります。
参考期間は、過去のAPI利用申請事業者が実際にかかった値を基に算出しています。実際にリリースまでにかかる期間は事業者の体制や使用するAPIの種類、サービスの規模等によって変動いたしますので、あらかじめご了承ください。
また、詳細のフローにつきましては、API利用申請者向け手引書（PDF／3.6MB）をご確認ください。
※開発、接続試験、本番動作確認は事業者の体制や利用するAPIの種類、サービスの規模によって期間が大きく変動します。
1．利用検討
利用したいAPIの概要・手引書・利用規約・機密保持誓約書等を確認して、APIの利用について検討ください。
2．利用申請
必要書類の確認をし、利用の意思が概ね固まったら、利用申請手続きを行ってください。
デジタル庁が申請内容を確認後、審査に必要な書類を案内するため、審査に必要な書類を作成のうえAPI利用申請フォームにてご提出ください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
（参考期間：約1週間）
3．審査
デジタル庁にて申請書類を確認し、審査を行います。承認されると、開発が可能となります。
（参考期間：約2週間）
4．開発
事業者において、必要な開発を行ってください。
（参考期間：約5か月）
5．接続試験
接続試験の準備ができましたら、接続確認環境の利用申請を提出してください。
デジタル庁が申請内容を確認し、アカウント等の払い出しが完了すると、接続試験を実施することができます。
（参考期間：約4か月）
- 接続試験は、テスト用マイナンバーカードを使用して実施します。そのため、J-LIS（地方公共団体情報システム機構）への貸与申請を実施し、接続試験の開始までに、テスト用マイナンバーカードの事前準備をお願いします。
- iOSの接続試験は、TestFlightを使用して実施します。TestFlightの利用にはApple IDの登録が必要です。承諾書の発行後に、デジタル庁がTestFlight登録申請に関する案内を送付するため、あらかじめApple IDの事前準備をお願いします。
6．本番動作確認
本番動作確認の開始予定日の15営業日前までに、動作確認を実施するための申請を提出してください。
デジタル庁が申請内容を確認し、アカウント等の払い出しが完了すると、本番動作確認を実施することができます。
（参考期間：約1か月）
- 本番動作確認は、マイナンバーカードを使用して実施します。本番動作確認の開始までに、利用目的に沿ったマイナンバーカードの事前準備をお願いします。
7．サービス提供前確認
サービス開始予定日の2週間前までに本番動作確認完了報告書を提出してください。
デジタル庁が本番動作確認完了報告書を受領したら、サービス提供前の確認を行います。
サービス提供前確認完了後、確認結果の通知を行い、事業者はサービスを開始することができます。
（参考期間：約1～2週間）
APIの利用申請
以下の流れに沿って、APIの利用を申請してください。
利用申請手続き
1．必要書類の確認
はじめに、API利用申請者向け手引書、利用規約、機密保持誓約書を確認し、仕様書取得を行ってAPIの利用について検討してください。
API利用申請者向け手引書（PDF／3.6MB）
利用規約（PDF／359KB）
機密保持誓約書（PDF／163KB）
仕様書の事前取得
仕様書の取得には申請が必要です。以下より申請を行ってください。
仕様書の取得申請
2．利用申請
利用の意思が概ね固まったら、以下よりAPIの利用を申請してください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
よくある質問・お問合せ
※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。