Register a Citizen (online)

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

Citizens can be registered with MyAccount by providing their Personal details, Address details and Login Credentials. 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. On creation of the account an auto generated email will be sent to the provided Email Address which will contain a randomly generated one time password along with provided username. Citizen can use these credentials received in email to login into the MyAccount Portal.

If the account with the provided details happen to exist already, then the account password will be reset and the new password with the existing username will be sent as e-mail to the existing account's email address. If a password is reset, the Level of Assurance remains the same.

New accounts cannot be created with existing usernames. Email Addresses can also be provided as username. 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 a contact (emailaddress with optional mobile and landline) and a username optionally a brandname

Examples

Using citizen details and address

{
  "method":"Registration",
  "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",
    "username": "goss.demo"
    },
  "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 Body

• ucrn
  • value- UCRN associated with the provided Citizen details in request
  • ucrnType
• uprn
  • value
  • uprnType
• NECCardNumber - Same NEC Card number as provided in Request
• username - Unique Username as provided in Request
• emailaddress - Same EmailAddress as provided in Request
• LoA - Level of Assurance associated with the newly created Citizen Account.

 Response Codes