Data Service Schema Reference

Headers and Parameters

Field	Location	Required	Type	Format / Constraints
X-API-KEY	Header	Yes	string	UUID format
X-IDEMPOTENCY-KEY	Header	Yes	string	Non-empty string
X-TEST-MODE	Header	No	string	Optional; "true" enables test mode
mpid	Path	Yes	string	Supplier MPID

Request Schema

Field	Required	Type	Format / Constraints
mpan_core	Yes	integer	Exactly 13 digits, numeric
data_service_mpid	Yes	string	Exactly 4 alphabetic characters
effective_from	Yes	string(datetime)	ISO 8601 with timezone; must be midnight; cannot be 28 days or more in the future
contract_reference	No	string or null	Max 50 chars; must be alphanumeric
appointment_scenario	Yes	string(enum)	One of COS, CSP, USP, SEG, MCA, MCS
mdr_mpid	No	string or null	If provided: exactly 4 alphabetic characters
mdr_effective_from	Conditional	string(datetime) or null	Required when mdr_mpid is supplied; ISO 8601 with timezone
consent_granularity	Yes	string(enum)	One of H, D, M, N
domestic_premise_indicator	Yes	boolean	true or false
fall_back_read_frequency	No	string(enum) or null	One of F, W, M, Q, S, A

Additional validation notes:

• Unknown fields are explicitly rejected.
• consent_granularity and domestic_premise_indicator are required on this endpoint.

Response Schema

Field	Required	Type	Format / Constraints
request_id	Yes	string	UUID
request_type	Yes	string	Process type name
request_status	Yes	string(enum)	Pending, Success, Failed
description	No	string or null	Optional process description
created_at	Yes	string(datetime)	ISO 8601 datetime
last_updated_at	Yes	string(datetime)	ISO 8601 datetime
mpan_core	Yes	integer	MPAN core