Solia Direct DocsControl Plane
⌘K

API ReferenceReference

Subjects endpoints

Exact request and response contracts for the subjects endpoints, generated from the enforced Partner API contract.

Machine-readable OpenAPI description

Endpoints in this group

PUT/v1/subjects/{externalSubjectId}Register or update your opaque subject reference

Base path: /api/public/partner/v1. Every response carries request_id; every failure uses the standard error envelope documented under Errors.

PUT/v1/subjects/{externalSubjectId}

Register or update your opaque subject reference

Send only your own opaque identifier. Do not send names, dates of birth or clinical detail.

Authentication & scope

  • Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
  • Required scope: subjects:write. A key without it is refused with 403 forbidden.

Path parameters

  • externalSubjectId (required) — string

Responses

  • 200 — The subject link.
json
{
  "data": {
    "external_subject_id": "string",
    "linked": true
  },
  "request_id": "string",
  "cursor": "string"
}