APIに関する共通質問

APIはHTTPSを利用したREST APIとして提供します。
契約後に管理コンソールで発行するAPIキーを使用して、お客様のサーバーから呼び出します。
各APIの仕様は、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

標準的な構成は、お客様のアプリに組み込んだSDKでICチップから読み取ったデータを、お客様のサーバー経由で対応するAPIのパラメータに設定し、リクエストを送信・レスポンスを受信する構成です。取得したAPIキーはアプリ側に保持せず、お客様のサーバーの環境変数に設定するなどしてAPIを呼び出してください。
また、APIの利用には接続元IPアドレスの登録が必要です。管理コンソールより接続元IPアドレスの設定を行うことができます。

本人確認アプリサービスをご利用の場合は、弊社提供アプリと管理コンソールを中心とした構成となるため、API・SDKの組み込みは不要です。
詳細はドキュメントをご確認ください。
本人確認API →
本人情報取得API →

取得できる情報は、利用するAPIによって異なります。
例えば、マイナンバーカードの券面データや券面事項入力補助情報、在留カード・特別永住者証明書などのICチップ情報、公的個人認証の検証結果や証跡などを取得できます。
なお、マイナンバーカード券面API（裏面）およびマイナンバーカード券面事項入力補助API（裏面）は、事前に弊社へ申請いただき、利用目的が法令上の利用範囲に照らして妥当と判断された場合に限り利用できます。
具体的な取得可能項目はドキュメントを、レスポンス項目・データ型については契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。
本人確認API →
本人情報取得API →

サーバー側では、アプリ（SDK）から送信された読み取りデータの受け取り、管理コンソールで発行したAPIキーを使用したAPI呼び出し、接続元IPアドレスの登録、レスポンスの受信・処理などが必要です。
APIキーはアプリケーションに埋め込まず、サーバー側で管理してください。具体的な実装手順は、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

当社へご来訪いただく場合に限り、テストカードの貸与に対応しています。
貸与できる枚数や時間には限りがあるため、事前に弊社担当者またはサポート窓口までご相談ください。

現時点では、秒間・日次・月次などの具体的な上限値は設けていません。
契約時に想定される利用量を確認し、実際の利用量が想定を大幅に上回る場合は、弊社からご連絡し、利用状況を確認させていただく場合があります。

APIの利用には、契約後に管理コンソールで発行するAPIキーを使用します。
APIキーは第三者に公開されないよう適切に管理してください。
具体的な認証方式については、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

リクエストは、利用するAPIによって異なりますが、レスポンスはJSON形式となります。
各APIのエンドポイント、パラメータ、データ型、レスポンス項目については、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

J-LIS等の外部機関への照会を含むAPIは、応答に時間を要する場合があるため、クライアント側のタイムアウトには余裕を持たせてください。
リトライする場合は、ネットワーク障害などの一過性のエラーに限り、間隔を空けて実施してください。初回の処理が成功していた場合に二重処理となる可能性があるため、同一リクエストのむやみな再送は避けてください。
推奨値などの詳細は、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

あります。APIの利用には、開発環境・本番環境それぞれで接続元IPアドレスの登録が必要です。
登録方法や具体的な接続要件については、契約時にご案内するとともに、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

APIはバージョン付きで提供しており、後方互換性に影響する重要な変更については、内容に応じて事前またはリリース時にお知らせします。
APIのバージョンや対応状況は更新される場合があります。詳細なバージョン・互換性については、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。

現在準備中のリリースノートよりご確認いただけます。ドキュメントより公開する予定のため、追ってお知らせいたします。
また、重要な仕様変更やアップデートについては、お客様へ随時お知らせします。

APIごとのエラーコード、エラーレスポンスおよび原因・対処方法は、契約後に閲覧権限が付与されるAPIリファレンスをご確認ください。
解決しない場合は、利用したAPI、発生日時、エラーコード等を添えてテックサポート窓口までお問い合わせください。

対象環境で発行された最新のAPIキーを使用しているか、接続元IPアドレスの設定に誤りがないかをご確認ください。
APIキーを再発行した場合、それまで使用していたAPIキーは無効となります。
解決しない場合は、テックサポート窓口までお問い合わせください。

通信環境、接続先URL、対象環境（開発・本番）、接続元IPアドレスの設定をご確認ください。
また、J-LIS等の外部機関側の遅延・停止が原因となる場合があります。
継続して発生する場合は、発生日時、対象API、リクエスト状況等を添えてテックサポート窓口までお問い合わせください。
また、同一リクエストのむやみな再送は避けてください。

利用シーンと、利用者がお持ちの本人確認書類に応じて選択します。
・契約や口座開設など、法的な根拠が必要な非対面の本人確認：公的個人認証（署名API）
・サービスへのログインなど、繰り返し行う本人認証：公的個人認証（利用者証明API）
・iPhoneに搭載したマイナンバーカードで、必要な情報だけを提示してもらう：カード代替電磁的記録
・窓口など対面で、マイナンバーカード・運転免許証・在留カード・特別永住者証明書を確認する：ICチップ読み取り
・上記の書類で非対面の本人確認を行う：ICチップ読み取り＋容貌撮影
複数の方式を組み合わせて利用することもできます。導入前のご相談も承っています。
本人確認API →
お問い合わせ →

犯罪収益移転防止法施行規則（第6条第1項第1号）における主な対応は次の通りです。2027年4月1日施行の改正により方式の呼称（条項の記号）が変わるものは、括弧内に改正後の呼称を記載しています。
・カ方式（旧ワ方式、2027年4月以降はヌ方式）公的個人認証
・ル方式（2027年4月以降はト方式）カード代替電磁的記録
・イ方式 対面での本人確認書類の提示＋ICチップ読み取り
・ヘ方式（2027年4月以降はハ方式）ICチップ情報の送信＋容貌の撮影
公的個人認証 →
カード代替電磁的記録 →
ICチップ読み取り →
ICチップ読み取り＋容貌撮影 →

利用する本人確認方式によって異なります。
・公的個人認証：マイナンバーカード（またはスマートフォンのマイナンバーカード）、署名用電子証明書の暗証番号（6〜16桁）または利用者証明用電子証明書の暗証番号（4桁）
・カード代替電磁的記録：Appleウォレットにマイナンバーカードを搭載したiPhone
・ICチップ読み取り：本人確認書類と、書類ごとの暗証番号や券面記載の番号（マイナンバーカードは券面事項入力補助用暗証番号または照合番号、運転免許証は暗証番号1・2、在留カード・特別永住者証明書は在留カード等番号）
・非対面で利用者自身のスマートフォンで読み取る場合：NFC搭載のスマートフォンと、SDKを組み込んだお客様のアプリ（またはマイナアプリ）
対面の場合、利用者側にスマートフォンは不要です。

書類・暗証番号の種類ごとに連続して間違えられる回数が決まっており、超えるとロックされます。
・マイナンバーカード 署名用電子証明書の暗証番号：5回
・マイナンバーカード 利用者証明用電子証明書・券面事項入力補助用の暗証番号：3回
・運転免許証の暗証番号1・2：3回（間違えた暗証番号のみロック）
・マイナ免許証の暗証番号：10回
ロックの解除は、事業者様・弊社では行えません。マイナンバーカードは市区町村の窓口、運転免許証・マイナ免許証は警察署・運転免許センターで利用者ご本人に解除手続きを行っていただく必要があります。