v1

latestOpenAPI 3.0.02026-07-23122.2 KB

Exemptions

Search for exemption certificates based on NHS Number, Forename, Surname, Date of Birth and Postcode

post/search

Request body

dobstring date required

Date of Birth

forenamestring required

Forename

nhsNumberstring required

NHS Number

postcodestring required

Postcode

prescriptionIdstring required

EPS R2 prescription ID

surnamestring required

Surname / Family Name

Example request

{
  "dob": "1993-06-22",
  "forename": "Adam",
  "nhsNumber": "9434765919",
  "postcode": "NE32JH",
  "prescriptionId": "471BC8-P83027-34B75X",
  "surname": "Johnson"
}

Response

Exemption has been found

messagestring

Message

typestring

Exemption type

Example response

{
  "message": "Exemption has been found / Exemption has not been found / bad request",
  "type": "9180 / null"
}

All 1 operations