Documentation

Self-Service Profile Editing

Self-service profile editing lets people keep their own details up to date, along with the details of their young children and their spouse, without being given general access to profiles. You decide exactly which fields they can change, and Qik works out which profiles count as "theirs" from their email address and the relationships recorded between profiles.

Who can edit which profiles

When self-service is turned on for someone, they can edit three groups of profiles:

GroupWhich profilesLimits
ThemselvesEvery profile in your organisation that carries their login's email addressNone
DependantsProfiles recorded as their Child, Grandchild or Niece / NephewOnly while the dependant is under 18. A profile with no date of birth is treated as under 18.
SpouseProfiles recorded as their SpouseNo age limit

No other relationship gives self-service access. Siblings, parents, grandparents, cousins and friends aren't included, even if the person is a minor. Relationships are managed on the profile. See Profile Relationships.

Qik works this out fresh on every request. When a dependant turns 18, or you remove a relationship, access ends straight away. There's nothing to clean up.

When family members share an email address

If a child's profile uses a parent's email address, the child's profile would normally count as one of the parent's own profiles. If you record a Child (or Grandchild, or Niece / Nephew) relationship between the two profiles, Qik treats the child's profile as a dependant instead. That means the under-18 limit applies, and the parent's access ends when the child turns 18.

Which fields they can edit

Self-service only opens the fields you tick. Everything else on the profile stays hidden and locked, unless the person has other roles that open it.

  • Each field must be ticked individually. There's no "all fields" option for self-service.
  • The same set of fields applies to every profile the person can self-edit (themselves, dependants and spouse).
  • Ticked fields can be read as well as edited on those profiles.
  • Custom fields can be included. Ticking a group of fields includes every field inside it.

Setting it up

  1. Open the role you want to use, or create a new one. See Roles and Permissions.
  2. On the Permissions tab, find the Profile type. You can type "self service" into Search for permissions to jump to it.
  3. In the Self Service section, tick Self service editing. This is the on/off switch.
  4. In the field list below it, tick each field people may edit, for example phone numbers, address or a custom "Emergency contact" field. The field list stays greyed out until the switch is on.
  5. Save the role.
  6. Give the role to the people who should use self-service. You can add it to an access pass on their login, or attach it to a position they hold in a group. See Managing Users and Access Passes.

Self-service appears only on the base Profile type in the role editor. It isn't offered on individual profile content types, and it works the same whichever scope the role is granted in.

What people see

In your organisation's Qik mobile app, people with self-service see a My Details button on their account screen. It opens a page listing:

  • You: their own profiles
  • Family: their eligible dependants and spouse, each labelled with their relationship

Tapping a profile opens a form with only the fields you've opened for self-service, and a Save changes button. If no fields are open, the person sees a message saying their details are view only. If the My Details button doesn't appear at all, self-service isn't turned on for that login.

Adding a family member

The My Details page also has an Add family member button. The person chooses a Relationship to you (Child, Grandchild, Niece / Nephew or Spouse) and fills in a short form:

  • first name (required), last name and date of birth
  • any other standard profile fields you've opened for self-service (custom fields can be filled in afterwards from the edit screen)

Qik creates a new profile, places it in the same scopes as the person's own profile, and records the relationship. Adding a family member never links to an existing profile, so nobody can use it to pull someone else's record into their own access. If the new profile duplicates an existing one, merge them as usual. See Merging Duplicate Profiles.

For builders

Self-service is enforced by Qik's access rules, not by the app screen, so it applies however a profile is edited. If you're building your own website or app with logins, you can offer the same experience through these endpoints:

  • GET /user/self: the profiles the signed-in person can self-edit, and which fields are editable
  • GET /user/self/:profileId: one of those profiles
  • PATCH /user/self/:profileId with { "data": { … } }: save changes
  • POST /user/self/dependents with { "relation", "profile" }: add a family member

When self-service isn't turned on for the login, these return an error saying it isn't enabled.

Tips and limits

  • Self-service is separate from Edit any and Edit own. People don't need either, and giving them either opens much more than self-service does.
  • Only the people listed above are covered. To let someone manage other profiles, use a normal role in the right scope.
  • Read-only fields can't be made editable through self-service.
  • Self-service is one of the built-in rules that give access beyond roles. See Access Beyond Roles.

FAQs

Can I just let people edit all fields on their own profile?
A parent can't see their teenager under Family. Why?
Do people need Edit own on profiles as well?
Can someone add an existing person as their child?