/nice_bizinfo/companies

POST /api/nice_bizinfo/companies

Price: 20 credits

South Korean company profile from NICE BizINFO: names, registration numbers, representative, listing class, market and size, status and dates, industry, products, group, bank, addresses and phones, certifications, yearly patent counts, employment and salary figures, the company's position within its industry and a written summary

How to use it

Pass an id from nice_bizinfo/companies/search or a 10-digit business registration number; resolve a corporate registration number or a company name through the search first.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — NICE BizINFO company id, business registration number or profile URL (examples: "380725", "JX8989", "2208139938", "https://www.nicebizinfo.com/ep/EP0100M002GE.nice?kiscode=064847"; minLength: 1)

Response

• @type string (default: "NiceBizinfoCompany")
• id string required
• name string nullable
• name_en string nullable
• name_short string nullable
• stock_name string nullable
• stock_name_en string nullable
• ticker string nullable
• business_registration_number string nullable
• corporate_registration_number string nullable
• ceo string nullable
• ceo_en string nullable
• company_class string nullable (one of: "kospi", "kospi_managed", "kosdaq", "kosdaq_managed", "konex", "k_otc", "externally_audited", "general", "sole_proprietor", "public_institution", "non_profit", "merged", "closed", "other")
• market string nullable (one of: "kospi", "kosdaq", "konex", "k_otc")
• size string nullable (one of: "large", "mid_sized", "small_medium", "other")
• status string nullable
• tax_status string nullable
• special_statuses array (default: [])
• established_date integer nullable
• opened_date integer nullable
• listed_date integer nullable
• closed_date integer nullable
• fiscal_year_end_month integer nullable
• financial_statement_date integer nullable
• employee_count integer nullable
• employee_count_date integer nullable
• industry_code string nullable
• industry string nullable
• industry_en string nullable
• products string nullable
• products_en string nullable
• business_types array (default: [])
• business_items array (default: [])
• group string nullable
• group_en string nullable
• group_code string nullable
• group_flagship string nullable
• bank string nullable
• bank_en string nullable
• bank_branch string nullable
• website string nullable
• image string nullable
• address string nullable
• address_en string nullable
• phone string nullable
• fax string nullable
• addresses array (default: [])
  • @type string (default: "NiceBizinfoAddress")
  • address string nullable
  • address_en string nullable
  • lot_address string nullable
  • lot_address_en string nullable
  • postal_code string nullable
  • legacy_postal_code string nullable
  • region string nullable
  • district string nullable
  • neighbourhood string nullable
  • phone string nullable
  • fax string nullable
• history string nullable
• certifications array (default: [])
  • @type string (default: "NiceBizinfoCertification")
  • code string required
  • name string nullable
  • is_valid boolean nullable
• patents array (default: [])
  • @type string (default: "NiceBizinfoPatentYear")
  • year integer required
  • patent_count integer nullable
  • registration_count integer nullable
• employment object nullable
  • @type string (default: "NiceBizinfoEmployment")
  • period string nullable
  • employee_count integer nullable
  • monthly_hires_count integer nullable
  • monthly_leavers_count integer nullable
  • annual_hires_count integer nullable
  • annual_hire_rate number nullable
  • annual_leavers_count integer nullable
  • annual_leave_rate number nullable
  • average_salary number nullable
  • average_salary_band string nullable
  • new_hire_average_salary number nullable
  • new_hire_average_salary_band string nullable
  • salary_source string nullable
  • pension_billed_amount number nullable
• industry_position array (default: [])
  • @type string (default: "NiceBizinfoIndustryPosition")
  • metric string required (one of: "activity", "profitability", "stability", "growth", "size")
  • rank_percent number nullable
  • score number nullable
  • band string nullable
  • band_en string nullable
• summary array (default: [])
• summary_date integer nullable
• updated_date integer nullable
• 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 — No company profile is published under that id 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.