API仕様（OpenAPI Specification） | 氏名突合支援サービス | ドキュメント

氏名簡易突合

入力された漢字・アルファベット氏名とカナ氏名の簡易突合を行う。

パラメータに設定可能な氏名の漢字 (kanji) とカナ (kana) のパターン例は下表を参照。

含まれる氏名情報	kanji	kana
漢字氏名	日本　花子	ニッポン　ハナコ
漢字氏名＋旧氏	日本［東京］　花子	ニッポン　ハナコ
^	^	トウキョウ　ハナコ
アルファベット氏名	ＮＩＰＰＯＮ　ＨＡＮＡＫＯ	ニッポン　ハナコ
^	ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ	ニッポン　ジャパン　ハナコ
^	ＨＡＮＡＫＯ　ＪＡＰＡＮ　ＮＩＰＰＯＮ	ニッポン　ジャパン　ハナコ
アルファベット氏名＋漢字氏名	ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ＿日本　花子	ニッポン　ジャパン　ハナコ
^	^	ニッポン　ハナコ
アルファベット氏名＋漢字氏名＋通称	ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ＿日本　花子（東京　花子）	ニッポン　ハナコ
^	^	ニッポン　ジャパン　ハナコ
^	^	トウキョウ　ハナコ

query Parameters

kanji required	string [ 1 .. 100 ] Example: kanji=日本［東京］　花子漢字・アルファベット氏名
kana required	string [ 1 .. 100 ] Example: kana=トウキョウ　ハナコカナ氏名
key required	string [ 32 .. 32 ] Example: key=REPLACE_WITH_YOUR_API_KEY APIキー

Responses

Response samples

200
403

Content type

application/json

{"response": "OK",
"result": {"status": 90
},
"version": "1.6.1o"
}

氏名詳細突合

入力された漢字・アルファベット氏名とカナ氏名の詳細突合を行う。

パラメータに設定可能な氏名の漢字 (kanji) とカナ (kana) のパターン例は下表を参照。

含まれる氏名情報	kanji	kana
漢字氏名	日本　花子	ニッポン　ハナコ
漢字氏名＋旧氏	日本［東京］　花子	ニッポン　ハナコ
^	^	トウキョウ　ハナコ
アルファベット氏名	ＮＩＰＰＯＮ　ＨＡＮＡＫＯ	ニッポン　ハナコ
^	ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ	ニッポン　ジャパン　ハナコ
^	ＨＡＮＡＫＯ　ＪＡＰＡＮ　ＮＩＰＰＯＮ	ニッポン　ジャパン　ハナコ
アルファベット氏名＋漢字氏名	ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ＿日本　花子	ニッポン　ジャパン　ハナコ
^	^	ニッポン　ハナコ
アルファベット氏名＋漢字氏名＋通称	ＮＩＰＰＯＮ　ＪＡＰＡＮ　ＨＡＮＡＫＯ＿日本　花子（東京　花子）	ニッポン　ハナコ
^	^	ニッポン　ジャパン　ハナコ
^	^	トウキョウ　ハナコ

query Parameters

kanji required	string [ 1 .. 100 ] Example: kanji=日本［東京］　花子漢字・アルファベット氏名
kana required	string [ 1 .. 100 ] Example: kana=トウキョウ　ハナコカナ氏名
key required	string [ 32 .. 32 ] Example: key=REPLACE_WITH_YOUR_API_KEY APIキー

Responses

Response samples

200
403

Content type

application/json

{"response": "OK",
"result": {"status": 90
},
"version": "1.6.1o"
}

漢字氏名推定

カナ氏名から漢字氏名の候補を推定する。

query Parameters

kana required	string [ 1 .. 100 ] Example: kana=トウキョウ　ハナコカナ氏名
key required	string [ 32 .. 32 ] Example: key=REPLACE_WITH_YOUR_API_KEY APIキー
max	integer [ 1 .. 10 ] Default: 5 Example: max=5 最大返却数

Responses

Response samples

200
403

Content type

application/json

{"response": "OK",
"result": {"status": "OK",
"probability": [0.4825615885836141,
0.020703272421234174,
0.0002177858504058593,
0.00008489041374228077,
0.000057109595304728965
],
"kanji": ["日本花子",
"日本華子",
"日本はなこ",
"日本ハナコ",
"日本はな子"
]
},
"version": "1.6.1o"
}

カナ氏名推定

入力された漢字・アルファベット氏名からカナ氏名の候補を推定する。

query Parameters

kanji required	string [ 1 .. 100 ] Example: kanji=日本［東京］　花子漢字・アルファベット氏名
key required	string [ 32 .. 32 ] Example: key=REPLACE_WITH_YOUR_API_KEY APIキー
max	integer [ 1 .. 10 ] Default: 5 Example: max=10 最大返却数

Responses

Response samples

200
403

Content type

application/json

{"response": "OK",
"result": {"status": "OK",
"probability": [0.6937584041873546,
0.01117801634667634,
3.800085867851474e-7,
2.593153688493599e-7,
6.6314047768254374e-9
],
"kana": ["ニホンハナコ",
"ニッポンハナコ",
"ニホンバナコ",
"ニホンカコ",
"ニホンカシ"
]
},
"version": "1.6.1o"
}