registercheckby openlaw group
API referenceFormations

Update a formation's metadata

PATCH
/formations/{formation_id}

Changes your workspace's metadata on a formation and returns the formation. Metadata is merged: a key set to a string is added or replaced, a key set to null is removed, a key not named is left alone. Only your workspace sees it. A merged result over the limits answers 400 validation_failed naming /metadata and changes nothing.

Costs 1 credit.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer rc_prod_….

In: header

Path Parameters

formation_id*string

The formation's id, which is the company's id (cmp_…). Until 2026-12-31 a raw UUID is still accepted, and the response says so with Deprecation and Sunset.

Match^cmp_[0-7][0-9a-hjkmnp-tv-z]{25}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Changes to your metadata on a formation.

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 PATCH "https://api.registercheck.de/v1/formations/cmp_01hxn3rys1fh58w4d1pb1x9s81" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "metadata": {      "deal_id": "D-2026-41"    }  }'
{  "id": "cmp_01hxn3rys1fh58w4d1pb1x9s85",  "object": "formation",  "registration_date": "2026-09-30",  "created_at": "2026-09-30T13:52:00Z",  "company": {    "object": "company",    "id": "cmp_01hxn3rys1fh58w4d1pb1x9s85",    "name": "Beispiel Festival GmbH"  },  "name": "Beispiel Festival GmbH",  "legal_form": "gmbh",  "register": {    "court": {      "code": "D2601",      "name": "Amtsgericht München"    },    "type": "HRB",    "number": "999998",    "formatted": "Amtsgericht München HRB 999998",    "country": "DE"  },  "state": "DE-BY",  "registered_office": "München",  "address": {    "street": "Festwiese 3",    "postal_code": "80335",    "city": "München",    "care_of": null,    "formatted": "Festwiese 3, 80335 München",    "country": "DE"  },  "capital": {    "amount": "25000.00",    "currency": "EUR"  },  "purpose": "Planung und Durchführung von Beispielfestivals.",  "metadata": {}}