Skip to main content

Data Service API Overview

Base route:

  • /data-services/v1

Authentication:

  • Header X-API-KEY is required.
  • Header X-IDEMPOTENCY-KEY is required on the appointment endpoint.

Description​

The Data Service Appointment process appoints or updates data services for a single MPAN and tracks the market lifecycle until the appointment is active (or fails/cancels). SSI sends outbound DIP appointment requests, handles inbound outcome messages, updates MPAN data service fields, and can trigger downstream migration/read flows where applicable.

Process Overview​

  1. Supplier submits POST /data-services/v1/{mpid}/appoint.
  2. SSI validates request/auth/idempotency, ensures there is no conflicting active DS appointment process, and creates a Pending process.
  3. SSI sends outbound IF-031 (DSApp) to DIP.
  4. DIP returns IF-032 (initial response):
    • R (rejected) -> process ends Failed.
    • otherwise -> SSI waits for IF-035 appointment outcome.
  5. DIP returns IF-035:
    • R or L -> process ends Failed.
    • A (accepted) -> continue.
  6. Accepted branch handling:
    • update-of-service/MDR-change path may complete directly after applying MDR updates.
    • standard appointment path waits for IF-036 active confirmation at the effective date/SLA.
  7. DIP returns IF-036 (active): SSI updates MPAN data service fields (service IDs, effective dates, consent granularity, MDR fields) and marks the process Success.
  8. Migration/co-agent branches may trigger additional downstream notifications and read/migration processes, as shown in the flow diagram.

Process Diagram​

Endpoints​

  • POST /data-services/v1/{mpid}/appoint: appoint a data service for one MPAN.

Docs in this section​