Skip to main content

GET /psr-details/v1/{mpid}?mpan_id=...

Returns the latest active PSR details for one MPAN.

Request​

Method and path:

  • GET /psr-details/v1/{mpid}?mpan_id=1234567890123

Headers:

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

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • mpan_id (required): integer MPAN core.

Request body:

  • None.

Response​

Success:

  • 202 Accepted
  • Body type: PSRCustomerResponseSchema
{
  "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_postcode": "AB1 2CD",
  "lawful_basis_for_sharing": true,
  "psr_details": [
    {
      "psr_category": "29",
      "psr_expiry_date": "20270401",
      "additional_information": null
    }
  ]
}

No content case:

  • 204 No Content when no active PSR details exist for the MPAN.

Field-level constraints: