Skip to main content

POST /regs-details/v1/{mpid}

Creates a change of registration details process for a single MPAN.

Request​

Method and path:

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

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:

  • ChangeOfRegRequestSchema

Example body:

{
  "request_type": "AddressChange",
  "mpan_core": 1234567890123,
  "address_line_1": "12 Market Street",
  "address_line_2": "Suite 4",
  "postcode": "AB1 2CD"
}

Other supported request types include:

  • DomIndicatorChange
  • ConsentGranularityChange
  • IHDStatusChange
  • SMSOChange
  • RelatedMPANAdd, RelatedMPANCreate, RelatedMPANRemove
  • LinkedMPANAdd, LinkedMPANCreate, LinkedMPANRemove

Response​

Success:

  • 202 Accepted
  • Body type: SupplierProcessResponseSchema
{
  "request_id": "6f63a1e1-3e36-420f-a2e0-f9b93f5f0a2f",
  "request_type": "change-of-reg-details",
  "request_status": "Pending",
  "description": null,
  "created_at": "2026-03-24T10:15:00+00:00",
  "last_updated_at": "2026-03-24T10:15:00+00:00",
  "mpan_core": 1234567890123
}

Other documented responses:

  • 400 MPAN not found or invalid request lookup in downstream logic.
  • 401 Unauthorized.
  • 409 Conflict.
  • 422 Validation error.
  • 428 Missing X-IDEMPOTENCY-KEY.

Field-level constraints: