Versions, limits, and operational parameters of this receiver.

GET

/v1/capabilities

const url = 'https://idmx.example.org/v1/capabilities';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://idmx.example.org/v1/capabilities

Unsigned. No feature flags: v1 has no optional behavior (capabilities.md §2). Receivers SHOULD send Cache-Control: max-age=3600; senders assume 1 hour without it and never use a document older than 24 hours (capabilities.md §4). Each successful fetch sets or refreshes the sender’s discovery pin.

Responses

200

Capabilities document.

application/json

Versions, limits, and operational parameters (capabilities.md §3). Members MUST NOT announce optional protocol behavior. Unknown members MUST be ignored.

object

versions

All major versions this receiver serves, as URL path segments. Absent means ["v1"]. Senders use the highest common version and MUST NOT probe version paths (discovery.md §5).

Array<string>

default: v1 >= 1 items unique items

max_message_size

required

Largest accepted request body in bytes. At least 25 MiB; no upper limit. Over limit -> message_too_large.

integer

>= 26214400

max_recipients

Largest accepted to length. Over limit -> invalid_request.

integer

default: 100 >= 100

discovery_pin_max_age

Seconds a sender pins this domain’s positive discovery result (discovery.md §3). 0 or absent removes the pin. Receivers SHOULD advertise 604800 (7 days); senders treat values above 31557600 (1 year) as 31557600.

integer

abuse_contact

Where to report abuse originating from the domains this receiver serves. One mailto: URI (RFC 6068) without header fields.

string format: uri

/^mailto:[^?]+$/

key

additional properties

any

Example

{
  "versions": [
    "v1"
  ],
  "max_recipients": 100,
  "abuse_contact": "mailto:abuse@receiver.example"
}

Headers

Cache-Control

string

default

RFC 9457 problem details. Semantics per type in errors.md.

application/problem+json

RFC 9457 problem details. type is https://idmx-project.org/problems/<identifier>.

object

type

required

string format: uri

title

string

status

integer

detail

string

instance

string

versions

REQUIRED in unsupported_version problems, absent otherwise: all major versions this receiver serves, as in the capabilities document (discovery.md §5.1).

Array<string>

unique items

key

additional properties

any

Example

{
  "type": "https://idmx-project.org/problems/invalid_request"
}