Add a company or person to a collection
You send only the reference; the name is resolved from the register. Adding an
entity that is already on the collection returns 409 with the existing item's id.
Free.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer rc_live_….
In: header
Path Parameters
The collection's id.
uuidHeader Parameters
Makes a retry safe. A request repeated with the same key within 24 hours returns
the first successful response (with Idempotent-Replayed: true) instead of acting
twice; an error is not stored, so its retry runs again. Reusing a key with a different
body returns 422; retrying while the first request is still running returns 409.
Use a random UUID.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
An entity to add. Send only its type and id.
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
curl -X POST "https://api.registercheck.de/v1/collections/0395bbca-b4c7-4bfe-894b-e4e50256dc90/items" \ -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "entity": { "object": "company", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "collection_item", "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80", "entity": { "object": "company", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "note": "string", "created_at": "2019-08-24T14:15:22Z", "metadata": { "crm_id": "0015g00000XyZ", "team": "kyc" }}