在留手続申請API

「在留手続申請API」とは

これまで、所属機関等の職員の方や、所属機関から依頼を受けた弁護士・行政書士の方等しかできなかった在留諸申請手続を、令和4年3月から、外国人本人の方々についても在留申請手続をオンラインで行うことが可能となりました。
在留手続申請APIは、マイナンバーカードをお持ちの個人の方等から当該申請を、Webサービス提供者が提供できるよう作成し、公開するものです。

「在留手続申請API」の概要と提供API一覧

1. 概要

本サービスでは、マイナンバーカードを利用し、電子申請にて在留に関わる手続を申請可能とするため、「アカウント登録機能/利用者認証機能」「申請機能」「照会機能」を提供します。

「問診機能」「補正機能」「取下げ機能」は本サービスには含まれません。

2. 提供API一覧

提供API一覧
No. 業務 API 概要
1 利用者認証 民間サービス事業者認証API 民間サービス事業者の認証を行うAPI。
申請者認証API サービス利用者が本サービスを用いて手続の申請及び申請状況の照会等を行う際に、電子証明書を利用した場合の申請者用アカウントの作成及び申請者認証を行うAPI。
2 申請 申請データ送信API
(既存電子申請システム形式)
サービス利用者から送信された既存電子申請システム形式の申請データを受信するためのAPI。
申請受付番号確認API 申請が正常に受け付けられた後、受付番号を通知するためのAPI。
3 照会 申請一覧取得API 申請者に紐づく、OSS申請単位の一覧情報を送信するAPI。
申請状況詳細取得API 申請者が行った申請の中から、指定されたOSS申請に紐づいた各手続の詳細なステータスを送信するAPI。
メッセージ詳細取得API 対象各サービス機関から受領したメッセージを送信するAPI。
4 アカウント更新 アカウント更新API 申請者認証APIでアカウントを登録したサービス利用者が、電子証明書の有効期限が切れた等により申請状況が確認できなくなった場合に、アカウントを更新するAPI。

「在留手続申請API」の利用にあたって

APIの利用を開始するためには、本サイトにて利用規約(別ウィンドウ)機密保持誓約書(別ウィンドウ)を確認・同意し、仕様書取得申請フォーム(別ウィンドウ)より申請してください。申請が承認されるとユーザアカウントが作成され、開発者専用サイト(デジタルPMO)への初回ログインのためのURLが記載されたメールが送信されますので、そのURLにアクセスし初期設定を行った後、サービス情報を登録してください。
その後、デジタルPMOにて利用申請を提出し、承認されると仕様書や関連ドキュメントがダウンロード可能になります。
(開発ベンダー等に仕様書を共有する場合は本サイトから第三者開示承諾願(別ウィンドウ)をダウンロードの上、記入が完了しましたら利用申請の際にデジタルPMOにてご提出ください。)
利用手順の詳細は民間サービス事業者向け手引書(別ウィンドウ)をご参照ください。
なお、利用検討にあたり疑問等が生じた際は、随時本サイトの問合せフォーム(別ウィンドウ)にて、疑問点をお問い合わせ下さい。

API利用の申請

APIの利用を開始するためには、利用規約、機密保持誓約書を確認・同意し、仕様書取得を申請してください。

質問・お問い合わせ