Find companies by asking in words
Reads a written request (prompt) into the structured filter, runs it through
the filter search, and answers the page with each hit's officer: the first
current representative (Geschäftsführung, Vorstand, Inhaber — anyone the store
keeps among the representatives) meeting the interpreted age condition, if the
request names one. Every hit comes from the register data; the model only maps
words to filter fields, and what it cannot map comes back verbatim in
unrecognized.
Explicit filters win over the prompt on the same field (a whole roles block
replaces the reading's); filters takes no limit or cursor of its own —
those are the request's. only_active (the default) adds status: ["active"].
A prompt and filters that together name no criterion answer
422 prompt_not_understood, uncharged.
Pages by limit and cursor as the filter search does: one page holds at most
100 companies, the first 10,000 are served, and a cursor holds the interpreted
filter it continues, so the prompt is not read again on the next page. Results
come in the filter search's order.
Costs 1 credit per 10 requested results, ⌈limit/10⌉ a call.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer rc_live_….
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A written request for companies. The request is read into the structured filter
(interpreted_filter in the answer); explicit filters win over what it says on the same
field, and a whole roles block replaces the reading's.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.registercheck.de/v1/companies/find" \ -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "prompt": "Such mir alle Firmen im Baugewerbe in Bayern mit Geschäftsführer über 60 Jahre", "limit": 25 }'{ "object": "page", "prompt": "Such mir alle Firmen im Baugewerbe in Bayern mit Geschäftsführer über 60 Jahre", "interpreted_filter": { "company": { "industry": [ "F" ], "state": { "equals": "DE-BY" }, "status": [ "active" ] }, "roles": { "match": "all", "conditions": [ { "status": "current", "age": { "gte": 61 } } ] } }, "unrecognized": [], "total_count": 1, "data": [ { "company": { "object": "summary", "type": "company", "id": "cmp_01hxn3rys1fh58w4d1pb1x9s81", "name": "Beispiel Reisen GmbH", "status": "active", "legal_form": "gmbh", "register": { "court": { "code": "D2601", "name": "Amtsgericht München" }, "type": "HRB", "number": "999999", "formatted": "Amtsgericht München HRB 999999", "country": "DE" }, "address": { "city": "München" }, "registration_date": null, "founding_date": "2010-01-15" }, "officer": { "id": "per_01hxn3rys1fh58w4d1pb1x9s82", "name": "Erika Mustermann", "age": 66 } } ], "next_cursor": null}