Livedocs/api-reference/company-search
Company Search
Resolve a German company by name, city, register number, or clue.
Selection rule
Use the top result only when confidence and ordering eligibility make it safe. A high text match alone is not enough for paid ordering.
- Prefer exact HRB/HRA/VR matches.
- Prefer verified registry-cache or verified discovery candidates.
- Do not order from candidates with ordering_eligible=false.
POST
/api/v1/documents/companies/search/Resolve a company by name, city, HRB/HRA/VR number, LEI, director, or clue.
Status
Live
Auth
Public
Credit cost
0
Request
Send query and optional mode. Short ambiguous queries are capped below exact certainty.
Request body
{
"query": "BMW AG München",
"mode": "deep",
"discover": false
}Response
Returns candidates with confidence_label, confidence_reasons, source, registry_number, profile_id, and ordering_eligible.
Response body
{
"candidates": [
{
"name": "BMW AG",
"city": "München",
"court": "München",
"registry_number": "HRB 42243",
"source": "registry_cache",
"profile_id": "9f2...",
"confidence": 0.94,
"confidence_label": "exact",
"confidence_reasons": ["Exact HRB match", "Court matches"],
"ordering_eligible": true
}
]
}Ordering eligibility
- Use only results with ordering_eligible=true.
- Do not treat possible or needs_verification results as exact.
Code examples
cURL
curl -X POST https://openregis.com/api/v1/documents/companies/search/ \
-H "Content-Type: application/json" \
-d '{"query":"BMW AG München","mode":"deep"}'Fehler
| Code | Meaning | Client action |
|---|---|---|
| invalid_query | The query is empty or malformed. | Ask the user for a company name, city, or register number. |
| rate_limited | Too many search requests. | Back off and retry later. |