Loss of Supplier Schema Reference

This page summarizes the request and response contract for the Loss of Supplier API.

Headers and Parameters

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

Invitation List Item Schema (LoSRequestSchema)

Used by:

• GET /loss-of-supplier/v1/{mpid}/list

Field	Required	Type	Format / Constraints
request_id	No	string(UUID) or null	UUID when present
mpan_core	Yes	integer	Exactly 13 digits
created_at	No	string(datetime) or null	ISO 8601 datetime
active_registration_id	Yes	string	Max length 36
pending_registration_id	Yes	string	Max length 36
gaining_supplier_mpid	Yes	string	Exactly 4 characters
gaining_supplier_role	Yes	string	Exactly 1 character
supply_start_date	Yes	string(datetime)	ISO 8601 datetime
intervention_start_date	No	string(datetime) or null	ISO 8601 datetime
objection_window_end_date	No	string(datetime) or null	ISO 8601 datetime
annulment_window_end_date	No	string(datetime) or null	ISO 8601 datetime

Intervention Request/Response Schema (InterventionSchema)

Used by:

• POST /loss-of-supplier/v1/{mpid}/intervene

Field	Required	Type	Format / Constraints
mpan_core	Yes	integer	Exactly 13 digits, numeric
request_id	Yes	string	UUID
intervention_type	Yes	string(enum)	Supported values: Objection, Annulment, NoObjection
updated_at	No	string(datetime) or null	Returned in the response; ignored if supplied on request

Additional validation notes:

• Missing or malformed request_id values are rejected by UUID validation.
• Send only documented request fields.