registercheckby openlaw group
API referenceNew formations

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 invalid_request and changes nothing.

Costs 1 credit.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

formation_id*string

The formation's id, which is the company's id.

Formatuuid

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

curl -X PATCH "https://api.registercheck.de/v1/formations/3f1c2a9e-5b7d-4c8a-9e21-6d4f0b8a1c55" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "metadata": {      "crm_id": "0015g00000XyZ",      "team": null    }  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "formation",  "registration_date": "2026-09-30",  "created_at": "2026-09-30T13:52:00Z",  "company": {    "object": "company",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string"  },  "name": "string",  "legal_form": "gmbh",  "register": {    "court": {      "code": "D2601",      "name": "Amtsgericht München"    },    "type": "HRA",    "number": "292661",    "formatted": "Amtsgericht München HRB 292661",    "country": "DE"  },  "state": "DE-BW",  "registered_office": "Heidenheim an der Brenz",  "address": {    "street": "string",    "postal_code": "string",    "city": "string",    "care_of": "string",    "formatted": "string",    "country": "DE"  },  "capital": {    "amount": "25000.00",    "currency": "EUR"  },  "purpose": "string",  "metadata": {    "crm_id": "0015g00000XyZ",    "team": "kyc"  }}