Skip to main content

POST /data-services/v1/{mpid}/appoint

Creates a data service appointment process for one MPAN.

Request​

Method and path:

  • POST /data-services/v1/{mpid}/appoint

Headers:

  • X-API-KEY (required): string, UUID format.
  • X-IDEMPOTENCY-KEY (required): string.
  • X-TEST-MODE (optional): string ("true" to suppress production comms).

Path parameters:

  • mpid (required): string supplier MPID.

Body schema:

  • Data service appointment request object
{
  "mpan_core": 1234567890123,
  "data_service_mpid": "DATS",
  "effective_from": "2026-03-30T00:00:00+00:00",
  "contract_reference": "DSA20260330",
  "appointment_scenario": "COS",
  "mdr_mpid": "MDRX",
  "mdr_effective_from": "2026-03-30T00:00:00+00:00",
  "consent_granularity": "H",
  "domestic_premise_indicator": true,
  "fall_back_read_frequency": "M"
}

Response​

Success:

  • 202 Accepted
  • Body: supplier process response object
{
  "request_id": "c0cc2c92-0e5f-43a3-8b4b-2a0b56338c12",
  "request_type": "data-service-appointment",
  "request_status": "Pending",
  "description": "Data Service Appointment Process",
  "created_at": "2026-03-24T10:40:00+00:00",
  "last_updated_at": "2026-03-24T10:40:00+00:00",
  "mpan_core": 1234567890123
}

Other documented responses:

  • 401 Unauthorized.
  • 409 Conflict.
  • 422 Validation error.
  • 428 Missing X-IDEMPOTENCY-KEY.

Field-level constraints: