Register a Citizen (offline)

The following details are taken from the documentation available on https://spportal.mycas.org.uk

This service is used to register Citizens with MyAccount without login credentials. Citizens can be registered Offline with MyAccount by providing their Personal details and Address details. This Web Service can also be used to re-register a Citizen account if the account was already created for the Citizen previously. The Citizen Accounts created by this web service will be registered with Assurance Level Zero.

If the account with the provided details happen to exist already, then relevant message will be returned. There will not be any effect on the existing accounts.

If the provided details like First name, Last name, Gender and Date of Birth match exactly with a unique record of the NHSCR data, then a Permanent UCRN is returned in response otherwise a Temporary UCRN is generated and returned. Also if multiple matches are found in NHSCR data, Middle Name, Mother's Birth Surname and Place of Birth provided in request can be used to uniquely match a record.

Guidance

• Either of Citizen details or UCRN can be passed for this web service. If both are passed the UCRN takes the precedence
• Either of AddressInput or UPRN can be passed for this web service. If both are passed the UPRN takes the precedence
• UCRNType and UPRNType will be ignored even if the permissible values are provided and will only work for the genuine UCRN and UPRN respectively

Request

requires a UCRN or citizen details  consisting of a Name (firstname, lastname and optional middlename), gender, dateofbirth and optionally placeofbirth and mothersbirthsurname and a UPRN or an Address containing adressline1 (optionally addressline2 and addressline3) town, postcode and Local Authority Code and optionally a contact (emailaddress with optional mobile and landline).

Examples

Using citizen details and address

{
  "method":"RegisterOffline",
  "params":{
    "callertoken":"YourCallerToken",
    "firstname": "Goss",
    "middlename": "isstill",
    "lastname": "Testing",
    "gender": "M",
    "dateofbirth": "1999-11-15T00:00:00",
    "placeofbirth": "Plymouth",
    "mothersbirthsurname": "Netserve",
    "mobile": "",
    "landline": "0844 8803637",
    "emailaddress": "goss.demo@gmail.com",
    "addressline1": "24 Darklake View",
    "town": "Plymouth",
    "postcode": "PL6 7TL",
    "lacode": "9079"
    },
  "id":"12",
  "jsonrpc": "2.0"
}

Using UCRN and UPRN

{
  "method":"Registration",
  "params":{
    "callertoken":"YourCallerToken",
    "ucrn": "2100000000000000193",
    "ucrntype": "P",
    "uprn": "135024740",
    "uprntype": "P",
    "mobile": "",
    "landline": "0844 8803637",
    "emailaddress": "goss.demo@gmail.com",
    "username": "goss.demo"
    
    },
  "id":"12",
  "jsonrpc": "2.0"
}

Response

• UCRN
  • UCRNType
• UPRN
  • UPRNType
• EmailAddress - Same EmailAddress as provided in Request
• LoA

Response Codes