Read API key access

GET/v1/auth/access

Returns the subject, mode, and scopes for the API key.

General API key authenticationVersion 2026-09-28

Request example

curl -X GET 'https://api.affinityrx.com/v1/auth/access' \
  -H "Authorization: Bearer $AFFINITY_API_KEY" \
  -H 'Affinity-Version: 2026-09-28'

Response example

These examples show the body structure. Values can differ. Select a status code to see its response.

{
  "apiKey": {
    "id": "key_01j2y8m6jcc9tt24af5pw9x1bc",
    "keyPrefix": "<string>",
    "object": "api_key"
  },
  "livemode": false,
  "object": "api_access",
  "scopes": [
    "<string>"
  ],
  "serviceAccount": {
    "apiVersion": "2026-09-28",
    "id": "sa_01j2y8m6jcc9tt24af5pw9x1bc",
    "object": "service_account",
    "subjectId": "<string>",
    "subjectType": "<string>"
  }
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 400,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 401,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 403,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 429,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

Implementation specification

Use these field types and limits to build your integration. Download the OpenAPI document for the complete contract.

Headers

Affinity-Versionstring

Selects the HTTP API contract for this request only. When omitted, API-key requests use their service account’s stored version. Does not change the stored default.

Pin requests to 2026-09-28.

Response specifications

200Successful response

application/json

apiKeyobjectrequired

No additional properties

Show apiKey fields

idstringrequired

Pattern: ^key_[0-7][0-9a-hjkmnp-tv-z]{25}$

keyPrefixstringrequired

objectstringrequired

Allowed: "api_key"

livemodebooleanrequired

objectstringrequired

Allowed: "api_access"

scopesstring[]required

Show scopes fields

Array items · string

string

serviceAccountobjectrequired

No additional properties

Show serviceAccount fields

apiVersionstringrequired

Show apiVersion fields

Any of · 1: string

string

Allowed: "2026-09-28"

idstringrequired

Pattern: ^sa_[0-7][0-9a-hjkmnp-tv-z]{25}$

objectstringrequired

Allowed: "service_account"

subjectIdstringrequired

subjectTypestringrequired

400HTTP 400

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

401Unauthorized

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

403Forbidden

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

429Too many requests

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri