Skip to main content

POST /psr-details/v1/{mpid}

Adds or amends PSR details for one MPAN. The service treats the request as a new submission or an update based on whether active PSR details already exist for the MPAN.

Request​

Method and path:

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

Headers:

  • X-API-KEY (required): string, API key in UUID format.
  • X-IDEMPOTENCY-KEY (required): string.

Path parameters:

  • mpid (required): string supplier MPID.

Body schema:

  • PSRDetailsNewRequestSchema
{
  "mpan_core": 1234567890123,
  "primary_psr_contact_name": "Jane Doe",
  "primary_psr_phone_number_1": "07123456789",
  "primary_psr_phone_number_2": null,
  "alternate_psr_contact_name": "John Doe",
  "alternate_psr_phone_number_1": "+44 7123 456789",
  "alternate_psr_phone_number_2": null,
  "psr_address_line_1": "Flat 1",
  "psr_address_line_2": "10 High Street",
  "psr_address_line_3": null,
  "psr_address_line_4": null,
  "psr_address_line_5": null,
  "psr_address_line_6": null,
  "psr_address_line_7": null,
  "psr_address_line_8": null,
  "psr_address_line_9": null,
  "psr_postcode": "AB1 2CD",
  "lawful_basis_for_sharing": true,
  "psr_details": [
    {
      "psr_category": "29",
      "psr_expiry_date": "20270401",
      "additional_information": null
    },
    {
      "psr_category": "17",
      "psr_expiry_date": null,
      "additional_information": "Medical equipment on site"
    }
  ]
}

Response​

Success:

  • 202 Accepted
  • Body type: SupplierProcessResponseSchema
{
  "request_id": "72f30f06-afcc-4ad8-8c1f-78e556ea9cbc",
  "request_type": "psr-details",
  "request_status": "Pending",
  "description": "PSR Details Process",
  "created_at": "2026-03-11T14:04:22+00:00",
  "last_updated_at": "2026-03-11T14:04:22+00:00",
  "mpan_core": 1234567890123
}

Other documented responses:

  • 401 Unauthorized
  • 422 Validation error
  • 428 Missing X-IDEMPOTENCY-KEY

Field-level constraints: