Search Citizen Details

This Method is not documented on the support portal https://spportal.mycas.org.uk but the service is currently available (June 2016)

The details of a uniquely matching Citizen Account can be searched using this web service.

Guidance

• UCRNType will be ignored even if a permissible value is provided and will only work for the genuine UCRN

Request

requires one of UCRN and UCRN Type, neccardnumber, emailaddress, username or citizen details  consisting of a Name (firstname, lastname and optional middlename), gender, dateofbirth and optionally placeofbirth and mothersbirthsurname.

Examples

Using citizen details

{
  "method":"searchCitizenDetails",
  "params":{
    "callertoken":"YourCallerToken",
    "firstname": "Goss",
     "middlename": "is",
     "lastname": "Testing",
     "gender": "F",
     "dateofbirth": "1999-11-15T00:00:00",
     "placeofbirth": "Plymouth",
     "mothersbirthsurname": "Netserve"
    },
  "id":"12",
  "jsonrpc": "2.0"
}

Using UCRN

{
  "method":"searchCitizenDetails",
  "params":{
    "callertoken":"YourCallerToken",
    "ucrn": "UCR859"
    },
  "id":"12",
  "jsonrpc": "2.0"
}

Using NEC card

{
  "method":"searchCitizenDetails",
  "params":{
    "callertoken":"YourCallerToken",
    "neccardnumber": "1234567890"
    },
  "id":"12",
  "jsonrpc": "2.0"
}

Using Username

{
  "method":"searchCitizenDetails",
  "params":{
    "callertoken":"YourCallerToken",
    "emailaddress": "[email protected]"
    },
  "id":"12",
  "jsonrpc": "2.0"
}

Using Emailaddress

{
  "method":"searchCitizenDetails",
  "params":{
    "callertoken":"YourCallerToken",
    "username": "goss.demo"
    },
  "id":"12",
  "jsonrpc": "2.0"
}

Response Body

• citizenAccount (Array)
  • basicCitizenDetails
    • name
      • firstname
      • middlename
      • lastname
    • gender
    • dateOfBirth
    • dateOfDeath
    • placeOfBirth
    • mothersBirthSurname
  • additionalCitizenDetails
    • preferredName
      • preferredFirstname
      • preferredMiddlename
      • preferredLastname
    • nickName
  • contact
    • mobileNumber
    • landlineNumber
    • emailAddress
  • ucrn
    • value- UCRN associated with the provided Citizen details in request
    • ucrnType
  • accountDetails
    • loA
    • loAApprovedBuOrgCode
    • username
    • accountStatus
  • addressDetails
    • address  (Array)
      • addressDetails
        • addressLine
          • addressLine1
          • addressLine2
          • addressLine3
        • town
        • postCode
        • addressProvider
      • addressString
      • uprn
        • value
        • uprnType
      • isPrimaryAddress
  • documentDetails
  • document (Array)
    • documentNumber
    • documentType
    • attachmentBytes
  • cardDetails
    • card (Array)
      • cardNumber
      • cardType

Response Codes

NB these are observed responses the service may return other codes