v1

latestOpenAPI 3.0.3MIT2026-07-23243157.4 KB
Interested Party

Retrieves an interested party by token

Retrieves an interested party by token and returns the interested party details if email provided in body matches retrieved party's email

post/api/v1/interested-party/{token}

Path parameters

tokenstring required

Encrypted interested party ID

Request body

emailstring

Example request

{
  "email": "person@example.org"
}

Response

Returns an interested party

IDnumber
caserefstring
behalfstring
menamestring
mebuildstring
mestreetstring
metownstring
mecountystring
mecodestring
mecountrystring
memailstring
mephonestring
orgnamestring
contactNamestring
contactJobstring
orgbuildstring
orgstreetstring
orgtownstring
orgcountystring
orgcodestring
orgcountrystring
orgmailstring
orgphonestring
younamestring
youbuildstring
youstreetstring
youtownstring
youcountystring
youcodestring
youcountrystring
youmailstring
youphonestring
agnamestring
agorgnamestring
agbuildstring
agstreetstring
agtownstring
agcountystring
agcodestring
agcountrystring
agmailstring
agphonestring
therepstring
validatedstring date
emailedstring date
exportedstring date
web_refnumber

Example response

{
  "ID": 30000120,
  "caseref": "EN010009",
  "behalf": "me",
  "mename": "David White",
  "mebuild": "Temple Quay",
  "metown": "BRISTOL",
  "mecode": "BS1 6PN",
  "mecountry": "United Kingdom",
  "memail": "person@example.org",
  "mephone": "0303 111 111",
  "therep": "this is my test that form unchanged for non material change projects after ACR051 developed.  Jun 2021",
  "validated": "2021-06-22T14:45:46.000Z",
  "emailed": "2021-06-22T14:45:46.000Z",
  "web_ref": 1
}