/houjinbangou/companies

POST /api/houjinbangou/companies

Price: 20 credits

Get a Japanese company's registry record by its 13-digit Corporate Number (法人番号) from the National Tax Agency: registered name (and kana reading, English name when registered), head-office address, assignment and last-update dates, and the full change history (former names/addresses, mergers and other registered changes).

How to use it

Look up a Japanese company by its 13-digit Corporate Number / 法人番号 (e.g. '1180301018771' for Toyota). Returns corporate_number, name (Japanese), kana, name_en/address_en (when the company registered them), address, assigned_at, updated_at and changes (date/reason of each registered change, including the assignment record). The Corporate Number's leading check digit is validated.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• corporate_number string required — Japanese Corporate Number (法人番号) — a 13-digit identifier (examples: "1180301018771", "7000012050002")

Response

• @type string (default: "HoujinbangouCompany")
• corporate_number string required
• name string required
• kana string nullable
• name_en string nullable
• address string nullable
• address_en string nullable
• updated_at string nullable
• updated_at_raw string nullable
• assigned_at string nullable
• status string nullable
• closed_at string nullable
• changes array (default: [])
  • @type string (default: "HoujinbangouChange")
  • date string nullable
  • date_raw string nullable
  • reason string nullable
  • assigned boolean (default: false)
• url string required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Corporate Number not found (valid 13-digit format but no company is assigned this number) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.