Filter companies by structured criteria
Builds a company segment from company, financial, role and shareholder
criteria. All top-level criteria must match. Within roles and shareholders,
match decides whether every condition or any condition must hold.
Pages by limit and cursor in the body. A cursor holds this filter, not its page size: the
next page may ask for another limit. A cursor sent with another filter answers
400 validation_failed naming /cursor.
A page holds at most 1,000 companies (limit), and a filter serves its first 10,000
companies: the last page within them has no next_cursor, and a page that would cross
them ends at them. To reach companies beyond them, narrow the filter.
Costs 1 credit per 10 returned results: ⌈returned/10⌉ a call, nothing when none is
found. The balance must hold ⌈limit/10⌉ before the call; the answer is charged for
what it returns.
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 structured company filter. At least one criterion.
A criterion the data store cannot apply is refused with 400 invalid_request, before anything is charged, rather than answered with a wider or empty page. For now that includes more than one officer or shareholder condition: send one condition per filter.
1 <= propertiesResponse Body
application/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/search/companies/filter" \ -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "company": { "status": [ "active" ], "legal_form": [ "gmbh", "ug" ], "industry": [ "62" ], "near": { "latitude": 48.1374, "longitude": 11.5755, "radius_meters": 25000 } }, "roles": { "match": "all", "conditions": [ { "last_name": { "contains": "Müller" }, "status": "current" } ] }, "limit": 50 }'{ "object": "page", "next_cursor": null, "total_count": 1, "data": [ { "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" } ]}