コンテンツにスキップ

API仕様

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

概要

APIは商業登記簿API「登記くん」に対してHTTP経由で実行できます。

HTTPステータスコード

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

GET /v1/toukikun/:houjinNumber

与えられた法人番号を元に、登記簿PDFを取得します。PDFをS3にアップロードし、URLと登記簿の解析結果を返します。

Note

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

リソースURL

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

パラメーター

パラメーター 説明
houjinNumber string 登記簿を取得したい法人の法人番号。ハイフン無しで13桁で指定してください。頭がゼロの場合にも省略せずに指定してください。 "0123012301234"

レスポンス

パラメーター 説明 用途
request_id string リクエストを一意に特定するためのUUID
message string システムからのメッセージ  お問い合わせの際に添付ください
is_charged bool 課金されたか
published_at timestamp API呼び出し時刻
cache_expires_at timestamp キャッシュ期間(課金から3日以内)
pdf_name string PDFファイル名
file_id string ファイルID PDFファイルを取得するには"https://api.tychy.jp/v1/getpdf/.pdf"のようにリクエストする
houjin_number string 法人番号
toukibo_created_at timestamp 登記簿発行時刻
houjin_kaku string 法人格 "株式会社"
houjin_name string 法人名
houjin_address string 法人住所
houjin_created_at string 法人設立年月日
houjin_bankrupted_at string 法人破産年月日
houjin_dissolved_at string 法人解散年月日
houjin_capital int 資本金
houjin_representative_names []string 代表者氏名

レスポンスの例

Content-Type:"application/json"
{
  "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",
  "pdf_name": "0123012301234_20240309220958.pdf",
  "file_id": "779243783f72659fe3b6",
  "houjin_number": "0123012301234",
  "toukibo_created_at": "2024-03-10T13:31:44Z",
  "houjin_kaku": "株式会社",
  "houjin_name": "株式会社近畿商事",
  "houjin_address": "東京都Sample区Sample1丁目1番地1",
  "houjin_created_at": "令和2年4月1日",
  "houjin_bankrupted_at": "",
  "houjin_dissolved_at": "",
  "houjin_capital": 200000000,
  "houjin_representative_names": [
        "壹岐正"
  ]
}

GET /v1/getpdf/:id

与えられたファイルIDから、登記簿PDFを取得します。

リソースURL

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

パラメーター

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

レスポンス

Content-Type:"application/json"で、pdfObject.BodyにPDF本文が格納されます。

Note

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

GET /v1/ping

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