Change of Registration Details Schema Reference

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

Request Schema (ChangeOfRegRequestSchema)

Field	Required	Type	Format / Constraints
request_type	Yes	string(enum)	Allowed values include AddressChange, DomIndicatorChange, ConsentGranularityChange, IHDStatusChange, SMSOChange, RelatedMPANAdd, RelatedMPANCreate, RelatedMPANRemove, LinkedMPANAdd, LinkedMPANCreate, LinkedMPANRemove
mpan_core	Yes	integer	Exactly 13 digits, numeric
address_line_1 .. address_line_9	Conditional	string or null	Used for AddressChange; max 40 chars; EDIFACT character set only
postcode	Conditional	string or null	Required for AddressChange; max 10 chars; alphanumeric plus spaces
is_dom_indicator	Conditional	boolean or null	Required for DomIndicatorChange
consent_granularity	Conditional	string(enum) or null	Required for ConsentGranularityChange; one of H, D, M, N
consent_granularity_efd	Conditional	string(datetime) or null	Required for ConsentGranularityChange; ISO 8601 with timezone
ihd_install_status	Conditional	string(enum) or null	Required for IHDStatusChange; one of I, D, E, F
ihd_install_status_efd	Conditional	string(datetime) or null	Required for IHDStatusChange; ISO 8601 with timezone
smso	Conditional	string or null	Required for SMSOChange; exactly 4 alphabetic characters
smso_efd	Conditional	string(datetime) or null	Required for SMSOChange; ISO 8601 with timezone; must be in the past, but no more than 5 days old
related_mpan_secondary	Conditional	integer or null	Required for related MPAN request types; integer and 13 digits
linked_mpan_import_export	Conditional	integer or null	Required for linked MPAN request types; integer and 13 digits

Additional validation notes:

• For AddressChange, at least one address_line_* field must be populated.
• Unknown fields are explicitly rejected.
• This endpoint supports the request types listed in the table above.

Create Response Schema (SupplierProcessResponseSchema)

Used by:

• POST /regs-details/v1/{mpid}

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