/acra/companies/search

POST /api/acra/companies/search

Price: 1 credit

Search Singapore companies in the ACRA registry

How to use it

Search the Singapore ACRA registry of business entities. Provide a full-text 'query' over the entity name and/or structured filters: entity_status, legal_entity_type, issuance_agency, postal_code. Returns matching entities with their UEN, name, legal entity type, status, issuance agency, UEN issue date and registered street/postal code.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Full-text search over the entity name (examples: "DBS BANK", "MILLENNIUM")
• entity_status string nullable — Filter by entity status. Limited to the searchable values Registered / Deregistered, which differ from the more detailed status returned by the get-by-id endpoint. (examples: "Registered", "Deregistered")
• legal_entity_type string nullable — Filter by legal entity type (examples: "Local Company", "Sole Proprietorship/ Partnership", "Limited Liability Partnership")
• issuance_agency string nullable — Filter by UEN issuance agency (examples: "ACRA")
• postal_code string nullable — Filter by registered address postal code (examples: "189648")
• count integer required — Max result count (min: 1)

Response

• @type string (default: "AcraCompany")
• uen string required
• url string required
• entity_name string nullable
• legal_entity_type string nullable
• entity_status string nullable
• issuance_agency string nullable
• business_constitution string nullable
• company_type string nullable
• paf_constitution string nullable
• registration_date string nullable
• uen_issue_date string nullable
• account_due_date string nullable
• annual_return_date string nullable
• primary_ssic_code string nullable
• primary_ssic_description string nullable
• primary_activity string nullable
• secondary_ssic_code string nullable
• secondary_ssic_description string nullable
• secondary_activity string nullable
• officer_count integer nullable
• address object nullable
  • @type string (default: "AcraAddress")
  • block string nullable
  • street_name string nullable
  • level_no string nullable
  • unit_no string nullable
  • building_name string nullable
  • postal_code string nullable
  • other_address_line1 string nullable
  • other_address_line2 string nullable
  • address_type string nullable
  • full_address string nullable
• former_names array (default: [])
• audit_firms array (default: [])
  • @type string (default: "AcraAuditFirm")
  • name string nullable
  • uen string nullable

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 — The entity was not found, or a precondition failed 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.