registercheckby openlaw group
API referenceTransparency register

Create a connection

POST
/connections

Stores a login of a register account your workspace uses, as a connection, and answers it with an id. Only the Transparenzregister is a provider for now (provider: transparency_register).

A live connection holds your own Transparenzregister account: its e-mail and password (credentials) are stored encrypted, written once and never shown again, and the register is asked once whether it logs the account in (the connection is verified, unverified when the register could not be asked, or refused; a refused login is stored all the same, with its error). The register bills each retrieved document, 1,65 EUR, to that account, not to Registercheck. A test connection holds no login: it uses the register's published test account and its test system, and takes no credentials. The environment belongs to the connection, so an extract asked for with a test connection runs in the test system.

A workspace can hold many connections, for example one per client of yours; label them (label, metadata) to tell them apart. Only an owner or an admin of the workspace may create, change or delete one. At most five live logins an hour are checked for a workspace; past that the call answers 429 and stores nothing. An Idempotency-Key is not stored or replayed here: the body is a password.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A connection to create. A live one carries credentials, a test one none.

Response Body

application/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/connections" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "provider": "transparency_register",    "environment": "live",    "credentials": {      "email": "compliance@example.de",      "password": "an-example-password"    },    "label": "Kunde A",    "metadata": {      "client_id": "k-1042"    }  }'

{  "id": "conn_01k6hb7xq0fm8a4q2t7bw9c5ve",  "object": "connection",  "provider": "transparency_register",  "environment": "live",  "status": "verified",  "error": null,  "account": {    "email_masked": "c***@example.de"  },  "label": "Kunde A",  "metadata": {    "client_id": "k-1042"  },  "created_at": "2026-11-17T09:58:12Z",  "updated_at": "2026-11-17T09:58:12Z",  "last_verified_at": "2026-11-17T09:58:12Z"}