Serial

テスト中

POST

/v6/serial/request

マイナンバーカードの利用者証明用電子証明書に紐づけられているシリアル番号の提供を利用者にリクエストします。

リクエスト送信後、利用者への要求に関するレスポンスが返されます。
利用者のxIDアプリでの公的個人認証の操作が終わると、その結果（status）と利用者のserialを含む個人情報がクライアントアプリのcallback_urlに渡されます。callback_urlへの応答についてはcallback_urlへの応答にて詳細をご確認ください

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-uat.x-id.io/v6/serial/request' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bytes": "/8Sh6xef604iedYjkqN0BnQ2ycFlNmvxNw0tsIk9SFo=",
    "is_digest": true,
    "notification_title": "シリアル番号提供のリクエストが届いています",
    "notification_description": "〇〇サービスからシリアル番号提供の要求が届いています。xIDアプリを開いて公的個人認証を行なってください。",
    "reason": "〇〇市における住民票交付申請を行うために公的個人認証を実施してください。〇〇サービスで入力して頂いた申請情報にマイナンバーカードの署名用電子証明書による電子署名を行い、送信します。"
}'

Response Example

200 - 例 1

{
    "request_id": "string",
    "is_renewed": true,
    "expires_in": 0
}

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBearerの後にTokenを連結します

例：

Authorization: Bearer ********************

Request Bodyパラメータapplication/json

Examples

Response

🟢200成功

application/json

Body

🟠400不正な要求

🟠401権限なし

🔴500サーバーエラー

更新日時 2025-07-14 08:47:31

Serial APIの変更点概要

SerialRedirect