Introduction

xID APIへようこそ🙌

xIDのAPIソリューションを活用することで、面倒な手続きなしにマイナンバーカードの公的個人認証の仕組みを導入したり、OpenID Connectの認証技術の国際標準仕様に準拠した認証・認可機能の実装が可能です。

認証・認可・電子署名・E2E暗号化によるマイナンバーの受け取りなど、サービスに合わせて各機能をご利用いただけます。

以下の手順でxID APIの利用を開始することができます。

利用手順

利用者情報暗号化のための鍵を生成する -> 利用者情報を暗号化する

当社に問い合わせのうえ、認可クライアントを発行する -> 認可クライアントを取得する

検証環境を用意する -> 検証環境を利用する

認可フローを実施し、アプリユーザーのアクセストークンを取得する -> アクセストークンを取得する

アクセストークンを使って任意のAPIリクエストを送信する

認可クライアント取得後、本サイトにて実際にxID APIの仕様を確認しながら各エンドポイントにリクエストを送ることができます。

ヒント

本サイトからAPIリクエストを送信するには、認可クライアント取得時にCORSを許可したいOriginにhttps://document.x-id.me/を指定してください。

サービス概要

xIDはマイナンバーカードに関する様々なサービスを提供しています。各ページにてAPIリクエストのシーケンスや利用者の操作フローを確認できます。

電子署名：利用者にxIDアプリでの電子署名をリクエストします。

本人確認情報更新：xIDアカウントに登録されている利用者の本人確認情報を更新します。

マイナンバー：利用者にマイナンバーの提供をリクエストします。

公的個人認証：利用者にクライアント事業者（自治体）を署名検証者とした公的個人認証をリクエストします。

マイナポータル向け公的個人認証：マイナポータルを使用する利用者にxIDによる公的個人認証をリクエストします。

券面事項入力補助：マイナンバーカードの券面事項入力補助APを用いて、マイナンバーを除く基本四情報の提供を利用者にリクエストします。

シリアル：利用者に公的個人認証を要求し、マイナンバーカードの利用者証明用電子証明書に紐付けられたシリアル番号の提供をリクエストします。

Authentication

OAuth 2.0: OAuth2

OIDC認可フローを実施し、各APIへのリクエストに必要なaccess_tokenを取得します。詳細はスタートアップガイドをご確認ください。

項目内容

Security Scheme Type oauth2

OAuth Flow (authorizationCode) Token URL: https://oidc.x-id.io/oauth2/token
Authorization URL: https://oidc-uat.x-id.io/oauth2/auth

Scopes:
• openid: 認証
• verification: 本人確認
• signing: 電子署名の要求
• mynumber: マイナンバーの取得
• reverification: 本人確認情報更新
• jpki: 公的個人認証
• pittari: マイナポータル向け公的個人認証
• serial: 利用者証明用証明書シリアル番号の取得
• cardinput: マイナンバーカード券面事項の取得

項目	内容
Security Scheme Type	oauth2
OAuth Flow (authorizationCode)	Token URL: `https://oidc.x-id.io/oauth2/token` Authorization URL: `https://oidc-uat.x-id.io/oauth2/auth` Scopes: • `openid`: 認証 • `verification`: 本人確認 • `signing`: 電子署名の要求 • `mynumber`: マイナンバーの取得 • `reverification`: 本人確認情報更新 • `jpki`: 公的個人認証 • `pittari`: マイナポータル向け公的個人認証 • `serial`: 利用者証明用証明書シリアル番号の取得 • `cardinput`: マイナンバーカード券面事項の取得

HTTP: Bearer Auth

項目	内容
Security Scheme Type	http
HTTP Authorization Scheme	bearer
Bearer format	JWT

HTTP: Basic Auth

client_idとclient_secretを入力してください。

項目	内容
Security Scheme Type	http
HTTP Authorization Scheme	basic

利用手順#

サービス概要#

Authentication#

OAuth 2.0: OAuth2#

HTTP: Bearer Auth#

HTTP: Basic Auth#

利用手順

サービス概要

Authentication

OAuth 2.0: OAuth2

HTTP: Bearer Auth

HTTP: Basic Auth