API仕様¶

このページでは、商業登記簿API「登記くん」のエンドポイント、リクエスト、レスポンス、エラーコードについて説明します。

接続確認・開発検証には Sandbox環境を利用できます。Sandbox用APIキーをご希望の場合は、support@tychy.jp までお問い合わせください。

HTTPステータスコード¶

ステータスコード	名称	説明
200	OK	処理が正常に完了しました。
202	Accepted	登記簿取得を他のリクエストで処理中です。
400	BadRequest	不正なパラメーターです。
401	Unauthorized	APIキーが正しくありません。
402	Payment Required	トライアル期間を過ぎているか、精算に失敗しています。
403	Forbidden	実行できないAPIが指定されました。
404	Not Found	入力された法人番号に対応する結果が存在しません。
429	Too Many Requests	APIリクエスト量が制限されました。
500	Internal Server Error	システムに異常が発生しました。お手数ですがsupport@tychy.jpまでお問い合わせください。
503	Service Unavailable	サービスが一時的に利用できません。
504	Gateway Timeout	タイムアウトしました。リトライしてください。
512	Teikyo Site Outside Business Hour	登記簿提供サイトの営業時間外です。
513	Teikyo Site Temporary Unavailable	登記簿提供サイトが一時的に利用できませんでした。
514	Touki Jiken	請求のあった会社・法人等は登記事件の処理中です。
515	Exceeds Plan Limit	プランの上限を超えています。
516	AccountNotActive	アカウントが無効です。
517	Large Touki Not Supported	大規模登記簿は現在サポートされていません。登記簿のデータ量が多く、分割請求が必要な法人は対応しておりません。詳細は FAQ をご確認ください。

GET /v1/toukikun/:houjinNumber¶

指定された法人番号をもとに商業登記簿PDFを取得し、PDFのダウンロードURLと解析済みの法人情報を返します。

Tip

登記簿の取得には30秒以上かかる場合があります。最初のリクエストがタイムアウトした場合でも、処理は非同期で継続され、取得結果はキャッシュされます。30秒ほど待ってから再度リクエストしてください。同じ法人番号に対するリクエストは、3日以内であれば一度しか課金されません。

リソースURL¶

https://api.tychy.jp/v1/toukikun/:houjinNumber

呼び出し例¶

:houjinNumber には、ハイフンなしの13桁の法人番号を指定してください。

curl -X GET https://api.tychy.jp/v1/toukikun/1234567890123 -H "Authorization: Bearer <APIキー>"

パラメーター¶

パラメーター	型	説明	例
houjinNumber	string	登記簿を取得する法人の法人番号。ハイフンなしの13桁で指定してください。	"1234567890123"

レスポンス¶

パラメーター	型	説明	補足
request_id	string	リクエストを一意に特定するためのUUID
message	string	システムからのメッセージ	お問い合わせの際にお知らせください。
is_charged	bool	このリクエストが課金対象になったかどうか
published_at	timestamp	API呼び出し時刻
cache_expires_at	timestamp	キャッシュの有効期限	この日時までは同じ法人番号の再取得は課金対象外です。
signed_url	string	登記簿PDFのリンク
pdf_name	string	PDFファイル名
file_id	string	ファイルID
houjin_number	string	法人番号
toukibo_created_at	timestamp	登記簿発行時刻
houjin_name	string	法人名
houjin_kaku	string	法人格	例: "株式会社"。対応している法人格の一覧はFAQをご確認ください。
houjin_address	string	法人住所
houjin_capital	int	資本金
houjin_stock	int	発行済み株式数
houjin_preferred_stocks	[]object	優先株式の情報	各要素に優先株式の種類（preferred_stock_type）と数量（preferred_stock_amount）を含みます。
houjin_executive_names	[]string	（現在有効な）役員氏名
houjin_representative_names	[]string	（現在有効な）代表者氏名
houjin_created_at	string	法人設立年月日
houjin_bankrupted_at	string	法人破産年月日
houjin_dissolved_at	string	法人解散年月日
houjin_continued_at	string	法人継続年月日

レスポンスの例¶

{
  "request_id": "018ecc69-d3b7-7ec9-8da8-e9a440300e2c",
  "message": "[free] toukibo found in cache",
  "is_charged": false,
  "published_at": "2024-03-10T13:31:44.187994546+09:00",
  "cache_expires_at": "2024-03-13T07:09:58.724351+09:00",
  "signed_url": "https://xxxx",
  "pdf_name": "0123012301234_20240309220958.pdf",
  "file_id": "779243783f72659fe3b6",
  "houjin_number": "0123012301234",
  "toukibo_created_at": "2024-03-10T13:31:44Z",
  "houjin_name": "株式会社近畿商事",
  "houjin_kaku": "株式会社",
  "houjin_address": "東京都Sample区Sample１丁目１番地１",
  "houjin_capital": 200000000,
  "houjin_stock": 20000,
  "houjin_preferred_stocks": [
    {
      "preferred_stock_type": "普通株式",
      "preferred_stock_amount": 10000
    },
    {
      "preferred_stock_type": "A1種優先株式",
      "preferred_stock_amount": 5000
    },
    {
      "preferred_stock_type": "A2種優先株式",
      "preferred_stock_amount": 5000
    }
  ],
  "houjin_executive_names": [
    "里井達也",
    "壹岐正"
  ],
  "houjin_representative_names": [
    "壹岐正"
  ],
  "houjin_created_at": "令和2年4月1日",
  "houjin_bankrupted_at": "",
  "houjin_dissolved_at": "",
  "houjin_continued_at": ""
}

GET /v1/getpdf/:id¶

ファイルIDを指定して、取得済みの登記簿PDFを取得します。

リソースURL¶

https://api.tychy.jp/v1/getpdf/:id

呼び出し例¶

:id には、GET /v1/toukikun/:houjinNumber のレスポンスに含まれる file_id を指定してください。

curl -X GET https://api.tychy.jp/v1/getpdf/jc1e0f1c9798cXXXXXXX -H "Authorization: Bearer <APIキー>"

パラメーター¶

パラメーター	型	説明	例
id	uuid	`GET /v1/toukikun/:houjinNumber`のレスポンスに含まれるファイルIDを指定してください。	"1b826e33-44fe-420a-b20c-b3bb6937aa2c"

レスポンス¶

レスポンスの Content-Type は application/json です。pdfObject.Body にPDF本文が格納されます。

Tip

PDFファイルの保存期間は1年間です。保存期間内であっても、ライセンス契約が終了した場合はファイルが削除されることがあります。

GET /v1/ping¶

APIの疎通確認用エンドポイントです。APIキーが正しく設定されているか確認する際に利用してください。

呼び出し例

curl -X GET https://api.tychy.jp/v1/ping -H "Authorization: Bearer <APIキー>"

GET /v1/todayusage¶

当日に課金対象となった登記簿取得件数を返します。¹

呼び出し例（50件取得した場合）

curl -X GET https://api.tychy.jp/v1/todayusage -H "Authorization: Bearer <APIキー>"
# → 50

GET /v1/currentmonthusage¶

当月に課金対象となった登記簿取得件数を返します。¹

呼び出し例（50件取得した場合）

curl -X GET https://api.tychy.jp/v1/currentmonthusage -H "Authorization: Bearer <APIキー>"
# → 50

GET /v1/previousmonthusage¶

先月に課金対象となった登記簿取得件数を返します。¹

呼び出し例（50件取得した場合）

curl -X GET https://api.tychy.jp/v1/previousmonthusage -H "Authorization: Bearer <APIキー>"
# → 50

課金対象外のリクエスト（エラーになった登記簿取得や、3日以内にキャッシュから取得した場合など）は含まれません。 ↩↩↩