/rues/companies/search

POST /api/rues/companies/search

Price: 10 credits

Search Colombian companies in the RUES mercantile registry by name or identification number

How to use it

Search Colombian companies in RUES by name or NIT. Returns the internal RUES id for the detail endpoint.

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 or identification number to search (examples: "bancolombia"; minLength: 1)
• search_by string — Search the query as a company name or as an identification number (default: "name"; one of: "name", "identification")
• status array nullable — Filter by registration status (one of: "ACTIVA", "CANCELADA")
• category array nullable — Filter by registration category (one of: "JURIDICA", "NATURAL", "COMERCIO", "SUCURSAL", "AGENCIA")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "RuesSearchResult")
• id string required
• name string required
• sigla string nullable
• registration_number string nullable
• nit string nullable
• identification_number string nullable
• dv string nullable
• chamber_code string nullable
• chamber string nullable
• department string nullable
• municipality string nullable
• company_type_code string nullable
• company_type string nullable
• legal_organization string nullable
• registration_category string nullable
• status string nullable
• ciiu_primary_code string nullable
• ciiu_secondary_code string nullable
• registration_date string nullable
• updated_at string nullable
• proponent_registration string nullable
• is_lottery_seller boolean (default: false)

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.