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	請求のあった会社・法人等は登記事件の処理中です。登記が完了した後に再度請求してください。

GET /v1/toukikun/:houjinNumber¶

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

Note

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

リソースURL¶

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

パラメーター¶

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

レスポンス¶

Content-Type:"application/json"

{
    "houjin_address": "東京都Sample区Sample１丁目１番地１",
    "houjin_name": "株式会社近畿商事",
    "houjin_number": "0123012301234",
    "houjin_representative_names": [
        "壹岐正"
    ],
    "message": "toukibo found in cache",
    "pdf_name": "012301230123420231022172537.pdf",
    "pdf_url": "https://api.tychy.jp/v1/toukikun/pdf/1b826e33-44fe-420a-b20c-b3bb6937aa2c",
    "pdf_url_expires_at": "2023-10-25T20:20:00+09:00",
    "published_at": "2023-10-22T12:00:00+09:00",
    "toukibo_created_at": "2023-06-26T20:00:00Z"
}

GET /v1/toukikun/pdf/:id¶

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

リソースURL¶

https://api.tychy.jp/v1/toukikun/pdf/:id

パラメーター¶

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

レスポンス¶

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

Note

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

GET /v1/ping¶

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