コンテンツにスキップ

API仕様

商業登記簿API「登記くん」の公開エンドポイント、認証、レスポンス、エラーコードを説明します。

共通仕様

項目 内容
Production Base URL https://api.tychy.jp
Sandbox Base URL https://sandbox.tychy.jp
Authentication Authorization: Bearer <API_KEY>

Sandboxでの検証

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

認証

すべての /v1 API は Bearer Token 認証です。

Request header

Authorization: Bearer <API_KEY>

APIキーが誤っている場合、または本番用キーをSandboxで使った場合は 401 Unauthorized になります。

登記簿を取得する

GET/v1/toukikun/:houjinNumber

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

タイムアウトと再試行

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

Parameters

houjinNumber
required
string
登記簿を取得する法人の法人番号。ハイフンなし13桁で指定します。

Request example

curl -H "Authorization: Bearer <API_KEY>" \
  https://api.tychy.jp/v1/toukikun/1234567890123

Response fields

request_id
string
リクエストを一意に特定するUUID。お問い合わせ時にお知らせください。
message
string
取得結果やキャッシュ状態を示すメッセージ。
is_charged
boolean
このリクエストが課金対象になったかどうか。
published_at
timestamp
API呼び出し時刻。
cache_expires_at
timestamp
キャッシュの有効期限。この日時までは同じ法人番号の再取得は課金対象外です。
signed_url
string
登記簿PDFのリンク。
pdf_name
string
PDFファイル名。
file_id
string
PDF取得用のファイルID。
houjin_number
string
法人番号。
toukibo_created_at
timestamp
登記簿発行時刻。
houjin_name
string
法人名。
houjin_kaku
string
法人格。対応一覧は [FAQ](faq.md#supported-houjinkaku) を参照してください。
houjin_address
string
法人住所。
houjin_capital
integer
資本金。
houjin_stock
integer
発行済み株式数。
houjin_preferred_stocks
array<object>
優先株式の種類と数量。
houjin_executive_names
array<string>
現在有効な役員氏名。
houjin_representative_names
array<string>
現在有効な代表者氏名。
houjin_created_at
string
法人設立年月日。
houjin_bankrupted_at
string
法人破産年月日。該当なしの場合は空文字。
houjin_dissolved_at
string
法人解散年月日。該当なしの場合は空文字。
houjin_continued_at
string
法人継続年月日。該当なしの場合は空文字。

Response example

{
  "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://example.com/signed-url",
  "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 }
  ],
  "houjin_executive_names": ["里井達也", "壹岐正"],
  "houjin_representative_names": ["壹岐正"],
  "houjin_created_at": "令和2年4月1日",
  "houjin_bankrupted_at": "",
  "houjin_dissolved_at": "",
  "houjin_continued_at": ""
}

PDFを取得する

GET/v1/getpdf/:id

/v1/toukikun/:houjinNumber のレスポンスに含まれる file_id を指定して、取得済みの登記簿PDFを取得します。

Parameters

id
required
string
/v1/toukikun のレスポンスに含まれる file_id。

Request example

curl -H "Authorization: Bearer <API_KEY>" \
  https://api.tychy.jp/v1/getpdf/779243783f72659fe3b6 \
  --output toukibo.pdf

Tip

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

疎通確認

GET/v1/ping

APIキーが正しく設定されているか確認するためのエンドポイントです。

curl -H "Authorization: Bearer <API_KEY>" \
  https://api.tychy.jp/v1/ping
# ping

利用件数を取得する

当日・当月・前月に課金対象となった登記簿取得件数を返します。エラーになったリクエストや、3日以内にキャッシュから取得したリクエストは含まれません。

GET/v1/todayusage

当日の課金対象件数を返します。

GET/v1/currentmonthusage

当月の課金対象件数を返します。

GET/v1/previousmonthusage

前月の課金対象件数を返します。

curl -H "Authorization: Bearer <API_KEY>" \
  https://api.tychy.jp/v1/currentmonthusage
# 50

HTTPステータスコード

よく見るべきものは 200 / 202 / 401 / 429 / 504 です。512 以降は、登記簿提供サイト側の状態や登記簿の内容に関する独自エラーです。

正常・処理中

200OK処理が正常に完了しました。
202Accepted他のリクエストで登記簿を取得中です。少し待ってから再取得してください。

リクエスト・認証・契約

400Bad Request不正なパラメーターです。
401UnauthorizedAPIキーが正しくありません。
402Payment Requiredトライアル期間を過ぎているか、精算に失敗しています。
403Forbidden実行できないAPIが指定されました。
404Not Found入力された法人番号に対応する結果が存在しません。
429Too Many RequestsAPIリクエスト量が制限されました。時間を置いて再試行してください。

一時的なエラー

500Internal Server Errorシステムに異常が発生しました。support@tychy.jp までお問い合わせください。
503Service Unavailableサービスが一時的に利用できません。
504Gateway Timeoutタイムアウトしました。時間を置いて同じ法人番号で再取得してください。

登記簿提供サイト・登記簿固有のエラー

512Teikyo Site Outside Business Hour登記簿提供サイトの営業時間外です。
513Teikyo Site Temporary Unavailable登記簿提供サイトが一時的に利用できませんでした。
514Touki Jiken請求のあった会社・法人等は登記事件の処理中です。
515Exceeds Plan Limitプランの上限を超えています。
516Account Not Activeアカウントが無効です。
517Large Touki Not Supported大規模登記簿は現在サポートされていません。詳細は FAQ をご確認ください。