登記くんドキュメント
製品サイト
会社概要
製品サイト
会社概要

API仕様

このページでは、商業登記簿API「登記くん」の仕様を説明します。

HTTPステータスコード

ステータスコード RPC 説明
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をS3にアップロードし、URLと登記簿の解析結果を返します。

TIP

登記簿請求には30秒以上かかる場合があります。最初のリクエストがタイムアウトした場合にも非同期で実行を完了し、結果をキャッシュしています。3分後に再度リクエストしてください。3日以内の同じ法人番号に対するリクエストには一度しか課金されません。

リソースURL

https://api.tychy.jp/v1/toukikun/: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 キャッシュ有効期限(課金から3日以内)
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 法人格 "株式会社"など、現在対応している法人格の一覧はこちら
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には/v1/toukikunのレスポンスから取得したファイル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

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

GET /v1/ping

疎通確認用です。APIキーが正しく設定されているかを確認するために利用してください。

呼び出し例

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

GET /v1/todayusage

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

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

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

GET /v1/currentmonthusage

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

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

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

GET /v1/previousmonthusage

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

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

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

Footnotes

  1. 課金対象でないリクエスト（エラーになった登記簿取得や、3日以内にキャッシュから取得した登記簿取得）は対象となりません。 ↩ ↩2 ↩3

ON THIS PAGE