登記くん API ドキュメント
法人番号を指定して、商業登記簿PDFと解析結果を取得できます。
できること¶
- 登記簿PDFを取得
- 法人番号を指定するだけで、商業登記簿PDFの取得と保存を実行します。
- JSONで解析結果を返却
- 法人名、所在地、代表者、役員、資本金、株式、破産・解散情報などを構造化します。
- 業務システムへ連携
- 審査システム、Slack Bot、Google Apps Script、CRMなどから利用できます。
Quickstart¶
APIキーを用意します。
本番利用にはポータルで発行されたAPIキー、検証にはSandbox用APIキーを使います。
本番利用にはポータルで発行されたAPIキー、検証にはSandbox用APIキーを使います。
疎通確認します。
GET /v1/ping で認証とBase URLが正しいことを確認します。法人番号で登記簿を取得します。
GET /v1/toukikun/:houjinNumber を呼び出し、解析済みJSON、PDFリンクの signed_url、file_id を受け取ります。必要に応じてPDFをAPI経由で取得します。
PDFファイルとしてダウンロードしたい場合は、
PDFファイルとしてダウンロードしたい場合は、
GET /v1/getpdf/:id に file_id を指定します。システム概要¶
sequenceDiagram
participant Customer as お客様のシステム
participant API as 登記くんAPI
participant Site as 登記簿サイト
participant S3 as S3
Customer->>API: 登記簿取得リクエスト送信(キー: 法人番号)
API->>Site: ログイン情報入力
Site->>Site: ログイン情報認証
Site->>API: ログイン成功
API->>Site: 登記簿取得リクエスト
Site->>API: 登記簿PDFデータ送信
API->>S3: 登記簿PDFデータをS3にアップロード
S3-->>API: アップロード完了の応答
API->>API: 登記簿PDFの解析(法人格、本店、商号、代表者氏名の取得)
API-->>Customer: 登記簿PDFのURL + 解析結果(法人格、本店、商号、代表者氏名、代表者住所等)
お問い合わせ¶
製品に関するお問い合わせは、support@tychy.jp までお願いいたします。