/rhode_island/companies/search

POST /api/rhode_island/companies/search

Price: 5 credits

Search Rhode Island businesses by name in the Secretary of State registry. Returns each matching entity's Identification Number, name, NAICS code, active/inactive flag and address.

How to use it

Find Rhode Island businesses by name (e.g. 'CVS', 'HASBRO'). Returns id_number, name, naics, is_inactive and address for each match. Use search_type to control matching (begins_with, exact_match, full_text, soundex) and status to restrict to active or inactive entities. Feed id_number into rhode_island/companies to get the full registry record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Company name to search for (examples: "CVS", "HASBRO"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• search_type string — How to match the name against the registry (default: "begins_with"; one of: "begins_with", "exact_match", "full_text", "soundex")
• status string — Restrict results to active or inactive entities (default: "active"; one of: "active", "inactive")

Response

• @type string (default: "RhodeIslandCompanySearchItem")
• id_number string required
• name string nullable
• naics string nullable
• is_inactive boolean (default: false)
• address 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.